Skip to content

Commit

Permalink
Update titles and labels (#108)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ifropc authored Mar 28, 2023
1 parent 5a03cca commit 96581d6
Show file tree
Hide file tree
Showing 9 changed files with 32 additions and 32 deletions.
10 changes: 5 additions & 5 deletions ap_api/resources/get-quote.api.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
id: get-quote
title: "Fetch a single quote provided to a client application"
title: "Retrieve a Quote"
description: "Only relevant for SEP-38 (used by SEP-31). Fetches the quote that was created by a client application using SEP-38's `POST /quote` endpoint."
sidebar_label: "Fetch a single quote provided to a client application"
sidebar_label: "Retrieve a Quote"
hide_title: true
hide_table_of_contents: true
api: {"tags":["Quotes"],"operationId":"getQuote","description":"Only relevant for SEP-38 (used by SEP-31). Fetches the quote that was created by a client application using SEP-38's `POST /quote` endpoint.","parameters":[{"in":"path","name":"id","description":"The ID returned as a result of creating the quote via SEP-38's `POST /quote` endpoint.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sell_amount":{"type":"string"},"sell_asset":{"type":"string"},"buy_amount":{"type":"string"},"buy_asset":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"price":{"type":"string"},"total_price":{"type":"string"},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"transaction_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"title":"Quote"}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"get","path":"/exchange/quotes/{id}","info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Fetch a single quote provided to a client application","description":{"content":"Only relevant for SEP-38 (used by SEP-31). Fetches the quote that was created by a client application using SEP-38's `POST /quote` endpoint.","type":"text/plain"},"url":{"path":["exchange","quotes",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID returned as a result of creating the quote via SEP-38's `POST /quote` endpoint.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
api: {"tags":["Quotes"],"operationId":"getQuote","description":"Only relevant for SEP-38 (used by SEP-31). Fetches the quote that was created by a client application using SEP-38's `POST /quote` endpoint.","parameters":[{"in":"path","name":"id","description":"The ID returned as a result of creating the quote via SEP-38's `POST /quote` endpoint.","schema":{"type":"string"},"required":true}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string"},"sell_amount":{"type":"string"},"sell_asset":{"type":"string"},"buy_amount":{"type":"string"},"buy_asset":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"price":{"type":"string"},"total_price":{"type":"string"},"creator":{"type":"object","description":"StellarId's are objects that identify end-users and SEP-31 Sending Anchors, but not SEP-31 Receiving Anchors.\n\nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend.\n\nFor a SEP-31 Sending Anchor, the `account` field should be used.\n","properties":{"id":{"type":"string","description":"The `id` of the customer registered through SEP-12."},"account":{"type":"string","description":"Either the Stellar account or Muxed account address of the on-chain entity."}},"title":"StellarId"},"transaction_id":{"type":"string"},"created_at":{"type":"string","format":"date-time"}},"title":"Quote"}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"},"id":{"type":"string"}},"required":["error"],"title":"Error"}}}}},"method":"get","path":"/exchange/quotes/{id}","info":{"version":"2.0.0","title":"Platform API"},"postman":{"name":"Retrieve a Quote","description":{"content":"Only relevant for SEP-38 (used by SEP-31). Fetches the quote that was created by a client application using SEP-38's `POST /quote` endpoint.","type":"text/plain"},"url":{"path":["exchange","quotes",":id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The ID returned as a result of creating the quote via SEP-38's `POST /quote` endpoint.","type":"text/plain"},"type":"any","value":"","key":"id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: api/resources/platform-api
custom_edit_url: null
Expand All @@ -20,7 +20,7 @@ import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## Fetch a single quote provided to a client application
## Retrieve a Quote



Expand All @@ -39,7 +39,7 @@ 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.


</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-24T21:24:50.824Z\",\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-24T21:24:50.824Z\"\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-28T21:41:33.513Z\",\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-28T21:41:33.513Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"404"} value={"404"}><div>

Not Found.

Expand Down
Loading

0 comments on commit 96581d6

Please sign in to comment.