Added descriptions for json schema items

evg4b · Nov 30, 2024 · 9a17a57 · 9a17a57
1 parent 5c7526a
commit 9a17a57
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 18 deletions.
diff --git a/schema.json b/schema.json
@@ -4,24 +4,24 @@
   "additionalProperties": false,
   "definitions": {
     "Duration": {
-      "description": "Duration in human-readable format",
+      "description": "Duration in human-readable format. Supported units are 'h' (hours), 'm' (minutes), 's' (seconds), 'ms' (milliseconds), 'us' (microseconds), 'ns' (nanoseconds).",
       "examples": [
-        "1h",
-        "1h 30m",
-        "1h 30m 15s",
-        "1h 30m 15s 500ms",
-        "1h 30m 15s 500ms 100us",
-        "1h 30m 15s 500ms 100us 50ns"
+        "3s",
+        "1m 30s",
+        "500ms",
+        "1h 30m 15s 500ms 100us 200ns"
       ],
       "pattern": "^(\\d+h)?\\s*(\\d+m)?\\s*(\\d+s)?\\s*(\\d+ms)?\\s*(\\d+(us|µs))?\\s*(\\d+(ns))?$",
+      "title": "Duration",
       "type": "string"
     },
     "FakeDataMockResponse": {
       "additionalProperties": false,
       "description": "Mock response definition based on fake data content",
       "properties": {
         "code": {
-          "$ref": "#/definitions/StatusCode"
+          "$ref": "#/definitions/StatusCode",
+          "description": "HTTP status code which will be sent in the mock response"
         },
         "delay": {
           "$ref": "#/definitions/Duration",
@@ -3369,7 +3369,8 @@
       "description": "Mock response definition based on file content",
       "properties": {
         "code": {
-          "$ref": "#/definitions/StatusCode"
+          "$ref": "#/definitions/StatusCode",
+          "description": "HTTP status code which will be sent in the mock response"
         },
         "delay": {
           "$ref": "#/definitions/Duration",
@@ -3394,6 +3395,7 @@
       "additionalProperties": {
         "type": "string"
       },
+      "description": "HTTP headers definition",
       "minProperties": 1,
       "type": "object"
     },
@@ -3512,6 +3514,7 @@
       "additionalProperties": {
         "type": "string"
       },
+      "description": "HTTP query parameters definition",
       "minProperties": 1,
       "type": "object"
     },
@@ -3543,6 +3546,7 @@
     },
     "StaticDirectory": {
       "additionalProperties": false,
+      "description": "Static serving directory definition",
       "properties": {
         "dir": {
           "description": "Path to the folder from which the static files will be served",

diff --git a/tools/schema/definitions/Duration.json b/tools/schema/definitions/Duration.json
@@ -2,13 +2,12 @@
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "string",
   "pattern": "^(\\d+h)?\\s*(\\d+m)?\\s*(\\d+s)?\\s*(\\d+ms)?\\s*(\\d+(us|µs))?\\s*(\\d+(ns))?$",
-  "description": "Duration in human-readable format",
+  "title": "Duration",
+  "description": "Duration in human-readable format. Supported units are 'h' (hours), 'm' (minutes), 's' (seconds), 'ms' (milliseconds), 'us' (microseconds), 'ns' (nanoseconds).",
   "examples": [
-    "1h",
-    "1h 30m",
-    "1h 30m 15s",
-    "1h 30m 15s 500ms",
-    "1h 30m 15s 500ms 100us",
-    "1h 30m 15s 500ms 100us 50ns"
+    "3s",
+    "1m 30s",
+    "500ms",
+    "1h 30m 15s 500ms 100us 200ns"
   ]
 }
diff --git a/tools/schema/definitions/FakeDataMockResponse.json b/tools/schema/definitions/FakeDataMockResponse.json
@@ -4,7 +4,8 @@
   "description": "Mock response definition based on fake data content",
   "properties": {
     "code": {
-      "$ref": "#/definitions/StatusCode"
+      "$ref": "#/definitions/StatusCode",
+      "description": "HTTP status code which will be sent in the mock response"
     },
     "delay": {
       "$ref": "#/definitions/Duration",

diff --git a/tools/schema/definitions/FileMockResponse.json b/tools/schema/definitions/FileMockResponse.json
@@ -4,7 +4,8 @@
   "description": "Mock response definition based on file content",
   "properties": {
     "code": {
-      "$ref": "#/definitions/StatusCode"
+      "$ref": "#/definitions/StatusCode",
+      "description": "HTTP status code which will be sent in the mock response"
     },
     "delay": {
       "$ref": "#/definitions/Duration",

diff --git a/tools/schema/definitions/Headers.json b/tools/schema/definitions/Headers.json
@@ -1,6 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
+  "description": "HTTP headers definition",
   "additionalProperties": {
     "type": "string"
   },

diff --git a/tools/schema/definitions/Queries.json b/tools/schema/definitions/Queries.json
@@ -1,6 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
+  "description": "HTTP query parameters definition",
   "additionalProperties": {
     "type": "string"
   },

diff --git a/tools/schema/definitions/StaticDirectory.json b/tools/schema/definitions/StaticDirectory.json
@@ -1,6 +1,7 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
   "type": "object",
+  "description": "Static serving directory definition",
   "properties": {
     "path": {
       "type": "string",