feat: Adds UsageRecord in subscription

Toaztr · Oct 18, 2021 · 8a2c5eb · 8a2c5eb
1 parent 1c532f4
commit 8a2c5eb
Show file tree

Hide file tree

Showing 7 changed files with 161 additions and 86 deletions.
diff --git a/models/Subscription.v1.json b/models/Subscription.v1.json
@@ -3,6 +3,15 @@
   "description": "Souscription Toaztr",
   "type": "object",
   "properties": {
+    "source": {
+      "type": "string",
+      "description": "Système qui a créé la souscription.",
+      "enum": [
+        "STRIPE",
+        "MANUAL",
+        "MASTER"
+      ]
+    },
     "type": {
       "$ref": "./SubscriptionType.v1.json"
     },
@@ -23,15 +32,6 @@
       "format": "date-time",
       "description": "Date limite de validité."
     },
-    "source": {
-      "type": "string",
-      "description": "Système qui a créé la souscription.",
-      "enum": [
-        "STRIPE",
-        "MANUAL",
-        "MASTER"
-      ]
-    },
     "scopes": {
       "description": "Scopes authorisés pour la souscription.",
       "type": "array",
@@ -50,6 +50,12 @@
       "description": "Nombre d'items en utilisation.",
       "minimum": 0,
       "default": 0
+    },
+    "metered_items": {
+      "type": "array",
+      "items": {
+        "$ref": "./SubscriptionMeteredItem.v1.json"
+      }
     }
   },
   "required": [

diff --git a/models/SubscriptionMeteredItem.v1.json b/models/SubscriptionMeteredItem.v1.json
@@ -0,0 +1,26 @@
+{
+  "type": "object",
+  "title": "SubscriptionMeteredItem",
+  "description": "Critères de sélection des appels enregistrés.",
+  "properties": {
+    "name": {
+      "type": "string",
+      "description": "Nom de l'item"
+    },
+    "ref": {
+      "type": "string",
+      "description": "Référence de l'item."
+    },
+    "paths": {
+      "type": "array",
+      "items": {
+        "$ref": "./SubscriptionMeteredPath.v1.json"
+      }
+    }
+  },
+  "required": [
+    "name",
+    "ref",
+    "paths"
+  ]
+}
diff --git a/models/SubscriptionMeteredPath.v1.json b/models/SubscriptionMeteredPath.v1.json
@@ -0,0 +1,18 @@
+{
+  "type": "object",
+  "title": "SubscriptionMeteredPath",
+  "description": "Chemin HTTP.",
+  "properties": {
+    "method": {
+      "$ref": "./SubscriptionRequestLogMethod.v1.json"
+    },
+    "path": {
+      "type": "string",
+      "description": "Chemin de la resource."
+    }
+  },
+  "required": [
+    "method",
+    "path"
+  ]
+}
diff --git a/models/RequestLog.v1.json → models/SubscriptionRequestLog.v1.json b/models/RequestLog.v1.json → models/SubscriptionRequestLog.v1.json
@@ -1,6 +1,6 @@
 {
   "type": "object",
-  "title": "RequestLog",
+  "title": "SubscriptionRequestLog",
   "description": "Trace d'une requête.",
   "properties": {
     "timestamp": {
@@ -9,13 +9,7 @@
       "format": "date-time"
     },
     "method": {
-      "description": "Méthode HTTP utilisée.",
-      "type": "string",
-      "enum": [
-        "POST",
-        "PUT",
-        "DELETE"
-      ]
+      "$ref": "./SubscriptionRequestLogMethod.v1.json"
     },
     "uri": {
       "description": "Identifiant unique de la resource.",

diff --git a/models/SubscriptionRequestLogMethod.v1.json b/models/SubscriptionRequestLogMethod.v1.json
@@ -0,0 +1,10 @@
+{
+    "title": "SubscriptionRequestLogMethod",
+    "type": "string",
+    "description": "Méthode HTTP utilisée.",
+    "enum": [
+      "POST",
+      "PUT",
+      "DELETE"
+    ]
+}
diff --git a/models/SubscriptionUsageRecord.v1.json b/models/SubscriptionUsageRecord.v1.json
@@ -0,0 +1,25 @@
+{
+  "title": "SubscriptionUsageRecord",
+  "description": "Enregistrement de l'utilisation d'une soucription.",
+  "type": "object",
+  "properties": {
+    "timestamp": {
+      "type": "string",
+      "format": "date-time",
+      "description": "Date d'enregistrement."
+    },
+    "ref": {
+      "type": "string",
+      "description": "Référence de l'item."
+    },
+    "count": {
+      "type": "number",
+      "description": "Nombre d'appels enregistrés."
+    }
+  },
+  "required": [
+    "timestamp",
+    "ref",
+    "count"
+  ]
+}