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

Commit ea5edfe

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

26 files changed

+4022
-2003
lines changed

website/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 2024-10-30 17:46:54 UTC
569+
Last updated 2024-11-06 13:33:16 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 2024-10-30 17:46:54 UTC
594+
Last updated 2024-11-06 13:33:16 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 2024-10-30 17:46:54 UTC
480+
Last updated 2024-11-06 13:33:16 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 2024-10-30 17:46:54 UTC
545+
Last updated 2024-11-06 13:33:16 UTC
546546
</div>
547547
</div>
548548
</body>

website/static/api/index.html

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

website/static/api/mesh_buildingblock.html

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -601,7 +601,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
601601
"definitionVersion" : 1,
602602
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
603603
"forcePurge" : false,
604-
"createdOn" : "2024-10-30T17:49:04.874524994Z"
604+
"createdOn" : "2024-11-06T13:36:14.903052143Z"
605605
},
606606
"spec" : {
607607
"displayName" : "parent block",
@@ -632,7 +632,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
632632
"definitionVersion" : 1,
633633
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
634634
"forcePurge" : false,
635-
"createdOn" : "2024-10-30T17:49:04.947339684Z"
635+
"createdOn" : "2024-11-06T13:36:14.984878412Z"
636636
},
637637
"spec" : {
638638
"displayName" : "child block",
@@ -923,7 +923,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
923923
"definitionVersion" : 1,
924924
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
925925
"forcePurge" : false,
926-
"createdOn" : "2024-10-30T17:49:04.947339684Z"
926+
"createdOn" : "2024-11-06T13:36:14.984878412Z"
927927
},
928928
"spec" : {
929929
"displayName" : "child block",
@@ -1015,7 +1015,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
10151015
}],
10161016
"parentBuildingBlocks" : [{
10171017
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
1018-
"buildingBlockUuid": "29e993e4-e121-4917-8a1c-7878354742a4"
1018+
"buildingBlockUuid": "8d71f49c-1792-4604-825f-7805dd41f8d4"
10191019
}]
10201020
}
10211021
}</code></pre>
@@ -1044,7 +1044,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
10441044
}],
10451045
"parentBuildingBlocks" : [{
10461046
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
1047-
"buildingBlockUuid": "29e993e4-e121-4917-8a1c-7878354742a4"
1047+
"buildingBlockUuid": "8d71f49c-1792-4604-825f-7805dd41f8d4"
10481048
}]
10491049
}
10501050
} '</code></pre>
@@ -1186,12 +1186,12 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
11861186
"kind" : "meshBuildingBlock",
11871187
"apiVersion" : "v1",
11881188
"metadata" : {
1189-
"uuid" : "9283fb1b-1f7b-4ce6-b104-88996e45939f",
1189+
"uuid" : "1c10ffc2-f17a-4712-a434-dc619bdb0b0b",
11901190
"definitionUuid" : "ef6aaf87-3f8c-477c-94f4-f3cf509728ca",
11911191
"definitionVersion" : 1,
11921192
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
11931193
"forcePurge" : false,
1194-
"createdOn" : "2024-10-30T17:49:06.293296297Z"
1194+
"createdOn" : "2024-11-06T13:36:16.807033732Z"
11951195
},
11961196
"spec" : {
11971197
"displayName" : "New BuildingBlock",
@@ -1201,7 +1201,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
12011201
"valueType" : "STRING"
12021202
} ],
12031203
"parentBuildingBlocks" : [ {
1204-
"buildingBlockUuid" : "29e993e4-e121-4917-8a1c-7878354742a4",
1204+
"buildingBlockUuid" : "8d71f49c-1792-4604-825f-7805dd41f8d4",
12051205
"definitionUuid" : "b23cfb9a-6974-444f-9d33-62134a632373"
12061206
} ]
12071207
},
@@ -1211,13 +1211,13 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
12111211
},
12121212
"_links" : {
12131213
"self" : {
1214-
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/9283fb1b-1f7b-4ce6-b104-88996e45939f"
1214+
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/1c10ffc2-f17a-4712-a434-dc619bdb0b0b"
12151215
},
12161216
"meshtenant" : {
12171217
"href" : "https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location"
12181218
},
12191219
"forcePurge" : {
1220-
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/9283fb1b-1f7b-4ce6-b104-88996e45939f/purge"
1220+
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/1c10ffc2-f17a-4712-a434-dc619bdb0b0b/purge"
12211221
}
12221222
}
12231223
}</code></pre>
@@ -1234,15 +1234,15 @@ <h5 id="_delete_meshbuildingblock">Delete meshBuildingBlock</h5>
12341234
<div class="listingblock">
12351235
<div class="title">Example Request</div>
12361236
<div class="content">
1237-
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/9283fb1b-1f7b-4ce6-b104-88996e45939f HTTP/1.1
1237+
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/1c10ffc2-f17a-4712-a434-dc619bdb0b0b HTTP/1.1
12381238
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
12391239
Host: mesh-backend-url</code></pre>
12401240
</div>
12411241
</div>
12421242
<div class="listingblock">
12431243
<div class="title">Example Curl Request</div>
12441244
<div class="content">
1245-
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/9283fb1b-1f7b-4ce6-b104-88996e45939f' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
1245+
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/1c10ffc2-f17a-4712-a434-dc619bdb0b0b' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
12461246
</div>
12471247
</div>
12481248
<div class="listingblock">
@@ -1272,15 +1272,15 @@ <h5 id="_purge_meshbuildingblock">Purge meshBuildingBlock</h5>
12721272
<div class="listingblock">
12731273
<div class="title">Example Request</div>
12741274
<div class="content">
1275-
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/9283fb1b-1f7b-4ce6-b104-88996e45939f/purge HTTP/1.1
1275+
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/1c10ffc2-f17a-4712-a434-dc619bdb0b0b/purge HTTP/1.1
12761276
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
12771277
Host: mesh-backend-url</code></pre>
12781278
</div>
12791279
</div>
12801280
<div class="listingblock">
12811281
<div class="title">Example Curl Request</div>
12821282
<div class="content">
1283-
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/9283fb1b-1f7b-4ce6-b104-88996e45939f/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
1283+
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/1c10ffc2-f17a-4712-a434-dc619bdb0b0b/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
12841284
</div>
12851285
</div>
12861286
<div class="listingblock">
@@ -1672,7 +1672,7 @@ <h5 id="_update_sources_and_steps">Update Sources and Steps</h5>
16721672
</div>
16731673
<div id="footer">
16741674
<div id="footer-text">
1675-
Last updated 2024-10-30 17:46:54 UTC
1675+
Last updated 2024-11-06 13:33:16 UTC
16761676
</div>
16771677
</div>
16781678
</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 2024-10-30 17:46:54 UTC
456+
Last updated 2024-11-06 13:33:16 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
@@ -677,7 +677,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
677677
{
678678
"message" : "MeshObjectCollection not-empty-collection cannot be deleted, because it is not empty",
679679
"errorCode" : "BadRequest",
680-
"errorId" : "NpueU4Bpm3"
680+
"errorId" : "wqhnsdj7Mr"
681681
}</code></pre>
682682
</div>
683683
</div>
@@ -686,7 +686,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
686686
</div>
687687
<div id="footer">
688688
<div id="footer-text">
689-
Last updated 2024-10-30 17:46:54 UTC
689+
Last updated 2024-11-06 13:33:16 UTC
690690
</div>
691691
</div>
692692
</body>

website/static/api/mesh_object_declarative_import.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1524,7 +1524,7 @@ <h5 id="_meshexchangerate">meshExchangeRate</h5>
15241524
</div>
15251525
<div id="footer">
15261526
<div id="footer-text">
1527-
Last updated 2024-10-30 17:46:54 UTC
1527+
Last updated 2024-11-06 13:33:16 UTC
15281528
</div>
15291529
</div>
15301530
</body>

0 commit comments

Comments
 (0)