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

Commit f755ff6

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

13 files changed

+282
-261
lines changed

website/static/billing-api/api_index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -559,7 +559,7 @@ <h3 id="_index">Index</h3>
559559
</div>
560560
<div id="footer">
561561
<div id="footer-text">
562-
Last updated 2025-01-08 08:40:45 UTC
562+
Last updated 2025-01-15 14:00:43 UTC
563563
</div>
564564
</div>
565565
</body>

website/static/billing-api/common_data_formats.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -519,7 +519,7 @@ <h3 id="paging">Paging</h3>
519519
</div>
520520
<div id="footer">
521521
<div id="footer-text">
522-
Last updated 2025-01-08 08:40:45 UTC
522+
Last updated 2025-01-15 14:00:43 UTC
523523
</div>
524524
</div>
525525
</body>

website/static/billing-api/index.html

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1265,7 +1265,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
12651265
"reportCategory" : "BILLING",
12661266
"platformType" : "Azure",
12671267
"platform" : "azure.prod",
1268-
"platformTenantId" : "7f8a4a09-dd69-40d9-b796-e309ce5d2489",
1268+
"platformTenantId" : "02ad42b1-4030-487e-b4d8-4c6d68795461",
12691269
"version" : 2
12701270
},
12711271
"status" : {
@@ -1316,7 +1316,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
13161316
"reportCategory" : "BILLING",
13171317
"platformType" : "Azure",
13181318
"platform" : "azure.prod",
1319-
"platformTenantId" : "26baed78-1a35-47d4-9399-e3a2a4744078",
1319+
"platformTenantId" : "f557461f-78d5-4a50-8335-eb6ba39197bf",
13201320
"version" : 1
13211321
},
13221322
"status" : {
@@ -1644,7 +1644,7 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
16441644
"reportCategory" : "BILLING",
16451645
"platformType" : "Azure",
16461646
"platform" : "azure.prod",
1647-
"platformTenantId" : "7f8a4a09-dd69-40d9-b796-e309ce5d2489",
1647+
"platformTenantId" : "02ad42b1-4030-487e-b4d8-4c6d68795461",
16481648
"version" : 2
16491649
},
16501650
"status" : {
@@ -1697,6 +1697,13 @@ <h4 id="mesh_chargeback"><a class="link" href="#mesh_chargeback">meshChargebacks
16971697
options than the chargeback statements. They contain basically the same information as a chargeback, but only
16981698
per tenant, not per project.</p>
16991699
</div>
1700+
<div class="paragraph">
1701+
<p>For customers who export chargeback statements on a monthly basis, the following recommendation applies:
1702+
chargeback statements of the previous month should be processed no earlier than one day after the configured finalization date,
1703+
at 7 a.m. (German local time). By default, chargeback statements are finalized at the 6th of a month, therefore,
1704+
they can be processed starting at the 7th of a month at 7 a.m.
1705+
If you are unsure about the configuration of the finalization day of chargebacks in your meshStack, please contact our support team.</p>
1706+
</div>
17001707
<div class="sect4">
17011708
<h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">List meshChargebacks</a></h5>
17021709
<div class="paragraph">
@@ -1748,7 +1755,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
17481755
</tr>
17491756
<tr>
17501757
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>period</code></p></td>
1751-
<td class="tableblock halign-left valign-top"><p class="tableblock">Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-06Z' (optional)</p></td>
1758+
<td class="tableblock halign-left valign-top"><p class="tableblock">Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-01Z' (optional)</p></td>
17521759
</tr>
17531760
<tr>
17541761
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>finalized</code></p></td>
@@ -1845,7 +1852,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
18451852
"apiVersion" : "v3",
18461853
"metadata" : {
18471854
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
1848-
"createdOn" : "2025-01-08T08:42:10.403495900Z",
1855+
"createdOn" : "2025-01-15T14:01:55.062973900Z",
18491856
"finalized" : true
18501857
},
18511858
"spec" : {
@@ -1907,7 +1914,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
19071914
"apiVersion" : "v3",
19081915
"metadata" : {
19091916
"name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
1910-
"createdOn" : "2025-01-08T08:42:10.405079500Z",
1917+
"createdOn" : "2025-01-15T14:01:55.064383800Z",
19111918
"finalized" : true
19121919
},
19131920
"spec" : {
@@ -2054,7 +2061,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
20542061
<tr>
20552062
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec.period</code></p></td>
20562063
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
2057-
<td class="tableblock halign-left valign-top"><p class="tableblock">The period of the meshChargeback, e.g. '2022-01-06Z'.</p></td>
2064+
<td class="tableblock halign-left valign-top"><p class="tableblock">The period of the meshChargeback, e.g. '2022-01-01Z'.</p></td>
20582065
</tr>
20592066
<tr>
20602067
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec.tags</code></p></td>
@@ -2200,7 +2207,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
22002207
"apiVersion" : "v3",
22012208
"metadata" : {
22022209
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
2203-
"createdOn" : "2025-01-08T08:42:10.403495900Z",
2210+
"createdOn" : "2025-01-15T14:01:55.062973900Z",
22042211
"finalized" : true
22052212
},
22062213
"spec" : {
@@ -2541,7 +2548,7 @@ <h5 id="_put_meshresourceusagereports"><a class="link" href="#_put_meshresourceu
25412548
</div>
25422549
<div id="footer">
25432550
<div id="footer-text">
2544-
Last updated 2025-01-08 08:40:45 UTC
2551+
Last updated 2025-01-15 14:00:43 UTC
25452552
</div>
25462553
</div>
25472554
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">

website/static/billing-api/mesh_chargeback.html

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -451,6 +451,13 @@ <h4 id="mesh_chargeback">meshChargebacks</h4>
451451
options than the chargeback statements. They contain basically the same information as a chargeback, but only
452452
per tenant, not per project.</p>
453453
</div>
454+
<div class="paragraph">
455+
<p>For customers who export chargeback statements on a monthly basis, the following recommendation applies:
456+
chargeback statements of the previous month should be processed no earlier than one day after the configured finalization date,
457+
at 7 a.m. (German local time). By default, chargeback statements are finalized at the 6th of a month, therefore,
458+
they can be processed starting at the 7th of a month at 7 a.m.
459+
If you are unsure about the configuration of the finalization day of chargebacks in your meshStack, please contact our support team.</p>
460+
</div>
454461
<div class="sect4">
455462
<h5 id="_list_meshchargebacks">List meshChargebacks</h5>
456463
<div class="paragraph">
@@ -502,7 +509,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
502509
</tr>
503510
<tr>
504511
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>period</code></p></td>
505-
<td class="tableblock halign-left valign-top"><p class="tableblock">Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-06Z' (optional)</p></td>
512+
<td class="tableblock halign-left valign-top"><p class="tableblock">Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-01Z' (optional)</p></td>
506513
</tr>
507514
<tr>
508515
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>finalized</code></p></td>
@@ -599,7 +606,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
599606
"apiVersion" : "v3",
600607
"metadata" : {
601608
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
602-
"createdOn" : "2025-01-08T08:42:10.403495900Z",
609+
"createdOn" : "2025-01-15T14:01:55.062973900Z",
603610
"finalized" : true
604611
},
605612
"spec" : {
@@ -661,7 +668,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
661668
"apiVersion" : "v3",
662669
"metadata" : {
663670
"name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
664-
"createdOn" : "2025-01-08T08:42:10.405079500Z",
671+
"createdOn" : "2025-01-15T14:01:55.064383800Z",
665672
"finalized" : true
666673
},
667674
"spec" : {
@@ -808,7 +815,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
808815
<tr>
809816
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec.period</code></p></td>
810817
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
811-
<td class="tableblock halign-left valign-top"><p class="tableblock">The period of the meshChargeback, e.g. '2022-01-06Z'.</p></td>
818+
<td class="tableblock halign-left valign-top"><p class="tableblock">The period of the meshChargeback, e.g. '2022-01-01Z'.</p></td>
812819
</tr>
813820
<tr>
814821
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec.tags</code></p></td>
@@ -954,7 +961,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
954961
"apiVersion" : "v3",
955962
"metadata" : {
956963
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
957-
"createdOn" : "2025-01-08T08:42:10.403495900Z",
964+
"createdOn" : "2025-01-15T14:01:55.062973900Z",
958965
"finalized" : true
959966
},
960967
"spec" : {
@@ -1019,7 +1026,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
10191026
</div>
10201027
<div id="footer">
10211028
<div id="footer-text">
1022-
Last updated 2025-01-08 08:40:45 UTC
1029+
Last updated 2025-01-15 14:00:43 UTC
10231030
</div>
10241031
</div>
10251032
</body>

website/static/billing-api/mesh_objects.html

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -765,7 +765,7 @@ <h5 id="_list_meshtenantusagereports">List meshTenantUsageReports</h5>
765765
"reportCategory" : "BILLING",
766766
"platformType" : "Azure",
767767
"platform" : "azure.prod",
768-
"platformTenantId" : "7f8a4a09-dd69-40d9-b796-e309ce5d2489",
768+
"platformTenantId" : "02ad42b1-4030-487e-b4d8-4c6d68795461",
769769
"version" : 2
770770
},
771771
"status" : {
@@ -816,7 +816,7 @@ <h5 id="_list_meshtenantusagereports">List meshTenantUsageReports</h5>
816816
"reportCategory" : "BILLING",
817817
"platformType" : "Azure",
818818
"platform" : "azure.prod",
819-
"platformTenantId" : "26baed78-1a35-47d4-9399-e3a2a4744078",
819+
"platformTenantId" : "f557461f-78d5-4a50-8335-eb6ba39197bf",
820820
"version" : 1
821821
},
822822
"status" : {
@@ -1144,7 +1144,7 @@ <h5 id="_get_meshtenantusagereport">Get meshTenantUsageReport</h5>
11441144
"reportCategory" : "BILLING",
11451145
"platformType" : "Azure",
11461146
"platform" : "azure.prod",
1147-
"platformTenantId" : "7f8a4a09-dd69-40d9-b796-e309ce5d2489",
1147+
"platformTenantId" : "02ad42b1-4030-487e-b4d8-4c6d68795461",
11481148
"version" : 2
11491149
},
11501150
"status" : {
@@ -1197,6 +1197,13 @@ <h4 id="mesh_chargeback">meshChargebacks</h4>
11971197
options than the chargeback statements. They contain basically the same information as a chargeback, but only
11981198
per tenant, not per project.</p>
11991199
</div>
1200+
<div class="paragraph">
1201+
<p>For customers who export chargeback statements on a monthly basis, the following recommendation applies:
1202+
chargeback statements of the previous month should be processed no earlier than one day after the configured finalization date,
1203+
at 7 a.m. (German local time). By default, chargeback statements are finalized at the 6th of a month, therefore,
1204+
they can be processed starting at the 7th of a month at 7 a.m.
1205+
If you are unsure about the configuration of the finalization day of chargebacks in your meshStack, please contact our support team.</p>
1206+
</div>
12001207
<div class="sect4">
12011208
<h5 id="_list_meshchargebacks">List meshChargebacks</h5>
12021209
<div class="paragraph">
@@ -1248,7 +1255,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
12481255
</tr>
12491256
<tr>
12501257
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>period</code></p></td>
1251-
<td class="tableblock halign-left valign-top"><p class="tableblock">Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-06Z' (optional)</p></td>
1258+
<td class="tableblock halign-left valign-top"><p class="tableblock">Filter for meshChargebacks that belong to the provided period, e.g. '2022-01-01Z' (optional)</p></td>
12521259
</tr>
12531260
<tr>
12541261
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>finalized</code></p></td>
@@ -1345,7 +1352,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
13451352
"apiVersion" : "v3",
13461353
"metadata" : {
13471354
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
1348-
"createdOn" : "2025-01-08T08:42:10.403495900Z",
1355+
"createdOn" : "2025-01-15T14:01:55.062973900Z",
13491356
"finalized" : true
13501357
},
13511358
"spec" : {
@@ -1407,7 +1414,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
14071414
"apiVersion" : "v3",
14081415
"metadata" : {
14091416
"name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
1410-
"createdOn" : "2025-01-08T08:42:10.405079500Z",
1417+
"createdOn" : "2025-01-15T14:01:55.064383800Z",
14111418
"finalized" : true
14121419
},
14131420
"spec" : {
@@ -1554,7 +1561,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
15541561
<tr>
15551562
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec.period</code></p></td>
15561563
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
1557-
<td class="tableblock halign-left valign-top"><p class="tableblock">The period of the meshChargeback, e.g. '2022-01-06Z'.</p></td>
1564+
<td class="tableblock halign-left valign-top"><p class="tableblock">The period of the meshChargeback, e.g. '2022-01-01Z'.</p></td>
15581565
</tr>
15591566
<tr>
15601567
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec.tags</code></p></td>
@@ -1700,7 +1707,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
17001707
"apiVersion" : "v3",
17011708
"metadata" : {
17021709
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
1703-
"createdOn" : "2025-01-08T08:42:10.403495900Z",
1710+
"createdOn" : "2025-01-15T14:01:55.062973900Z",
17041711
"finalized" : true
17051712
},
17061713
"spec" : {
@@ -2039,7 +2046,7 @@ <h5 id="_put_meshresourceusagereports">Put meshResourceUsageReports</h5>
20392046
</div>
20402047
<div id="footer">
20412048
<div id="footer-text">
2042-
Last updated 2025-01-08 08:40:45 UTC
2049+
Last updated 2025-01-15 14:00:43 UTC
20432050
</div>
20442051
</div>
20452052
</body>

website/static/billing-api/mesh_resource_usage_report.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,7 @@ <h5 id="_put_meshresourceusagereports">Put meshResourceUsageReports</h5>
716716
</div>
717717
<div id="footer">
718718
<div id="footer-text">
719-
Last updated 2025-01-08 08:40:45 UTC
719+
Last updated 2025-01-15 14:00:43 UTC
720720
</div>
721721
</div>
722722
</body>

website/static/billing-api/mesh_tenant_usage_reports.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -642,7 +642,7 @@ <h5 id="_list_meshtenantusagereports">List meshTenantUsageReports</h5>
642642
"reportCategory" : "BILLING",
643643
"platformType" : "Azure",
644644
"platform" : "azure.prod",
645-
"platformTenantId" : "7f8a4a09-dd69-40d9-b796-e309ce5d2489",
645+
"platformTenantId" : "02ad42b1-4030-487e-b4d8-4c6d68795461",
646646
"version" : 2
647647
},
648648
"status" : {
@@ -693,7 +693,7 @@ <h5 id="_list_meshtenantusagereports">List meshTenantUsageReports</h5>
693693
"reportCategory" : "BILLING",
694694
"platformType" : "Azure",
695695
"platform" : "azure.prod",
696-
"platformTenantId" : "26baed78-1a35-47d4-9399-e3a2a4744078",
696+
"platformTenantId" : "f557461f-78d5-4a50-8335-eb6ba39197bf",
697697
"version" : 1
698698
},
699699
"status" : {
@@ -1021,7 +1021,7 @@ <h5 id="_get_meshtenantusagereport">Get meshTenantUsageReport</h5>
10211021
"reportCategory" : "BILLING",
10221022
"platformType" : "Azure",
10231023
"platform" : "azure.prod",
1024-
"platformTenantId" : "7f8a4a09-dd69-40d9-b796-e309ce5d2489",
1024+
"platformTenantId" : "02ad42b1-4030-487e-b4d8-4c6d68795461",
10251025
"version" : 2
10261026
},
10271027
"status" : {
@@ -1066,7 +1066,7 @@ <h5 id="_get_meshtenantusagereport">Get meshTenantUsageReport</h5>
10661066
</div>
10671067
<div id="footer">
10681068
<div id="footer-text">
1069-
Last updated 2025-01-08 08:40:45 UTC
1069+
Last updated 2025-01-15 14:00:43 UTC
10701070
</div>
10711071
</div>
10721072
</body>

0 commit comments

Comments
 (0)