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

Commit c0a904f

Browse files
github-merge-queue[bot]malhussan
github-merge-queue[bot]
authored and
malhussan
committed
docs: update meshStack API docs from latest develop build
1 parent f755ff6 commit c0a904f

26 files changed

+2096
-2096
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 2025-01-08 12:56:07 UTC
569+
Last updated 2025-01-15 14:00:46 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-01-08 12:56:07 UTC
594+
Last updated 2025-01-15 14:00:46 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-01-08 12:56:07 UTC
480+
Last updated 2025-01-15 14:00:46 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-01-08 12:56:07 UTC
545+
Last updated 2025-01-15 14:00:46 UTC
546546
</div>
547547
</div>
548548
</body>

‎website/static/api/index.html‎

Lines changed: 148 additions & 148 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
@@ -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" : "2025-01-08T12:58:22.044151011Z"
604+
"createdOn" : "2025-01-15T14:02:43.624144423Z"
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" : "2025-01-08T12:58:22.112868871Z"
635+
"createdOn" : "2025-01-15T14:02:43.669973192Z"
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" : "2025-01-08T12:58:22.112868871Z"
926+
"createdOn" : "2025-01-15T14:02:43.669973192Z"
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": "2f9fb773-b1c9-43ad-8296-88b119ac91ab"
1018+
"buildingBlockUuid": "711d0199-3fc8-4a76-a2f2-540fc9496ebb"
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": "2f9fb773-b1c9-43ad-8296-88b119ac91ab"
1047+
"buildingBlockUuid": "711d0199-3fc8-4a76-a2f2-540fc9496ebb"
10481048
}]
10491049
}
10501050
} '</code></pre>
@@ -1172,7 +1172,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
11721172
Vary: Origin
11731173
Vary: Access-Control-Request-Method
11741174
Vary: Access-Control-Request-Headers
1175-
Location: https://mesh-backend-url/api/meshobjects/meshbuildingblocks/6363f6de-cc25-4233-8987-f0d1a1aa3a9e
1175+
Location: https://mesh-backend-url/api/meshobjects/meshbuildingblocks/86bc02e4-31a6-4f09-aa0d-fadc772caeb5
11761176
Content-Type: application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json
11771177
X-Content-Type-Options: nosniff
11781178
X-XSS-Protection: 0
@@ -1187,12 +1187,12 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
11871187
"kind" : "meshBuildingBlock",
11881188
"apiVersion" : "v1",
11891189
"metadata" : {
1190-
"uuid" : "6363f6de-cc25-4233-8987-f0d1a1aa3a9e",
1190+
"uuid" : "86bc02e4-31a6-4f09-aa0d-fadc772caeb5",
11911191
"definitionUuid" : "ef6aaf87-3f8c-477c-94f4-f3cf509728ca",
11921192
"definitionVersion" : 1,
11931193
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
11941194
"forcePurge" : false,
1195-
"createdOn" : "2025-01-08T12:58:23.635997255Z"
1195+
"createdOn" : "2025-01-15T14:02:44.733089449Z"
11961196
},
11971197
"spec" : {
11981198
"displayName" : "New BuildingBlock",
@@ -1202,7 +1202,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
12021202
"valueType" : "STRING"
12031203
} ],
12041204
"parentBuildingBlocks" : [ {
1205-
"buildingBlockUuid" : "2f9fb773-b1c9-43ad-8296-88b119ac91ab",
1205+
"buildingBlockUuid" : "711d0199-3fc8-4a76-a2f2-540fc9496ebb",
12061206
"definitionUuid" : "b23cfb9a-6974-444f-9d33-62134a632373"
12071207
} ]
12081208
},
@@ -1212,13 +1212,13 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
12121212
},
12131213
"_links" : {
12141214
"self" : {
1215-
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/6363f6de-cc25-4233-8987-f0d1a1aa3a9e"
1215+
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/86bc02e4-31a6-4f09-aa0d-fadc772caeb5"
12161216
},
12171217
"meshtenant" : {
12181218
"href" : "https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location"
12191219
},
12201220
"forcePurge" : {
1221-
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/6363f6de-cc25-4233-8987-f0d1a1aa3a9e/purge"
1221+
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/86bc02e4-31a6-4f09-aa0d-fadc772caeb5/purge"
12221222
}
12231223
}
12241224
}</code></pre>
@@ -1235,15 +1235,15 @@ <h5 id="_delete_meshbuildingblock">Delete meshBuildingBlock</h5>
12351235
<div class="listingblock">
12361236
<div class="title">Example Request</div>
12371237
<div class="content">
1238-
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/6363f6de-cc25-4233-8987-f0d1a1aa3a9e HTTP/1.1
1238+
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/86bc02e4-31a6-4f09-aa0d-fadc772caeb5 HTTP/1.1
12391239
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
12401240
Host: mesh-backend-url</code></pre>
12411241
</div>
12421242
</div>
12431243
<div class="listingblock">
12441244
<div class="title">Example Curl Request</div>
12451245
<div class="content">
1246-
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/6363f6de-cc25-4233-8987-f0d1a1aa3a9e' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
1246+
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/86bc02e4-31a6-4f09-aa0d-fadc772caeb5' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
12471247
</div>
12481248
</div>
12491249
<div class="listingblock">
@@ -1273,15 +1273,15 @@ <h5 id="_purge_meshbuildingblock">Purge meshBuildingBlock</h5>
12731273
<div class="listingblock">
12741274
<div class="title">Example Request</div>
12751275
<div class="content">
1276-
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/6363f6de-cc25-4233-8987-f0d1a1aa3a9e/purge HTTP/1.1
1276+
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/86bc02e4-31a6-4f09-aa0d-fadc772caeb5/purge HTTP/1.1
12771277
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
12781278
Host: mesh-backend-url</code></pre>
12791279
</div>
12801280
</div>
12811281
<div class="listingblock">
12821282
<div class="title">Example Curl Request</div>
12831283
<div class="content">
1284-
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/6363f6de-cc25-4233-8987-f0d1a1aa3a9e/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
1284+
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/86bc02e4-31a6-4f09-aa0d-fadc772caeb5/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
12851285
</div>
12861286
</div>
12871287
<div class="listingblock">
@@ -1712,7 +1712,7 @@ <h5 id="_update_sources_and_steps">Update Sources and Steps</h5>
17121712
</div>
17131713
<div id="footer">
17141714
<div id="footer-text">
1715-
Last updated 2025-01-08 12:56:07 UTC
1715+
Last updated 2025-01-15 14:00:46 UTC
17161716
</div>
17171717
</div>
17181718
</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-01-08 12:56:07 UTC
456+
Last updated 2025-01-15 14:00:46 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" : "K2TQtJeo1B"
680+
"errorId" : "aMTZTKqZY5"
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 2025-01-08 12:56:07 UTC
689+
Last updated 2025-01-15 14:00:46 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 2025-01-08 12:56:07 UTC
1527+
Last updated 2025-01-15 14:00:46 UTC
15281528
</div>
15291529
</div>
15301530
</body>

0 commit comments

Comments
 (0)