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

Commit cb023ef

Browse files
github-merge-queue[bot]nroi
authored andcommitted
docs: update meshStack API docs from latest develop build
1 parent 771eccb commit cb023ef

27 files changed

+1944
-2308
lines changed

website/static/api/api_index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -549,12 +549,12 @@ <h3 id="_index">Index</h3>
549549

550550
{
551551
"_links" : {
552-
"meshobjects" : {
553-
"href" : "https://mesh-backend-url/api/meshobjects"
554-
},
555552
"metadata" : {
556553
"href" : "https://mesh-backend-url/api/metadata"
557554
},
555+
"meshobjects" : {
556+
"href" : "https://mesh-backend-url/api/meshobjects"
557+
},
558558
"self" : {
559559
"href" : "https://mesh-backend-url/api"
560560
}
@@ -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-05 14:46:23 UTC
569+
Last updated 2025-03-12 13:05:13 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-05 14:46:23 UTC
594+
Last updated 2025-03-12 13:05:13 UTC
595595
</div>
596596
</div>
597597
</body>

website/static/api/api_keys.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -477,7 +477,7 @@ <h3 id="api_keys">API Keys</h3>
477477
</div>
478478
<div id="footer">
479479
<div id="footer-text">
480-
Last updated 2025-03-05 14:46:23 UTC
480+
Last updated 2025-03-12 13:05:13 UTC
481481
</div>
482482
</div>
483483
</body>

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-05 14:46:23 UTC
545+
Last updated 2025-03-12 13:05:13 UTC
546546
</div>
547547
</div>
548548
</body>

website/static/api/deprecated_resources.html

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -520,13 +520,13 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
520520
</tr>
521521
<tr>
522522
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
523-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshprojects/{fullProjectIdentifier}</code><br>
523+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshprojects</code><br>
524524
<code>meshProject.v1</code></p></td>
525525
<td class="tableblock halign-left valign-top"><p class="tableblock">Please use <code>meshProject.v2</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
526526
</tr>
527527
<tr>
528528
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
529-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshprojects</code><br>
529+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshprojects/{fullProjectIdentifier}</code><br>
530530
<code>meshProject.v1</code></p></td>
531531
<td class="tableblock halign-left valign-top"><p class="tableblock">Please use <code>meshProject.v2</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
532532
</tr>
@@ -652,6 +652,11 @@ <h3 id="_deprecated_meshobjects_in_declarative_import">Deprecated meshObjects in
652652
<td class="tableblock halign-left valign-top"><p class="tableblock">Replace all uses of <code>meshCustomerUserGroup</code> object with <code>meshWorkspaceUserGroup</code>.</p></td>
653653
</tr>
654654
<tr>
655+
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
656+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>meshCustomerGroupBinding.v1</code></p></td>
657+
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshWorkspaceGroupBinding.v2</code>, which targets a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
658+
</tr>
659+
<tr>
655660
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
656661
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>meshUser.v1</code></p></td>
657662
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshUser.v2</code>, which features an updated set of <code>_links</code> reflecting the renaming of <code>meshCustomer</code> to <code>meshWorkspace</code>.</p></td>
@@ -717,7 +722,7 @@ <h3 id="_deprecated_meshobjects_in_declarative_import">Deprecated meshObjects in
717722
</div>
718723
<div id="footer">
719724
<div id="footer-text">
720-
Last updated 2025-03-05 14:46:23 UTC
725+
Last updated 2025-03-12 13:05:13 UTC
721726
</div>
722727
</div>
723728
</body>

website/static/api/index.html

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

website/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-03-05T14:48:25.208807960Z"
608+
"createdOn" : "2025-03-12T13:07:12.389627709Z"
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-05T14:48:25.255850770Z"
639+
"createdOn" : "2025-03-12T13:07:12.439151161Z"
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-03-05T14:48:25.255850770Z"
930+
"createdOn" : "2025-03-12T13:07:12.439151161Z"
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": "2c80f879-9000-4752-a46e-e3f6aa8ffeb0"
1022+
"buildingBlockUuid": "fcc05d9e-2852-488e-995e-be5f6e05a39c"
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": "2c80f879-9000-4752-a46e-e3f6aa8ffeb0"
1051+
"buildingBlockUuid": "fcc05d9e-2852-488e-995e-be5f6e05a39c"
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/d1799348-e64a-4df9-8144-a4c6dec77c72
1179+
Location: https://mesh-backend-url/api/meshobjects/meshbuildingblocks/34da6eee-535a-47fa-863c-dde0a97918dc
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" : "d1799348-e64a-4df9-8144-a4c6dec77c72",
1194+
"uuid" : "34da6eee-535a-47fa-863c-dde0a97918dc",
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-05T14:48:26.284154856Z"
1199+
"createdOn" : "2025-03-12T13:07:13.491798630Z"
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" : "2c80f879-9000-4752-a46e-e3f6aa8ffeb0",
1209+
"buildingBlockUuid" : "fcc05d9e-2852-488e-995e-be5f6e05a39c",
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/d1799348-e64a-4df9-8144-a4c6dec77c72"
1219+
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/34da6eee-535a-47fa-863c-dde0a97918dc"
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/d1799348-e64a-4df9-8144-a4c6dec77c72/purge"
1225+
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/34da6eee-535a-47fa-863c-dde0a97918dc/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/d1799348-e64a-4df9-8144-a4c6dec77c72 HTTP/1.1
1242+
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/34da6eee-535a-47fa-863c-dde0a97918dc 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/d1799348-e64a-4df9-8144-a4c6dec77c72' -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/34da6eee-535a-47fa-863c-dde0a97918dc' -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/d1799348-e64a-4df9-8144-a4c6dec77c72/purge HTTP/1.1
1280+
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/34da6eee-535a-47fa-863c-dde0a97918dc/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/d1799348-e64a-4df9-8144-a4c6dec77c72/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/34da6eee-535a-47fa-863c-dde0a97918dc/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
12891289
</div>
12901290
</div>
12911291
<div class="listingblock">
@@ -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-05 14:46:23 UTC
1719+
Last updated 2025-03-12 13:05:13 UTC
17201720
</div>
17211721
</div>
17221722
</body>

website/static/api/mesh_buildingblockrunner.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ <h3 id="mesh_buildingblockrunner">Building Block Runner API</h3>
453453
</div>
454454
<div id="footer">
455455
<div id="footer-text">
456-
Last updated 2025-03-05 14:46:23 UTC
456+
Last updated 2025-03-12 13:05:13 UTC
457457
</div>
458458
</div>
459459
</body>

website/static/api/mesh_object_collection.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -678,7 +678,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
678678
{
679679
"message" : "MeshObjectCollection not-empty-collection cannot be deleted, because it is not empty",
680680
"errorCode" : "BadRequest",
681-
"errorId" : "xxH4SmM2dq"
681+
"errorId" : "y4HEcmbGKb"
682682
}</code></pre>
683683
</div>
684684
</div>
@@ -687,7 +687,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
687687
</div>
688688
<div id="footer">
689689
<div id="footer-text">
690-
Last updated 2025-03-05 14:46:23 UTC
690+
Last updated 2025-03-12 13:05:13 UTC
691691
</div>
692692
</div>
693693
</body>

website/static/api/mesh_object_declarative_import.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -877,7 +877,7 @@ <h5 id="_meshuser">meshUser</h5>
877877
<h6 id="_yaml">YAML</h6>
878878
<div class="listingblock">
879879
<div class="content">
880-
<pre class="highlight"><code class="language-yaml" data-lang="yaml">apiVersion: v1
880+
<pre class="highlight"><code class="language-yaml" data-lang="yaml">apiVersion: v2
881881
kind: meshUser
882882
metadata:
883883
name: john-doe
@@ -901,7 +901,7 @@ <h6 id="_json">JSON</h6>
901901
<div class="listingblock">
902902
<div class="content">
903903
<pre class="highlight"><code class="language-json" data-lang="json">{
904-
"apiVersion": "v1",
904+
"apiVersion": "v2",
905905
"kind": "meshUser",
906906
"metadata": {
907907
"name": "john-doe"
@@ -1538,7 +1538,7 @@ <h5 id="_meshexchangerate">meshExchangeRate</h5>
15381538
</div>
15391539
<div id="footer">
15401540
<div id="footer-text">
1541-
Last updated 2025-03-05 14:46:23 UTC
1541+
Last updated 2025-03-12 13:05:13 UTC
15421542
</div>
15431543
</div>
15441544
</body>

0 commit comments

Comments
 (0)