Skip to content

Commit

Permalink
docs: update meshStack API docs from latest develop build
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-merge-queue @Jelledb
github-merge-queue[bot] authored and Jelledb committed Aug 28, 2024
1 parent 20d191f commit bc8ca89
Show file tree
Hide file tree
Showing 22 changed files with 1,542 additions and 1,542 deletions.
8 changes: 4 additions & 4 deletions website/static/api/api_index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -549,12 +549,12 @@ <h3 id="_index">Index</h3>

{
"_links" : {
"metadata" : {
"href" : "https://mesh-backend-url/api/metadata"
},
"meshobjects" : {
"href" : "https://mesh-backend-url/api/meshobjects"
},
"metadata" : {
"href" : "https://mesh-backend-url/api/metadata"
},
"self" : {
"href" : "https://mesh-backend-url/api"
}
Expand All @@ -566,7 +566,7 @@ <h3 id="_index">Index</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-08-07 11:55:40 UTC
Last updated 2024-08-28 09:49:21 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/api_key_login.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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-07 11:55:40 UTC
Last updated 2024-08-28 09:49:21 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/api_keys.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ <h3 id="api_keys">API Keys</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-08-07 11:55:40 UTC
Last updated 2024-08-28 09:49:21 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/common_data_formats.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ <h3 id="tags">Tags</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-08-07 11:55:40 UTC
Last updated 2024-08-28 09:49:21 UTC
</div>
</div>
</body>
Expand Down
244 changes: 122 additions & 122 deletions website/static/api/index.html
View file

Large diffs are not rendered by default.

30 changes: 15 additions & 15 deletions website/static/api/mesh_buildingblock.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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-07T11:57:47.328682315Z"
"createdOn" : "2024-08-28T09:52:04.958424106Z"
},
"spec" : {
"displayName" : "parent block",
Expand Down Expand Up @@ -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-07T11:57:47.341037385Z"
"createdOn" : "2024-08-28T09:52:04.971365216Z"
},
"spec" : {
"displayName" : "child block",
Expand Down Expand Up @@ -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-07T11:57:47.341037385Z"
"createdOn" : "2024-08-28T09:52:04.971365216Z"
},
"spec" : {
"displayName" : "child block",
Expand Down Expand Up @@ -1015,7 +1015,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
}],
"parentBuildingBlocks" : [{
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
"buildingBlockUuid": "3bdfadfd-4953-4dea-8f42-492aacb59718"
"buildingBlockUuid": "796c4201-9c8c-4986-bf91-7e4ea6cd4c9d"
}]
}
}</code></pre>
Expand Down Expand Up @@ -1044,7 +1044,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
}],
"parentBuildingBlocks" : [{
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
"buildingBlockUuid": "3bdfadfd-4953-4dea-8f42-492aacb59718"
"buildingBlockUuid": "796c4201-9c8c-4986-bf91-7e4ea6cd4c9d"
}]
}
} '</code></pre>
Expand Down Expand Up @@ -1186,12 +1186,12 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
"apiVersion" : "v1",
"kind" : "meshBuildingBlock",
"metadata" : {
"uuid" : "9765d8ae-3c18-40f5-b597-8a426f8ca499",
"uuid" : "0b5934df-dcc8-4f73-81af-31e35fb8f93a",
"definitionUuid" : "ef6aaf87-3f8c-477c-94f4-f3cf509728ca",
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-08-07T11:57:48.657677341Z"
"createdOn" : "2024-08-28T09:52:06.296038842Z"
},
"spec" : {
"displayName" : "New BuildingBlock",
Expand All @@ -1201,7 +1201,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
"valueType" : "STRING"
} ],
"parentBuildingBlocks" : [ {
"buildingBlockUuid" : "3bdfadfd-4953-4dea-8f42-492aacb59718",
"buildingBlockUuid" : "796c4201-9c8c-4986-bf91-7e4ea6cd4c9d",
"definitionUuid" : "b23cfb9a-6974-444f-9d33-62134a632373"
} ]
},
Expand All @@ -1211,13 +1211,13 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
},
"_links" : {
"self" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/9765d8ae-3c18-40f5-b597-8a426f8ca499"
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/0b5934df-dcc8-4f73-81af-31e35fb8f93a"
},
"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/9765d8ae-3c18-40f5-b597-8a426f8ca499/purge"
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/0b5934df-dcc8-4f73-81af-31e35fb8f93a/purge"
}
}
}</code></pre>
Expand All @@ -1234,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/9765d8ae-3c18-40f5-b597-8a426f8ca499 HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/0b5934df-dcc8-4f73-81af-31e35fb8f93a 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/9765d8ae-3c18-40f5-b597-8a426f8ca499' -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/0b5934df-dcc8-4f73-81af-31e35fb8f93a' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
</div>
</div>
<div class="listingblock">
Expand Down Expand Up @@ -1272,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/9765d8ae-3c18-40f5-b597-8a426f8ca499/purge HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/0b5934df-dcc8-4f73-81af-31e35fb8f93a/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/9765d8ae-3c18-40f5-b597-8a426f8ca499/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/0b5934df-dcc8-4f73-81af-31e35fb8f93a/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
</div>
</div>
<div class="listingblock">
Expand All @@ -1304,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-07 11:55:40 UTC
Last updated 2024-08-28 09:49:21 UTC
</div>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions website/static/api/mesh_object_collection.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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" : "GOt1iXm2r3"
"errorId" : "N5tYFxZm63"
}</code></pre>
</div>
</div>
Expand All @@ -686,7 +686,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-08-07 11:55:40 UTC
Last updated 2024-08-28 09:49:21 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/mesh_object_declarative_import.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1523,7 +1523,7 @@ <h5 id="_meshexchangerate">meshExchangeRate</h5>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-08-07 11:55:40 UTC
Last updated 2024-08-28 09:49:21 UTC
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit bc8ca89

Please sign in to comment.