chore: better docs

hirosystems · Jul 1, 2024 · 329d3e1 · 329d3e1
1 parent b0e7998
commit 329d3e1
Show file tree

Hide file tree

Showing 8 changed files with 265 additions and 96 deletions.
diff --git a/.github/workflows/vercel.yml b/.github/workflows/vercel.yml
@@ -25,7 +25,7 @@ jobs:
 
     environment:
       name: ${{ github.ref_name == 'main' && 'Production' || 'Preview' }}
-      url: ${{ github.ref_name == 'main' && 'https://runes-api.vercel.app/' || 'https://runes-api-pbcblockstack-blockstack.vercel.app/' }}
+      url: ${{ github.ref_name == 'main' && 'https://runes-api.vercel.app/' || 'https://runehook-pbcblockstack-hirosystems.vercel.app/' }}
 
     steps:
       - uses: actions/checkout@v2

diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 /target
 Runehook.toml
+.DS_Store
diff --git a/api/src/api/routes/addresses.ts b/api/src/api/routes/addresses.ts
@@ -19,9 +19,9 @@ export const AddressRoutes: FastifyPluginCallback<
     {
       schema: {
         operationId: 'getAddressBalances',
-        summary: 'Get address balances',
+        summary: 'Address balances',
         description: 'Retrieves a paginated list of address balances',
-        tags: ['Runes'],
+        tags: ['Balances'],
         params: Type.Object({
           address: AddressSchema,
         }),

diff --git a/api/src/api/routes/blocks.ts b/api/src/api/routes/blocks.ts
@@ -19,9 +19,9 @@ export const BlockRoutes: FastifyPluginCallback<
     {
       schema: {
         operationId: 'getBlockActivity',
-        summary: 'Get block activity',
+        summary: 'Block activity',
         description: 'Retrieves a paginated list of rune activity for a block',
-        tags: ['Runes'],
+        tags: ['Activities'],
         params: Type.Object({
           block: BlockSchema,
         }),

diff --git a/api/src/api/routes/etchings.ts b/api/src/api/routes/etchings.ts
@@ -29,9 +29,9 @@ export const EtchingRoutes: FastifyPluginCallback<
     {
       schema: {
         operationId: 'getEtchings',
-        summary: 'Get rune etchings',
+        summary: 'Rune etchings',
         description: 'Retrieves a paginated list of rune etchings',
-        tags: ['Runes'],
+        tags: ['Etchings'],
         querystring: Type.Object({
           offset: Optional(OffsetSchema),
           limit: Optional(LimitSchema),
@@ -61,7 +61,7 @@ export const EtchingRoutes: FastifyPluginCallback<
         operationId: 'getEtching',
         summary: 'Rune etching',
         description: 'Retrieves information for a Rune etching',
-        tags: ['Runes'],
+        tags: ['Etchings'],
         params: Type.Object({
           etching: RuneSchema,
         }),
@@ -86,9 +86,9 @@ export const EtchingRoutes: FastifyPluginCallback<
     {
       schema: {
         operationId: 'getRuneActivity',
-        summary: 'Rune rune activity',
+        summary: 'Rune activity',
         description: 'Retrieves all activity for a Rune',
-        tags: ['Runes'],
+        tags: ['Activities'],
         params: Type.Object({
           etching: RuneSchema,
         }),
@@ -119,9 +119,9 @@ export const EtchingRoutes: FastifyPluginCallback<
     {
       schema: {
         operationId: 'getRuneAddressActivity',
-        summary: 'Rune rune activity for address',
+        summary: 'Rune activity for address',
         description: 'Retrieves all activity for a Rune address',
-        tags: ['Runes'],
+        tags: ['Activities'],
         params: Type.Object({
           etching: RuneSchema,
           address: AddressSchema,
@@ -160,7 +160,7 @@ export const EtchingRoutes: FastifyPluginCallback<
         operationId: 'getRuneHolders',
         summary: 'Rune holders',
         description: 'Retrieves a paginated list of holders for a Rune',
-        tags: ['Runes'],
+        tags: ['Balances'],
         params: Type.Object({
           etching: RuneSchema,
         }),
@@ -193,7 +193,7 @@ export const EtchingRoutes: FastifyPluginCallback<
         operationId: 'getRuneHolderBalance',
         summary: 'Rune holder balance',
         description: 'Retrieves holder balance for a specific Rune',
-        tags: ['Runes'],
+        tags: ['Balances'],
         params: Type.Object({
           etching: RuneSchema,
           address: AddressSchema,

diff --git a/api/src/api/routes/transactions.ts b/api/src/api/routes/transactions.ts
@@ -19,9 +19,9 @@ export const TransactionRoutes: FastifyPluginCallback<
     {
       schema: {
         operationId: 'getTransactionActivity',
-        summary: 'Get transaction activity',
+        summary: 'Transaction activity',
         description: 'Retrieves a paginated list of rune activity for a transaction',
-        tags: ['Runes'],
+        tags: ['Activities'],
         params: Type.Object({
           tx_id: TransactionIdSchema,
         }),