Skip to content

📝 Simplify README MethodTable introductions #2727

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.

Sign up for GitHub

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

Open
JFWooten4 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

📝 Simplify README MethodTable introductions #2727

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 3 additions & 1 deletion docs/data/apis/horizon/api-reference/errors/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { MethodTable } from "@site/src/components/MethodTable";

After processing a request, Horizon returns a success or error response to the client. A success response will return a Status Code of 200, and an error response will return a Status Code in the range of 4XX - 5XX along with additional information about why the request could not complete successfully.

There are two categories of errors: [HTTP Status Codes](./http-status-codes/README.mdx) and [Result Codes](./result-codes/README.mdx). Result Codes only follow a Transaction Failed (400) HTTP Status Code.
There are two categories of errors:

<MethodTable title="Error Categories">

Expand All @@ -17,3 +17,5 @@ There are two categories of errors: [HTTP Status Codes](./http-status-codes/READ
| [Result Codes](./result-codes/README.mdx) | Errors that occur at the Stellar Core level. |

</MethodTable>

Result Codes only follow a Transaction Failed (400) HTTP Status Code.
2 changes: 1 addition & 1 deletion docs/data/apis/horizon/api-reference/errors/http-status-codes/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Stellar uses conventional HTTP response codes to indicate the success or failure
- Codes in the 4xx range indicate an error that failed given the information provided
- Codes in the 5xx range indicate an error with the Horizon server.

There are two types of Status Codes: [Standard Status Codes](./standard.mdx) and [Horizon-Specific Status Codes](./horizon-specific/README.mdx).
There are two types of Status Codes:

<MethodTable title="HTTP Status Code Types">

Expand Down
2 changes: 1 addition & 1 deletion docs/data/apis/horizon/api-reference/errors/result-codes/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Result Codes describe why a transaction or operation failed in Stellar Core and

In the “extras” field, the errors returned are referred to as “Result Codes” and are Horizon’s abstraction of “Stellar Protocol Codes”, which are more specific codes available in the XDR. Result Codes are Horizon’s way of normalizing Stellar Protocol Codes.

There are three types of Result Codes: [Transaction Result Codes](./transactions.mdx), [Operation Result Codes](./operations.mdx), and [Operation-Specific Result Codes](./operation-specific/README.mdx).
There are three types of Result Codes:

<MethodTable title="Result Code Types">

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/anchor-platform/api-reference/platform/README.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 10

import { MethodTable } from "@site/src/components/MethodTable";

Data on the Anchor Platform is available through two different APIs: A REST API and a JSON-RPC API. Each of these APIs has associated documentation here.
Data on the Anchor Platform is available through two different APIs:

<MethodTable title="API Types">

Expand Down