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

Commit 58d4c12

Browse files
author
GitHub Actions
committed
Update meshStack API docs from latest develop build
1 parent 0b0a171 commit 58d4c12

39 files changed

+7900
-7884
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-
"metadata" : {
553-
"href" : "https://mesh-backend-url/api/metadata"
554-
},
555552
"meshobjects" : {
556553
"href" : "https://mesh-backend-url/api/meshobjects"
557554
},
555+
"metadata" : {
556+
"href" : "https://mesh-backend-url/api/metadata"
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-15 08:31:59 UTC
569+
Last updated 2025-10-15 09:26:22 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-15 08:31:59 UTC
594+
Last updated 2025-10-15 09:26:22 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-15 08:31:59 UTC
527+
Last updated 2025-10-15 09:26:22 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-15 08:31:59 UTC
545+
Last updated 2025-10-15 09:26:22 UTC
546546
</div>
547547
</div>
548548
</body>

‎static/api/deprecated_resources.html‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -460,25 +460,25 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
460460
</tr>
461461
<tr>
462462
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
463-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshusers/{username}</code><br>
463+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshusers</code><br>
464464
<code>meshUser.v1</code></p></td>
465465
<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>
466466
</tr>
467467
<tr>
468468
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
469-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshusers</code><br>
469+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshusers/{username}</code><br>
470470
<code>meshUser.v1</code></p></td>
471471
<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>
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</code><br>
475+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomers/{identifier}</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/{identifier}</code><br>
481+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomers</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>
@@ -496,37 +496,37 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
496496
</tr>
497497
<tr>
498498
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
499-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomerusergroups</code><br>
499+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomerusergroups/{fullCustomerUserGroupIdentifier}</code><br>
500500
<code>meshCustomerUserGroup.v1</code></p></td>
501501
<td class="tableblock halign-left valign-top"><p class="tableblock">Replace all uses of <code>meshCustomerUserGroup</code> object with <code>meshWorkspaceUserGroup</code>.</p></td>
502502
</tr>
503503
<tr>
504504
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
505-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomerusergroups/{fullCustomerUserGroupIdentifier}</code><br>
505+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomerusergroups</code><br>
506506
<code>meshCustomerUserGroup.v1</code></p></td>
507507
<td class="tableblock halign-left valign-top"><p class="tableblock">Replace all uses of <code>meshCustomerUserGroup</code> object with <code>meshWorkspaceUserGroup</code>.</p></td>
508508
</tr>
509509
<tr>
510510
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
511-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshpaymentmethods</code><br>
511+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshpaymentmethods/{identifier}</code><br>
512512
<code>meshPaymentMethod.v1</code></p></td>
513513
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshPaymentMethod.v2</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
514514
</tr>
515515
<tr>
516516
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
517-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshpaymentmethods/{identifier}</code><br>
517+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshpaymentmethods</code><br>
518518
<code>meshPaymentMethod.v1</code></p></td>
519519
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshPaymentMethod.v2</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
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>
@@ -544,13 +544,13 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
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/{tenantIdentifier}</code><br>
547+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</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</code><br>
553+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</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,19 +592,19 @@ <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/{identifier}</code><br>
595+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshworkspaces</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</code><br>
601+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshworkspaces/{identifier}</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>
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>GET /api/meshobjects/meshtenants/{tenantIdentifier}</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>
@@ -616,13 +616,13 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
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/{buildingBlockUuid}</code><br>
625+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /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>
@@ -634,13 +634,13 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
634634
</tr>
635635
<tr>
636636
<td class="tableblock halign-left valign-top"></td>
637-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshbuildingblocks</code><br>
637+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshbuildingblocks/{buildingBlockUuid}</code><br>
638638
<code>meshBuildingBlock.v1</code></p></td>
639639
<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>
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</code><br>
643+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshplatforms/{uuid}</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>
@@ -652,7 +652,7 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
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/{uuid}</code><br>
655+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshplatforms</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>
@@ -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-15 08:31:59 UTC
783+
Last updated 2025-10-15 09:26:22 UTC
784784
</div>
785785
</div>
786786
</body>

0 commit comments

Comments
 (0)