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

Commit 775cdb1

Browse files
github-merge-queue[bot]sttomm
github-merge-queue[bot]
authored and
sttomm
committed
docs: update meshStack API docs from latest develop build
1 parent 4bf5317 commit 775cdb1

13 files changed

+144
-144
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-29 13:37:32 UTC
562+
Last updated 2025-02-05 14:30:13 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-29 13:37:32 UTC
522+
Last updated 2025-02-05 14:30:13 UTC
523523
</div>
524524
</div>
525525
</body>

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

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

10491049
{
10501050
"_links" : {
1051-
"meshtenantusagereports" : {
1052-
"href" : "https://mesh-billing-url/api/meshobjects/meshtenantusagereports{?ownedByWorkspace,ownedByProject,isManaged,platform,platformType,platformTenantId,period,reportCategory,paymentMethodIdentifier,meshTenantId,finalizedAfter,cancelledAfter,status,showCancelled,sort}",
1053-
"templated" : true
1054-
},
10551051
"meshchargebacks" : {
10561052
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized,legacy,finalizedSince,cancelledSince}",
10571053
"templated" : true
10581054
},
1055+
"meshtenantusagereports" : {
1056+
"href" : "https://mesh-billing-url/api/meshobjects/meshtenantusagereports{?ownedByWorkspace,ownedByProject,isManaged,platform,platformType,platformTenantId,period,reportCategory,paymentMethodIdentifier,meshTenantId,finalizedAfter,cancelledAfter,status,showCancelled,sort}",
1057+
"templated" : true
1058+
},
10591059
"self" : {
10601060
"href" : "https://mesh-billing-url/api/meshobjects"
10611061
}
@@ -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" : "26911025-b14f-4fe5-8aa5-1c7d4dedab64",
1268+
"platformTenantId" : "567873fb-2a8d-4144-b2b9-26e5594f04cc",
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" : "235fdeb9-bb47-494b-88ba-f87a14aaf570",
1319+
"platformTenantId" : "04a07269-ff56-4628-9727-424d9273fdac",
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" : "26911025-b14f-4fe5-8aa5-1c7d4dedab64",
1647+
"platformTenantId" : "567873fb-2a8d-4144-b2b9-26e5594f04cc",
16481648
"version" : 2
16491649
},
16501650
"status" : {
@@ -1843,30 +1843,30 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
18431843
Expires: 0
18441844
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
18451845
X-Frame-Options: DENY
1846-
Content-Length: 3374
1846+
Content-Length: 3377
18471847

18481848
{
18491849
"_embedded" : {
18501850
"meshChargebacks" : [ {
18511851
"kind" : "meshChargeback",
18521852
"apiVersion" : "v3",
18531853
"metadata" : {
1854-
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
1855-
"createdOn" : "2025-01-29T13:38:58.602826Z",
1854+
"name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
1855+
"createdOn" : "2025-02-05T14:31:35.464930400Z",
18561856
"finalized" : true
18571857
},
18581858
"spec" : {
18591859
"projectIdentifier" : "testProject",
1860-
"period" : "2025-01-01Z",
1860+
"period" : "2025-02-01Z",
18611861
"tags" : {
18621862
"paymentIdentifier" : [ "123" ]
18631863
},
18641864
"workspaceIdentifier" : "testWorkspace"
18651865
},
18661866
"status" : {
18671867
"timeframe" : {
1868-
"from" : "2025-01-01T00:00:00Z",
1869-
"to" : "2025-02-01T00:00:00Z"
1868+
"from" : "2025-02-01T00:00:00Z",
1869+
"to" : "2025-03-01T00:00:00Z"
18701870
},
18711871
"lineItems" : [ {
18721872
"reportCategory" : "BILLING",
@@ -1906,27 +1906,27 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
19061906
},
19071907
"_links" : {
19081908
"self" : {
1909-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
1909+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject"
19101910
}
19111911
}
19121912
}, {
19131913
"kind" : "meshChargeback",
19141914
"apiVersion" : "v3",
19151915
"metadata" : {
1916-
"name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
1917-
"createdOn" : "2025-01-29T13:38:58.603682500Z",
1916+
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
1917+
"createdOn" : "2025-02-05T14:31:35.465963100Z",
19181918
"finalized" : true
19191919
},
19201920
"spec" : {
19211921
"projectIdentifier" : "testProject",
1922-
"period" : "2024-12-01Z",
1922+
"period" : "2025-01-01Z",
19231923
"tags" : { },
19241924
"workspaceIdentifier" : "testWorkspace"
19251925
},
19261926
"status" : {
19271927
"timeframe" : {
1928-
"from" : "2024-12-01T00:00:00Z",
1929-
"to" : "2025-01-01T00:00:00Z"
1928+
"from" : "2025-01-01T00:00:00Z",
1929+
"to" : "2025-02-01T00:00:00Z"
19301930
},
19311931
"lineItems" : [ ],
19321932
"netAmounts" : [ {
@@ -1938,7 +1938,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
19381938
},
19391939
"_links" : {
19401940
"self" : {
1941-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-12-01Z/testPartner%3AtestWorkspace%3AtestProject"
1941+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
19421942
}
19431943
}
19441944
} ]
@@ -1985,7 +1985,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
19851985
<div class="listingblock">
19861986
<div class="title">Example Request</div>
19871987
<div class="content">
1988-
<pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">GET /api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
1988+
<pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">GET /api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
19891989
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
19901990
Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json
19911991
Host: mesh-billing-url</code></pre>
@@ -1994,7 +1994,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
19941994
<div class="listingblock">
19951995
<div class="title">Example Curl Request</div>
19961996
<div class="content">
1997-
<pre class="highlightjs highlight"><code data-lang="bash" class="language-bash hljs">$ curl 'https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%253AtestWorkspace%253AtestProject' -i -u 'valid_username:valid_password' -X GET \
1997+
<pre class="highlightjs highlight"><code data-lang="bash" class="language-bash hljs">$ curl 'https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%253AtestWorkspace%253AtestProject' -i -u 'valid_username:valid_password' -X GET \
19981998
-H 'Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json'</code></pre>
19991999
</div>
20002000
</div>
@@ -2200,28 +2200,28 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
22002200
Expires: 0
22012201
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
22022202
X-Frame-Options: DENY
2203-
Content-Length: 1849
2203+
Content-Length: 1852
22042204

22052205
{
22062206
"kind" : "meshChargeback",
22072207
"apiVersion" : "v3",
22082208
"metadata" : {
2209-
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
2210-
"createdOn" : "2025-01-29T13:38:58.602826Z",
2209+
"name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
2210+
"createdOn" : "2025-02-05T14:31:35.464930400Z",
22112211
"finalized" : true
22122212
},
22132213
"spec" : {
22142214
"projectIdentifier" : "testProject",
2215-
"period" : "2025-01-01Z",
2215+
"period" : "2025-02-01Z",
22162216
"tags" : {
22172217
"paymentIdentifier" : [ "123" ]
22182218
},
22192219
"workspaceIdentifier" : "testWorkspace"
22202220
},
22212221
"status" : {
22222222
"timeframe" : {
2223-
"from" : "2025-01-01T00:00:00Z",
2224-
"to" : "2025-02-01T00:00:00Z"
2223+
"from" : "2025-02-01T00:00:00Z",
2224+
"to" : "2025-03-01T00:00:00Z"
22252225
},
22262226
"lineItems" : [ {
22272227
"reportCategory" : "BILLING",
@@ -2261,7 +2261,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
22612261
},
22622262
"_links" : {
22632263
"self" : {
2264-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
2264+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject"
22652265
}
22662266
}
22672267
}</code></pre>
@@ -2548,7 +2548,7 @@ <h5 id="_put_meshresourceusagereports"><a class="link" href="#_put_meshresourceu
25482548
</div>
25492549
<div id="footer">
25502550
<div id="footer-text">
2551-
Last updated 2025-01-29 13:37:32 UTC
2551+
Last updated 2025-02-05 14:30:13 UTC
25522552
</div>
25532553
</div>
25542554
<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: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -597,30 +597,30 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
597597
Expires: 0
598598
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
599599
X-Frame-Options: DENY
600-
Content-Length: 3374
600+
Content-Length: 3377
601601

602602
{
603603
"_embedded" : {
604604
"meshChargebacks" : [ {
605605
"kind" : "meshChargeback",
606606
"apiVersion" : "v3",
607607
"metadata" : {
608-
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
609-
"createdOn" : "2025-01-29T13:38:58.602826Z",
608+
"name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
609+
"createdOn" : "2025-02-05T14:31:35.464930400Z",
610610
"finalized" : true
611611
},
612612
"spec" : {
613613
"projectIdentifier" : "testProject",
614-
"period" : "2025-01-01Z",
614+
"period" : "2025-02-01Z",
615615
"tags" : {
616616
"paymentIdentifier" : [ "123" ]
617617
},
618618
"workspaceIdentifier" : "testWorkspace"
619619
},
620620
"status" : {
621621
"timeframe" : {
622-
"from" : "2025-01-01T00:00:00Z",
623-
"to" : "2025-02-01T00:00:00Z"
622+
"from" : "2025-02-01T00:00:00Z",
623+
"to" : "2025-03-01T00:00:00Z"
624624
},
625625
"lineItems" : [ {
626626
"reportCategory" : "BILLING",
@@ -660,27 +660,27 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
660660
},
661661
"_links" : {
662662
"self" : {
663-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
663+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject"
664664
}
665665
}
666666
}, {
667667
"kind" : "meshChargeback",
668668
"apiVersion" : "v3",
669669
"metadata" : {
670-
"name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
671-
"createdOn" : "2025-01-29T13:38:58.603682500Z",
670+
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
671+
"createdOn" : "2025-02-05T14:31:35.465963100Z",
672672
"finalized" : true
673673
},
674674
"spec" : {
675675
"projectIdentifier" : "testProject",
676-
"period" : "2024-12-01Z",
676+
"period" : "2025-01-01Z",
677677
"tags" : { },
678678
"workspaceIdentifier" : "testWorkspace"
679679
},
680680
"status" : {
681681
"timeframe" : {
682-
"from" : "2024-12-01T00:00:00Z",
683-
"to" : "2025-01-01T00:00:00Z"
682+
"from" : "2025-01-01T00:00:00Z",
683+
"to" : "2025-02-01T00:00:00Z"
684684
},
685685
"lineItems" : [ ],
686686
"netAmounts" : [ {
@@ -692,7 +692,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
692692
},
693693
"_links" : {
694694
"self" : {
695-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-12-01Z/testPartner%3AtestWorkspace%3AtestProject"
695+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
696696
}
697697
}
698698
} ]
@@ -739,7 +739,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
739739
<div class="listingblock">
740740
<div class="title">Example Request</div>
741741
<div class="content">
742-
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
742+
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
743743
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
744744
Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json
745745
Host: mesh-billing-url</code></pre>
@@ -748,7 +748,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
748748
<div class="listingblock">
749749
<div class="title">Example Curl Request</div>
750750
<div class="content">
751-
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%253AtestWorkspace%253AtestProject' -i -u 'valid_username:valid_password' -X GET \
751+
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%253AtestWorkspace%253AtestProject' -i -u 'valid_username:valid_password' -X GET \
752752
-H 'Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json'</code></pre>
753753
</div>
754754
</div>
@@ -954,28 +954,28 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
954954
Expires: 0
955955
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
956956
X-Frame-Options: DENY
957-
Content-Length: 1849
957+
Content-Length: 1852
958958

959959
{
960960
"kind" : "meshChargeback",
961961
"apiVersion" : "v3",
962962
"metadata" : {
963-
"name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
964-
"createdOn" : "2025-01-29T13:38:58.602826Z",
963+
"name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
964+
"createdOn" : "2025-02-05T14:31:35.464930400Z",
965965
"finalized" : true
966966
},
967967
"spec" : {
968968
"projectIdentifier" : "testProject",
969-
"period" : "2025-01-01Z",
969+
"period" : "2025-02-01Z",
970970
"tags" : {
971971
"paymentIdentifier" : [ "123" ]
972972
},
973973
"workspaceIdentifier" : "testWorkspace"
974974
},
975975
"status" : {
976976
"timeframe" : {
977-
"from" : "2025-01-01T00:00:00Z",
978-
"to" : "2025-02-01T00:00:00Z"
977+
"from" : "2025-02-01T00:00:00Z",
978+
"to" : "2025-03-01T00:00:00Z"
979979
},
980980
"lineItems" : [ {
981981
"reportCategory" : "BILLING",
@@ -1015,7 +1015,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
10151015
},
10161016
"_links" : {
10171017
"self" : {
1018-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
1018+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject"
10191019
}
10201020
}
10211021
}</code></pre>
@@ -1026,7 +1026,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
10261026
</div>
10271027
<div id="footer">
10281028
<div id="footer-text">
1029-
Last updated 2025-01-29 13:37:32 UTC
1029+
Last updated 2025-02-05 14:30:13 UTC
10301030
</div>
10311031
</div>
10321032
</body>

0 commit comments

Comments
 (0)