Skip to content

Commit a9e0b10

Browse files
authored
chore: some docs cleanup (#269)
1 parent 2ac1c3b commit a9e0b10

File tree

8 files changed

+15
-20
lines changed

8 files changed

+15
-20
lines changed

server/api/backend-wallet/transfer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ export async function transfer(fastify: FastifyInstance) {
4242
method: "POST",
4343
url: "/backend-wallet/:chain/transfer",
4444
schema: {
45-
summary: "Transfer",
45+
summary: "Transfer tokens",
4646
description:
4747
"Transfer native or ERC20 tokens from this wallet to another wallet",
4848
tags: ["Backend Wallet"],

server/api/contract/royalties/read/getDefaultRoyaltyInfo.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ export async function getDefaultRoyaltyInfo(fastify: FastifyInstance) {
3333
method: "GET",
3434
url: "/contract/:chain/:contractAddress/royalties/get-default-royalty-info",
3535
schema: {
36-
summary: "Get Default Royalty Info",
36+
summary: "Get royalty details",
3737
description:
3838
"Gets the royalty recipient and BPS (basis points) of the smart contract.",
3939
tags: ["Contract-Royalties"],

server/api/contract/royalties/read/getTokenRoyaltyInfo.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export async function getTokenRoyaltyInfo(fastify: FastifyInstance) {
3535
method: "GET",
3636
url: "/contract/:chain/:contractAddress/royalties/get-token-royalty-info/:token_id",
3737
schema: {
38-
summary: "Get Token Royalty Info",
38+
summary: "Get token royalty details",
3939
description:
4040
"Gets the royalty recipient and BPS (basis points) of a particular token in the contract.",
4141
tags: ["Contract-Royalties"],

server/api/contract/royalties/write/setDefaultRoyaltyInfo.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ export async function setDefaultRoyaltyInfo(fastify: FastifyInstance) {
3535
method: "POST",
3636
url: "/contract/:chain/:contractAddress/royalties/set-default-royalty-info",
3737
schema: {
38-
summary: "Set Default Royalty Info",
38+
summary: "Set royalty details",
3939
description: "Set the royalty recipient and fee for the smart contract.",
4040
tags: ["Contract-Royalties"],
4141
operationId: "setDefaultRoyaltyInfo",

server/api/contract/royalties/write/setTokenRoyaltyInfo.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export async function setTokenRoyaltyInfo(fastify: FastifyInstance) {
4141
method: "POST",
4242
url: "/contract/:chain/:contractAddress/royalties/set-token-royalty-info",
4343
schema: {
44-
summary: "Set Token Royalty Info",
44+
summary: "Set token royalty details",
4545
description:
4646
"Set the royalty recipient and fee for a particular token in the contract.",
4747
tags: ["Contract-Royalties"],

server/api/transaction/cancel.ts

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,35 +7,29 @@ import { cancelTransactionAndUpdate } from "../../utils/transaction";
77
// INPUT
88
const requestBodySchema = Type.Object({
99
queueId: Type.String({
10-
description: "Transaction Queue ID",
10+
description: "Transaction queue ID",
1111
examples: ["9eb88b00-f04f-409b-9df7-7dcc9003bc35"],
1212
}),
1313
});
1414

15-
requestBodySchema.examples = [
16-
{
17-
queueId: "9eb88b00-f04f-409b-9df7-7dcc9003bc35",
18-
},
19-
];
20-
2115
// OUTPUT
2216
export const responseBodySchema = Type.Object({
2317
result: Type.Object({
2418
queueId: Type.String({
25-
description: "Transaction Queue ID",
19+
description: "Transaction queue ID",
2620
examples: ["9eb88b00-f04f-409b-9df7-7dcc9003bc35"],
2721
}),
2822
status: Type.String({
29-
description: "Response Status",
23+
description: "Response status",
3024
examples: ["success, error"],
3125
}),
3226
message: Type.String({
33-
description: "Response Message",
27+
description: "Response message",
3428
examples: ["Transaction cancelled on-chain successfully"],
3529
}),
3630
transactionHash: Type.Optional(
3731
Type.String({
38-
description: "Transaction Hash of the on-chain cancel transaction",
32+
description: "Transaction hash of the on-chain cancel transaction",
3933
examples: [
4034
"0x0514076b5b7e3062c8dc17e10f7c0befe88e6efb7e97f16e3c14afb36c296467",
4135
],
@@ -59,7 +53,9 @@ export async function cancelTransaction(fastify: FastifyInstance) {
5953
method: "POST",
6054
url: "/transaction/cancel",
6155
schema: {
62-
description: "Cancel Transaction",
56+
summary: "Cancel transaction",
57+
description:
58+
"Attempt to cancel a transaction by sending a null transaction with a higher gas setting. This transaction is not guaranteed to be cancelled.",
6359
tags: ["Transaction"],
6460
operationId: "cancel",
6561
body: requestBodySchema,

server/api/transaction/retry.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,9 @@ import { retryTx } from "../../../src/db/transactions/retryTx";
55
import { standardResponseSchema } from "../../schemas/sharedApiSchemas";
66

77
// INPUT
8-
98
const requestBodySchema = Type.Object({
109
queueId: Type.String({
11-
description: "Transaction Queue ID",
10+
description: "Transaction queue ID",
1211
examples: ["9eb88b00-f04f-409b-9df7-7dcc9003bc35"],
1312
}),
1413
maxFeePerGas: Type.String(),

server/api/transaction/status.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import {
1818
// INPUT
1919
const requestSchema = Type.Object({
2020
queueId: Type.String({
21-
description: "Transaction Queue ID",
21+
description: "Transaction queue ID",
2222
examples: ["9eb88b00-f04f-409b-9df7-7dcc9003bc35"],
2323
}),
2424
});

0 commit comments

Comments
 (0)