Skip to content
This repository was archived by the owner on Dec 29, 2025. It is now read-only.

Commit af5d2f5

Browse files
github-merge-queue[bot]tfelix
authored andcommitted
docs: update meshStack API docs from latest develop build
1 parent e2bf794 commit af5d2f5

29 files changed

+8816
-3350
lines changed

website/static/api/api_index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -461,7 +461,7 @@ <h3 id="_index">Index</h3>
461461
<tbody>
462462
<tr>
463463
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Accept</code></p></td>
464-
<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.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>
464+
<td class="tableblock halign-left valign-top"><p class="tableblock">This endpoint of meshObject API is individually <a href="#versioning">versioned</a>. Use <code>application/vnd.meshcloud.api.v1.hal+json</code> for this version of the endpoint.</p></td>
465465
</tr>
466466
</tbody>
467467
</table>
@@ -566,7 +566,7 @@ <h3 id="_index">Index</h3>
566566
</div>
567567
<div id="footer">
568568
<div id="footer-text">
569-
Last updated 2025-03-19 14:11:07 UTC
569+
Last updated 2025-03-26 14:51:43 UTC
570570
</div>
571571
</div>
572572
</body>

website/static/api/api_key_login.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -591,7 +591,7 @@ <h3 id="api_key_login">API Key Login</h3>
591591
</div>
592592
<div id="footer">
593593
<div id="footer-text">
594-
Last updated 2025-03-19 14:11:07 UTC
594+
Last updated 2025-03-26 14:51:43 UTC
595595
</div>
596596
</div>
597597
</body>

website/static/api/authentication.html

Lines changed: 531 additions & 0 deletions
Large diffs are not rendered by default.

website/static/api/common_data_formats.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -542,7 +542,7 @@ <h3 id="tags">Tags</h3>
542542
</div>
543543
<div id="footer">
544544
<div id="footer-text">
545-
Last updated 2025-03-19 14:11:07 UTC
545+
Last updated 2025-03-26 14:51:43 UTC
546546
</div>
547547
</div>
548548
</body>

website/static/api/deprecated_resources.html

Lines changed: 71 additions & 53 deletions
Large diffs are not rendered by default.

website/static/api/index.html

Lines changed: 1405 additions & 385 deletions
Large diffs are not rendered by default.

website/static/api/mesh_buildingblock.html

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -465,7 +465,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
465465
<tbody>
466466
<tr>
467467
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Accept</code></p></td>
468-
<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>
468+
<td class="tableblock halign-left valign-top"><p class="tableblock">This endpoint of meshObject API is individually <a href="#versioning">versioned</a>. Use <code>application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json</code> for this version of the endpoint.</p></td>
469469
</tr>
470470
</tbody>
471471
</table>
@@ -605,7 +605,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
605605
"definitionVersion" : 1,
606606
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
607607
"forcePurge" : false,
608-
"createdOn" : "2025-03-19T14:13:28.569557344Z"
608+
"createdOn" : "2025-03-26T14:53:49.239714668Z"
609609
},
610610
"spec" : {
611611
"displayName" : "parent block",
@@ -636,7 +636,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
636636
"definitionVersion" : 1,
637637
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
638638
"forcePurge" : false,
639-
"createdOn" : "2025-03-19T14:13:28.618582143Z"
639+
"createdOn" : "2025-03-26T14:53:49.316633927Z"
640640
},
641641
"spec" : {
642642
"displayName" : "child block",
@@ -706,7 +706,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
706706
<tbody>
707707
<tr>
708708
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Accept</code></p></td>
709-
<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>
709+
<td class="tableblock halign-left valign-top"><p class="tableblock">This endpoint of meshObject API is individually <a href="#versioning">versioned</a>. Use <code>application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json</code> for this version of the endpoint.</p></td>
710710
</tr>
711711
</tbody>
712712
</table>
@@ -927,7 +927,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
927927
"definitionVersion" : 1,
928928
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
929929
"forcePurge" : false,
930-
"createdOn" : "2025-03-19T14:13:28.618582143Z"
930+
"createdOn" : "2025-03-26T14:53:49.316633927Z"
931931
},
932932
"spec" : {
933933
"displayName" : "child block",
@@ -984,11 +984,11 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
984984
<tbody>
985985
<tr>
986986
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Content-Type</code></p></td>
987-
<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>
987+
<td class="tableblock halign-left valign-top"><p class="tableblock">This endpoint of meshObject API is individually <a href="#versioning">versioned</a>. Use <code>application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json</code> for this version of the endpoint.</p></td>
988988
</tr>
989989
<tr>
990990
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Accept</code></p></td>
991-
<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>
991+
<td class="tableblock halign-left valign-top"><p class="tableblock">This endpoint of meshObject API is individually <a href="#versioning">versioned</a>. Use <code>application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json</code> for this version of the endpoint.</p></td>
992992
</tr>
993993
</tbody>
994994
</table>
@@ -1019,7 +1019,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
10191019
}],
10201020
"parentBuildingBlocks" : [{
10211021
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
1022-
"buildingBlockUuid": "1b2b59a4-15d8-4f1b-8af1-29f270381c4c"
1022+
"buildingBlockUuid": "7cf1600a-4486-48c7-9b3c-236357aac5d9"
10231023
}]
10241024
}
10251025
}</code></pre>
@@ -1048,7 +1048,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
10481048
}],
10491049
"parentBuildingBlocks" : [{
10501050
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
1051-
"buildingBlockUuid": "1b2b59a4-15d8-4f1b-8af1-29f270381c4c"
1051+
"buildingBlockUuid": "7cf1600a-4486-48c7-9b3c-236357aac5d9"
10521052
}]
10531053
}
10541054
} '</code></pre>
@@ -1176,7 +1176,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
11761176
Vary: Origin
11771177
Vary: Access-Control-Request-Method
11781178
Vary: Access-Control-Request-Headers
1179-
Location: https://mesh-backend-url/api/meshobjects/meshbuildingblocks/10c3e102-bb48-48bd-a709-195f122933a8
1179+
Location: https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5d62043f-6ee2-4b3b-a415-7d41cf9d7f1d
11801180
Content-Type: application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json
11811181
X-Content-Type-Options: nosniff
11821182
X-XSS-Protection: 0
@@ -1191,12 +1191,12 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
11911191
"kind" : "meshBuildingBlock",
11921192
"apiVersion" : "v1",
11931193
"metadata" : {
1194-
"uuid" : "10c3e102-bb48-48bd-a709-195f122933a8",
1194+
"uuid" : "5d62043f-6ee2-4b3b-a415-7d41cf9d7f1d",
11951195
"definitionUuid" : "ef6aaf87-3f8c-477c-94f4-f3cf509728ca",
11961196
"definitionVersion" : 1,
11971197
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
11981198
"forcePurge" : false,
1199-
"createdOn" : "2025-03-19T14:13:29.680114825Z"
1199+
"createdOn" : "2025-03-26T14:53:50.425832315Z"
12001200
},
12011201
"spec" : {
12021202
"displayName" : "New BuildingBlock",
@@ -1206,7 +1206,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
12061206
"valueType" : "STRING"
12071207
} ],
12081208
"parentBuildingBlocks" : [ {
1209-
"buildingBlockUuid" : "1b2b59a4-15d8-4f1b-8af1-29f270381c4c",
1209+
"buildingBlockUuid" : "7cf1600a-4486-48c7-9b3c-236357aac5d9",
12101210
"definitionUuid" : "b23cfb9a-6974-444f-9d33-62134a632373"
12111211
} ]
12121212
},
@@ -1216,13 +1216,13 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
12161216
},
12171217
"_links" : {
12181218
"self" : {
1219-
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/10c3e102-bb48-48bd-a709-195f122933a8"
1219+
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5d62043f-6ee2-4b3b-a415-7d41cf9d7f1d"
12201220
},
12211221
"meshtenant" : {
12221222
"href" : "https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location"
12231223
},
12241224
"forcePurge" : {
1225-
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/10c3e102-bb48-48bd-a709-195f122933a8/purge"
1225+
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5d62043f-6ee2-4b3b-a415-7d41cf9d7f1d/purge"
12261226
}
12271227
}
12281228
}</code></pre>
@@ -1239,15 +1239,15 @@ <h5 id="_delete_meshbuildingblock">Delete meshBuildingBlock</h5>
12391239
<div class="listingblock">
12401240
<div class="title">Example Request</div>
12411241
<div class="content">
1242-
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/10c3e102-bb48-48bd-a709-195f122933a8 HTTP/1.1
1242+
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/5d62043f-6ee2-4b3b-a415-7d41cf9d7f1d HTTP/1.1
12431243
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
12441244
Host: mesh-backend-url</code></pre>
12451245
</div>
12461246
</div>
12471247
<div class="listingblock">
12481248
<div class="title">Example Curl Request</div>
12491249
<div class="content">
1250-
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/10c3e102-bb48-48bd-a709-195f122933a8' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
1250+
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5d62043f-6ee2-4b3b-a415-7d41cf9d7f1d' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
12511251
</div>
12521252
</div>
12531253
<div class="listingblock">
@@ -1277,15 +1277,15 @@ <h5 id="_purge_meshbuildingblock">Purge meshBuildingBlock</h5>
12771277
<div class="listingblock">
12781278
<div class="title">Example Request</div>
12791279
<div class="content">
1280-
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/10c3e102-bb48-48bd-a709-195f122933a8/purge HTTP/1.1
1280+
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/5d62043f-6ee2-4b3b-a415-7d41cf9d7f1d/purge HTTP/1.1
12811281
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
12821282
Host: mesh-backend-url</code></pre>
12831283
</div>
12841284
</div>
12851285
<div class="listingblock">
12861286
<div class="title">Example Curl Request</div>
12871287
<div class="content">
1288-
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/10c3e102-bb48-48bd-a709-195f122933a8/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
1288+
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/5d62043f-6ee2-4b3b-a415-7d41cf9d7f1d/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
12891289
</div>
12901290
</div>
12911291
<div class="listingblock">
@@ -1343,7 +1343,7 @@ <h5 id="_register_sources_and_steps">Register Sources and Steps</h5>
13431343
<tbody>
13441344
<tr>
13451345
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Accept</code></p></td>
1346-
<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.meshbuildingblockrun.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>
1346+
<td class="tableblock halign-left valign-top"><p class="tableblock">This endpoint of meshObject API is individually <a href="#versioning">versioned</a>. Use <code>application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json</code> for this version of the endpoint.</p></td>
13471347
</tr>
13481348
</tbody>
13491349
</table>
@@ -1494,7 +1494,7 @@ <h5 id="_update_sources_and_steps">Update Sources and Steps</h5>
14941494
<tbody>
14951495
<tr>
14961496
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Accept</code></p></td>
1497-
<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.meshbuildingblockrun.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>
1497+
<td class="tableblock halign-left valign-top"><p class="tableblock">This endpoint of meshObject API is individually <a href="#versioning">versioned</a>. Use <code>application/vnd.meshcloud.api.meshbuildingblockrun.v1.hal+json</code> for this version of the endpoint.</p></td>
14981498
</tr>
14991499
</tbody>
15001500
</table>
@@ -1716,7 +1716,7 @@ <h5 id="_update_sources_and_steps">Update Sources and Steps</h5>
17161716
</div>
17171717
<div id="footer">
17181718
<div id="footer-text">
1719-
Last updated 2025-03-19 14:11:07 UTC
1719+
Last updated 2025-03-26 14:51:43 UTC
17201720
</div>
17211721
</div>
17221722
</body>

0 commit comments

Comments
 (0)