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

Commit 298e6f0

Browse files
author
GitHub Actions
committed
Update meshStack API docs from latest develop build
1 parent b4c3bc2 commit 298e6f0

33 files changed

+3681
-3681
lines changed

static/api/api_index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -566,7 +566,7 @@ <h3 id="_index">Index</h3>
566566
</div>
567567
<div id="footer">
568568
<div id="footer-text">
569-
Last updated 2025-07-30 08:52:04 UTC
569+
Last updated 2025-07-30 10:37:08 UTC
570570
</div>
571571
</div>
572572
</body>

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-07-30 08:52:04 UTC
594+
Last updated 2025-07-30 10:37:08 UTC
595595
</div>
596596
</div>
597597
</body>

static/api/authentication.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,7 @@ <h3 id="_basic_authentication">Basic Authentication</h3>
524524
</div>
525525
<div id="footer">
526526
<div id="footer-text">
527-
Last updated 2025-07-30 08:52:04 UTC
527+
Last updated 2025-07-30 10:37:08 UTC
528528
</div>
529529
</div>
530530
</body>

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-07-30 08:52:04 UTC
545+
Last updated 2025-07-30 10:37:08 UTC
546546
</div>
547547
</div>
548548
</body>

static/api/deprecated_resources.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -604,31 +604,31 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
604604
</tr>
605605
<tr>
606606
<td class="tableblock halign-left valign-top"></td>
607-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
607+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshtenants</code><br>
608608
<code>meshTenant.v3</code></p></td>
609609
<td class="tableblock halign-left valign-top"><p class="tableblock">Please consider upgrading to <code>meshTenant.v4</code>, which uses a UUID to identify a meshTenant.</p></td>
610610
</tr>
611611
<tr>
612612
<td class="tableblock halign-left valign-top"></td>
613-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
613+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
614614
<code>meshTenant.v3</code></p></td>
615615
<td class="tableblock halign-left valign-top"><p class="tableblock">Please consider upgrading to <code>meshTenant.v4</code>, which uses a UUID to identify a meshTenant.</p></td>
616616
</tr>
617617
<tr>
618618
<td class="tableblock halign-left valign-top"></td>
619-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshtenants</code><br>
619+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
620620
<code>meshTenant.v3</code></p></td>
621621
<td class="tableblock halign-left valign-top"><p class="tableblock">Please consider upgrading to <code>meshTenant.v4</code>, which uses a UUID to identify a meshTenant.</p></td>
622622
</tr>
623623
<tr>
624624
<td class="tableblock halign-left valign-top"></td>
625-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshbuildingblocks</code><br>
625+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshbuildingblocks/{buildingBlockUuid}</code><br>
626626
<code>meshBuildingBlock.v1</code></p></td>
627627
<td class="tableblock halign-left valign-top"><p class="tableblock">Please consider adopting <code>meshBuildingBlock.v2</code>, which supports building blocks on workspace level as well.</p></td>
628628
</tr>
629629
<tr>
630630
<td class="tableblock halign-left valign-top"></td>
631-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshbuildingblocks/{buildingBlockUuid}</code><br>
631+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshbuildingblocks</code><br>
632632
<code>meshBuildingBlock.v1</code></p></td>
633633
<td class="tableblock halign-left valign-top"><p class="tableblock">Please consider adopting <code>meshBuildingBlock.v2</code>, which supports building blocks on workspace level as well.</p></td>
634634
</tr>
@@ -756,7 +756,7 @@ <h3 id="_deprecated_meshobjects_in_declarative_import">Deprecated meshObjects in
756756
</div>
757757
<div id="footer">
758758
<div id="footer-text">
759-
Last updated 2025-07-30 08:52:04 UTC
759+
Last updated 2025-07-30 10:37:08 UTC
760760
</div>
761761
</div>
762762
</body>

static/api/index.html

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

static/api/mesh_buildingblock.html

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -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-07-30T08:55:19.238950462Z"
608+
"createdOn" : "2025-07-30T10:39:10.298626852Z"
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-07-30T08:55:19.248372562Z"
639+
"createdOn" : "2025-07-30T10:39:10.312971313Z"
640640
},
641641
"spec" : {
642642
"displayName" : "child block",
@@ -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-07-30T08:55:19.248372562Z"
930+
"createdOn" : "2025-07-30T10:39:10.312971313Z"
931931
},
932932
"spec" : {
933933
"displayName" : "child block",
@@ -1019,7 +1019,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
10191019
}],
10201020
"parentBuildingBlocks" : [{
10211021
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
1022-
"buildingBlockUuid": "67c72a16-b11d-4042-bc7f-3abfc170a1fb"
1022+
"buildingBlockUuid": "745dfe08-ee62-42f7-93cf-8d93a6b01ea7"
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": "67c72a16-b11d-4042-bc7f-3abfc170a1fb"
1051+
"buildingBlockUuid": "745dfe08-ee62-42f7-93cf-8d93a6b01ea7"
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/74150df5-33fd-4666-887f-a97876e12218
1179+
Location: https://mesh-backend-url/api/meshobjects/meshbuildingblocks/47f28ce0-20d5-4ab8-b65a-73893f4be28e
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" : "74150df5-33fd-4666-887f-a97876e12218",
1194+
"uuid" : "47f28ce0-20d5-4ab8-b65a-73893f4be28e",
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-07-30T08:55:20.480541469Z"
1199+
"createdOn" : "2025-07-30T10:39:11.557963410Z"
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" : "67c72a16-b11d-4042-bc7f-3abfc170a1fb",
1209+
"buildingBlockUuid" : "745dfe08-ee62-42f7-93cf-8d93a6b01ea7",
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/74150df5-33fd-4666-887f-a97876e12218"
1219+
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/47f28ce0-20d5-4ab8-b65a-73893f4be28e"
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/74150df5-33fd-4666-887f-a97876e12218/purge"
1225+
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/47f28ce0-20d5-4ab8-b65a-73893f4be28e/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/74150df5-33fd-4666-887f-a97876e12218 HTTP/1.1
1242+
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/47f28ce0-20d5-4ab8-b65a-73893f4be28e 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/74150df5-33fd-4666-887f-a97876e12218' -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/47f28ce0-20d5-4ab8-b65a-73893f4be28e' -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/74150df5-33fd-4666-887f-a97876e12218/purge HTTP/1.1
1280+
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/47f28ce0-20d5-4ab8-b65a-73893f4be28e/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/74150df5-33fd-4666-887f-a97876e12218/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/47f28ce0-20d5-4ab8-b65a-73893f4be28e/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
12891289
</div>
12901290
</div>
12911291
<div class="listingblock">
@@ -1708,7 +1708,7 @@ <h5 id="_update_sources_and_steps">Update Sources and Steps</h5>
17081708
</div>
17091709
<div id="footer">
17101710
<div id="footer-text">
1711-
Last updated 2025-07-30 08:52:04 UTC
1711+
Last updated 2025-07-30 10:37:08 UTC
17121712
</div>
17131713
</div>
17141714
</body>

0 commit comments

Comments
 (0)