Skip to content

Commit

Permalink
change summary to description
Browse files Browse the repository at this point in the history
  • Loading branch information
pdp2121 committed Sep 19, 2024
1 parent b65138a commit a7a3f6a
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 13 deletions.
4 changes: 2 additions & 2 deletions docs/contributing/add-a-new-request.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,14 +37,14 @@ For the above command, `<request_name>` should be the name of the new request in

- Fields to update:
1. `...Request` with the name of the request (ex. `AccountChannelsRequest`)
2. `summary:` with a description of this request
2. `description:` with a description of this request
3. If there are any common fields in `shared/base.yaml` that can be re-used, do so with `allOf` - otherwise delete that TODO comment.
4. `properties` with the parameters for this request (in alphabetical order)
5. `required` with a list of any required parameters (in alphabetical order)

```
...Request:
summary: >
description: >
...
type: object
# TODO: Add any common fields from `shared/base.yaml` that are applicable using `allOf`. Otherwise delete these comments! For example:
Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/add-a-new-transaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,14 @@
- Fields to update:

1. `...Transaction` with the name of the transaction (ex. `Payment`)
2. `summary:` with a description of this transaction
2. `description:` with a description of this transaction
3. If there are any common fields in `shared/base.yaml` that can be re-used, do so with `allOf` - otherwise delete that TODO comment.
4. `properties` with the parameters for this transaction (in alphabetical order)
5. `required` with a list of any required parameters (in alphabetical order)

```
...Transaction:
summary: >
description: >
...
type: object
# TODO: Add any common fields from `shared/base.yaml` that are applicable using `allOf`. Otherwise delete these comments! For example:
Expand Down
2 changes: 1 addition & 1 deletion open_api/json_api.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ paths:
# TODO: Potentially we can try making a union of types at this level of Request / Response pairs (as opposed to one big Request array, and one big Response array)
# If that works, we could solve the problem below of tying inputs to outputs very specifically. Needs further investigation.
post:
summary: Send JSON-RPC request to server
description: Send JSON-RPC request to server
requestBody:
description: JSON-RPC request object
content:
Expand Down
2 changes: 1 addition & 1 deletion open_api/json_api_v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ paths:
# We use OpenAPI's discriminator field with the `method` name to delineate between the options
/:
post:
summary: Send JSON-RPC request to server
description: Send JSON-RPC request to server
requestBody:
description: JSON-RPC request object
content:
Expand Down
2 changes: 1 addition & 1 deletion shared/requests/account_channels.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ components:
schemas:
AccountChannelsRequest:
$id: AccountChannelsRequestPayload
summary: >
description: >
The account_channels method returns information about an account's Payment Channels.
This includes only channels where the specified account is the channel's source, not the destination.
(A channel's source and owner are the same.) All information retrieved is relative to a particular version of the ledger.
Expand Down
2 changes: 1 addition & 1 deletion shared/requests/account_info.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
components:
schemas:
AccountInfoRequest:
summary: >
description: >
The account_info command retrieves information about an account, its activity, and its XRP balance.
All information retrieved is relative to a particular version of the ledger.
Returns an AccountInfoResponse
Expand Down
2 changes: 1 addition & 1 deletion shared/requests/account_lines.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
components:
schemas:
AccountLinesRequest:
summary: >
description: >
The account_lines command retrieves information about an account's trust lines, including balances in all non-XRP currencies and assets.
All information retrieved is relative to a particular version of the ledger.
Returns an AccountLinesResponse
Expand Down
4 changes: 1 addition & 3 deletions shared/requests/ledger_entry.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,10 @@ components:

# Ledger entry request message
LedgerEntryRequest:
summary: >
description: >
The ledger_entry method returns a single ledger entry from the XRP Ledger in its raw format.
All information retrieved is relative to a particular version of the ledger.
Returns a LedgerEntryResponse
description: The ledger_entry method returns a single ledger entry from the XRP Ledger in its raw format. All information retrieved is relative to a particular version of the ledger.
type: object
allOf:
- $ref: '../base.yaml#/components/schemas/LookupByLedgerRequest'
- $ref: '../base.yaml#/components/schemas/BaseRequest'
Expand Down
2 changes: 1 addition & 1 deletion shared/transactions/payment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ components:
schemas:
PaymentTransactionBase:
$id: PaymentTransactionBase
summary: >
description: >
A Payment transaction represents a transfer of value from one account to another. (Depending on the path taken, this can involve additional exchanges of value, which occur atomically.) This transaction type can be used for several types of payments.
Payments are also the only way to create accounts.
type: object
Expand Down

0 comments on commit a7a3f6a

Please sign in to comment.