docs(openapi): add '/symbols/{symbol}.json' details

kripod · Apr 27, 2024 · 825517e · 825517e
1 parent 28f6846
commit 825517e
Showing 1 changed file with 37 additions and 1 deletion.
diff --git a/src/pages/api/v1/_openapi.json b/src/pages/api/v1/_openapi.json
@@ -41,7 +41,43 @@
         }
       }
     },
-    "/symbols/{symbol}.json": {},
+    "/symbols/{symbol}.json": {
+      "get": {
+        "responses": {
+          "200": {
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "patternProperties": {
+                    "^[+-\\\\d]+$": {
+                      "type": "number"
+                    }
+                  },
+                  "additionalProperties": false
+                },
+                "example": {
+                  "1999-12-29": 254.92,
+                  "2000-01-04": 254.47,
+                  "2000-01-05": 254.48
+                }
+              }
+            }
+          }
+        }
+      },
+      "parameters": [
+        {
+          "name": "symbol",
+          "in": "path",
+          "required": true,
+          "schema": {
+            "$ref": "#/components/schemas/Symbol"
+          },
+          "example": "EURHUF"
+        }
+      ]
+    },
     "/symbols/{symbol}/{year}.json": {},
     "/years.json": {
       "get": {