docs: added examples to Faucets, fees, fungible tokens and Info API's (#1234)

* Added examples to Faucets, fees, fungible tokens and Info API's

Added examples for burn block, faucets,info,fungible tokens API's

* Removed response 429 and changed an example to mainnet for network block time

* Add enum value for get_network_block_time_by_network API

* Describe max for limit attribute in tokens/ft/metadata api

Author: LakshmiLavanyaKasturi

docs/openapi.yaml

@@ -674,6 +674,7 @@ paths:
         required: true
         schema:
           type: string
+          example: 0x00000000000000000002bba732926cf68b6eda3e2cdbc2a85af79f10efeeeb10
     get:
       summary: Get block by burnchain block hash
       description: Retrieves block details of a specific block for a given burnchain block hash
@@ -704,6 +705,7 @@ paths:
         required: true
         schema:
           type: number
+          example: 744603
     get:
       summary: Get block by burnchain height
       description: Retrieves block details of a specific block for a given burn chain height
@@ -1776,7 +1778,8 @@ paths:
           schema:
             type: string
             enum: [testnet, mainnet]
-          description: Which network to retrieve the target block time of
+            example: mainnet
+          description: the target block time for a given network (testnet, mainnet).
       responses:
         200:
           description: Success
@@ -1800,7 +1803,8 @@ paths:
           required: false
           schema:
             type: number
-          description: The block height at which to query supply details from, if not provided then the latest block height is used
+            example: 200
+          description: Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value.
       responses:
         200:
           description: Success
@@ -1856,7 +1860,8 @@ paths:
           required: false
           schema:
             type: number
-          description: The block height at which to query supply details from, if not provided then the latest block height is used
+            example: 200
+          description: Supply details are queried from specified block height. If the block height is not specified, the latest block height is taken as default value.
       responses:
         200:
           description: Success
@@ -2902,17 +2907,20 @@ paths:
       parameters:
         - name: limit
           in: query
-          description: max number of tokens to fetch
+          description: max number of tokens to fetch.
           required: false
           schema:
             type: integer
+            example: 100
+            maximum: 200
         - name: offset
           in: query
           description: index of first tokens to fetch
           required: false
           example: 42000
           schema:
             type: integer
+            example: 500
       responses:
         200:
           description: List of fungible tokens metadata
@@ -3198,6 +3206,7 @@ paths:
           required: true
           schema:
             type: string
+            example: SPSCWDV3RKV5ZRN1FQD84YE1NQFEDJ9R1F4DYQ11.newyorkcitycoin-token-v2
       responses:
         200:
           description: Fungible tokens metadata for contract id
@@ -3214,7 +3223,7 @@ paths:
       summary: Fetch fee rate
       deprecated: true
       description: |
-        **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for the given transaction](#operation/post_fee_transaction).
+        **NOTE:** This endpoint is deprecated in favor of [Get approximate fees for a given transaction](#operation/post_fee_transaction).
 
         Retrieves estimated fee rate.
       tags:
@@ -3239,7 +3248,7 @@ paths:
 
   /v2/fees/transaction:
     post:
-      summary: Get approximate fees for the given transaction
+      summary: Get approximate fees for a given transaction
       tags:
         - Fees
       description: |