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

Commit 0498508

Browse files
author
GitHub Actions
committed
Update meshStack API docs from latest develop build
1 parent 995ab64 commit 0498508

39 files changed

+9032
-9106
lines changed

‎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-10-14 12:14:00 UTC
569+
Last updated 2025-10-14 12:19:54 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-10-14 12:14:00 UTC
594+
Last updated 2025-10-14 12:19:54 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-10-14 12:14:00 UTC
527+
Last updated 2025-10-14 12:19:54 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-10-14 12:14:00 UTC
545+
Last updated 2025-10-14 12:19:54 UTC
546546
</div>
547547
</div>
548548
</body>

‎static/api/deprecated_resources.html‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -472,25 +472,25 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
472472
</tr>
473473
<tr>
474474
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
475-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomers/{identifier}</code><br>
475+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomers</code><br>
476476
<code>meshCustomer.v1</code></p></td>
477477
<td class="tableblock halign-left valign-top"><p class="tableblock">Replace all uses of the <code>meshCustomer</code> object with <code>meshWorkspace</code>.</p></td>
478478
</tr>
479479
<tr>
480480
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
481-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomers</code><br>
481+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomers/{identifier}</code><br>
482482
<code>meshCustomer.v1</code></p></td>
483483
<td class="tableblock halign-left valign-top"><p class="tableblock">Replace all uses of the <code>meshCustomer</code> object with <code>meshWorkspace</code>.</p></td>
484484
</tr>
485485
<tr>
486486
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
487-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshserviceinstances/{serviceIdentifier}</code><br>
487+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshserviceinstances</code><br>
488488
<code>meshServiceInstance.v1</code></p></td>
489489
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshServiceInstance.v2</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
490490
</tr>
491491
<tr>
492492
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
493-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshserviceinstances</code><br>
493+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshserviceinstances/{serviceIdentifier}</code><br>
494494
<code>meshServiceInstance.v1</code></p></td>
495495
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshServiceInstance.v2</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
496496
</tr>
@@ -532,25 +532,25 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
532532
</tr>
533533
<tr>
534534
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
535-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
535+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
536536
<code>meshTenant.v1</code></p></td>
537537
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshTenant.v3</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
538538
</tr>
539539
<tr>
540540
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
541-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
541+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
542542
<code>meshTenant.v1</code></p></td>
543543
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshTenant.v3</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
544544
</tr>
545545
<tr>
546546
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
547-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
547+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
548548
<code>meshTenant.v2</code></p></td>
549549
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshTenant.v3</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
550550
</tr>
551551
<tr>
552552
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
553-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
553+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
554554
<code>meshTenant.v2</code></p></td>
555555
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshTenant.v3</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
556556
</tr>
@@ -592,13 +592,13 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
592592
</tr>
593593
<tr>
594594
<td class="tableblock halign-left valign-top"></td>
595-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshworkspaces</code><br>
595+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshworkspaces/{identifier}</code><br>
596596
<code>meshWorkspace.v1</code></p></td>
597597
<td class="tableblock halign-left valign-top"><p class="tableblock">Please update to <code>meshWorkspace.vv2</code> at your earliest convenience.</p></td>
598598
</tr>
599599
<tr>
600600
<td class="tableblock halign-left valign-top"></td>
601-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshworkspaces/{identifier}</code><br>
601+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshworkspaces</code><br>
602602
<code>meshWorkspace.v1</code></p></td>
603603
<td class="tableblock halign-left valign-top"><p class="tableblock">Please update to <code>meshWorkspace.vv2</code> at your earliest convenience.</p></td>
604604
</tr>
@@ -610,25 +610,25 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
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</code><br>
613+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</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>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
619+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</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>GET /api/meshobjects/meshbuildingblocks</code><br>
625+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshbuildingblocks</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>POST /api/meshobjects/meshbuildingblocks</code><br>
631+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /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>
@@ -640,25 +640,25 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
640640
</tr>
641641
<tr>
642642
<td class="tableblock halign-left valign-top"></td>
643-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshplatforms/{uuid}</code><br>
643+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshplatforms</code><br>
644644
<code>meshPlatform.v1</code></p></td>
645645
<td class="tableblock halign-left valign-top"><p class="tableblock">Please update to <code>meshPlatform.vv2-preview</code> at your earliest convenience.</p></td>
646646
</tr>
647647
<tr>
648648
<td class="tableblock halign-left valign-top"></td>
649-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>PUT /api/meshobjects/meshplatforms/{uuid}</code><br>
649+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshplatforms</code><br>
650650
<code>meshPlatform.v1</code></p></td>
651651
<td class="tableblock halign-left valign-top"><p class="tableblock">Please update to <code>meshPlatform.vv2-preview</code> at your earliest convenience.</p></td>
652652
</tr>
653653
<tr>
654654
<td class="tableblock halign-left valign-top"></td>
655-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshplatforms</code><br>
655+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshplatforms/{uuid}</code><br>
656656
<code>meshPlatform.v1</code></p></td>
657657
<td class="tableblock halign-left valign-top"><p class="tableblock">Please update to <code>meshPlatform.vv2-preview</code> at your earliest convenience.</p></td>
658658
</tr>
659659
<tr>
660660
<td class="tableblock halign-left valign-top"></td>
661-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshplatforms</code><br>
661+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>PUT /api/meshobjects/meshplatforms/{uuid}</code><br>
662662
<code>meshPlatform.v1</code></p></td>
663663
<td class="tableblock halign-left valign-top"><p class="tableblock">Please update to <code>meshPlatform.vv2-preview</code> at your earliest convenience.</p></td>
664664
</tr>
@@ -780,7 +780,7 @@ <h3 id="_deprecated_meshobjects_in_declarative_import">Deprecated meshObjects in
780780
</div>
781781
<div id="footer">
782782
<div id="footer-text">
783-
Last updated 2025-10-14 12:14:00 UTC
783+
Last updated 2025-10-14 12:19:54 UTC
784784
</div>
785785
</div>
786786
</body>

0 commit comments

Comments
 (0)