Skip to content

[docs-agent] Fix UTXO tickers/tickers-list paths, params, error schema #1410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alchemy-bot wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[docs-agent] Fix UTXO tickers/tickers-list paths, params, error schema #1410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 27 additions & 12 deletions src/openapi/utxo-bitcoincash/utxo-bitcoincash.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ paths:
"400":
$ref: "#/components/responses/BadRequest"

"/{apiKey}/api/v2/tickers-list":
"/{apiKey}/api/v2/tickers-list/":
get:
operationId: getTickersList
summary: Get Tickers List
Expand All @@ -472,11 +472,17 @@ paths:
- $ref: "#/components/parameters/apiKey"
- in: query
name: timestamp
required: false
description: Unix timestamp to query availability for. Defaults to the latest available.
required: true
description: Unix timestamp for the requested currency list.
schema:
type: integer
example: 1578391200
- in: query
name: token
required: false
description: Token symbol or contract/address key for token-specific rates.
schema:
type: string
responses:
"200":
description: Available tickers.
Expand All @@ -490,7 +496,7 @@ paths:
"400":
$ref: "#/components/responses/BadRequest"

"/{apiKey}/api/v2/tickers":
"/{apiKey}/api/v2/tickers/":
get:
operationId: getTickers
summary: Get Tickers
Expand Down Expand Up @@ -520,6 +526,18 @@ paths:
schema:
type: integer
example: 1578391200
- in: query
name: block
required: false
description: Block height or hash whose timestamp should be used for historical rates.
schema:
type: string
- in: query
name: token
required: false
description: Token symbol or contract/address key for token-specific rates.
schema:
type: string
responses:
"200":
description: Currency rate response.
Expand Down Expand Up @@ -643,26 +661,23 @@ components:
schema:
$ref: "#/components/schemas/Error"
example:
error:
message: "invalid request"
error: "invalid request"
NotFound:
description: Resource not found on the requested network.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error:
message: "not found"
error: "not found"
schemas:
Error:
type: object
required: [error]
properties:
error:
type: object
properties:
message:
type: string
type: string
description: Human-readable error message.
BlockIndexResponse:
type: object
required: [blockHash]
Expand Down
39 changes: 27 additions & 12 deletions src/openapi/utxo-dogecoin/utxo-dogecoin.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,7 @@ paths:
"400":
$ref: "#/components/responses/BadRequest"

"/{apiKey}/api/v2/tickers-list":
"/{apiKey}/api/v2/tickers-list/":
get:
operationId: getTickersList
summary: Get Tickers List
Expand All @@ -469,11 +469,17 @@ paths:
- $ref: "#/components/parameters/apiKey"
- in: query
name: timestamp
required: false
description: Unix timestamp to query availability for. Defaults to the latest available.
required: true
description: Unix timestamp for the requested currency list.
schema:
type: integer
example: 1578391200
- in: query
name: token
required: false
description: Token symbol or contract/address key for token-specific rates.
schema:
type: string
responses:
"200":
description: Available tickers.
Expand All @@ -487,7 +493,7 @@ paths:
"400":
$ref: "#/components/responses/BadRequest"

"/{apiKey}/api/v2/tickers":
"/{apiKey}/api/v2/tickers/":
get:
operationId: getTickers
summary: Get Tickers
Expand Down Expand Up @@ -517,6 +523,18 @@ paths:
schema:
type: integer
example: 1578391200
- in: query
name: block
required: false
description: Block height or hash whose timestamp should be used for historical rates.
schema:
type: string
- in: query
name: token
required: false
description: Token symbol or contract/address key for token-specific rates.
schema:
type: string
responses:
"200":
description: Currency rate response.
Expand Down Expand Up @@ -640,26 +658,23 @@ components:
schema:
$ref: "#/components/schemas/Error"
example:
error:
message: "invalid request"
error: "invalid request"
NotFound:
description: Resource not found on the requested network.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error:
message: "not found"
error: "not found"
schemas:
Error:
type: object
required: [error]
properties:
error:
type: object
properties:
message:
type: string
type: string
description: Human-readable error message.
BlockIndexResponse:
type: object
required: [blockHash]
Expand Down
39 changes: 27 additions & 12 deletions src/openapi/utxo-litecoin/utxo-litecoin.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ paths:
"400":
$ref: "#/components/responses/BadRequest"

"/{apiKey}/api/v2/tickers-list":
"/{apiKey}/api/v2/tickers-list/":
get:
operationId: getTickersList
summary: Get Tickers List
Expand All @@ -477,11 +477,17 @@ paths:
- $ref: "#/components/parameters/apiKey"
- in: query
name: timestamp
required: false
description: Unix timestamp to query availability for. Defaults to the latest available.
required: true
description: Unix timestamp for the requested currency list.
schema:
type: integer
example: 1578391200
- in: query
name: token
required: false
description: Token symbol or contract/address key for token-specific rates.
schema:
type: string
responses:
"200":
description: Available tickers.
Expand All @@ -495,7 +501,7 @@ paths:
"400":
$ref: "#/components/responses/BadRequest"

"/{apiKey}/api/v2/tickers":
"/{apiKey}/api/v2/tickers/":
get:
operationId: getTickers
summary: Get Tickers
Expand Down Expand Up @@ -525,6 +531,18 @@ paths:
schema:
type: integer
example: 1578391200
- in: query
name: block
required: false
description: Block height or hash whose timestamp should be used for historical rates.
schema:
type: string
- in: query
name: token
required: false
description: Token symbol or contract/address key for token-specific rates.
schema:
type: string
responses:
"200":
description: Currency rate response.
Expand Down Expand Up @@ -648,26 +666,23 @@ components:
schema:
$ref: "#/components/schemas/Error"
example:
error:
message: "invalid request"
error: "invalid request"
NotFound:
description: Resource not found on the requested network.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error:
message: "not found"
error: "not found"
schemas:
Error:
type: object
required: [error]
properties:
error:
type: object
properties:
message:
type: string
type: string
description: Human-readable error message.
BlockIndexResponse:
type: object
required: [blockHash]
Expand Down
39 changes: 27 additions & 12 deletions src/openapi/utxo/utxo.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ paths:
"400":
$ref: "#/components/responses/BadRequest"

"/{apiKey}/api/v2/tickers-list":
"/{apiKey}/api/v2/tickers-list/":
get:
operationId: getTickersList
summary: Get Tickers List
Expand All @@ -461,11 +461,17 @@ paths:
- $ref: "#/components/parameters/apiKey"
- in: query
name: timestamp
required: false
description: Unix timestamp to query availability for. Defaults to the latest available.
required: true
description: Unix timestamp for the requested currency list.
schema:
type: integer
example: 1574346615
- in: query
name: token
required: false
description: Token symbol or contract/address key for token-specific rates.
schema:
type: string
responses:
"200":
description: Available tickers.
Expand All @@ -479,7 +485,7 @@ paths:
"400":
$ref: "#/components/responses/BadRequest"

"/{apiKey}/api/v2/tickers":
"/{apiKey}/api/v2/tickers/":
get:
operationId: getTickers
summary: Get Tickers
Expand Down Expand Up @@ -509,6 +515,18 @@ paths:
schema:
type: integer
example: 1574346615
- in: query
name: block
required: false
description: Block height or hash whose timestamp should be used for historical rates.
schema:
type: string
- in: query
name: token
required: false
description: Token symbol or contract/address key for token-specific rates.
schema:
type: string
responses:
"200":
description: Currency rate response.
Expand Down Expand Up @@ -632,26 +650,23 @@ components:
schema:
$ref: "#/components/schemas/Error"
example:
error:
message: "invalid request"
error: "invalid request"
NotFound:
description: Resource not found on the requested network.
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
example:
error:
message: "not found"
error: "not found"
schemas:
Error:
type: object
required: [error]
properties:
error:
type: object
properties:
message:
type: string
type: string
description: Human-readable error message.
BlockIndexResponse:
type: object
required: [blockHash]
Expand Down
Loading