Merge pull request #298 from blockfrost/srk/hosted

Document hosted endpoints
blockfrost · Mar 19, 2023 · f1d31b0 · f1d31b0
2 parents 2efa517 + a91035f
commit f1d31b0
Show file tree

Hide file tree

Showing 14 changed files with 164 additions and 26 deletions.
diff --git a/openapi.yaml b/openapi.yaml
@@ -71,6 +71,15 @@ info:
           </td>
       </tr>
     </table>
+    <style>
+    .hosted {
+      background-color: #0168fa;
+      border-radius: 5px;
+      padding: 4px;
+      margin-right: 2px;
+      color: white;
+    }
+    </style>
 
     ## Milkomeda
 
@@ -1650,7 +1659,10 @@ paths:
       tags:
         - Cardano » Transactions
       summary: Submit a transaction
-      description: Submit an already serialized transaction to the network.
+      description: |
+        Submit an already serialized transaction to the network.
+
+        <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
       parameters:
         - in: header
           name: Content-Type
@@ -2291,7 +2303,12 @@ paths:
       tags:
         - Cardano » Mempool
       summary: Mempool
-      description: Return transactions that are currently stored in Blockfrost mempool, waiting to be included in a newly minted block. Shows only transactions submitted via Blockfrost.io.
+      description: |
+        Return transactions that are currently stored in Blockfrost mempool,
+        waiting to be included in a newly minted block.
+        Shows only transactions submitted via Blockfrost.io.
+
+        <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
       parameters:
         - in: query
           name: count
@@ -2347,7 +2364,10 @@ paths:
       tags:
         - Cardano » Mempool
       summary: Specific transaction
-      description: Return content of the requested transaction.
+      description: |
+        Return content of the requested transaction.
+
+        <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
       parameters:
         - in: path
           name: hash
@@ -2381,7 +2401,11 @@ paths:
       tags:
         - Cardano » Mempool
       summary: Mempool by address
-      description: List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address. Shows only transactions submitted via Blockfrost.io.
+      description: |
+        List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address.
+        Shows only transactions submitted via Blockfrost.io.
+
+        <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
       parameters:
         - in: path
           name: address
@@ -4324,7 +4348,10 @@ paths:
       tags:
         - Cardano » Utilities
       summary: Submit a transaction for execution units evaluation
-      description: Submit an already serialized transaction to evaluate how much execution units it requires.
+      description: |
+        Submit an already serialized transaction to evaluate how much execution units it requires.
+
+        <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
       parameters:
         - in: header
           name: Content-Type
@@ -4374,7 +4401,10 @@ paths:
       tags:
         - Cardano » Utilities
       summary: Submit a transaction for execution units evaluation (additional UTXO set)
-      description: Submit a JSON payload with transaction CBOR and additional utxo set to evaluate how much execution units it requires.
+      description: |
+        Submit a JSON payload with transaction CBOR and additional UTXO set to evaluate how much execution units it requires.
+
+        <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
       parameters:
         - in: header
           name: Content-Type
@@ -4489,6 +4519,8 @@ paths:
       description: |
         You need to `/ipfs/pin/add` an object to avoid it being garbage collected. This usage
         is being counted in your user account quota.
+
+        <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
       x-codeSamples:
         - lang: curl
           source: |
@@ -4539,7 +4571,10 @@ paths:
       tags:
         - IPFS » Gateway
       summary: Relay to an IPFS gateway
-      description: Retrieve an object from the IPFS gateway (useful if you do not want to rely on a public gateway, such as `ipfs.blockfrost.dev`).
+      description: |
+        Retrieve an object from the IPFS gateway (useful if you do not want to rely on a public gateway, such as `ipfs.blockfrost.dev`).
+
+        <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
       parameters:
         - in: path
           required: true
@@ -4619,7 +4654,10 @@ paths:
       tags:
         - IPFS » Pins
       summary: List pinned objects
-      description: List objects pinned to local storage
+      description: |
+        List objects pinned to local storage
+
+        <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
       parameters:
         - in: query
           name: count
@@ -4712,7 +4750,10 @@ paths:
       tags:
         - IPFS » Pins
       summary: Get details about pinned object
-      description: Get information about locally pinned IPFS object
+      description: |
+        Get information about locally pinned IPFS object
+
+        <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
       parameters:
         - in: path
           required: true
@@ -4780,7 +4821,10 @@ paths:
       tags:
         - IPFS » Pins
       summary: Remove a IPFS pin
-      description: Remove pinned objects from local storage
+      description: |
+        Remove pinned objects from local storage
+
+        <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
       parameters:
         - in: path
           required: true

diff --git a/src/definitions.yaml b/src/definitions.yaml
@@ -71,6 +71,15 @@ info:
           </td>
       </tr>
     </table>
+    <style>
+    .hosted {
+      background-color: #0168fa;
+      border-radius: 5px;
+      padding: 4px;
+      margin-right: 2px;
+      color: white;
+    }
+    </style>
 
     ## Milkomeda
 

diff --git a/src/generated-types.ts b/src/generated-types.ts
@@ -1251,11 +1251,15 @@ export interface paths {
     /**
      * Submit a transaction 
      * @description Submit an already serialized transaction to the network.
+     * 
+     * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
      */
     post: {
       /**
        * Submit a transaction 
        * @description Submit an already serialized transaction to the network.
+       * 
+       * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
        */
       parameters: {
         header: {
@@ -1726,12 +1730,20 @@ export interface paths {
   "/mempool": {
     /**
      * Mempool 
-     * @description Return transactions that are currently stored in Blockfrost mempool, waiting to be included in a newly minted block. Shows only transactions submitted via Blockfrost.io.
+     * @description Return transactions that are currently stored in Blockfrost mempool,
+     * waiting to be included in a newly minted block.
+     * Shows only transactions submitted via Blockfrost.io.
+     * 
+     * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
      */
     get: {
       /**
        * Mempool 
-       * @description Return transactions that are currently stored in Blockfrost mempool, waiting to be included in a newly minted block. Shows only transactions submitted via Blockfrost.io.
+       * @description Return transactions that are currently stored in Blockfrost mempool,
+       * waiting to be included in a newly minted block.
+       * Shows only transactions submitted via Blockfrost.io.
+       * 
+       * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
        */
       parameters?: {
           /** @description The number of results displayed on one page. */
@@ -1766,11 +1778,15 @@ export interface paths {
     /**
      * Specific transaction 
      * @description Return content of the requested transaction.
+     * 
+     * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
      */
     get: {
       /**
        * Specific transaction 
        * @description Return content of the requested transaction.
+       * 
+       * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
        */
       parameters: {
           /**
@@ -1800,12 +1816,18 @@ export interface paths {
   "/mempool/addresses/{address}": {
     /**
      * Mempool by address 
-     * @description List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address. Shows only transactions submitted via Blockfrost.io.
+     * @description List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address.
+     * Shows only transactions submitted via Blockfrost.io.
+     * 
+     * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
      */
     get: {
       /**
        * Mempool by address 
-       * @description List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address. Shows only transactions submitted via Blockfrost.io.
+       * @description List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address.
+       * Shows only transactions submitted via Blockfrost.io.
+       * 
+       * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
        */
       parameters: {
           /** @description The number of results displayed on one page. */
@@ -3347,11 +3369,15 @@ export interface paths {
     /**
      * Submit a transaction for execution units evaluation 
      * @description Submit an already serialized transaction to evaluate how much execution units it requires.
+     * 
+     * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
      */
     post: {
       /**
        * Submit a transaction for execution units evaluation 
        * @description Submit an already serialized transaction to evaluate how much execution units it requires.
+       * 
+       * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
        */
       parameters: {
         header: {
@@ -3384,12 +3410,16 @@ export interface paths {
   "/utils/txs/evaluate/utxos": {
     /**
      * Submit a transaction for execution units evaluation (additional UTXO set) 
-     * @description Submit a JSON payload with transaction CBOR and additional utxo set to evaluate how much execution units it requires.
+     * @description Submit a JSON payload with transaction CBOR and additional UTXO set to evaluate how much execution units it requires.
+     * 
+     * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
      */
     post: {
       /**
        * Submit a transaction for execution units evaluation (additional UTXO set) 
-       * @description Submit a JSON payload with transaction CBOR and additional utxo set to evaluate how much execution units it requires.
+       * @description Submit a JSON payload with transaction CBOR and additional UTXO set to evaluate how much execution units it requires.
+       * 
+       * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
        */
       parameters: {
         header: {
@@ -3435,12 +3465,16 @@ export interface paths {
      * Add a file to IPFS 
      * @description You need to `/ipfs/pin/add` an object to avoid it being garbage collected. This usage
      * is being counted in your user account quota.
+     * 
+     * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
      */
     post: {
       /**
        * Add a file to IPFS 
        * @description You need to `/ipfs/pin/add` an object to avoid it being garbage collected. This usage
        * is being counted in your user account quota.
+       * 
+       * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
        */
       responses: {
         /** @description Returns information about added IPFS object */
@@ -3478,11 +3512,15 @@ export interface paths {
     /**
      * Relay to an IPFS gateway 
      * @description Retrieve an object from the IPFS gateway (useful if you do not want to rely on a public gateway, such as `ipfs.blockfrost.dev`).
+     * 
+     * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
      */
     get: {
       /**
        * Relay to an IPFS gateway 
        * @description Retrieve an object from the IPFS gateway (useful if you do not want to rely on a public gateway, such as `ipfs.blockfrost.dev`).
+       * 
+       * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
        */
       parameters: {
         path: {
@@ -3549,11 +3587,15 @@ export interface paths {
     /**
      * List pinned objects 
      * @description List objects pinned to local storage
+     * 
+     * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
      */
     get: {
       /**
        * List pinned objects 
        * @description List objects pinned to local storage
+       * 
+       * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
        */
       parameters?: {
           /** @description The number of results displayed on one page. */
@@ -3619,11 +3661,15 @@ export interface paths {
     /**
      * Get details about pinned object 
      * @description Get information about locally pinned IPFS object
+     * 
+     * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
      */
     get: {
       /**
        * Get details about pinned object 
        * @description Get information about locally pinned IPFS object
+       * 
+       * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
        */
       parameters: {
         path: {
@@ -3682,11 +3728,15 @@ export interface paths {
     /**
      * Remove a IPFS pin 
      * @description Remove pinned objects from local storage
+     * 
+     * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
      */
     post: {
       /**
        * Remove a IPFS pin 
        * @description Remove pinned objects from local storage
+       * 
+       * <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
        */
       parameters: {
         path: {

diff --git a/src/paths/api/mempool/addresses/{address}/index.yaml b/src/paths/api/mempool/addresses/{address}/index.yaml
@@ -2,7 +2,11 @@ get:
   tags:
     - Cardano » Mempool
   summary: Mempool by address
-  description: List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address. Shows only transactions submitted via Blockfrost.io.
+  description: |
+    List of mempool transactions where at least one of the transaction inputs or outputs belongs to the address.
+    Shows only transactions submitted via Blockfrost.io.
+
+    <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
   parameters:
     - in: path
       name: address

diff --git a/src/paths/api/mempool/index.yaml b/src/paths/api/mempool/index.yaml
@@ -2,7 +2,12 @@ get:
   tags:
     - Cardano » Mempool
   summary: Mempool
-  description: Return transactions that are currently stored in Blockfrost mempool, waiting to be included in a newly minted block. Shows only transactions submitted via Blockfrost.io.
+  description: |
+    Return transactions that are currently stored in Blockfrost mempool,
+    waiting to be included in a newly minted block.
+    Shows only transactions submitted via Blockfrost.io.
+
+    <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
   parameters:
     - in: query
       name: count

diff --git a/src/paths/api/mempool/{hash}/index.yaml b/src/paths/api/mempool/{hash}/index.yaml
@@ -2,7 +2,10 @@ get:
   tags:
     - Cardano » Mempool
   summary: Specific transaction
-  description: Return content of the requested transaction.
+  description: |
+    Return content of the requested transaction.
+
+    <span class="hosted">Hosted</span> Endpoint only available for hosted variant.
   parameters:
     - in: path
       name: hash