Skip to content
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.

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

Update openapi schema to include missing fields in asset schema #94

Merged
merged 17 commits into from
Jul 31, 2023
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
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
4 changes: 4 additions & 0 deletions ap_api/resources/get-quote.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,11 @@ For a SEP-12 customer, the `id` field should be sufficient to fully identify the
For a SEP-31 Sending Anchor, the `account` field should be used.


<<<<<<< HEAD
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` of the customer registered through SEP-12."}}></SchemaItem><SchemaItem collapsible={false} name={"account"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transaction_id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"string\",\n \"sell_amount\": \"string\",\n \"sell_asset\": \"string\",\n \"buy_amount\": \"string\",\n \"buy_asset\": \"string\",\n \"expires_at\": \"2023-03-30T16:39:26.886Z\",\n \"price\": \"string\",\n \"total_price\": \"string\",\n \"creator\": {\n \"id\": \"string\",\n \"account\": \"string\"\n },\n \"transaction_id\": \"string\",\n \"created_at\": \"2023-03-30T16:39:26.886Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
=======
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` of the customer registered through SEP-12."}}></SchemaItem><SchemaItem collapsible={false} name={"account"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transaction_id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"string\",\n \"sell_amount\": \"string\",\n \"sell_asset\": \"string\",\n \"buy_amount\": \"string\",\n \"buy_asset\": \"string\",\n \"expires_at\": \"2023-03-29T17:10:07.537Z\",\n \"price\": \"string\",\n \"total_price\": \"string\",\n \"creator\": {\n \"id\": \"string\",\n \"account\": \"string\"\n },\n \"transaction_id\": \"string\",\n \"created_at\": \"2023-03-29T17:10:07.537Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>
>>>>>>> b7af04c9e7c69517f54c59a06d39b95c32820c70

Not Found.

Expand Down
4 changes: 4 additions & 0 deletions ap_api/resources/get-quotes.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,11 @@ For a SEP-12 customer, the `id` field should be sufficient to fully identify the
For a SEP-31 Sending Anchor, the `account` field should be used.


<<<<<<< HEAD
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` of the customer registered through SEP-12."}}></SchemaItem><SchemaItem collapsible={false} name={"account"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transaction_id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"cursor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"records\": [\n {\n \"id\": \"string\",\n \"sell_amount\": \"string\",\n \"sell_asset\": \"string\",\n \"buy_amount\": \"string\",\n \"buy_asset\": \"string\",\n \"expires_at\": \"2023-03-30T16:39:26.885Z\",\n \"price\": \"string\",\n \"total_price\": \"string\",\n \"creator\": {\n \"id\": \"string\",\n \"account\": \"string\"\n },\n \"transaction_id\": \"string\",\n \"created_at\": \"2023-03-30T16:39:26.885Z\"\n }\n ],\n \"cursor\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
=======
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` of the customer registered through SEP-12."}}></SchemaItem><SchemaItem collapsible={false} name={"account"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"transaction_id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"type":"string","format":"date-time"}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={false} name={"cursor"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"records\": [\n {\n \"id\": \"string\",\n \"sell_amount\": \"string\",\n \"sell_asset\": \"string\",\n \"buy_amount\": \"string\",\n \"buy_asset\": \"string\",\n \"expires_at\": \"2023-03-29T17:10:07.537Z\",\n \"price\": \"string\",\n \"total_price\": \"string\",\n \"creator\": {\n \"id\": \"string\",\n \"account\": \"string\"\n },\n \"transaction_id\": \"string\",\n \"created_at\": \"2023-03-29T17:10:07.537Z\"\n }\n ],\n \"cursor\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
>>>>>>> b7af04c9e7c69517f54c59a06d39b95c32820c70

Bad Request

Expand Down
4 changes: 4 additions & 0 deletions ap_api/resources/get-transaction.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,11 @@ For a SEP-12 customer, the `id` field should be sufficient to fully identify the
For a SEP-31 Sending Anchor, the `account` field should be used.


<<<<<<< HEAD
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` of the customer registered through SEP-12."}}></SchemaItem><SchemaItem collapsible={false} name={"account"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}}></SchemaItem></div></details></SchemaItem></TabItem></SchemaTabs></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"string\",\n \"sep\": \"24\",\n \"kind\": \"deposit\",\n \"status\": \"incomplete\",\n \"amount_expected\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"amount_in\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"amount_out\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"amount_fee\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"kyc_verified\": true,\n \"started_at\": \"2023-03-30T16:39:26.884Z\",\n \"updated_at\": \"2023-03-30T16:39:26.884Z\",\n \"completed_at\": \"2023-03-30T16:39:26.884Z\",\n \"message\": \"string\",\n \"refunds\": {\n \"amount_refunded\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"amount_fee\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"payments\": [\n {\n \"id\": \"string\",\n \"id_type\": \"stellar\",\n \"amount\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"fee\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"requested_at\": \"2023-03-30T16:39:26.884Z\",\n \"refunded_at\": \"2023-03-30T16:39:26.884Z\"\n }\n ]\n },\n \"stellar_transactions\": [\n {\n \"id\": \"string\",\n \"memo\": \"string\",\n \"memo_type\": \"text\",\n \"created_at\": \"2023-03-30T16:39:26.884Z\",\n \"envelope\": \"string\",\n \"payments\": [\n {\n \"id\": \"string\",\n \"payment_type\": \"payment\",\n \"source_account\": \"string\",\n \"destination_account\": \"string\",\n \"amount\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n }\n }\n ]\n }\n ],\n \"source_account\": \"string\",\n \"destination_account\": \"string\",\n \"external_transaction_id\": \"string\",\n \"memo\": \"string\",\n \"memo_type\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
=======
</div><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The `id` of the customer registered through SEP-12."}}></SchemaItem><SchemaItem collapsible={false} name={"account"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}}></SchemaItem></div></details></SchemaItem></TabItem></SchemaTabs></li></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"id\": \"string\",\n \"sep\": \"24\",\n \"kind\": \"deposit\",\n \"status\": \"incomplete\",\n \"amount_expected\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"amount_in\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"amount_out\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"amount_fee\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"kyc_verified\": true,\n \"started_at\": \"2023-03-29T17:10:07.536Z\",\n \"updated_at\": \"2023-03-29T17:10:07.536Z\",\n \"completed_at\": \"2023-03-29T17:10:07.536Z\",\n \"message\": \"string\",\n \"refunds\": {\n \"amount_refunded\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"amount_fee\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"payments\": [\n {\n \"id\": \"string\",\n \"id_type\": \"stellar\",\n \"amount\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"fee\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n },\n \"requested_at\": \"2023-03-29T17:10:07.536Z\",\n \"refunded_at\": \"2023-03-29T17:10:07.536Z\"\n }\n ]\n },\n \"stellar_transactions\": [\n {\n \"id\": \"string\",\n \"memo\": \"string\",\n \"memo_type\": \"text\",\n \"created_at\": \"2023-03-29T17:10:07.536Z\",\n \"envelope\": \"string\",\n \"payments\": [\n {\n \"id\": \"string\",\n \"payment_type\": \"payment\",\n \"source_account\": \"string\",\n \"destination_account\": \"string\",\n \"amount\": {\n \"amount\": \"string\",\n \"asset\": \"string\"\n }\n }\n ]\n }\n ],\n \"source_account\": \"string\",\n \"destination_account\": \"string\",\n \"external_transaction_id\": \"string\",\n \"memo\": \"string\",\n \"memo_type\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
>>>>>>> b7af04c9e7c69517f54c59a06d39b95c32820c70

Bad Request

Expand Down
8 changes: 8 additions & 0 deletions ap_api/resources/patch-transactions.api.mdx

Large diffs are not rendered by default.

8 changes: 8 additions & 0 deletions api/READ_FIRST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# STOP WHAT YOU'RE DOING

If you're here to make some fixes to Stellar's API documentation (first, thank
you!), you probably don't want to be in this location. Most of the API
documentation located here has been generated by the `.yml` files contained in
the [`/openapi`](../openapi/) directory. Unless you're working on something
that's _outside_ the `/api/resources` directory, you'll probably want to check
in `/openapi` instead of here.
14 changes: 13 additions & 1 deletion api/resources/assets/object.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,24 @@ When Horizon returns information about an asset, it uses the following format:
- num_claimable_balances
- number
- The current number of claimable_balances for this asset.
- num_contracts
- number
- The current number of Soroban contracts holding this asset.
- num_liquidity_pools
- number
- The current number of liquidity pools holding this asset.
- balances
- object
- The number of units issued for this asset grouped by each trustline flag state.
- claimable_balances_amount
- string
- The number of units in claimable balances for this asset.
- The number of units for this asset held by all claimable balances.
- contracts_amount
- string
- The number of units for this asset held by all Soroban contracts.
- liquidity_pools_amount
- string
- The number of units for this asset held by all liquidity pools.
- amount
- string
- The number of authorized units issued for this asset. This will be deprecated in Horizon v3.
Expand Down
4 changes: 2 additions & 2 deletions api/resources/get-effects-by-account-id.api.mdx

Large diffs are not rendered by default.

Loading