Skip to content

docs: update Query API OpenAPI specification #72

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
sallymoc wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −24
Open

docs: update Query API OpenAPI specification #72

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
43 changes: 19 additions & 24 deletions static/openapi/query-services.openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,6 @@ paths:
description: |-
Query event logs with optional filters.

Please note: beta version – may be subject to incompatible changes.

### Request structure

| Name | Type | Necessity | Description |
Expand Down Expand Up @@ -135,13 +133,7 @@ paths:
| epoch | string | Numeric (uint32) | Only find logs in the epoch range. |
| deductedAmount | string | Numeric (uint64) | Only find logs in the deducted amount range. |
| remainingAmount | string | Numeric (int64) | Only find logs in the remaining amount range. |

### Pagination

| Name | Type | Necessity | Description |
|--------|--------|-----------|-----------------------------------------------------------------------------------------------------|
| offset | uint32 | optional | The offset of the first record to return. Defaults to zero (first record). Maximum offset is 10000. |
| size | uint32 | optional | Defaults to 10. Maximum size is 1000. Zero value is ignored (uses default). |
| logId | string | Numeric (uint64) | Only find logs in the logId range. Combine with a tickNumber filter to paginate beyond 10K events in a tick. |
operationId: ArchiveQueryService_GetEventLogs
requestBody:
content:
Expand Down Expand Up @@ -285,13 +277,6 @@ paths:
| tickNumber | string | Numeric | Only find transactions in tick range. |
| inputType | string | Numeric | Only find transactions in input type range. |
| timestamp | string | Numeric (Unix Timestamp in milliseconds) | Only find transactions in time range. |

### Pagination

| Name | Type | Necessity | Description |
|--------|--------|-----------|-----------------------------------------------------------------------------------------------------|
| offset | uint32 | optional | The offset of the first record to return. Defaults to zero (first record). Maximum offset is 10000. |
| size | uint32 | optional | Defaults to 10. Maximum size is 1000. Zero value is ignored (uses default). |
operationId: ArchiveQueryService_GetTransactionsForIdentity
requestBody:
content:
Expand Down Expand Up @@ -359,8 +344,6 @@ paths:
| lte | string | optional | Less than or equal to. |

Only one lower bound and one upper bound can be specified.

For examples how to use filters and ranges see the GetTransactionsForIdentity endpoint documentation.
operationId: ArchiveQueryService_GetTransactionsForTick
requestBody:
content:
Expand Down Expand Up @@ -481,10 +464,10 @@ components:
type: array
items:
type: string
description: List of computor identities (signed by arbitrator).
description: List of computor identities.
signature:
type: string
description: Signature of the arbitrator.
description: Base64 encoded byte array representing the signature of the arbitrator.
description: ComputorList
ContractReserveDeductionData:
type: object
Expand Down Expand Up @@ -818,9 +801,9 @@ components:
format: uint32
size:
type: integer
description: The size specifies how many results should be returned. Defaults to 10.
description: Number of results that should be returned. Defaults to 10 and allows a maximum of 1000 unless otherwise stated.
format: uint32
description: The number of maximum results (offset + size) is limited to 10000.
description: Offset + size together is limited to the number of maximum results (10000 unless otherwise stated).
ProcessedTickInterval:
type: object
properties:
Expand Down Expand Up @@ -923,15 +906,19 @@ components:
properties:
tickNumber:
type: integer
description: The number of the tick.
format: uint32
epoch:
type: integer
description: The number of the epoch.
format: uint32
computorIndex:
type: integer
description: The computor index of the tick leader.
format: uint32
timestamp:
type: string
description: The timestamp of the tick. Not guaranteed to be perfectly synchronized with UTC.
varStruct:
type: string
timeLock:
Expand All @@ -940,29 +927,37 @@ components:
type: array
items:
type: string
description: A list of all the ticks transaction hashes in the correct order.
contractFees:
type: array
items:
type: string
signature:
type: string
description: Base64 encoded byte array representing the signature of the tick data's signature.
description: TickData
Transaction:
type: object
properties:
hash:
type: string
description: The unique identifier for this transaction.
amount:
type: string
description: Qubic amount. Can be zero.
source:
type: string
description: The source identity that sent the transaction.
destination:
type: string
description: The destination identity for the transaction.
tickNumber:
type: integer
description: The number of the tick.
format: uint32
timestamp:
type: string
description: The timestamp of the tick. Not guaranteed to be perfectly synchronized with UTC.
inputType:
type: integer
description: Smart contract procedure index. (The smart contract procedure this transaction is supposed to trigger)
Expand All @@ -987,8 +982,8 @@ tags:
- name: ArchiveQueryService
description: Qubic Query API
x-scalar-ignore: true
- name: Events (Beta)
description: Query event logs from the Qubic blockchain. Beta endpoint.
- name: Events
description: Query event logs from the Qubic blockchain.
- name: Network
description: Network status and computor information.
- name: Ticks
Expand Down