Release/next (#150)

* Prepare new release * Add doc for new rule operator 'array includes' (#142) * Remove enterprise plan from pricing * Add documentation for improved presence indicators See mockoon/mockoon#1512 * Set version 9.0.0 * Add isValidDate docs See mockoon/mockoon#1510 * Add docs for new path and method rules See mockoon/mockoon#1468 and mockoon/mockoon#1467 * Add uuid helper docs See mockoon/mockoon#1533 * Update multipart docs See mockoon/mockoon#1445 * Add hbs docs link in helpers page * Update trial req/s limit * Update docs for setData helper See mockoon/mockoon#1098 * Add docs for CRUD numeric ids see mockoon/mockoon#1542 * Add custom templating helper docs See mockoon/mockoon#1545 * Websocket documentation (#143) * websocket documentation * websocket doc updates * doc updates with images * an update about websocket broadcasting * Update docs for websockets * Remove old docs * Update docs for mockoon/mockoon#1557 * Add docs for new json schema rule See mockoon/mockoon#1452 * Remove old docs * Update cloud landing pages * Add changelog --------- Co-authored-by: Ankit <[email protected]> Co-authored-by: Isuru Weerarathna <[email protected]>
mockoon · Oct 25, 2024 · d2e49fa · d2e49fa
1 parent 61a87c9
commit d2e49fa
Show file tree

Hide file tree

Showing 631 changed files with 1,954 additions and 7,116 deletions.
diff --git a/components/footer.tsx b/components/footer.tsx
@@ -145,7 +145,7 @@ const Footer: FunctionComponent<{
               </li>
               <li className='mb-2'>
                 {/* Do not use <Link>, as routes with a dot inside get rewritten without trailing slash */}
-                <a href='/releases/8.4.0/' className='text-reset'>
+                <a href='/releases/9.0.0/' className='text-reset'>
                   Releases
                 </a>
               </li>

diff --git a/components/nav.tsx b/components/nav.tsx
@@ -320,7 +320,7 @@ const Nav: FunctionComponent = function () {
                           Blog
                         </Link>
                         <a
-                          href='/releases/8.4.0/'
+                          href='/releases/9.0.0/'
                           className={`dropdown-item ${
                             router.pathname === '/releases' ||
                             router.pathname === '/releases/[version]'

diff --git a/components/oss-cloud-comparison.tsx b/components/oss-cloud-comparison.tsx
@@ -113,7 +113,7 @@ const OssCloudComparison = function () {
                   <i className='icon-clear'></i>
                 </span>
                 <br />
-                Manual file sharing (git, etc.)
+                <small>Manual file sharing (git, etc.)</small>
               </td>
               <td>
                 <span className='text-success fw-bold fs-3 me-2'>
@@ -128,14 +128,14 @@ const OssCloudComparison = function () {
                   <i className='icon-clear'></i>
                 </span>
                 <br />
-                Self-hosting with the CLI and Docker image
+                <small>Self-hosting with the CLI and Docker image</small>
               </td>
               <td>
                 <span className='text-success fw-bold fs-3 me-2'>
                   <i className='icon-check'></i>
                 </span>
                 <br />
-                Online cloud deployments
+                <small>Online cloud deployments</small>
               </td>
             </tr>
             <tr>

diff --git a/components/plans.tsx b/components/plans.tsx
@@ -854,30 +854,37 @@ const PlansView: FunctionComponent<{
             </section>
 
             {showTagline && (
-              <div className='py-8'>
-                <p className='quotation p-5 lead text-gray-700 text-center mb-0'>
-                  Your subscription goes directly towards the development and
-                  maintenance of Mockoon and allows us to keep our tools
-                  independent and open-source.
-                </p>
-                <div className='d-flex align-items-center justify-content-center'>
-                  <div className='avatar avatar-xl'>
-                    <img
-                      className='avatar-img img-thumbnail rounded-circle mr-4'
-                      src='/images/about/guillaume.jpg'
-                      alt='Founder @ Mockoon'
-                      width={128}
-                      height={128}
-                    />
-                  </div>
-                  <div className='ps-5'>
-                    <p className='fs-sm fw-bold mb-0'>Guillaume</p>
-                    <p className='fs-sm text-gray-700 mb-0'>
-                      Founder @ Mockoon
-                    </p>
+              <>
+                <div className='text-center'>
+                  <Link href='/cloud/' className='btn btn-primary-subtle'>
+                    Discover Mockoon Cloud
+                  </Link>
+                </div>
+                <div className='py-8'>
+                  <p className='quotation p-5 lead text-gray-700 text-center mb-0'>
+                    Your subscription goes directly towards the development and
+                    maintenance of Mockoon and allows us to keep our tools
+                    independent and open-source.
+                  </p>
+                  <div className='d-flex align-items-center justify-content-center'>
+                    <div className='avatar avatar-xl'>
+                      <img
+                        className='avatar-img img-thumbnail rounded-circle mr-4'
+                        src='/images/about/guillaume.jpg'
+                        alt='Founder @ Mockoon'
+                        width={128}
+                        height={128}
+                      />
+                    </div>
+                    <div className='ps-5'>
+                      <p className='fs-sm fw-bold mb-0'>Guillaume</p>
+                      <p className='fs-sm text-gray-700 mb-0'>
+                        Founder @ Mockoon
+                      </p>
+                    </div>
                   </div>
                 </div>
-              </div>
+              </>
             )}
           </div>
         </section>

diff --git a/content/docs/latest/about.md b/content/docs/latest/about.md
@@ -11,14 +11,29 @@ order: 10
 ---
 
 This documentation covers Mockoon's most used features and options to help you create the best mock APIs. These topics apply to the [desktop application](/download/), [CLI](/cli/), and [serverless package](/serverless/) which supports the same features.
-We maintain a documentation for the five latest desktop versions. Head over to our [releases section](/releases/) for more details about the changes in each version.
+
+You will find a documentation for the most recent releases of Mockoon. Head over to our [releases section](/releases/) for more details about the changes in each version.
 
 If you find a mistake in the documentation, you can open an issue on the [website's repository](https://github.com/mockoon/mockoon.com).
 
-## CLI documentation
+## CLI-specific documentation (flags, etc.)
 
 You will find the [CLI documentation](https://github.com/mockoon/mockoon/blob/main/packages/cli/README.md) in its dedicated readme file on the repository. It covers the CLI's specific features, like the available flags or how to use the Docker file.
 
-## Serverless documentation
+## Serverless-specific documentation (options, etc.)
 
 You will find the [serverless package documentation](https://github.com/mockoon/mockoon/blob/main/packages/serverless/README.md) in its dedicated readme file on the repository. It covers the package usage instructions and specific features.
+
+## Versioning
+
+Even if Mockoon is primarily a desktop application, we are following [semantic versioning](https://semver.org/). All the applications and packages **share the same version number** for each release.
+
+This allows you to migrate from one version to another without worrying about compatibility issues between the desktop application and the CLI or serverless package.
+
+### Major versions
+
+While the desktop application can easily **migrate from one version to another** (including major versions), this is not the case for the CLI or serverless package. When you are using one of your [data files](docs:mockoon-data-files/data-storage-location) with the CLI or serverless package, or sharing it with your team, you need to make sure that the data file schema is compatible with the version you or your team is using.
+
+Every time we introduce a **breaking change** in the data file schema (e.g. new feature) we release a **new major version**. We recommend that you always migrate simultaneously to the same major version for all the desktop applications and packages you are using.
+
+> 📝 Note to our Cloud users: the same recommendation applies when you are using our **Cloud features**. Please have a look at the [team collaboration](docs:mockoon-cloud/data-synchronization-team-collaboration#major-versions-migrations) and [cloud deployments](docs:mockoon-cloud/api-mock-cloud-deployments#major-versions-migrations) documentations for more information.
diff --git a/content/docs/latest/admin-api/data-buckets.md b/content/docs/latest/admin-api/data-buckets.md
@@ -1,8 +1,8 @@
 ---
 title: Data Buckets
 meta:
-  title: 'Admin API: Reset the data buckets'
-  description: 'Learn how to reset the data buckets of a running environment to their initial state using the admin API'
+  title: 'Admin API: Data buckets management'
+  description: 'Learn how to manage the data buckets of a running environment using the admin API: retrieve their values and reset them to their initial state'
 order: 801
 ---
 
@@ -12,7 +12,32 @@ order: 801
 
 ---
 
-This endpoint allows you to reset the [data buckets](docs:data-buckets/overview) to their initial state without restarting the server.
+This endpoint allows you to manage the [data buckets](docs:data-buckets/overview) without restarting the server.
+
+## Get a data bucket value
+
+To get the value of a data bucket, call the `/mockoon-admin/data-buckets` endpoint with the following parameters:
+
+- **Method:** `GET`
+- **URL:** `/mockoon-admin/data-buckets/:nameOrId`, where `:nameOrId` is the name or unique id of the data bucket.
+
+**Example request:**
+
+```http
+GET /mockoon-admin/data-buckets/myData
+```
+
+**Example response:**
+
+```json
+{
+  "name": "myData",
+  "id": "abcd",
+  "value": { "property": "value" }
+}
+```
+
+The value of the data bucket is returned as a JSON object in the `value` property. This allows you to check if the data bucket was correctly parsed from the JSON string content initially provided.
 
 ## Reset the data buckets
 

diff --git a/content/docs/latest/admin-api/environment-variables.md b/content/docs/latest/admin-api/environment-variables.md
@@ -14,6 +14,28 @@ order: 802
 
 This endpoint allows you to manage the [environment variables](docs:variables/environment-variables), without restarting the mock server or the application.
 
+## Get an environment variable value
+
+To get the value of an environment variable, call the `/mockoon-admin/env-vars` endpoint with the following parameters:
+
+- **Method:** `GET`
+- **URL:** `/mockoon-admin/env-vars/:key`, where `:key` is the name of the variable, including or not the `MOCKOON_` prefix, or the [custom prefix](docs:variables/environment-variables#changing-or-removing-the-prefix) defined in the application settings.
+
+**Example request:**
+
+```http
+GET /mockoon-admin/env-vars/MOCKOON_ENV_VAR
+```
+
+**Example response:**
+
+```json
+{
+  "key": "MOCKOON_ENV_VAR",
+  "value": "variableValue"
+}
+```
+
 ## Set or update an environment variable
 
 To set or update an environment variable, call the `/mockoon-admin/env-vars` endpoint with the following parameters:
@@ -24,7 +46,7 @@ To set or update an environment variable, call the `/mockoon-admin/env-vars` end
   - `key`: the name of the variable, including the `MOCKOON_` prefix, or the [custom prefix](docs:variables/environment-variables#changing-or-removing-the-prefix) defined in the application settings.
   - `value`: the value of the variable.
 
-**Example:**
+**Example request:**
 
 ```http
 POST /mockoon-admin/env-vars

diff --git a/content/docs/latest/admin-api/global-variables.md b/content/docs/latest/admin-api/global-variables.md
@@ -14,6 +14,28 @@ order: 802
 
 This endpoint allows you to manage and purge [global variables](docs:variables/global-variables), without restarting the server.
 
+## Get a global variable value
+
+To get the value of a global variable, call the `/mockoon-admin/global-vars` endpoint with the following parameters:
+
+- **Method:** `GET`
+- **URL:** `/mockoon-admin/global-vars/:key`, where `:key` is the name of the variable.
+
+**Example request:**
+
+```http
+GET /mockoon-admin/global-vars/my_var
+```
+
+**Example response:**
+
+```json
+{
+  "key": "my_var",
+  "value": "variableValue"
+}
+```
+
 ## Set or update a global variable
 
 To set or update a global variable, call the `/mockoon-admin/global-vars` endpoint with the following parameters:
@@ -24,7 +46,7 @@ To set or update a global variable, call the `/mockoon-admin/global-vars` endpoi
   - `key`: the name of the variable.
   - `value`: the value of the variable.
 
-**Example:**
+**Example request:**
 
 ```http
 POST /mockoon-admin/global-vars

diff --git a/content/docs/latest/admin-api/overview.md b/content/docs/latest/admin-api/overview.md
@@ -52,8 +52,8 @@ const mockoonServerless = new mockoon.MockoonServerless(mockEnv, {
 
 Currently, the admin API allows you to:
 
-- [Purge the state of a running environment](docs:admin-api/server-state)
-- [Manage and purge the global variables](docs:admin-api/global-variables)
+- [Reset the state of a running environment](docs:admin-api/server-state)
+- [Manage the global variables](docs:admin-api/global-variables)
 - [Manage the environment variables](docs:admin-api/environment-variables)
-- [Fetch and purge the transaction logs](docs:admin-api/transaction-logs)
-- [Reset the data buckets](docs:admin-api/data-buckets)
+- [Manage the transaction logs](docs:admin-api/transaction-logs)
+- [Manage the data buckets](docs:admin-api/data-buckets)
diff --git a/content/docs/latest/admin-api/transaction-logs.md b/content/docs/latest/admin-api/transaction-logs.md
@@ -24,15 +24,15 @@ To retrieve the transaction logs, call the following endpoint:
   - `page` (optional): the page number to retrieve. Default is 1.
   - `limit` (optional): the number of logs to retrieve per page. Default is 10.
 
-**Examples:**
+**Example request:**
 
 ```http
 GET /mockoon-admin/logs
 GET /mockoon-admin/logs?page=2
 GET /mockoon-admin/logs?page=2&limit=20
 ```
 
-**Example of response ([data model](https://github.com/mockoon/mockoon/blob/main/packages/commons/src/models/server.model.ts#L27-L47)):**
+**Example response ([data model](https://github.com/mockoon/mockoon/blob/main/packages/commons/src/models/server.model.ts#L27-L47)):**
 
 ```json
 [