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[bot] authored and tfelix committed May 2, 2024
1 parent ecd6f68 commit d143173
Show file tree
Hide file tree
Showing 19 changed files with 523 additions and 523 deletions.
2 changes: 1 addition & 1 deletion website/static/api/api_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ <h3 id="_index">Index</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-24 14:55:23 UTC
Last updated 2024-05-02 12:13:35 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/common_data_formats.html
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-04-24 14:55:23 UTC
Last updated 2024-05-02 12:13:35 UTC
</div>
</div>
</body>
Expand Down
156 changes: 78 additions & 78 deletions website/static/api/index.html

Large diffs are not rendered by default.

38 changes: 19 additions & 19 deletions website/static/api/mesh_buildingblock.html
Original file line number Diff line number Diff line change
Expand Up @@ -596,12 +596,12 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
"apiVersion" : "v1",
"kind" : "meshBuildingBlock",
"metadata" : {
"uuid" : "c17073bc-6804-4da5-a57f-056da364f931",
"definitionUuid" : "9e03ed7c-b5ca-4b43-903b-bacf8ff1d9da",
"uuid" : "6ac805f5-1135-46a6-9fe6-3ce1efb8f97b",
"definitionUuid" : "e6675227-060c-4a25-b43e-86269b656f6e",
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-04-24T14:57:54.339054Z"
"createdOn" : "2024-05-02T12:18:41.545920Z"
},
"spec" : {
"displayName" : "parent block",
Expand All @@ -614,7 +614,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
},
"_links" : {
"self" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/c17073bc-6804-4da5-a57f-056da364f931"
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/6ac805f5-1135-46a6-9fe6-3ce1efb8f97b"
},
"meshtenant" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location"
Expand All @@ -624,12 +624,12 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
"apiVersion" : "v1",
"kind" : "meshBuildingBlock",
"metadata" : {
"uuid" : "5c6a9801-66d9-4fe5-89e4-1bde32ed7217",
"definitionUuid" : "cee80f61-f5d3-4a23-81f6-d4bd9ea80595",
"uuid" : "4b139590-608f-48d6-b79b-2faf1d17244f",
"definitionUuid" : "ea148b4f-33c9-4abf-af64-3ac2da26a4cd",
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-04-24T14:57:54.351220Z"
"createdOn" : "2024-05-02T12:18:41.587446Z"
},
"spec" : {
"displayName" : "child block",
Expand All @@ -639,8 +639,8 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
"valueType" : "STRING"
} ],
"parentBuildingBlocks" : [ {
"buildingBlockUuid" : "c17073bc-6804-4da5-a57f-056da364f931",
"definitionUuid" : "9e03ed7c-b5ca-4b43-903b-bacf8ff1d9da"
"buildingBlockUuid" : "6ac805f5-1135-46a6-9fe6-3ce1efb8f97b",
"definitionUuid" : "e6675227-060c-4a25-b43e-86269b656f6e"
} ]
},
"status" : {
Expand All @@ -653,7 +653,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
},
"_links" : {
"self" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5c6a9801-66d9-4fe5-89e4-1bde32ed7217"
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/4b139590-608f-48d6-b79b-2faf1d17244f"
},
"meshtenant" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location"
Expand Down Expand Up @@ -703,7 +703,7 @@ <h5 id="_get_meshbuildingblock">Get 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">GET /api/meshobjects/meshbuildingblocks/5c6a9801-66d9-4fe5-89e4-1bde32ed7217 HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/meshobjects/meshbuildingblocks/4b139590-608f-48d6-b79b-2faf1d17244f HTTP/1.1
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
Accept: application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json
Host: mesh-backend-url</code></pre>
Expand All @@ -712,7 +712,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
<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/5c6a9801-66d9-4fe5-89e4-1bde32ed7217' -i -u 'valid_username:valid_password' -X GET \
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/4b139590-608f-48d6-b79b-2faf1d17244f' -i -u 'valid_username:valid_password' -X GET \
-H 'Accept: application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json'</code></pre>
</div>
</div>
Expand Down Expand Up @@ -908,12 +908,12 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
"apiVersion" : "v1",
"kind" : "meshBuildingBlock",
"metadata" : {
"uuid" : "5c6a9801-66d9-4fe5-89e4-1bde32ed7217",
"definitionUuid" : "cee80f61-f5d3-4a23-81f6-d4bd9ea80595",
"uuid" : "4b139590-608f-48d6-b79b-2faf1d17244f",
"definitionUuid" : "ea148b4f-33c9-4abf-af64-3ac2da26a4cd",
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-04-24T14:57:54.351220Z"
"createdOn" : "2024-05-02T12:18:41.587446Z"
},
"spec" : {
"displayName" : "child block",
Expand All @@ -923,8 +923,8 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
"valueType" : "STRING"
} ],
"parentBuildingBlocks" : [ {
"buildingBlockUuid" : "c17073bc-6804-4da5-a57f-056da364f931",
"definitionUuid" : "9e03ed7c-b5ca-4b43-903b-bacf8ff1d9da"
"buildingBlockUuid" : "6ac805f5-1135-46a6-9fe6-3ce1efb8f97b",
"definitionUuid" : "e6675227-060c-4a25-b43e-86269b656f6e"
} ]
},
"status" : {
Expand All @@ -937,7 +937,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
},
"_links" : {
"self" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5c6a9801-66d9-4fe5-89e4-1bde32ed7217"
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/4b139590-608f-48d6-b79b-2faf1d17244f"
},
"meshtenant" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location"
Expand All @@ -951,7 +951,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-24 14:55:23 UTC
Last updated 2024-05-02 12:13:35 UTC
</div>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 deletions website/static/api/mesh_object_collection.html
Original file line number Diff line number Diff line change
Expand Up @@ -678,7 +678,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
{
"error" : "MeshBadRequestException",
"message" : "MeshObjectCollection not-empty-collection cannot be deleted, because it is not empty",
"errorId" : "45CwuQX6Eq"
"errorId" : "NXSmU8r8eN"
}</code></pre>
</div>
</div>
Expand All @@ -687,7 +687,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-04-24 14:55:23 UTC
Last updated 2024-05-02 12:13:35 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/mesh_object_declarative_import.html
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-04-24 14:55:23 UTC
Last updated 2024-05-02 12:13:35 UTC
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit d143173

Please sign in to comment.