chore: some docs cleanup (#269)

Author: arcoraven

server/api/backend-wallet/transfer.ts

@@ -42,7 +42,7 @@ export async function transfer(fastify: FastifyInstance) {
     method: "POST",
     url: "/backend-wallet/:chain/transfer",
     schema: {
-      summary: "Transfer",
+      summary: "Transfer tokens",
       description:
         "Transfer native or ERC20 tokens from this wallet to another wallet",
       tags: ["Backend Wallet"],

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

@@ -33,7 +33,7 @@ export async function getDefaultRoyaltyInfo(fastify: FastifyInstance) {
     method: "GET",
     url: "/contract/:chain/:contractAddress/royalties/get-default-royalty-info",
     schema: {
-      summary: "Get Default Royalty Info",
+      summary: "Get royalty details",
       description:
         "Gets the royalty recipient and BPS (basis points) of the smart contract.",
       tags: ["Contract-Royalties"],

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

@@ -35,7 +35,7 @@ export async function getTokenRoyaltyInfo(fastify: FastifyInstance) {
     method: "GET",
     url: "/contract/:chain/:contractAddress/royalties/get-token-royalty-info/:token_id",
     schema: {
-      summary: "Get Token Royalty Info",
+      summary: "Get token royalty details",
       description:
         "Gets the royalty recipient and BPS (basis points) of a particular token in the contract.",
       tags: ["Contract-Royalties"],

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

@@ -35,7 +35,7 @@ export async function setDefaultRoyaltyInfo(fastify: FastifyInstance) {
     method: "POST",
     url: "/contract/:chain/:contractAddress/royalties/set-default-royalty-info",
     schema: {
-      summary: "Set Default Royalty Info",
+      summary: "Set royalty details",
       description: "Set the royalty recipient and fee for the smart contract.",
       tags: ["Contract-Royalties"],
       operationId: "setDefaultRoyaltyInfo",

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

@@ -41,7 +41,7 @@ export async function setTokenRoyaltyInfo(fastify: FastifyInstance) {
     method: "POST",
     url: "/contract/:chain/:contractAddress/royalties/set-token-royalty-info",
     schema: {
-      summary: "Set Token Royalty Info",
+      summary: "Set token royalty details",
       description:
         "Set the royalty recipient and fee for a particular token in the contract.",
       tags: ["Contract-Royalties"],

server/api/transaction/cancel.ts

@@ -7,35 +7,29 @@ import { cancelTransactionAndUpdate } from "../../utils/transaction";
 // INPUT
 const requestBodySchema = Type.Object({
   queueId: Type.String({
-    description: "Transaction Queue ID",
+    description: "Transaction queue ID",
     examples: ["9eb88b00-f04f-409b-9df7-7dcc9003bc35"],
   }),
 });
 
-requestBodySchema.examples = [
-  {
-    queueId: "9eb88b00-f04f-409b-9df7-7dcc9003bc35",
-  },
-];
-
 // OUTPUT
 export const responseBodySchema = Type.Object({
   result: Type.Object({
     queueId: Type.String({
-      description: "Transaction Queue ID",
+      description: "Transaction queue ID",
       examples: ["9eb88b00-f04f-409b-9df7-7dcc9003bc35"],
     }),
     status: Type.String({
-      description: "Response Status",
+      description: "Response status",
       examples: ["success, error"],
     }),
     message: Type.String({
-      description: "Response Message",
+      description: "Response message",
       examples: ["Transaction cancelled on-chain successfully"],
     }),
     transactionHash: Type.Optional(
       Type.String({
-        description: "Transaction Hash of the on-chain cancel transaction",
+        description: "Transaction hash of the on-chain cancel transaction",
         examples: [
           "0x0514076b5b7e3062c8dc17e10f7c0befe88e6efb7e97f16e3c14afb36c296467",
         ],
@@ -59,7 +53,9 @@ export async function cancelTransaction(fastify: FastifyInstance) {
     method: "POST",
     url: "/transaction/cancel",
     schema: {
-      description: "Cancel Transaction",
+      summary: "Cancel transaction",
+      description:
+        "Attempt to cancel a transaction by sending a null transaction with a higher gas setting. This transaction is not guaranteed to be cancelled.",
       tags: ["Transaction"],
       operationId: "cancel",
       body: requestBodySchema,

server/api/transaction/retry.ts

@@ -5,10 +5,9 @@ import { retryTx } from "../../../src/db/transactions/retryTx";
 import { standardResponseSchema } from "../../schemas/sharedApiSchemas";
 
 // INPUT
-
 const requestBodySchema = Type.Object({
   queueId: Type.String({
-    description: "Transaction Queue ID",
+    description: "Transaction queue ID",
     examples: ["9eb88b00-f04f-409b-9df7-7dcc9003bc35"],
   }),
   maxFeePerGas: Type.String(),

server/api/transaction/status.ts

@@ -18,7 +18,7 @@ import {
 // INPUT
 const requestSchema = Type.Object({
   queueId: Type.String({
-    description: "Transaction Queue ID",
+    description: "Transaction queue ID",
     examples: ["9eb88b00-f04f-409b-9df7-7dcc9003bc35"],
   }),
 });