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

Commit c322361

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 6eb68b7 commit c322361

14 files changed

+143
-143
lines changed

‎website/static/billing-api/api_index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,7 @@ <h3 id="_index">Index</h3>
567567
</div>
568568
<div id="footer">
569569
<div id="footer-text">
570-
Last updated 2024-10-30 17:46:59 UTC
570+
Last updated 2024-11-06 13:33:14 UTC
571571
</div>
572572
</div>
573573
</body>

‎website/static/billing-api/cloud-resources.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -707,18 +707,18 @@ <h4 id="resources-getExternalCloudResources">getExternalCloudResources</h4>
707707
"paged" : true,
708708
"unpaged" : false
709709
},
710+
"last" : true,
710711
"totalPages" : 1,
711712
"totalElements" : 1,
712-
"last" : true,
713713
"size" : 20,
714714
"number" : 0,
715715
"sort" : {
716716
"empty" : false,
717717
"sorted" : true,
718718
"unsorted" : false
719719
},
720-
"numberOfElements" : 1,
721720
"first" : true,
721+
"numberOfElements" : 1,
722722
"empty" : false
723723
}</code></pre>
724724
</div>
@@ -728,7 +728,7 @@ <h4 id="resources-getExternalCloudResources">getExternalCloudResources</h4>
728728
</div>
729729
<div id="footer">
730730
<div id="footer-text">
731-
Last updated 2024-10-30 17:46:59 UTC
731+
Last updated 2024-11-06 13:33:14 UTC
732732
</div>
733733
</div>
734734
</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 2024-10-30 17:46:59 UTC
522+
Last updated 2024-11-06 13:33:14 UTC
523523
</div>
524524
</div>
525525
</body>

‎website/static/billing-api/index.html‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1061,14 +1061,14 @@ <h3 id="mesh_objects"><a class="link" href="#mesh_objects">meshObjects</a></h3>
10611061

10621062
{
10631063
"_links" : {
1064-
"meshchargebacks" : {
1065-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized,legacy,finalizedSince,cancelledSince}",
1066-
"templated" : true
1067-
},
10681064
"meshtenantusagereports" : {
10691065
"href" : "https://mesh-billing-url/api/meshobjects/meshtenantusagereports{?workspaceIdentifier,projectIdentifier,platformFullIdentifier,period,reportCategory,paymentIdentifier}",
10701066
"templated" : true
10711067
},
1068+
"meshchargebacks" : {
1069+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized,legacy,finalizedSince,cancelledSince}",
1070+
"templated" : true
1071+
},
10721072
"self" : {
10731073
"href" : "https://mesh-billing-url/api/meshobjects"
10741074
}
@@ -1241,7 +1241,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
12411241
"apiVersion" : "v2",
12421242
"metadata" : {
12431243
"name" : "gcp1.gcp-ffm:project:2018-01-01Z",
1244-
"lastModified" : "2024-10-30T17:48:32.593083500Z",
1244+
"lastModified" : "2024-11-06T13:34:42.164566300Z",
12451245
"finalized" : true
12461246
},
12471247
"spec" : {
@@ -1254,8 +1254,8 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
12541254
"status" : {
12551255
"projectIdentifier" : "testProject",
12561256
"timeframe" : {
1257-
"from" : "2024-10-01T00:00:00Z",
1258-
"to" : "2024-11-01T00:00:00Z"
1257+
"from" : "2024-11-01T00:00:00Z",
1258+
"to" : "2024-12-01T00:00:00Z"
12591259
},
12601260
"netAmounts" : [ {
12611261
"currency" : "EUR",
@@ -1486,7 +1486,7 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
14861486
"apiVersion" : "v2",
14871487
"metadata" : {
14881488
"name" : "gcp1.gcp-ffm:project:2018-01-01Z",
1489-
"lastModified" : "2024-10-30T17:48:32.593083500Z",
1489+
"lastModified" : "2024-11-06T13:34:42.164566300Z",
14901490
"finalized" : true
14911491
},
14921492
"spec" : {
@@ -1499,8 +1499,8 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
14991499
"status" : {
15001500
"projectIdentifier" : "testProject",
15011501
"timeframe" : {
1502-
"from" : "2024-10-01T00:00:00Z",
1503-
"to" : "2024-11-01T00:00:00Z"
1502+
"from" : "2024-11-01T00:00:00Z",
1503+
"to" : "2024-12-01T00:00:00Z"
15041504
},
15051505
"netAmounts" : [ {
15061506
"currency" : "EUR",
@@ -1672,22 +1672,22 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
16721672
"kind" : "meshChargeback",
16731673
"apiVersion" : "v3",
16741674
"metadata" : {
1675-
"name" : "2024-10-01Z/testPartner:testWorkspace:testProject",
1676-
"createdOn" : "2024-10-30T17:48:30.578961200Z",
1675+
"name" : "2024-11-01Z/testPartner:testWorkspace:testProject",
1676+
"createdOn" : "2024-11-06T13:34:39.519450400Z",
16771677
"finalized" : true
16781678
},
16791679
"spec" : {
16801680
"projectIdentifier" : "testProject",
1681-
"period" : "2024-10-01Z",
1681+
"period" : "2024-11-01Z",
16821682
"tags" : {
16831683
"paymentIdentifier" : [ "123" ]
16841684
},
16851685
"workspaceIdentifier" : "testWorkspace"
16861686
},
16871687
"status" : {
16881688
"timeframe" : {
1689-
"from" : "2024-10-01T00:00:00Z",
1690-
"to" : "2024-11-01T00:00:00Z"
1689+
"from" : "2024-11-01T00:00:00Z",
1690+
"to" : "2024-12-01T00:00:00Z"
16911691
},
16921692
"lineItems" : [ {
16931693
"reportCategory" : "BILLING",
@@ -1727,27 +1727,27 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
17271727
},
17281728
"_links" : {
17291729
"self" : {
1730-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-10-01Z/testPartner%3AtestWorkspace%3AtestProject"
1730+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-11-01Z/testPartner%3AtestWorkspace%3AtestProject"
17311731
}
17321732
}
17331733
}, {
17341734
"kind" : "meshChargeback",
17351735
"apiVersion" : "v3",
17361736
"metadata" : {
1737-
"name" : "2024-09-01Z/testPartner:testWorkspace:testProject",
1738-
"createdOn" : "2024-10-30T17:48:30.580673200Z",
1737+
"name" : "2024-10-01Z/testPartner:testWorkspace:testProject",
1738+
"createdOn" : "2024-11-06T13:34:39.520904700Z",
17391739
"finalized" : true
17401740
},
17411741
"spec" : {
17421742
"projectIdentifier" : "testProject",
1743-
"period" : "2024-09-01Z",
1743+
"period" : "2024-10-01Z",
17441744
"tags" : { },
17451745
"workspaceIdentifier" : "testWorkspace"
17461746
},
17471747
"status" : {
17481748
"timeframe" : {
1749-
"from" : "2024-09-01T00:00:00Z",
1750-
"to" : "2024-10-01T00:00:00Z"
1749+
"from" : "2024-10-01T00:00:00Z",
1750+
"to" : "2024-11-01T00:00:00Z"
17511751
},
17521752
"lineItems" : [ ],
17531753
"netAmounts" : [ {
@@ -1759,7 +1759,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
17591759
},
17601760
"_links" : {
17611761
"self" : {
1762-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-09-01Z/testPartner%3AtestWorkspace%3AtestProject"
1762+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-10-01Z/testPartner%3AtestWorkspace%3AtestProject"
17631763
}
17641764
}
17651765
} ]
@@ -1806,7 +1806,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
18061806
<div class="listingblock">
18071807
<div class="title">Example Request</div>
18081808
<div class="content">
1809-
<pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">GET /api/meshobjects/meshchargebacks/2024-10-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
1809+
<pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">GET /api/meshobjects/meshchargebacks/2024-11-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
18101810
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
18111811
Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json
18121812
Host: mesh-billing-url</code></pre>
@@ -1815,7 +1815,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
18151815
<div class="listingblock">
18161816
<div class="title">Example Curl Request</div>
18171817
<div class="content">
1818-
<pre class="highlightjs highlight"><code data-lang="bash" class="language-bash hljs">$ curl 'https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-10-01Z/testPartner%253AtestWorkspace%253AtestProject' -i -u 'valid_username:valid_password' -X GET \
1818+
<pre class="highlightjs highlight"><code data-lang="bash" class="language-bash hljs">$ curl 'https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-11-01Z/testPartner%253AtestWorkspace%253AtestProject' -i -u 'valid_username:valid_password' -X GET \
18191819
-H 'Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json'</code></pre>
18201820
</div>
18211821
</div>
@@ -2027,22 +2027,22 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
20272027
"kind" : "meshChargeback",
20282028
"apiVersion" : "v3",
20292029
"metadata" : {
2030-
"name" : "2024-10-01Z/testPartner:testWorkspace:testProject",
2031-
"createdOn" : "2024-10-30T17:48:30.578961200Z",
2030+
"name" : "2024-11-01Z/testPartner:testWorkspace:testProject",
2031+
"createdOn" : "2024-11-06T13:34:39.519450400Z",
20322032
"finalized" : true
20332033
},
20342034
"spec" : {
20352035
"projectIdentifier" : "testProject",
2036-
"period" : "2024-10-01Z",
2036+
"period" : "2024-11-01Z",
20372037
"tags" : {
20382038
"paymentIdentifier" : [ "123" ]
20392039
},
20402040
"workspaceIdentifier" : "testWorkspace"
20412041
},
20422042
"status" : {
20432043
"timeframe" : {
2044-
"from" : "2024-10-01T00:00:00Z",
2045-
"to" : "2024-11-01T00:00:00Z"
2044+
"from" : "2024-11-01T00:00:00Z",
2045+
"to" : "2024-12-01T00:00:00Z"
20462046
},
20472047
"lineItems" : [ {
20482048
"reportCategory" : "BILLING",
@@ -2082,7 +2082,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
20822082
},
20832083
"_links" : {
20842084
"self" : {
2085-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-10-01Z/testPartner%3AtestWorkspace%3AtestProject"
2085+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-11-01Z/testPartner%3AtestWorkspace%3AtestProject"
20862086
}
20872087
}
20882088
}</code></pre>
@@ -2103,7 +2103,7 @@ <h5 id="_put_meshresourceusagereports"><a class="link" href="#_put_meshresourceu
21032103
meshTenantUsageReports.</p>
21042104
</div>
21052105
<table class="tableblock frame-all grid-all stretch">
2106-
<caption class="title">/api/meshobjects/meshresourceusagereports/{tenantIdentifier}/{period}</caption>
2106+
<caption class="title">/api/meshobjects/meshresourceusagereports/{platformTenantId}/{period}</caption>
21072107
<colgroup>
21082108
<col style="width: 50%;">
21092109
<col style="width: 50%;">
@@ -2116,8 +2116,8 @@ <h5 id="_put_meshresourceusagereports"><a class="link" href="#_put_meshresourceu
21162116
</thead>
21172117
<tbody>
21182118
<tr>
2119-
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>tenantIdentifier</code></p></td>
2120-
<td class="tableblock halign-left valign-top"><p class="tableblock">A unique identifier for the tenant causing the costs.</p></td>
2119+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>platformTenantId</code></p></td>
2120+
<td class="tableblock halign-left valign-top"><p class="tableblock">The Platform Tenant ID of the tenant causing the costs.</p></td>
21212121
</tr>
21222122
<tr>
21232123
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>period</code></p></td>
@@ -2631,18 +2631,18 @@ <h4 id="resources-getExternalCloudResources"><a class="link" href="#resources-ge
26312631
"paged" : true,
26322632
"unpaged" : false
26332633
},
2634+
"last" : true,
26342635
"totalPages" : 1,
26352636
"totalElements" : 1,
2636-
"last" : true,
26372637
"size" : 20,
26382638
"number" : 0,
26392639
"sort" : {
26402640
"empty" : false,
26412641
"sorted" : true,
26422642
"unsorted" : false
26432643
},
2644-
"numberOfElements" : 1,
26452644
"first" : true,
2645+
"numberOfElements" : 1,
26462646
"empty" : false
26472647
}</code></pre>
26482648
</div>
@@ -2654,7 +2654,7 @@ <h4 id="resources-getExternalCloudResources"><a class="link" href="#resources-ge
26542654
</div>
26552655
<div id="footer">
26562656
<div id="footer-text">
2657-
Last updated 2024-10-30 17:46:59 UTC
2657+
Last updated 2024-11-06 13:33:14 UTC
26582658
</div>
26592659
</div>
26602660
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">

0 commit comments

Comments
 (0)