Skip to content

Commit

Permalink
Now generating the API docs with the new changes
Browse files Browse the repository at this point in the history
Issue stellar#88

Signed-off-by: Elliot Voris <[email protected]>
  • Loading branch information
ElliotFriend committed Mar 6, 2023
1 parent 6999688 commit 3d1f52a
Show file tree
Hide file tree
Showing 45 changed files with 73 additions and 73 deletions.
6 changes: 3 additions & 3 deletions api/resources/cb-retrieve-related-operations.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/cb-retrieve-related-transactions.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/get-all-offers.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/get-all-trades.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/get-data-by-account-id.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ This endpoint represents a single data for a given account.

Success

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"value"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"value\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={" Retrieve An Accounts Data"} value={" Retrieve An Accounts Data"}><ResponseSamples responseExample={"{\n \"value\": \"MQ==\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>
</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"value"} 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 \"value\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"RetrieveAnAccountsData"} value={"RetrieveAnAccountsData"}><ResponseSamples responseExample={"{\n \"value\": \"MQ==\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>

2 changes: 1 addition & 1 deletion api/resources/get-effects-by-account-id.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/get-offer-by-offer-id.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/get-offers-by-account-id.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/get-operations-by-account-id.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/get-payments-by-account-id.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/get-trades-by-account-id.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/get-trades-by-offer-id.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/get-transactions-by-account-id.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/list-all-accounts.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/list-all-assets.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/list-all-claimable-balances.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/list-all-effects.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/list-all-ledgers.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/list-all-operations.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/list-all-payments.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/list-all-transactions.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/list-liquidity-pools.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/list-strict-receive-payment-paths.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/list-strict-send-payment-paths.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/list-trade-aggregations.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/lp-retrieve-related-operations.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/lp-retrieve-related-transactions.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/retrieve-a-claimable-balance.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/retrieve-a-ledger.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/retrieve-a-ledgers-effects.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/retrieve-a-ledgers-operations.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/retrieve-a-ledgers-payments.api.mdx

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions api/resources/retrieve-a-ledgers-transactions.api.mdx

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion api/resources/retrieve-a-liquidity-pool.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,5 +30,5 @@ The single liquidity pool endpoint provides information on a liquidity pool.

Success

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>_links</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>self</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"href"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"link"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"templated"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>transactions</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"href"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"link"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"templated"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>operations</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"href"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"link"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"templated"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"paging_token"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"fee_bp"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"uint32"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"total_trustlines"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"total_shares"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>reserves</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"asset"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"amount"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"last_modified_ledger"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"last_modified_time"} required={false} deprecated={undefined} schemaDescription={undefined} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"_links\": {\n \"self\": {\n \"href\": \"string\",\n \"templated\": true\n },\n \"transactions\": {\n \"href\": \"string\",\n \"templated\": true\n },\n \"operations\": {\n \"href\": \"string\",\n \"templated\": true\n }\n },\n \"id\": \"string\",\n \"paging_token\": \"string\",\n \"fee_bp\": 0,\n \"type\": \"string\",\n \"total_trustlines\": \"string\",\n \"total_shares\": \"string\",\n \"reserves\": {\n \"asset\": \"string\",\n \"amount\": \"string\"\n },\n \"last_modified_ledger\": \"string\",\n \"last_modified_time\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={" Retrieve A Liquidity Pool"} value={" Retrieve A Liquidity Pool"}><ResponseSamples responseExample={"{\n \"_links\": {\n \"self\": {\n \"href\": \"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9\"\n },\n \"effects\": {\n \"href\": \"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects{?cursor,limit,order}\",\n \"templated\": true\n },\n \"operations\": {\n \"href\": \"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations{?cursor,limit,order}\",\n \"templated\": true\n },\n \"transactions\": {\n \"href\": \"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/transactions{?cursor,limit,order}\",\n \"templated\": true\n }\n },\n \"id\": \"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9\",\n \"paging_token\": \"113725249324879873\",\n \"fee_bp\": 30,\n \"type\": \"constant_product\",\n \"total_trustlines\": \"300\",\n \"total_shares\": \"5000\",\n \"reserves\": [\n {\n \"amount\": \"1000.0000005\",\n \"asset\": \"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S\"\n },\n {\n \"amount\": \"2000.0000000\",\n \"asset\": \"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>
</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>_links</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>self</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"href"} required={false} schemaName={"link"} qualifierMessage={undefined} schema={{"type":"string","format":"link"}}></SchemaItem><SchemaItem collapsible={false} name={"templated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>transactions</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"href"} required={false} schemaName={"link"} qualifierMessage={undefined} schema={{"type":"string","format":"link"}}></SchemaItem><SchemaItem collapsible={false} name={"templated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>operations</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"href"} required={false} schemaName={"link"} qualifierMessage={undefined} schema={{"type":"string","format":"link"}}></SchemaItem><SchemaItem collapsible={false} name={"templated"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"type":"boolean"}}></SchemaItem></div></details></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"paging_token"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"fee_bp"} required={false} schemaName={"uint32"} qualifierMessage={undefined} schema={{"type":"integer","format":"uint32"}}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"total_trustlines"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"total_shares"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>reserves</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"asset"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"amount"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"last_modified_ledger"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"type":"string"}}></SchemaItem><SchemaItem collapsible={false} name={"last_modified_time"} 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 \"_links\": {\n \"self\": {\n \"href\": \"string\",\n \"templated\": true\n },\n \"transactions\": {\n \"href\": \"string\",\n \"templated\": true\n },\n \"operations\": {\n \"href\": \"string\",\n \"templated\": true\n }\n },\n \"id\": \"string\",\n \"paging_token\": \"string\",\n \"fee_bp\": 0,\n \"type\": \"string\",\n \"total_trustlines\": \"string\",\n \"total_shares\": \"string\",\n \"reserves\": {\n \"asset\": \"string\",\n \"amount\": \"string\"\n },\n \"last_modified_ledger\": \"string\",\n \"last_modified_time\": \"string\"\n}"} language={"json"}></ResponseSamples></TabItem><TabItem label={"RetrieveALiquidityPool"} value={"RetrieveALiquidityPool"}><ResponseSamples responseExample={"{\n \"_links\": {\n \"self\": {\n \"href\": \"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9\"\n },\n \"effects\": {\n \"href\": \"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/effects{?cursor,limit,order}\",\n \"templated\": true\n },\n \"operations\": {\n \"href\": \"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/operations{?cursor,limit,order}\",\n \"templated\": true\n },\n \"transactions\": {\n \"href\": \"https://horizon.stellar.org/liquidity_pools/67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9/transactions{?cursor,limit,order}\",\n \"templated\": true\n }\n },\n \"id\": \"67260c4c1807b262ff851b0a3fe141194936bb0215b2f77447f1df11998eabb9\",\n \"paging_token\": \"113725249324879873\",\n \"fee_bp\": 30,\n \"type\": \"constant_product\",\n \"total_trustlines\": \"300\",\n \"total_shares\": \"5000\",\n \"reserves\": [\n {\n \"amount\": \"1000.0000005\",\n \"asset\": \"EURT:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S\"\n },\n {\n \"amount\": \"2000.0000000\",\n \"asset\": \"PHP:GAP5LETOV6YIE62YAM56STDANPRDO7ZFDBGSNHJQIYGGKSMOZAHOOS2S\"\n }\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>

Loading

0 comments on commit 3d1f52a

Please sign in to comment.