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
@meshcloud-gh-actions
meshcloud-gh-actions[bot] authored and GitHub Actions committed Feb 12, 2025
1 parent c41027f commit 3c7e671
Show file tree
Hide file tree
Showing 26 changed files with 1,480 additions and 1,493 deletions.
2 changes: 1 addition & 1 deletion website/static/api/api_index.html
View file
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 2025-02-12 13:26:37 UTC
Last updated 2025-02-12 14:25:27 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 2025-02-12 13:26:37 UTC
Last updated 2025-02-12 14:25:27 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 2025-02-12 13:26:37 UTC
Last updated 2025-02-12 14:25: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 2025-02-12 13:26:37 UTC
Last updated 2025-02-12 14:25:27 UTC
</div>
</div>
</body>
Expand Down
290 changes: 145 additions & 145 deletions website/static/api/index.html
View file

Large diffs are not rendered by default.

32 changes: 16 additions & 16 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" : "2025-02-12T13:28:40.999379027Z"
"createdOn" : "2025-02-12T14:27:03.473989523Z"
},
"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" : "2025-02-12T13:28:41.050227123Z"
"createdOn" : "2025-02-12T14:27:03.517459322Z"
},
"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" : "2025-02-12T13:28:41.050227123Z"
"createdOn" : "2025-02-12T14:27:03.517459322Z"
},
"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": "d291b758-a83c-420f-832b-0b0e81ec08bc"
"buildingBlockUuid": "b6e0ed91-d8b0-4a97-9fb2-5ebdebfea295"
}]
}
}</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": "d291b758-a83c-420f-832b-0b0e81ec08bc"
"buildingBlockUuid": "b6e0ed91-d8b0-4a97-9fb2-5ebdebfea295"
}]
}
} '</code></pre>
Expand Down Expand Up @@ -1172,7 +1172,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: https://mesh-backend-url/api/meshobjects/meshbuildingblocks/faf32499-e759-40ad-8516-e912373b423c
Location: https://mesh-backend-url/api/meshobjects/meshbuildingblocks/988eff54-af17-4f9f-a0f0-af9300204acb
Content-Type: application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Expand All @@ -1187,12 +1187,12 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
"kind" : "meshBuildingBlock",
"apiVersion" : "v1",
"metadata" : {
"uuid" : "faf32499-e759-40ad-8516-e912373b423c",
"uuid" : "988eff54-af17-4f9f-a0f0-af9300204acb",
"definitionUuid" : "ef6aaf87-3f8c-477c-94f4-f3cf509728ca",
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2025-02-12T13:28:42.128315334Z"
"createdOn" : "2025-02-12T14:27:04.556913342Z"
},
"spec" : {
"displayName" : "New BuildingBlock",
Expand All @@ -1202,7 +1202,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
"valueType" : "STRING"
} ],
"parentBuildingBlocks" : [ {
"buildingBlockUuid" : "d291b758-a83c-420f-832b-0b0e81ec08bc",
"buildingBlockUuid" : "b6e0ed91-d8b0-4a97-9fb2-5ebdebfea295",
"definitionUuid" : "b23cfb9a-6974-444f-9d33-62134a632373"
} ]
},
Expand All @@ -1212,13 +1212,13 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
},
"_links" : {
"self" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/faf32499-e759-40ad-8516-e912373b423c"
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/988eff54-af17-4f9f-a0f0-af9300204acb"
},
"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/faf32499-e759-40ad-8516-e912373b423c/purge"
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/988eff54-af17-4f9f-a0f0-af9300204acb/purge"
}
}
}</code></pre>
Expand All @@ -1235,15 +1235,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/faf32499-e759-40ad-8516-e912373b423c HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/988eff54-af17-4f9f-a0f0-af9300204acb 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/faf32499-e759-40ad-8516-e912373b423c' -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/988eff54-af17-4f9f-a0f0-af9300204acb' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
</div>
</div>
<div class="listingblock">
Expand Down Expand Up @@ -1273,15 +1273,15 @@ <h5 id="_purge_meshbuildingblock">Purge 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/faf32499-e759-40ad-8516-e912373b423c/purge HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/988eff54-af17-4f9f-a0f0-af9300204acb/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/faf32499-e759-40ad-8516-e912373b423c/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/988eff54-af17-4f9f-a0f0-af9300204acb/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
</div>
</div>
<div class="listingblock">
Expand Down Expand Up @@ -1712,7 +1712,7 @@ <h5 id="_update_sources_and_steps">Update Sources and Steps</h5>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-02-12 13:26:37 UTC
Last updated 2025-02-12 14:25:27 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/mesh_buildingblockrunner.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ <h3 id="mesh_buildingblockrunner">Building Block Runner API</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-02-12 13:26:37 UTC
Last updated 2025-02-12 14:25: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 @@ -677,7 +677,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
{
"message" : "MeshObjectCollection not-empty-collection cannot be deleted, because it is not empty",
"errorCode" : "BadRequest",
"errorId" : "pOU3cqrAPb"
"errorId" : "B5UvcGAyxG"
}</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 2025-02-12 13:26:37 UTC
Last updated 2025-02-12 14:25: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 @@ -1538,7 +1538,7 @@ <h5 id="_meshexchangerate">meshExchangeRate</h5>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-02-12 13:26:37 UTC
Last updated 2025-02-12 14:25:27 UTC
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit 3c7e671

Please sign in to comment.