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
github-merge-queue[bot] authored and GitHub Actions committed Jul 12, 2024
1 parent 2ab0e3a commit 2de33d2
Show file tree
Hide file tree
Showing 20 changed files with 1,211 additions and 1,211 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-07-10 13:07:14 UTC
Last updated 2024-07-12 09:16:27 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-07-10 13:07:14 UTC
Last updated 2024-07-12 09:16:27 UTC
</div>
</div>
</body>
Expand Down
228 changes: 114 additions & 114 deletions website/static/api/index.html
View file

Large diffs are not rendered by default.

24 changes: 12 additions & 12 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-07-10T13:12:12.610285397Z"
"createdOn" : "2024-07-12T09:20:20.010369799Z"
},
"spec" : {
"displayName" : "parent block",
Expand Down Expand Up @@ -629,7 +629,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-07-10T13:12:12.625025026Z"
"createdOn" : "2024-07-12T09:20:20.022632428Z"
},
"spec" : {
"displayName" : "child block",
Expand Down Expand Up @@ -913,7 +913,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-07-10T13:12:12.625025026Z"
"createdOn" : "2024-07-12T09:20:20.022632428Z"
},
"spec" : {
"displayName" : "child block",
Expand Down Expand Up @@ -997,7 +997,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
}],
"parentBuildingBlocks" : [{
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
"buildingBlockUuid": "0a2d06d1-a97e-411a-8c6d-06e3ab032da4"
"buildingBlockUuid": "313f1cd1-e99f-41a9-821b-1c287cd4f01a"
}]
}
}</code></pre>
Expand Down Expand Up @@ -1025,7 +1025,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
}],
"parentBuildingBlocks" : [{
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
"buildingBlockUuid": "0a2d06d1-a97e-411a-8c6d-06e3ab032da4"
"buildingBlockUuid": "313f1cd1-e99f-41a9-821b-1c287cd4f01a"
}]
}
} '</code></pre>
Expand Down Expand Up @@ -1163,12 +1163,12 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
"apiVersion" : "v1",
"kind" : "meshBuildingBlock",
"metadata" : {
"uuid" : "72fcc7f8-430f-4eed-a28f-7d28a5a2df28",
"uuid" : "1f5e5f6c-4d42-4482-abd5-ac6fdd5c89d8",
"definitionUuid" : "ef6aaf87-3f8c-477c-94f4-f3cf509728ca",
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-07-10T13:12:13.978150469Z",
"createdOn" : "2024-07-12T09:20:21.336718412Z",
"markedForDeletionOn" : null,
"markedForDeletionBy" : null
},
Expand All @@ -1180,7 +1180,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
"valueType" : "STRING"
} ],
"parentBuildingBlocks" : [ {
"buildingBlockUuid" : "0a2d06d1-a97e-411a-8c6d-06e3ab032da4",
"buildingBlockUuid" : "313f1cd1-e99f-41a9-821b-1c287cd4f01a",
"definitionUuid" : "b23cfb9a-6974-444f-9d33-62134a632373"
} ]
},
Expand All @@ -1190,7 +1190,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
},
"_links" : {
"self" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/72fcc7f8-430f-4eed-a28f-7d28a5a2df28"
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/1f5e5f6c-4d42-4482-abd5-ac6fdd5c89d8"
},
"meshtenant" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location"
Expand All @@ -1208,15 +1208,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/72fcc7f8-430f-4eed-a28f-7d28a5a2df28 HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/1f5e5f6c-4d42-4482-abd5-ac6fdd5c89d8 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/72fcc7f8-430f-4eed-a28f-7d28a5a2df28' -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/1f5e5f6c-4d42-4482-abd5-ac6fdd5c89d8' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
</div>
</div>
<div class="listingblock">
Expand All @@ -1240,7 +1240,7 @@ <h5 id="_delete_meshbuildingblock">Delete meshBuildingBlock</h5>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-10 13:07:14 UTC
Last updated 2024-07-12 09:16:27 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 @@ -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" : "RxiBuYZeJw"
"errorId" : "OZiQc36XMW"
}</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-07-10 13:07:14 UTC
Last updated 2024-07-12 09:16:27 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-07-10 13:07:14 UTC
Last updated 2024-07-12 09:16:27 UTC
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit 2de33d2

Please sign in to comment.