Skip to content

Commit 17f58f4

Browse files
github-merge-queue[bot]GitHub Actions
github-merge-queue[bot]
authored and
GitHub Actions
committed
docs: update meshStack API docs from latest develop build
1 parent 26e0c61 commit 17f58f4

33 files changed

+4380
-4345
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-
"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-06-11 13:53:07 UTC
569+
Last updated 2025-06-18 07:32:12 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-06-11 13:53:07 UTC
594+
Last updated 2025-06-18 07:32:12 UTC
595595
</div>
596596
</div>
597597
</body>

‎website/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-06-11 13:53:07 UTC
527+
Last updated 2025-06-18 07:32:12 UTC
528528
</div>
529529
</div>
530530
</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-06-11 13:53:07 UTC
545+
Last updated 2025-06-18 07:32:12 UTC
546546
</div>
547547
</div>
548548
</body>

‎website/static/api/deprecated_resources.html

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -460,13 +460,13 @@ <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>
@@ -484,13 +484,13 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
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>
@@ -508,13 +508,13 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
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/{identifier}</code><br>
511+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshpaymentmethods</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</code><br>
517+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshpaymentmethods/{identifier}</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>
@@ -532,31 +532,31 @@ <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</code><br>
535+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</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.v4</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/{tenantIdentifier}</code><br>
541+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</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.v4</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/{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.v4</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.v4</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
556556
</tr>
557557
<tr>
558558
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
559-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshbuildingblocks</code><br>
559+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshbuildingblocks</code><br>
560560
<code>meshBuildingBlock.v1</code></p></td>
561561
<td class="tableblock halign-left valign-top"><p class="tableblock">Please use <code>meshBuildingBlock.v2</code>, which supports building blocks on workspace level as well.</p></td>
562562
</tr>
@@ -568,7 +568,7 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
568568
</tr>
569569
<tr>
570570
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
571-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshbuildingblocks</code><br>
571+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshbuildingblocks</code><br>
572572
<code>meshBuildingBlock.v1</code></p></td>
573573
<td class="tableblock halign-left valign-top"><p class="tableblock">Please use <code>meshBuildingBlock.v2</code>, which supports building blocks on workspace level as well.</p></td>
574574
</tr>
@@ -610,7 +610,7 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
610610
</tr>
611611
<tr>
612612
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-11-01</p></td>
613-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshtenants</code><br>
613+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
614614
<code>meshTenant.v3</code></p></td>
615615
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshTenant.v4</code>, which uses a UUID to identify a meshTenant.</p></td>
616616
</tr>
@@ -622,7 +622,7 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
622622
</tr>
623623
<tr>
624624
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-11-01</p></td>
625-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
625+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshtenants</code><br>
626626
<code>meshTenant.v3</code></p></td>
627627
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshTenant.v4</code>, which uses a UUID to identify a meshTenant.</p></td>
628628
</tr>
@@ -739,7 +739,7 @@ <h3 id="_deprecated_meshobjects_in_declarative_import">Deprecated meshObjects in
739739
</div>
740740
<div id="footer">
741741
<div id="footer-text">
742-
Last updated 2025-06-11 13:53:07 UTC
742+
Last updated 2025-06-18 07:32:12 UTC
743743
</div>
744744
</div>
745745
</body>

0 commit comments

Comments
 (0)