update openapi file

Author: Svisstack

coinapi/indexes-api-rest/spec/openapi.json

@@ -1,8 +1,7 @@
 {
-  "openapi": "3.0.1",
+  "openapi": "3.0.4",
   "info": {
-    "title": "Indexes REST API",
-    "description": "",
+    "title": "CoinAPI Indexes REST API",
     "contact": {
       "name": "API BRICKS LTD",
       "url": "https://www.coinapi.io",
@@ -26,7 +25,7 @@
           "Metadata"
         ],
         "summary": "List all exchanges",
-        "description": "Get a detailed list of exchanges provided by the system.\r\n            \r\n:::info\r\nProperties of the output are providing aggregated information from across all symbols related to the specific exchange. If you need to calculate your aggregation (e.g., limiting only the particular type of symbols), you should use /v1/symbols endpoint as a data source.\r\n:::",
+        "description": "Get a detailed list of exchanges provided by the system.\n            \n:::info\nProperties of the output are providing aggregated information from across all symbols related to the specific exchange. If you need to calculate your aggregation (e.g., limiting only the particular type of symbols), you should use /v1/symbols endpoint as a data source.\n:::",
         "parameters": [
           {
             "name": "filter_exchange_id",
@@ -1274,7 +1273,7 @@
           "Periods"
         ],
         "summary": "List all periods",
-        "description": "Get full list of supported time periods\r\n            \r\n### Available periods\r\n            \r\nTime unit | Period identifiers\r\n--------- | -----------\r\nSecond | 1SEC, 2SEC, 3SEC, 4SEC, 5SEC, 6SEC, 10SEC, 15SEC, 20SEC, 30SEC\r\nMinute | 1MIN, 2MIN, 3MIN, 4MIN, 5MIN, 6MIN, 10MIN, 15MIN, 20MIN, 30MIN\r\nHour | 1HRS, 2HRS, 3HRS, 4HRS, 6HRS, 8HRS, 12HRS\r\nDay | 1DAY, 2DAY, 3DAY, 5DAY, 7DAY, 10DAY\r\nMonth | 1MTH, 2MTH, 3MTH, 4MTH, 6MTH\r\nYear | 1YRS, 2YRS, 3YRS, 4YRS, 5YRS\r\n            \r\n:::tip\r\nYou can assume that we will not remove any periods from this response, however, we may add new ones.\r\n:::",
+        "description": "Get full list of supported time periods\n            \n### Available periods\n            \nTime unit | Period identifiers\n--------- | -----------\nSecond | 1SEC, 2SEC, 3SEC, 4SEC, 5SEC, 6SEC, 10SEC, 15SEC, 20SEC, 30SEC\nMinute | 1MIN, 2MIN, 3MIN, 4MIN, 5MIN, 6MIN, 10MIN, 15MIN, 20MIN, 30MIN\nHour | 1HRS, 2HRS, 3HRS, 4HRS, 6HRS, 8HRS, 12HRS\nDay | 1DAY, 2DAY, 3DAY, 5DAY, 7DAY, 10DAY\nMonth | 1MTH, 2MTH, 3MTH, 4MTH, 6MTH\nYear | 1YRS, 2YRS, 3YRS, 4YRS, 5YRS\n            \n:::tip\nYou can assume that we will not remove any periods from this response, however, we may add new ones.\n:::",
         "responses": {
           "200": {
             "description": "successful operation",
@@ -1686,17 +1685,26 @@
       }
     },
     "securitySchemes": {
-      "ApiKey": {
+      "APIKey": {
         "type": "apiKey",
-        "description": "CoinApi API key needed to access the endpoints",
-        "name": "X-CoinAPI-Key",
+        "description": "API Key is required to access the endpoints",
+        "name": "Authorization",
+        "in": "header"
+      },
+      "JWT": {
+        "type": "apiKey",
+        "description": "JWT token needed to access the endpoints",
+        "name": "Authorization",
         "in": "header"
       }
     }
   },
   "security": [
     {
-      "ApiKey": [ ]
+      "APIKey": [ ]
+    },
+    {
+      "JWT": [ ]
     }
   ],
   "tags": [

coinapi/indexes-api-rest/spec/openapi.yaml

@@ -1,7 +1,6 @@
-openapi: 3.0.1
+openapi: 3.0.4
 info:
-  title: Indexes REST API
-  description: ''
+  title: CoinAPI Indexes REST API
   contact:
     name: API BRICKS LTD
     url: https://www.coinapi.io
@@ -18,7 +17,7 @@ paths:
       tags:
         - Metadata
       summary: List all exchanges
-      description: "Get a detailed list of exchanges provided by the system.\r\n            \r\n:::info\r\nProperties of the output are providing aggregated information from across all symbols related to the specific exchange. If you need to calculate your aggregation (e.g., limiting only the particular type of symbols), you should use /v1/symbols endpoint as a data source.\r\n:::"
+      description: "Get a detailed list of exchanges provided by the system.\n            \n:::info\nProperties of the output are providing aggregated information from across all symbols related to the specific exchange. If you need to calculate your aggregation (e.g., limiting only the particular type of symbols), you should use /v1/symbols endpoint as a data source.\n:::"
       parameters:
         - name: filter_exchange_id
           in: query
@@ -927,7 +926,7 @@ paths:
       tags:
         - Periods
       summary: List all periods
-      description: "Get full list of supported time periods\r\n            \r\n### Available periods\r\n            \r\nTime unit | Period identifiers\r\n--------- | -----------\r\nSecond | 1SEC, 2SEC, 3SEC, 4SEC, 5SEC, 6SEC, 10SEC, 15SEC, 20SEC, 30SEC\r\nMinute | 1MIN, 2MIN, 3MIN, 4MIN, 5MIN, 6MIN, 10MIN, 15MIN, 20MIN, 30MIN\r\nHour | 1HRS, 2HRS, 3HRS, 4HRS, 6HRS, 8HRS, 12HRS\r\nDay | 1DAY, 2DAY, 3DAY, 5DAY, 7DAY, 10DAY\r\nMonth | 1MTH, 2MTH, 3MTH, 4MTH, 6MTH\r\nYear | 1YRS, 2YRS, 3YRS, 4YRS, 5YRS\r\n            \r\n:::tip\r\nYou can assume that we will not remove any periods from this response, however, we may add new ones.\r\n:::"
+      description: "Get full list of supported time periods\n            \n### Available periods\n            \nTime unit | Period identifiers\n--------- | -----------\nSecond | 1SEC, 2SEC, 3SEC, 4SEC, 5SEC, 6SEC, 10SEC, 15SEC, 20SEC, 30SEC\nMinute | 1MIN, 2MIN, 3MIN, 4MIN, 5MIN, 6MIN, 10MIN, 15MIN, 20MIN, 30MIN\nHour | 1HRS, 2HRS, 3HRS, 4HRS, 6HRS, 8HRS, 12HRS\nDay | 1DAY, 2DAY, 3DAY, 5DAY, 7DAY, 10DAY\nMonth | 1MTH, 2MTH, 3MTH, 4MTH, 6MTH\nYear | 1YRS, 2YRS, 3YRS, 4YRS, 5YRS\n            \n:::tip\nYou can assume that we will not remove any periods from this response, however, we may add new ones.\n:::"
       responses:
         '200':
           description: successful operation
@@ -1254,13 +1253,19 @@ components:
       additionalProperties: false
       description: Represents a timeseries period used in exchange rate data.
   securitySchemes:
-    ApiKey:
+    APIKey:
       type: apiKey
-      description: CoinApi API key needed to access the endpoints
-      name: X-CoinAPI-Key
+      description: API Key is required to access the endpoints
+      name: Authorization
+      in: header
+    JWT:
+      type: apiKey
+      description: JWT token needed to access the endpoints
+      name: Authorization
       in: header
 security:
-  - ApiKey: [ ]
+  - APIKey: [ ]
+  - JWT: [ ]
 tags:
   - name: Periods
     description: <span data-status-page="28926"></span>