Skip to content

Commit 7afa1e7

Browse files
0xsequence-botpkieltykaVojtechVitektaylanpince
authored and
JamesLawton
committed
[AUTOMATED] Update Trails OpenAPI docs (#20)
* [AUTOMATED] Update: proto/docs/trails-api.gen.yaml * [AUTOMATED] Update: proto/docs/trails-api.gen.yaml * [AUTOMATED] Update: proto/docs/trails-api.gen.yaml * [AUTOMATED] Update: proto/docs/trails-api.gen.yaml * [AUTOMATED] Update: proto/docs/trails-api.gen.yaml * [AUTOMATED] Update: proto/docs/trails-api.gen.yaml * [AUTOMATED] Update: proto/docs/trails-api.gen.yaml --------- Co-authored-by: pkieltyka <[email protected]> Co-authored-by: VojtechVitek <[email protected]> Co-authored-by: taylanpince <[email protected]>
1 parent c9e380f commit 7afa1e7

File tree

1 file changed

+68
-189
lines changed

1 file changed

+68
-189
lines changed

‎api-reference/trails-api.gen.yaml‎

Lines changed: 68 additions & 189 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,14 @@
1-
# trails-api v1.0.0 193cd6f08c65e11fee1f03aab0378d79e319e31f
1+
# trails-api v1.0.0 005f3be0cfe130e92ee5ab03d992cac2bf9d2919
22
# --
3-
# Code generated by [email protected].2 with openapi generator; DO NOT EDIT
3+
# Code generated by [email protected].3 with openapi generator; DO NOT EDIT
44
#
55
# webrpc-gen -service=Trails -match=@public -schema=proto/trails-api.ridl -target=openapi -title=Trails API -securityAnnotation=@auth -securitySchemes={ 'ApiKeyAuth': { 'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key' }, } -out=proto/docs/trails-api.gen.yaml
66
openapi: 3.0.0
77
info:
88
title: 'Trails API'
99
version: ''
10-
servers:
11-
- url: https://trails-api.sequence.app
12-
description: Trails API Server
1310
components:
14-
securitySchemes: {'ApiKeyAuth': {'type': 'apiKey', 'in': 'header', 'description': 'apiKey for authenticating requests, get an access key at https://t.me/build_with_trails', 'name': 'X-Access-Key'}}
11+
securitySchemes: {'ApiKeyAuth': {'type': 'apiKey', 'in': 'header', 'description': 'Project access key for authenticating requests, get an access key at https://sequence.build', 'name': 'X-Access-Key'}}
1512
schemas:
1613
ErrorWebrpcEndpoint:
1714
type: object
@@ -849,6 +846,28 @@ components:
849846
status:
850847
type: number
851848
example: 422
849+
ErrorIntentsDisabled:
850+
type: object
851+
required:
852+
- error
853+
- code
854+
- msg
855+
- status
856+
properties:
857+
error:
858+
type: string
859+
example: "IntentsDisabled"
860+
code:
861+
type: number
862+
example: 9000
863+
msg:
864+
type: string
865+
example: "Intents service is currently unavailable"
866+
cause:
867+
type: string
868+
status:
869+
type: number
870+
example: 400
852871
TradeType:
853872
type: string
854873
description: Represented as string on the server side
@@ -867,12 +886,15 @@ components:
867886
description: Represented as uint8 on the server side
868887
enum:
869888
- UNKNOWN
889+
- ON_HOLD
870890
- PENDING
871891
- RELAYING
872-
- RELAYED
892+
- SENT
893+
- ERRORED
873894
- MINING
874895
- SUCCEEDED
875896
- FAILED
897+
- ABORTED
876898
IntentStatus:
877899
type: string
878900
description: Represented as uint8 on the server side
@@ -936,6 +958,7 @@ components:
936958
type: object
937959
required:
938960
- id
961+
- projectId
939962
- intentId
940963
- status
941964
- quoteRequest
@@ -954,6 +977,8 @@ components:
954977
properties:
955978
id:
956979
type: number
980+
projectId:
981+
type: number
957982
intentId:
958983
type: string
959984
status:
@@ -1090,6 +1115,7 @@ components:
10901115
type: object
10911116
required:
10921117
- id
1118+
- projectId
10931119
- intentId
10941120
- status
10951121
- ownerAddress
@@ -1099,11 +1125,11 @@ components:
10991125
- depositTransaction
11001126
- originTransactionId
11011127
- originTransaction
1102-
- destinationTransactionId
1103-
- destinationTransaction
11041128
properties:
11051129
id:
11061130
type: number
1131+
projectId:
1132+
type: number
11071133
intentId:
11081134
type: string
11091135
status:
@@ -1168,6 +1194,8 @@ components:
11681194
$ref: '#/components/schemas/DepositIntentEntry'
11691195
txnHash:
11701196
type: string
1197+
txnMinedAt:
1198+
type: string
11711199
status:
11721200
$ref: '#/components/schemas/TransactionStatus'
11731201
statusReason:
@@ -1611,6 +1639,7 @@ components:
16111639
- branch
16121640
- commitHash
16131641
- runnables
1642+
- services
16141643
properties:
16151644
healthOK:
16161645
type: boolean
@@ -1626,6 +1655,26 @@ components:
16261655
type: string
16271656
runnables:
16281657
type: object
1658+
services:
1659+
type: array
1660+
description: '[]ServiceStatus'
1661+
items:
1662+
$ref: '#/components/schemas/ServiceStatus'
1663+
ServiceStatus:
1664+
type: object
1665+
required:
1666+
- name
1667+
- healthy
1668+
- latency
1669+
properties:
1670+
name:
1671+
type: string
1672+
healthy:
1673+
type: boolean
1674+
error:
1675+
type: string
1676+
latency:
1677+
type: string
16291678
QuoteIntentResponse:
16301679
type: object
16311680
required:
@@ -1719,12 +1768,16 @@ components:
17191768
SearchIntentsRequest:
17201769
type: object
17211770
properties:
1722-
byOriginIntentAddress:
1771+
byIntentId:
17231772
type: string
1724-
byDepositTransactionHash:
1773+
byProjectId:
1774+
type: number
1775+
byTransactionHash:
17251776
type: string
17261777
byOwnerAddress:
17271778
type: string
1779+
byOriginIntentAddress:
1780+
type: string
17281781
SearchIntentsResponse:
17291782
type: object
17301783
required:
@@ -1740,6 +1793,10 @@ components:
17401793
properties:
17411794
page:
17421795
$ref: '#/components/schemas/Page'
1796+
byProjectId:
1797+
type: number
1798+
byOwnerAddress:
1799+
type: string
17431800
GetIntentTransactionHistoryResponse:
17441801
type: object
17451802
required:
@@ -1781,181 +1838,3 @@ components:
17811838
order:
17821839
$ref: '#/components/schemas/SortOrder'
17831840
paths:
1784-
/rpc/Trails/QuoteIntent:
1785-
post:
1786-
summary: Quote Intent
1787-
description: Get a quote for a cross-chain intent transaction including gas fees and optimal routing
1788-
operationId: QuoteIntent
1789-
requestBody:
1790-
required: true
1791-
content:
1792-
application/json:
1793-
schema:
1794-
$ref: '#/components/schemas/QuoteIntentRequest'
1795-
responses:
1796-
'200':
1797-
description: Successful response
1798-
content:
1799-
application/json:
1800-
schema:
1801-
$ref: '#/components/schemas/QuoteIntentResponse'
1802-
/rpc/Trails/CommitIntent:
1803-
post:
1804-
summary: Commit Intent
1805-
description: Commit an intent to execute a cross-chain transaction
1806-
operationId: CommitIntent
1807-
requestBody:
1808-
required: true
1809-
content:
1810-
application/json:
1811-
schema:
1812-
$ref: '#/components/schemas/CommitIntentRequest'
1813-
responses:
1814-
'200':
1815-
description: Successful response
1816-
content:
1817-
application/json:
1818-
schema:
1819-
$ref: '#/components/schemas/CommitIntentResponse'
1820-
/rpc/Trails/ExecuteIntent:
1821-
post:
1822-
summary: Execute Intent
1823-
description: Execute a committed intent transaction
1824-
operationId: ExecuteIntent
1825-
requestBody:
1826-
required: true
1827-
content:
1828-
application/json:
1829-
schema:
1830-
$ref: '#/components/schemas/ExecuteIntentRequest'
1831-
responses:
1832-
'200':
1833-
description: Successful response
1834-
content:
1835-
application/json:
1836-
schema:
1837-
$ref: '#/components/schemas/ExecuteIntentResponse'
1838-
/rpc/Trails/GetIntentReceipt:
1839-
post:
1840-
summary: Get Intent Receipt
1841-
description: Retrieve the receipt for a completed intent transaction
1842-
operationId: GetIntentReceipt
1843-
requestBody:
1844-
required: true
1845-
content:
1846-
application/json:
1847-
schema:
1848-
$ref: '#/components/schemas/GetIntentReceiptRequest'
1849-
responses:
1850-
'200':
1851-
description: Successful response
1852-
content:
1853-
application/json:
1854-
schema:
1855-
$ref: '#/components/schemas/GetIntentReceiptResponse'
1856-
/rpc/Trails/WaitIntentReceipt:
1857-
post:
1858-
summary: Wait for Intent Receipt
1859-
description: Wait for an intent transaction to complete and return the receipt
1860-
operationId: WaitIntentReceipt
1861-
requestBody:
1862-
required: true
1863-
content:
1864-
application/json:
1865-
schema:
1866-
$ref: '#/components/schemas/WaitIntentReceiptRequest'
1867-
responses:
1868-
'200':
1869-
description: Successful response
1870-
content:
1871-
application/json:
1872-
schema:
1873-
$ref: '#/components/schemas/WaitIntentReceiptResponse'
1874-
/rpc/Trails/GetIntent:
1875-
post:
1876-
summary: Get Intent
1877-
description: Retrieve details of a specific intent by ID
1878-
operationId: GetIntent
1879-
requestBody:
1880-
required: true
1881-
content:
1882-
application/json:
1883-
schema:
1884-
$ref: '#/components/schemas/GetIntentRequest'
1885-
responses:
1886-
'200':
1887-
description: Successful response
1888-
content:
1889-
application/json:
1890-
schema:
1891-
$ref: '#/components/schemas/GetIntentResponse'
1892-
/rpc/Trails/SearchIntents:
1893-
post:
1894-
summary: Search Intents
1895-
description: Search for intents by various criteria including owner address, intent address, or transaction hash
1896-
operationId: SearchIntents
1897-
requestBody:
1898-
required: true
1899-
content:
1900-
application/json:
1901-
schema:
1902-
$ref: '#/components/schemas/SearchIntentsRequest'
1903-
responses:
1904-
'200':
1905-
description: Successful response
1906-
content:
1907-
application/json:
1908-
schema:
1909-
$ref: '#/components/schemas/SearchIntentsResponse'
1910-
/rpc/Trails/GetIntentTransactionHistory:
1911-
post:
1912-
summary: Get Intent Transaction History
1913-
description: Retrieve transaction history for intents with pagination support
1914-
operationId: GetIntentTransactionHistory
1915-
requestBody:
1916-
required: true
1917-
content:
1918-
application/json:
1919-
schema:
1920-
$ref: '#/components/schemas/GetIntentTransactionHistoryRequest'
1921-
responses:
1922-
'200':
1923-
description: Successful response
1924-
content:
1925-
application/json:
1926-
schema:
1927-
$ref: '#/components/schemas/GetIntentTransactionHistoryResponse'
1928-
/rpc/Trails/GetTokenPrices:
1929-
post:
1930-
summary: Get Token Prices
1931-
description: Retrieve current USD prices for specified tokens
1932-
operationId: GetTokenPrices
1933-
requestBody:
1934-
required: true
1935-
content:
1936-
application/json:
1937-
schema:
1938-
type: object
1939-
required:
1940-
- tokens
1941-
properties:
1942-
tokens:
1943-
type: array
1944-
description: '[]Token'
1945-
items:
1946-
$ref: '#/components/schemas/Token'
1947-
responses:
1948-
'200':
1949-
description: Successful response
1950-
content:
1951-
application/json:
1952-
schema:
1953-
type: object
1954-
required:
1955-
- tokenPrices
1956-
properties:
1957-
tokenPrices:
1958-
type: array
1959-
description: '[]TokenPrice'
1960-
items:
1961-
$ref: '#/components/schemas/TokenPrice'

0 commit comments

Comments
 (0)