docs: Add summary; update descriptions (#180)

Author: arcoraven

.github/contributing.md

@@ -14,7 +14,7 @@ For OSS contributions, we use a [Forking Workflow](https://www.atlassian.com/git
 
 To begin:
 
-1. [Create a fork](https://github.com/thirdweb-dev/web3-api/fork) of this repository to your own GitHub account.
+1. [Create a fork](https://github.com/thirdweb-dev/engine/fork) of this repository to your own GitHub account.
 
 2. [Clone your fork](https://help.github.com/articles/cloning-a-repository/) to your local device.
 

core/schema/index.ts

@@ -39,7 +39,7 @@ export const chainResponseSchema = Type.Object({
 
 export const walletAuthSchema = Type.Object({
   "x-backend-wallet-address": Type.String({
-    description: "Wallet address",
+    description: "Backend wallet address",
   }),
   "x-account-address": Type.Optional(
     Type.String({

docs/1-user-guide.md

@@ -1,4 +1,4 @@
-# thirdweb web3-api User Guide
+# thirdweb Engine User Guide
 
 ## Getting Started
 
@@ -25,7 +25,7 @@
 
 ### PostgreSQL DB
 
-A PostgreSQL DB is required to run web3-api, both the server and worker need access to it. Check [installation guide](./.github/installations.md) for more details.
+A PostgreSQL DB is required to run _Engine_, both the server and worker need access to it. Check [installation guide](./.github/installations.md) for more details.
 
 Once you have PostgreSQL DB running set the POSTGRES_CONNECTION_URL environment variable:
 

server/api/backend-wallet/create.ts

@@ -30,7 +30,8 @@ export const createWallet = async (fastify: FastifyInstance) => {
     method: "POST",
     url: "/backend-wallet/create",
     schema: {
-      description: "Create a new backend wallet",
+      summary: "Create backend wallet",
+      description: "Create a backend wallet.",
       tags: ["Backend Wallet"],
       operationId: "backendWallet_create",
       response: {

server/api/backend-wallet/getAll.ts

@@ -34,7 +34,8 @@ export async function getAll(fastify: FastifyInstance) {
     method: "GET",
     url: "/backend-wallet/get-all",
     schema: {
-      description: "Get all created EOA wallet",
+      summary: "Get all backend wallets",
+      description: "Get all backend wallets.",
       tags: ["Backend Wallet"],
       operationId: "backendWallet_getAll",
       response: {

server/api/backend-wallet/getBalance.ts

@@ -39,7 +39,8 @@ export async function getBalance(fastify: FastifyInstance) {
     method: "GET",
     url: "/backend-wallet/:chain/:wallet_address/get-balance",
     schema: {
-      description: "Get Wallet Balance",
+      summary: "Get balance",
+      description: "Get the native balance for a backend wallet.",
       tags: ["Backend Wallet"],
       operationId: "backendWallet_getBalance",
       params: requestSchema,

server/api/backend-wallet/import.ts

@@ -99,7 +99,8 @@ export const importWallet = async (fastify: FastifyInstance) => {
     method: "POST",
     url: "/backend-wallet/import",
     schema: {
-      description: "Import a wallet that has already been created",
+      summary: "Import backend wallet",
+      description: "Import an existing wallet as a backend wallet.",
       tags: ["Backend Wallet"],
       operationId: "backendWallet_import",
       body: RequestBodySchema,

server/api/chain/get.ts

@@ -15,20 +15,18 @@ const responseSchema = Type.Object({
 responseSchema.examples = [
   {
     result: {
-      result: {
-        name: "Mumbai",
-        chain: "Polygon",
-        rpc: ["https://mumbai.rpc.thirdweb.com/${THIRDWEB_API_SECRET_KEY}"],
-        nativeCurrency: {
-          name: "MATIC",
-          symbol: "MATIC",
-          decimals: 18,
-        },
-        shortName: "maticmum",
-        chainId: 80001,
-        testnet: true,
-        slug: "mumbai",
+      name: "Mumbai",
+      chain: "Polygon",
+      rpc: ["https://mumbai.rpc.thirdweb.com/${THIRDWEB_API_SECRET_KEY}"],
+      nativeCurrency: {
+        name: "MATIC",
+        symbol: "MATIC",
+        decimals: 18,
       },
+      shortName: "maticmum",
+      chainId: 80001,
+      testnet: true,
+      slug: "mumbai",
     },
   },
 ];
@@ -42,7 +40,8 @@ export async function getChainData(fastify: FastifyInstance) {
     method: "GET",
     url: "/chain/get",
     schema: {
-      description: "Get a particular chain information",
+      summary: "Get chain details",
+      description: "Get details about a chain.",
       tags: ["Chain"],
       operationId: "chain",
       querystring: chainRequestQuerystringSchema,

server/api/chain/getAll.ts

@@ -53,7 +53,8 @@ export async function getAllChainData(fastify: FastifyInstance) {
     method: "GET",
     url: "/chain/get-all",
     schema: {
-      description: "Get all chains information",
+      summary: "Get all chain details",
+      description: "Get details about all supported chains.",
       tags: ["Chain"],
       operationId: "getAllChainData",
       response: {

server/api/contract/events/getAllEvents.ts

@@ -66,8 +66,8 @@ export async function getAllEvents(fastify: FastifyInstance) {
     method: "GET",
     url: "/contract/:chain/:contract_address/events/get-all",
     schema: {
-      description:
-        "Get a list of all the events emitted from this contract during the specified time period",
+      summary: "Get all events",
+      description: "Get a list of all blockchain events for this contract.",
       tags: ["Contract-Events"],
       operationId: "getAllEvents",
       params: requestSchema,