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

Commit 6480227

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

31 files changed

+3281
-3263
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-04-23 14:01:13 UTC
569+
Last updated 2025-04-30 13:37:33 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-04-23 14:01:13 UTC
594+
Last updated 2025-04-30 13:37:33 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-04-23 14:01:13 UTC
527+
Last updated 2025-04-30 13:37:33 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-04-23 14:01:13 UTC
545+
Last updated 2025-04-30 13:37:33 UTC
546546
</div>
547547
</div>
548548
</body>

‎website/static/api/deprecated_resources.html‎

Lines changed: 12 additions & 12 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.vv1</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.vv1</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</code><br>
487+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshserviceinstances/{serviceIdentifier}</code><br>
488488
<code>meshServiceInstance.vv1</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/{serviceIdentifier}</code><br>
493+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshserviceinstances</code><br>
494494
<code>meshServiceInstance.vv1</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.vv1</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.vv1</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>
@@ -544,31 +544,31 @@ <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</code><br>
547+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
548548
<code>meshTenant.vv2</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.vv2</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>
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/{buildingBlockUuid}</code><br>
559+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshbuildingblocks</code><br>
560560
<code>meshBuildingBlock.vv1</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>
563563
<tr>
564564
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
565-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshbuildingblocks</code><br>
565+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshbuildingblocks/{buildingBlockUuid}</code><br>
566566
<code>meshBuildingBlock.vv1</code></p></td>
567567
<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>
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.vv1</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>
@@ -716,7 +716,7 @@ <h3 id="_deprecated_meshobjects_in_declarative_import">Deprecated meshObjects in
716716
</div>
717717
<div id="footer">
718718
<div id="footer-text">
719-
Last updated 2025-04-23 14:01:13 UTC
719+
Last updated 2025-04-30 13:37:33 UTC
720720
</div>
721721
</div>
722722
</body>

0 commit comments

Comments
 (0)