diff --git a/projects.json b/projects.json index 9fddf57f..7694ca7b 100644 --- a/projects.json +++ b/projects.json @@ -41,6 +41,10 @@ { "text": "TypeScript Client (Tiny)", "link": "https://github.com/ray-network/koios-tiny-client" + }, + { + "text": "Laravel PHP Client", + "link": "https://github.com/cardano-blockhouse/cardano-koios-api" } ], "Community Projects/Tools": [ diff --git a/specs/results/koiosapi-guild.yaml b/specs/results/koiosapi-guild.yaml index 6b9736ce..602d299e 100644 --- a/specs/results/koiosapi-guild.yaml +++ b/specs/results/koiosapi-guild.yaml @@ -134,6 +134,10 @@ info: Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. + # Authentication + + While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). + The examples across this API site already [supports authentication](/#auth), for you to use in the queries. # Community projects @@ -1889,7 +1893,11 @@ components: _asset_list: - ['313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e','41484c636f696e'] - ['313534a537bc476c86ff7c57ec511bd7f24a9d15654091b24e9c606e','41484c636f696e'] - securitySchemes: {} + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT schemas: tip: type: array @@ -3737,7 +3745,7 @@ components: NotFound: description: The server does not recognise the combination of endpoint and parameters provided Unauthorized: - description: The selected server has restricted the endpoint to be only usable via authentication. The authentication supplied was not authorized to access the endpoint + description: Access token is missing or invalid PartialContent: description: The result was truncated BadRequest: @@ -3770,4 +3778,5 @@ tags: - name: Script description: Query information about specific scripts (Smart Contracts) x-tag-expanded: false -security: [] +security: + - bearerAuth: [] diff --git a/specs/results/koiosapi-mainnet.yaml b/specs/results/koiosapi-mainnet.yaml index 1495a9bd..1fba8708 100644 --- a/specs/results/koiosapi-mainnet.yaml +++ b/specs/results/koiosapi-mainnet.yaml @@ -134,6 +134,10 @@ info: Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. + # Authentication + + While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). + The examples across this API site already [supports authentication](/#auth), for you to use in the queries. # Community projects @@ -1889,7 +1893,11 @@ components: _asset_list: - ['750900e4999ebe0d58f19b634768ba25e525aaf12403bfe8fe130501','424f4f4b'] - ['1d7f33bd23d85e1a25d87d86fac4f199c3197a2f7afeb662a0f34e1e','776f726c646d6f62696c65746f6b656e'] - securitySchemes: {} + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT schemas: tip: type: array @@ -3737,7 +3745,7 @@ components: NotFound: description: The server does not recognise the combination of endpoint and parameters provided Unauthorized: - description: The selected server has restricted the endpoint to be only usable via authentication. The authentication supplied was not authorized to access the endpoint + description: Access token is missing or invalid PartialContent: description: The result was truncated BadRequest: @@ -3770,4 +3778,5 @@ tags: - name: Script description: Query information about specific scripts (Smart Contracts) x-tag-expanded: false -security: [] +security: + - bearerAuth: [] diff --git a/specs/results/koiosapi-preprod.yaml b/specs/results/koiosapi-preprod.yaml index 35a6ef3e..1a36baa0 100644 --- a/specs/results/koiosapi-preprod.yaml +++ b/specs/results/koiosapi-preprod.yaml @@ -134,6 +134,10 @@ info: Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. + # Authentication + + While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). + The examples across this API site already [supports authentication](/#auth), for you to use in the queries. # Community projects @@ -1889,7 +1893,11 @@ components: _asset_list: - ['c6e65ba7878b2f8ea0ad39287d3e2fd256dc5c4160fc19bdf4c4d87e','7447454e53'] - ['777e6b4903dab74963ae581d39875c5dac16c09bb1f511c0af1ddda8','6141414441'] - securitySchemes: {} + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT schemas: tip: type: array @@ -3737,7 +3745,7 @@ components: NotFound: description: The server does not recognise the combination of endpoint and parameters provided Unauthorized: - description: The selected server has restricted the endpoint to be only usable via authentication. The authentication supplied was not authorized to access the endpoint + description: Access token is missing or invalid PartialContent: description: The result was truncated BadRequest: @@ -3770,4 +3778,5 @@ tags: - name: Script description: Query information about specific scripts (Smart Contracts) x-tag-expanded: false -security: [] +security: + - bearerAuth: [] diff --git a/specs/results/koiosapi-preview.yaml b/specs/results/koiosapi-preview.yaml index 90010439..c3b14e54 100644 --- a/specs/results/koiosapi-preview.yaml +++ b/specs/results/koiosapi-preview.yaml @@ -134,6 +134,10 @@ info: Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. + # Authentication + + While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). + The examples across this API site already [supports authentication](/#auth), for you to use in the queries. # Community projects @@ -1889,7 +1893,11 @@ components: _asset_list: - ['065270479316f1d92e00f7f9f095ebeaac9d009c878dc35ce36d3404','433374'] - ['189e2c53985411addb8df0f3e09f70e343da69f06746c408aba672a8','15fc257714a51769e192761d674db2ee2e80137428e522f9b914debb5f785301'] - securitySchemes: {} + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT schemas: tip: type: array @@ -3737,7 +3745,7 @@ components: NotFound: description: The server does not recognise the combination of endpoint and parameters provided Unauthorized: - description: The selected server has restricted the endpoint to be only usable via authentication. The authentication supplied was not authorized to access the endpoint + description: Access token is missing or invalid PartialContent: description: The result was truncated BadRequest: @@ -3770,4 +3778,5 @@ tags: - name: Script description: Query information about specific scripts (Smart Contracts) x-tag-expanded: false -security: [] +security: + - bearerAuth: [] diff --git a/specs/templates/1-api-info.yaml b/specs/templates/1-api-info.yaml index d95261aa..40a81dda 100644 --- a/specs/templates/1-api-info.yaml +++ b/specs/templates/1-api-info.yaml @@ -133,6 +133,10 @@ info: Yet, there may be cases where the above restrictions may need exceptions (for example, an explorer or a wallet might need more connections than above - going beyond the Burst Limit). For such cases, it is best to approach the team and we can work towards a solution. + # Authentication + + While Koios public tier remains unauthenticated and allows queries without any authentication, it has low limits to prevent actions against an erroraneous query/loop from a consumer. There is also a Free tier which requires setting up Bearer Auth token that is linked to the owner's wallet account (which can be connected to via [Koios website](https://koios.rest/pricing/Pricing.html) ). + The examples across this API site already [supports authentication](/#auth), for you to use in the queries. # Community projects diff --git a/specs/templates/api-main.yaml b/specs/templates/api-main.yaml index aad6ba54..5897119f 100644 --- a/specs/templates/api-main.yaml +++ b/specs/templates/api-main.yaml @@ -1243,7 +1243,11 @@ paths: components: #!params!# #!requestBodies!# - securitySchemes: {} + securitySchemes: + bearerAuth: + type: http + scheme: bearer + bearerFormat: JWT #!schemas!# headers: {} responses: @@ -1252,7 +1256,7 @@ components: NotFound: description: The server does not recognise the combination of endpoint and parameters provided Unauthorized: - description: The selected server has restricted the endpoint to be only usable via authentication. The authentication supplied was not authorized to access the endpoint + description: Access token is missing or invalid PartialContent: description: The result was truncated BadRequest: @@ -1285,4 +1289,5 @@ tags: - name: Script description: Query information about specific scripts (Smart Contracts) x-tag-expanded: false -security: [] +security: + - bearerAuth: []