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

[PARTNER-70] Documentation update for 2.1 #165

Merged
merged 3 commits into from
Jun 20, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
2 changes: 1 addition & 1 deletion ap_api/callbacks/get-rates.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Success.

An object describing the fees added on top of the rate provided via the `price` attribute.

</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The total fee to be applied."}}></SchemaItem><SchemaItem collapsible={false} name={"asset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The asset the fee will be charged in. Must be represented in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>details</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the fee, for example `ACH fee`, `Brazilian conciliation fee`, `Service fee`, etc."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text describing the fee."}}></SchemaItem><SchemaItem collapsible={false} name={"amount"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The amount of asset applied. If `fee.details` is provided, `sum(fee.details.amount)` should be equals `fee.total`."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"rate\": {\n \"id\": \"string\",\n \"expires_at\": \"2023-06-02T22:28:25.293Z\",\n \"price\": \"string\",\n \"sell_amount\": \"string\",\n \"buy_amount\": \"string\",\n \"fee\": {\n \"total\": \"string\",\n \"asset\": \"string\",\n \"details\": [\n {\n \"name\": \"string\",\n \"description\": \"string\",\n \"amount\": \"string\"\n }\n ]\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"422"} value={"422"}><div>
</div><SchemaItem collapsible={false} name={"total"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The total fee to be applied."}}></SchemaItem><SchemaItem collapsible={false} name={"asset"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The asset the fee will be charged in. Must be represented in [Asset Identification Format](https://github.com/stellar/stellar-protocol/blob/master/ecosystem/sep-0038.md#asset-identification-format)."}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>details</strong><span style={{"opacity":"0.6"}}> object[]</span></summary><div style={{"marginLeft":"1rem"}}><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The name of the fee, for example `ACH fee`, `Brazilian conciliation fee`, `Service fee`, etc."}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"A text describing the fee."}}></SchemaItem><SchemaItem collapsible={false} name={"amount"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string","description":"The amount of asset applied. If `fee.details` is provided, `sum(fee.details.amount)` should be equals `fee.total`."}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"rate\": {\n \"id\": \"string\",\n \"expires_at\": \"2023-06-15T01:39:28.699Z\",\n \"price\": \"string\",\n \"sell_amount\": \"string\",\n \"buy_amount\": \"string\",\n \"fee\": {\n \"total\": \"string\",\n \"asset\": \"string\",\n \"details\": [\n {\n \"name\": \"string\",\n \"description\": \"string\",\n \"amount\": \"string\"\n }\n ]\n }\n }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"422"} value={"422"}><div>

Unprocessable Entity. This status should be returned when the anchor understood the request but cannot
return a success response.
Expand Down
6 changes: 3 additions & 3 deletions ap_api/callbacks/put-customer.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion ap_api/callbacks/sidebar.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ap_api/resources/get-transaction.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,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></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 \"started_at\": \"2023-06-02T22:28:25.036Z\",\n \"updated_at\": \"2023-06-02T22:28:25.036Z\",\n \"completed_at\": \"2023-06-02T22:28:25.036Z\",\n \"transfer_received_at\": \"2023-06-02T22:28:25.036Z\",\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-06-02T22:28:25.036Z\",\n \"refunded_at\": \"2023-06-02T22:28:25.036Z\"\n }\n ]\n },\n \"stellar_transactions\": [\n {\n \"id\": \"string\",\n \"memo\": \"string\",\n \"memo_type\": \"text\",\n \"created_at\": \"2023-06-02T22:28:25.036Z\",\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\": \"text id hash\"\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 \"started_at\": \"2023-06-15T01:39:28.736Z\",\n \"updated_at\": \"2023-06-15T01:39:28.736Z\",\n \"completed_at\": \"2023-06-15T01:39:28.736Z\",\n \"transfer_received_at\": \"2023-06-15T01:39:28.736Z\",\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-06-15T01:39:28.736Z\",\n \"refunded_at\": \"2023-06-15T01:39:28.736Z\"\n }\n ]\n },\n \"stellar_transactions\": [\n {\n \"id\": \"string\",\n \"memo\": \"string\",\n \"memo_type\": \"text\",\n \"created_at\": \"2023-06-15T01:39:28.736Z\",\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\": \"text id hash\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>

Bad Request

Expand Down
Loading