Skip to content

Commit

Permalink
Karthik/5438/remove deprecatd fields for protocol 22 from docs (#1014)
Browse files Browse the repository at this point in the history 
* Remove references for amount and num_accounts from all
asset definitions in docs

* Remove valid_before and valid_after fields from transaction related endpoint responses

* Remove remaining occurences of valid_before and valid_after from transaction related endpoint descriptions
  • Loading branch information
@karthikiyer56
karthikiyer56 authored Oct 2, 2024
1 parent 929461a commit f9c7d8f
Show file tree
Hide file tree
Showing 17 changed files with 14 additions and 240 deletions.
22 changes: 2 additions & 20 deletions docs/data/horizon/api-reference/cb-retrieve-related-transactions.api.mdx
View file

Large diffs are not rendered by default.

22 changes: 2 additions & 20 deletions docs/data/horizon/api-reference/get-transactions-by-account-id.api.mdx
View file

Large diffs are not rendered by default.

24 changes: 3 additions & 21 deletions docs/data/horizon/api-reference/list-all-assets.api.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -653,25 +653,7 @@ This endpoint lists all assets.
qualifierMessage={undefined}
schema={{"type":"string"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"amount"}
required={false}
schemaName={"string"}
qualifierMessage={undefined}
schema={{"type":"string"}}
>

</SchemaItem><SchemaItem
collapsible={false}
name={"num_accounts"}
required={false}
schemaName={"integer"}
qualifierMessage={undefined}
schema={{"type":"integer"}}
>


</SchemaItem><SchemaItem
collapsible={true}
className={"schemaItem"}
Expand Down Expand Up @@ -749,7 +731,7 @@ This endpoint lists all assets.
value={"Example (from schema)"}
>
<ResponseSamples
responseExample={"{\n \"_links\": {\n \"self\": {\n \"href\": \"string\",\n \"templated\": true\n },\n \"next\": {\n \"href\": \"string\",\n \"templated\": true\n },\n \"prev\": {\n \"href\": \"string\",\n \"templated\": true\n }\n },\n \"_embedded\": {\n \"records\": [\n {\n \"_links\": {\n \"toml\": {\n \"href\": \"string\",\n \"templated\": true\n }\n },\n \"asset_type\": \"string\",\n \"asset_issuer\": \"string\",\n \"paging_token\": \"string\",\n \"accounts\": {\n \"authorized\": 0,\n \"authorized_to_maintain_liabilities\": 0,\n \"unauthorized\": 0\n },\n \"num_claimable_balances\": 0,\n \"num_contracts\": 0,\n \"num_liquidity_pools\": 0,\n \"balances\": {\n \"authorized\": \"string\",\n \"authorized_to_maintain_liabilities\": \"string\",\n \"unauthorized\": \"string\"\n },\n \"claimable_balances_amount\": \"string\",\n \"contracts_amount\": \"string\",\n \"liquidity_pools_amount\": \"string\",\n \"amount\": \"string\",\n \"num_accounts\": 0,\n \"flags\": {\n \"auth_required\": true,\n \"auth_revocable\": true,\n \"auth_immutable\": true\n }\n }\n ]\n }\n}"}
responseExample={"{\n \"_links\": {\n \"self\": {\n \"href\": \"string\",\n \"templated\": true\n },\n \"next\": {\n \"href\": \"string\",\n \"templated\": true\n },\n \"prev\": {\n \"href\": \"string\",\n \"templated\": true\n }\n },\n \"_embedded\": {\n \"records\": [\n {\n \"_links\": {\n \"toml\": {\n \"href\": \"string\",\n \"templated\": true\n }\n },\n \"asset_type\": \"string\",\n \"asset_issuer\": \"string\",\n \"paging_token\": \"string\",\n \"accounts\": {\n \"authorized\": 0,\n \"authorized_to_maintain_liabilities\": 0,\n \"unauthorized\": 0\n },\n \"num_claimable_balances\": 0,\n \"num_contracts\": 0,\n \"num_liquidity_pools\": 0,\n \"balances\": {\n \"authorized\": \"string\",\n \"authorized_to_maintain_liabilities\": \"string\",\n \"unauthorized\": \"string\"\n },\n \"claimable_balances_amount\": \"string\",\n \"contracts_amount\": \"string\",\n \"liquidity_pools_amount\": \"string\",\n \"flags\": {\n \"auth_required\": true,\n \"auth_revocable\": true,\n \"auth_immutable\": true\n }\n }\n ]\n }\n}"}
language={"json"}
>

Expand All @@ -759,7 +741,7 @@ This endpoint lists all assets.
value={"ListAllAssets"}
>
<ResponseSamples
responseExample={"{\n \"_links\": {\n \"self\": {\n \"href\": \"https://horizon-testnet.stellar.org/assets?asset_code=CNY&cursor=&limit=3&order=asc\"\n },\n \"next\": {\n \"href\": \"https://horizon-testnet.stellar.org/assets?asset_code=CNY&cursor=CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4&limit=3&order=asc\"\n },\n \"prev\": {\n \"href\": \"https://horizon-testnet.stellar.org/assets?asset_code=CNY&cursor=CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4&limit=3&order=desc\"\n }\n },\n \"_embedded\": {\n \"records\": [\n {\n \"_links\": {\n \"toml\": {\n \"href\": \"https://swisscustodys.org/.well-known/stellar.toml\"\n }\n },\n \"asset_type\": \"credit_alphanum4\",\n \"asset_code\": \"CNY\",\n \"asset_issuer\": \"GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A\",\n \"paging_token\": \"CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4\",\n \"num_accounts\": 10,\n \"num_claimable_balances\": 0,\n \"num_contracts\": 0,\n \"num_liquidity_pools\": 0,\n \"amount\": \"899996000000.0000000\",\n \"accounts\": {\n \"authorized\": 10,\n \"authorized_to_maintain_liabilities\": 0,\n \"unauthorized\": 0\n },\n \"claimable_balances_amount\": \"0.0000000\",\n \"contracts_amount\": \"0.0000000\",\n \"liquidity_pools_amount\": \"0.0000000\",\n \"balances\": {\n \"authorized\": \"899996000000.0000000\",\n \"authorized_to_maintain_liabilities\": \"0.0000000\",\n \"unauthorized\": \"0.0000000\"\n },\n \"flags\": {\n \"auth_required\": false,\n \"auth_revocable\": false,\n \"auth_immutable\": false,\n \"auth_clawback_enabled\": false\n }\n },\n {\n \"_links\": {\n \"toml\": {\n \"href\": \"https://StellarAssets.org/fx/.well-known/stellar.toml\"\n }\n },\n \"asset_type\": \"credit_alphanum4\",\n \"asset_code\": \"CNY\",\n \"asset_issuer\": \"GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N\",\n \"paging_token\": \"CNY_GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N_credit_alphanum4\",\n \"num_accounts\": 43,\n \"num_claimable_balances\": 0,\n \"num_contracts\": 0,\n \"num_liquidity_pools\": 0,\n \"amount\": \"1.0000000\",\n \"accounts\": {\n \"authorized\": 43,\n \"authorized_to_maintain_liabilities\": 0,\n \"unauthorized\": 0\n },\n \"claimable_balances_amount\": \"0.0000000\",\n \"contracts_amount\": \"0.0000000\",\n \"liquidity_pools_amount\": \"0.0000000\",\n \"balances\": {\n \"authorized\": \"1.0000000\",\n \"authorized_to_maintain_liabilities\": \"0.0000000\",\n \"unauthorized\": \"0.0000000\"\n },\n \"flags\": {\n \"auth_required\": false,\n \"auth_revocable\": true,\n \"auth_immutable\": false,\n \"auth_clawback_enabled\": true\n }\n },\n {\n \"_links\": {\n \"toml\": {\n \"href\": \"https://masterstellar.com/.well-known/stellar.toml\"\n }\n },\n \"asset_type\": \"credit_alphanum4\",\n \"asset_code\": \"CNY\",\n \"asset_issuer\": \"GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I\",\n \"paging_token\": \"CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4\",\n \"num_accounts\": 1,\n \"num_claimable_balances\": 0,\n \"num_contracts\": 0,\n \"num_liquidity_pools\": 0,\n \"amount\": \"65000000000.0000000\",\n \"accounts\": {\n \"authorized\": 1,\n \"authorized_to_maintain_liabilities\": 0,\n \"unauthorized\": 0\n },\n \"claimable_balances_amount\": \"0.0000000\",\n \"contracts_amount\": \"0.0000000\",\n \"liquidity_pools_amount\": \"0.0000000\",\n \"balances\": {\n \"authorized\": \"65000000000.0000000\",\n \"authorized_to_maintain_liabilities\": \"0.0000000\",\n \"unauthorized\": \"0.0000000\"\n },\n \"flags\": {\n \"auth_required\": false,\n \"auth_revocable\": false,\n \"auth_immutable\": false,\n \"auth_clawback_enabled\": false\n }\n }\n ]\n }\n}"}
responseExample={"{\n \"_links\": {\n \"self\": {\n \"href\": \"https://horizon-testnet.stellar.org/assets?asset_code=CNY&cursor=&limit=3&order=asc\"\n },\n \"next\": {\n \"href\": \"https://horizon-testnet.stellar.org/assets?asset_code=CNY&cursor=CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4&limit=3&order=asc\"\n },\n \"prev\": {\n \"href\": \"https://horizon-testnet.stellar.org/assets?asset_code=CNY&cursor=CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4&limit=3&order=desc\"\n }\n },\n \"_embedded\": {\n \"records\": [\n {\n \"_links\": {\n \"toml\": {\n \"href\": \"https://swisscustodys.org/.well-known/stellar.toml\"\n }\n },\n \"asset_type\": \"credit_alphanum4\",\n \"asset_code\": \"CNY\",\n \"asset_issuer\": \"GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A\",\n \"paging_token\": \"CNY_GA6VXTS64XUOCQZSBAYHD24ZYJYPNB3KJ2CVKSYIE43P2DQQIX74UT2A_credit_alphanum4\",\n \"num_claimable_balances\": 0,\n \"num_contracts\": 0,\n \"num_liquidity_pools\": 0,\n \"accounts\": {\n \"authorized\": 10,\n \"authorized_to_maintain_liabilities\": 0,\n \"unauthorized\": 0\n },\n \"claimable_balances_amount\": \"0.0000000\",\n \"contracts_amount\": \"0.0000000\",\n \"liquidity_pools_amount\": \"0.0000000\",\n \"balances\": {\n \"authorized\": \"899996000000.0000000\",\n \"authorized_to_maintain_liabilities\": \"0.0000000\",\n \"unauthorized\": \"0.0000000\"\n },\n \"flags\": {\n \"auth_required\": false,\n \"auth_revocable\": false,\n \"auth_immutable\": false,\n \"auth_clawback_enabled\": false\n }\n },\n {\n \"_links\": {\n \"toml\": {\n \"href\": \"https://StellarAssets.org/fx/.well-known/stellar.toml\"\n }\n },\n \"asset_type\": \"credit_alphanum4\",\n \"asset_code\": \"CNY\",\n \"asset_issuer\": \"GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N\",\n \"paging_token\": \"CNY_GAASPHILC6DCBPP2P4T66QNSYF6C6OGN6DK36NY4G5SBR7AWH75TJG7N_credit_alphanum4\",\n \"num_claimable_balances\": 0,\n \"num_contracts\": 0,\n \"num_liquidity_pools\": 0,\n \"accounts\": {\n \"authorized\": 43,\n \"authorized_to_maintain_liabilities\": 0,\n \"unauthorized\": 0\n },\n \"claimable_balances_amount\": \"0.0000000\",\n \"contracts_amount\": \"0.0000000\",\n \"liquidity_pools_amount\": \"0.0000000\",\n \"balances\": {\n \"authorized\": \"1.0000000\",\n \"authorized_to_maintain_liabilities\": \"0.0000000\",\n \"unauthorized\": \"0.0000000\"\n },\n \"flags\": {\n \"auth_required\": false,\n \"auth_revocable\": true,\n \"auth_immutable\": false,\n \"auth_clawback_enabled\": true\n }\n },\n {\n \"_links\": {\n \"toml\": {\n \"href\": \"https://masterstellar.com/.well-known/stellar.toml\"\n }\n },\n \"asset_type\": \"credit_alphanum4\",\n \"asset_code\": \"CNY\",\n \"asset_issuer\": \"GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I\",\n \"paging_token\": \"CNY_GABGBJYLIC2OGATH3DVW22UEB66TFMWC3VKTAPFIOINVESRZLFKIHA4I_credit_alphanum4\",\n \"num_claimable_balances\": 0,\n \"num_contracts\": 0,\n \"num_liquidity_pools\": 0,\n \"accounts\": {\n \"authorized\": 1,\n \"authorized_to_maintain_liabilities\": 0,\n \"unauthorized\": 0\n },\n \"claimable_balances_amount\": \"0.0000000\",\n \"contracts_amount\": \"0.0000000\",\n \"liquidity_pools_amount\": \"0.0000000\",\n \"balances\": {\n \"authorized\": \"65000000000.0000000\",\n \"authorized_to_maintain_liabilities\": \"0.0000000\",\n \"unauthorized\": \"0.0000000\"\n },\n \"flags\": {\n \"auth_required\": false,\n \"auth_revocable\": false,\n \"auth_immutable\": false,\n \"auth_clawback_enabled\": false\n }\n }\n ]\n }\n}"}
language={"json"}
>

Expand Down
Loading

0 comments on commit f9c7d8f

Please sign in to comment.