Website fields adjustment for new flow withoit IPNS.

Apillon · Jul 26, 2024 · 118a5f9 · 118a5f9
1 parent 11448b3
commit 118a5f9
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 11 deletions.
diff --git a/build/3-hosting-api.md b/build/3-hosting-api.md
@@ -36,7 +36,8 @@ Each item is an instance of website class, with below properties:
 | description    | `string`   | Website description                                                                                                      |
 | domain         | `string`   | Website domain. This property needs to be specified, so that Apillon is able to create SSL Certificates for IPFS gateway |
 | bucketUuid     | `string`   | Uuid of bucket for file upload                                                                                           |
-| ipnsStaging    | `string`   | Staging IPNS. Set if deployment to staging environment exists                                                            |
+| cidStaging     | `string`   | Staging ipfs CID. Set if deployment to staging environment exists                                                        |
+| cidProduction  | `string`   | Production ipfs CID. Set if deployment to production environment exists                                                  |
 | ipnsProduction | `string`   | Production IPNS.                                                                                                         |
 | createTime     | `DateTime` | Item create time                                                                                                         |
 | updateTime     | `DateTime` | Item last update time                                                                                                    |
@@ -80,7 +81,6 @@ curl --location --request GET "https://api.apillon.io/storage/buckets?search=My
                 "description": null,
                 "domain": null,
                 "bucketUuid": "1938a45c-3a54-43ee-af08-3abe90265f46",
-                "ipnsStaging": null,
                 "ipnsProduction": null
             }
             ...
@@ -156,7 +156,6 @@ curl --location --request POST "https://api.apillon.io/hosting/websites" \
     "description": "My unstoppable website",
     "domain": "example-domain.io",
     "bucketUuid": "cd299839-dae6-47d0-8fdc-40143163e156",
-    "ipnsStaging": null,
     "ipnsProduction": null
   }
 }
@@ -228,7 +227,8 @@ curl --location --request GET "https://api.apillon.io/hosting/websites/:websiteU
     "description": "My unstoppable website",
     "domain": "example-domain.io",
     "bucketUuid": "cd299839-dae6-47d0-8fdc-40143163e156",
-    "ipnsStaging": null,
+    "cidStaging": null,
+    "cidProduction": null,
     "ipnsProduction": null,
     "w3StagingLink": null,
     "w3ProductionLink": null,
@@ -731,14 +731,14 @@ curl --location --request GET "https://api.apillon.io/hosting/websites/:websiteU
 
 #### Body fields
 
-| Name           | Description                                                           | Required |
-| -------------- | --------------------------------------------------------------------- | -------- |
-| targetUrl      | The target URL of the website the short URL will point to             | true     |
+| Name      | Description                                               | Required |
+| --------- | --------------------------------------------------------- | -------- |
+| targetUrl | The target URL of the website the short URL will point to | true     |
 
 #### Response fields
 
 | Field     | Type     | Description                                   |
-| ----------| -------- | --------------------------------------------- |
+| --------- | -------- | --------------------------------------------- |
 | id        | `string` | The short URL slug                            |
 | url       | `string` | The full short URL                            |
 | targetUrl | `string` | The target URL which the short link points to |

diff --git a/build/6-apillon-cli.md b/build/6-apillon-cli.md
@@ -97,7 +97,7 @@ apillon hosting list-websites --search "My-Website" --limit 1
       "description": "My own website",
       "domain": "https://my-website.com",
       "bucketUuid": "47251013-37c6-4b30-be2b-8583dea25c4c",
-      "ipnsStaging": "k2k4r8ob2rf35wbmhhtzbq6nd4lhwv...",
+      "cidStaging": "bafybeidwxptqhokkmwgtzrjgj2pvcapmyce...",
       "ipnsProduction": "k2k4r8pple7phwm9azqgxshxdzy..."
     },
     ...
@@ -432,12 +432,15 @@ apillon storage delete-directory --bucket-uuid "123e4567-e89b-12d3-a456-42665544
 ### IPNS Commands
 
 #### `storage ipns list`
+
 Lists all IPNS records for a specific bucket.
 
 **Options**
+
 - `-b, --bucket-uuid <uuid>`: UUID of the bucket.
 
 **Example**
+
 ```sh
 apillon storage ipns list --bucket-uuid "123e4567-e89b-12d3-a456-426655440000"
 ```
@@ -475,52 +478,64 @@ apillon storage ipns list --bucket-uuid "123e4567-e89b-12d3-a456-426655440000"
 ```
 
 #### `storage ipns create`
+
 Creates a new IPNS record for a specific bucket.
 
 **Options**
+
 - `-b, --bucket-uuid <uuid>`: UUID of the bucket.
 - `-n, --name <name>`: Name of the IPNS record.
 - `-d, --description <description>`: Description of the IPNS record (optional).
 - `-c, --cid <cid>`: CID to which this IPNS name will point.
 
 **Example**
+
 ```sh
 apillon storage ipns create --bucket-uuid "123e4567-e89b-12d3-a456-426655440000" --name "my-ipns-record" --cid "QmWX5CcNvnaVmgGBn4o82XW9uW1uLvsHQDdNrANrQeSdXm"
 ```
 
 #### `storage ipns get`
+
 Retrieves information about a specific IPNS record.
 
 **Options**
+
 - `-b, --bucket-uuid <uuid>`: UUID of the bucket.
 - `-i, --ipns-uuid <uuid>`: UUID of the IPNS record.
 
 **Example**
+
 ```sh
 apillon storage ipns get --ipns-uuid "123e4567-e89b-12d3-a456-426655440000"
 ```
 
 #### `storage ipns publish`
+
 Publishes an IPNS record to IPFS and links it to a CID.
 
 **Options**
+
 - `-b, --bucket-uuid <uuid>`: UUID of the bucket.
 - `-i, --ipns-uuid <uuid>`: UUID of the IPNS record.
 - `-c, --cid <string>`: CID to which this IPNS name will point.
 
 **Example**
+
 ```sh
 apillon storage ipns publish --ipns-uuid "123e4567-e89b-12d3-a456-426655440000" --cid "QmWX5CcNvnaVmgGBn4o82XW9uW1uLvsHQDdNrANrQeSdXm"
 ```
 
 #### `storage ipns delete`
+
 Deletes an IPNS record from a specific bucket.
 
 **Options**
+
 - `-b, --bucket-uuid <uuid>`: UUID of the bucket.
 - `-i, --ipns-uuid <uuid>`: UUID of the IPNS record.
 
 **Example**
+
 ```sh
 apillon storage ipns delete --ipns-uuid "123e4567-e89b-12d3-a456-426655440000"
 ```
@@ -786,10 +801,8 @@ jobs:
       ## Find the correct command in your framework documentation. You may need to change the
       ## name of the source folder in the last step (CLI call)
       ####
-
       # - name: Build app
       #   run: npm run build
-
       - name: Deploy website
         env:
           APILLON_API_KEY: ${{ secrets.APILLON_API_KEY }}