docs: update meshStack API docs from latest develop build

website/static/api/api_index.html

@@ -549,12 +549,12 @@ <h3 id="_index">Index</h3>
 
 {
   "_links" : {
-    "meshobjects" : {
-      "href" : "https://mesh-backend-url/api/meshobjects"
-    },
     "metadata" : {
       "href" : "https://mesh-backend-url/api/metadata"
     },
+    "meshobjects" : {
+      "href" : "https://mesh-backend-url/api/meshobjects"
+    },
     "self" : {
       "href" : "https://mesh-backend-url/api"
     }
@@ -566,7 +566,7 @@ <h3 id="_index">Index</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:50 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>

website/static/api/api_key_login.html

@@ -591,7 +591,7 @@ <h3 id="api_key_login">API Key Login</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:50 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>

website/static/api/api_keys.html

@@ -477,7 +477,7 @@ <h3 id="api_keys">API Keys</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:50 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>

website/static/api/common_data_formats.html

@@ -542,7 +542,7 @@ <h3 id="tags">Tags</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:50 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>

website/static/api/mesh_buildingblock.html

@@ -601,7 +601,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
         "definitionVersion" : 1,
         "tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
         "forcePurge" : false,
-        "createdOn" : "2024-08-01T11:25:27.254595144Z"
+        "createdOn" : "2024-08-07T11:57:47.328682315Z"
       },
       "spec" : {
         "displayName" : "parent block",
@@ -632,7 +632,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
         "definitionVersion" : 1,
         "tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
         "forcePurge" : false,
-        "createdOn" : "2024-08-01T11:25:27.278257164Z"
+        "createdOn" : "2024-08-07T11:57:47.341037385Z"
       },
       "spec" : {
         "displayName" : "child block",
@@ -923,7 +923,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
     "definitionVersion" : 1,
     "tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
     "forcePurge" : false,
-    "createdOn" : "2024-08-01T11:25:27.278257164Z"
+    "createdOn" : "2024-08-07T11:57:47.341037385Z"
   },
   "spec" : {
     "displayName" : "child block",
@@ -980,16 +980,21 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
 <tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Content-Type</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">meshApi is <a href="#versioning">versioned</a> and you should use  <code>application/vnd.meshcloud.api.meshobjects.v1+json</code> as an <code>Content-Type</code> header.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">meshApi is <a href="#versioning">versioned</a> and you should use  <code>application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json</code> as a <code>Content-Type</code> header.</p></td>
+</tr>
+<tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Accept</code></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">meshApi is <a href="#versioning">versioned</a> and you should use  <code>application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json</code> as an <code>Accept</code> header to be guaranteed the V1 response format of this endpoint. New versions will be added in future.</p></td>
 </tr>
 </tbody>
 </table>
 <div class="listingblock">
 <div class="title">Example Request</div>
 <div class="content">
 <pre class="highlight nowrap"><code class="language-http" data-lang="http">POST /api/meshobjects/meshbuildingblocks HTTP/1.1
-Content-Type: application/vnd.meshcloud.api.meshobjects.v1+json;charset=UTF-8
+Content-Type: application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json;charset=UTF-8
 Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
+Accept: application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json
 Content-Length: 599
 Host: mesh-backend-url
 
@@ -1010,7 +1015,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
     }],
     "parentBuildingBlocks" : [{
       "definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
-      "buildingBlockUuid": "fde91819-1f15-43f7-b39c-b710c304fec0"
+      "buildingBlockUuid": "3bdfadfd-4953-4dea-8f42-492aacb59718"
     }]
   }
 }</code></pre>
@@ -1020,7 +1025,8 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
 <div class="title">Example Curl Request</div>
 <div class="content">
 <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks' -i -u 'valid_username:valid_password' -X POST \
-    -H 'Content-Type: application/vnd.meshcloud.api.meshobjects.v1+json;charset=UTF-8' \
+    -H 'Content-Type: application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json;charset=UTF-8' \
+    -H 'Accept: application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json' \
     -d '{
   "apiVersion" : "v1",
   "kind" : "meshBuildingBlock",
@@ -1038,7 +1044,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
     }],
     "parentBuildingBlocks" : [{
       "definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
-      "buildingBlockUuid": "fde91819-1f15-43f7-b39c-b710c304fec0"
+      "buildingBlockUuid": "3bdfadfd-4953-4dea-8f42-492aacb59718"
     }]
   }
 } '</code></pre>
@@ -1166,28 +1172,26 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
 Vary: Origin
 Vary: Access-Control-Request-Method
 Vary: Access-Control-Request-Headers
-Content-Type: application/hal+json
+Content-Type: application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json
 X-Content-Type-Options: nosniff
 X-XSS-Protection: 0
 Cache-Control: no-cache, no-store, max-age=0, must-revalidate
 Pragma: no-cache
 Expires: 0
 Strict-Transport-Security: max-age=31536000 ; includeSubDomains
 X-Frame-Options: DENY
-Content-Length: 1321
+Content-Length: 1253
 
 {
   "apiVersion" : "v1",
   "kind" : "meshBuildingBlock",
   "metadata" : {
-    "uuid" : "cedd5681-2582-40a7-bb83-28f41e39be9e",
+    "uuid" : "9765d8ae-3c18-40f5-b597-8a426f8ca499",
     "definitionUuid" : "ef6aaf87-3f8c-477c-94f4-f3cf509728ca",
     "definitionVersion" : 1,
     "tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
     "forcePurge" : false,
-    "createdOn" : "2024-08-01T11:25:29.206893378Z",
-    "markedForDeletionOn" : null,
-    "markedForDeletionBy" : null
+    "createdOn" : "2024-08-07T11:57:48.657677341Z"
   },
   "spec" : {
     "displayName" : "New BuildingBlock",
@@ -1197,7 +1201,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
       "valueType" : "STRING"
     } ],
     "parentBuildingBlocks" : [ {
-      "buildingBlockUuid" : "fde91819-1f15-43f7-b39c-b710c304fec0",
+      "buildingBlockUuid" : "3bdfadfd-4953-4dea-8f42-492aacb59718",
       "definitionUuid" : "b23cfb9a-6974-444f-9d33-62134a632373"
     } ]
   },
@@ -1207,13 +1211,13 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
   },
   "_links" : {
     "self" : {
-      "href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/cedd5681-2582-40a7-bb83-28f41e39be9e"
+      "href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/9765d8ae-3c18-40f5-b597-8a426f8ca499"
     },
     "meshtenant" : {
       "href" : "https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location"
     },
     "forcePurge" : {
-      "href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/cedd5681-2582-40a7-bb83-28f41e39be9e/purge"
+      "href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/9765d8ae-3c18-40f5-b597-8a426f8ca499/purge"
     }
   }
 }</code></pre>
@@ -1230,15 +1234,15 @@ <h5 id="_delete_meshbuildingblock">Delete meshBuildingBlock</h5>
 <div class="listingblock">
 <div class="title">Example Request</div>
 <div class="content">
-<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/cedd5681-2582-40a7-bb83-28f41e39be9e HTTP/1.1
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/9765d8ae-3c18-40f5-b597-8a426f8ca499 HTTP/1.1
 Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
 Host: mesh-backend-url</code></pre>
 </div>
 </div>
 <div class="listingblock">
 <div class="title">Example Curl Request</div>
 <div class="content">
-<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/cedd5681-2582-40a7-bb83-28f41e39be9e' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/9765d8ae-3c18-40f5-b597-8a426f8ca499' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
 </div>
 </div>
 <div class="listingblock">
@@ -1268,15 +1272,15 @@ <h5 id="_force_purging_of_a_meshbuildingblock">Force purging of a meshBuildingBl
 <div class="listingblock">
 <div class="title">Example Request</div>
 <div class="content">
-<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/cedd5681-2582-40a7-bb83-28f41e39be9e/purge HTTP/1.1
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/9765d8ae-3c18-40f5-b597-8a426f8ca499/purge HTTP/1.1
 Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
 Host: mesh-backend-url</code></pre>
 </div>
 </div>
 <div class="listingblock">
 <div class="title">Example Curl Request</div>
 <div class="content">
-<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/cedd5681-2582-40a7-bb83-28f41e39be9e/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
+<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/9765d8ae-3c18-40f5-b597-8a426f8ca499/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
 </div>
 </div>
 <div class="listingblock">
@@ -1300,7 +1304,7 @@ <h5 id="_force_purging_of_a_meshbuildingblock">Force purging of a meshBuildingBl
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:50 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>

website/static/api/mesh_object_collection.html

@@ -677,7 +677,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
 {
   "error" : "MeshBadRequestException",
   "message" : "MeshObjectCollection not-empty-collection cannot be deleted, because it is not empty",
-  "errorId" : "GOtZTNWM3k"
+  "errorId" : "GOt1iXm2r3"
 }</code></pre>
 </div>
 </div>
@@ -686,7 +686,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:50 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>

website/static/api/mesh_object_declarative_import.html

@@ -1523,7 +1523,7 @@ <h5 id="_meshexchangerate">meshExchangeRate</h5>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:50 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>