Skip to content

Commit 30f582c

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 545fcb3 commit 30f582c

13 files changed

+288
-385
lines changed

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

+1-1
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-04-09 12:06:25 UTC
562+
Last updated 2025-04-16 12:43:45 UTC
563563
</div>
564564
</div>
565565
</body>

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

+1-1
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-04-09 12:06:25 UTC
522+
Last updated 2025-04-16 12:43:45 UTC
523523
</div>
524524
</div>
525525
</body>

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

+69-110
Original file line numberDiff line numberDiff line change
@@ -1099,16 +1099,16 @@ <h3 id="mesh_objects"><a class="link" href="#mesh_objects">meshObjects</a></h3>
10991099
Expires: 0
11001100
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
11011101
X-Frame-Options: DENY
1102-
Content-Length: 673
1102+
Content-Length: 666
11031103

11041104
{
11051105
"_links" : {
1106-
"meshtenantusagereports" : {
1107-
"href" : "https://mesh-billing-url/api/meshobjects/meshtenantusagereports{?ownedByWorkspace,ownedByProject,isManaged,platform,platformType,platformTenantId,period,reportCategory,paymentMethodIdentifier,meshTenantId,finalizedAfter,cancelledAfter,status,showCancelled,sort}",
1106+
"meshchargebacks" : {
1107+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized,finalizedSince,cancelledSince}",
11081108
"templated" : true
11091109
},
1110-
"meshchargebacks" : {
1111-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized,legacy,finalizedSince,cancelledSince}",
1110+
"meshtenantusagereports" : {
1111+
"href" : "https://mesh-billing-url/api/meshobjects/meshtenantusagereports{?ownedByWorkspace,ownedByProject,isManaged,platform,platformType,platformTenantId,period,reportCategory,paymentMethodIdentifier,meshTenantId,finalizedAfter,cancelledAfter,status,showCancelled,sort}",
11121112
"templated" : true
11131113
},
11141114
"self" : {
@@ -1320,7 +1320,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
13201320
"reportCategory" : "BILLING",
13211321
"platformType" : "Azure",
13221322
"platform" : "azure.prod",
1323-
"platformTenantId" : "3ce47185-bb38-4da7-99eb-cb69e72c65dd",
1323+
"platformTenantId" : "b2214ee2-910b-4fde-b6a6-7c68b2d95304",
13241324
"version" : 2
13251325
},
13261326
"status" : {
@@ -1371,7 +1371,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
13711371
"reportCategory" : "BILLING",
13721372
"platformType" : "Azure",
13731373
"platform" : "azure.prod",
1374-
"platformTenantId" : "ff73e596-f784-4984-bad6-c99507cc30ad",
1374+
"platformTenantId" : "cab5bcad-6598-4e32-a7e3-cdf45a9bff13",
13751375
"version" : 1
13761376
},
13771377
"status" : {
@@ -1699,7 +1699,7 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
16991699
"reportCategory" : "BILLING",
17001700
"platformType" : "Azure",
17011701
"platform" : "azure.prod",
1702-
"platformTenantId" : "3ce47185-bb38-4da7-99eb-cb69e72c65dd",
1702+
"platformTenantId" : "b2214ee2-910b-4fde-b6a6-7c68b2d95304",
17031703
"version" : 2
17041704
},
17051705
"status" : {
@@ -1898,102 +1898,58 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
18981898
Expires: 0
18991899
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
19001900
X-Frame-Options: DENY
1901-
Content-Length: 3377
1901+
Content-Length: 1984
19021902

19031903
{
19041904
"_embedded" : {
19051905
"meshChargebacks" : [ {
19061906
"kind" : "meshChargeback",
19071907
"apiVersion" : "v3",
19081908
"metadata" : {
1909-
"name" : "2025-04-01Z/testPartner:testWorkspace:testProject",
1910-
"createdOn" : "2025-04-09T12:08:16.210065300Z",
1911-
"finalized" : true
1909+
"name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
1910+
"createdOn" : "2025-03-02T00:00:00Z",
1911+
"finalized" : true,
1912+
"finalizationDate" : "2025-03-02T00:00:00Z",
1913+
"version" : 1
19121914
},
19131915
"spec" : {
19141916
"projectIdentifier" : "testProject",
1915-
"period" : "2025-04-01Z",
1917+
"period" : "2025-02-01Z",
19161918
"tags" : {
19171919
"paymentIdentifier" : [ "123" ]
19181920
},
19191921
"workspaceIdentifier" : "testWorkspace"
19201922
},
19211923
"status" : {
19221924
"timeframe" : {
1923-
"from" : "2025-04-01T00:00:00Z",
1924-
"to" : "2025-05-01T00:00:00Z"
1925+
"from" : "2025-02-01T00:00:00Z",
1926+
"to" : "2025-03-01T00:00:00Z"
19251927
},
19261928
"lineItems" : [ {
19271929
"reportCategory" : "BILLING",
1928-
"platformTenantId" : "test1-localProjectId",
1929-
"platformFullIdentifier" : "test1-instance.test1-location",
1930-
"reportId" : "test1-reportId",
1931-
"entryDate" : "2019-08-03T00:07:01.289Z",
1932-
"period" : "2019-07-01Z",
1930+
"platformTenantId" : "test1-id",
1931+
"platformFullIdentifier" : "test1-platform.location",
1932+
"reportId" : "TenantUsageReports/test1-platform.location:test1-id:2025-02-01Z:1",
1933+
"entryDate" : "2025-03-02T00:00:00Z",
1934+
"period" : "2025-02-01Z",
19331935
"netAmount" : 1.65,
1934-
"baseNetAmount" : 1.65,
1935-
"baseCurrency" : "EUR",
1936-
"exchangeRate" : 1,
1937-
"currency" : "EUR",
1938-
"sellerId" : "Operations",
1939-
"sellerProductGroup" : "Platform Team"
1940-
}, {
1941-
"reportCategory" : "BILLING",
1942-
"platformTenantId" : "test2-localProjectId",
1943-
"platformFullIdentifier" : "test2-instance.test2-location",
1944-
"reportId" : "test2-reportId",
1945-
"entryDate" : "2019-08-03T00:07:01.289Z",
1946-
"period" : "2019-07-01Z",
1947-
"netAmount" : 3.12,
1948-
"baseNetAmount" : 3.12,
1936+
"baseNetAmount" : 1.815,
19491937
"baseCurrency" : "EUR",
1950-
"exchangeRate" : 1,
1951-
"currency" : "EUR",
1938+
"exchangeRate" : 1.1,
1939+
"currency" : "USD",
19521940
"sellerId" : "Operations",
19531941
"sellerProductGroup" : "Platform Team"
19541942
} ],
19551943
"netAmounts" : [ {
1956-
"currency" : "EUR",
1957-
"amount" : 4.77,
1958-
"baseCurrency" : "EUR",
1959-
"baseNetAmount" : 4.77
1960-
} ]
1961-
},
1962-
"_links" : {
1963-
"self" : {
1964-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-04-01Z/testPartner%3AtestWorkspace%3AtestProject"
1965-
}
1966-
}
1967-
}, {
1968-
"kind" : "meshChargeback",
1969-
"apiVersion" : "v3",
1970-
"metadata" : {
1971-
"name" : "2025-03-01Z/testPartner:testWorkspace:testProject",
1972-
"createdOn" : "2025-04-09T12:08:16.210990500Z",
1973-
"finalized" : true
1974-
},
1975-
"spec" : {
1976-
"projectIdentifier" : "testProject",
1977-
"period" : "2025-03-01Z",
1978-
"tags" : { },
1979-
"workspaceIdentifier" : "testWorkspace"
1980-
},
1981-
"status" : {
1982-
"timeframe" : {
1983-
"from" : "2025-03-01T00:00:00Z",
1984-
"to" : "2025-04-01T00:00:00Z"
1985-
},
1986-
"lineItems" : [ ],
1987-
"netAmounts" : [ {
1988-
"currency" : "EUR",
1989-
"amount" : 0,
1944+
"currency" : "USD",
1945+
"amount" : 1.65,
19901946
"baseCurrency" : "EUR",
1991-
"baseNetAmount" : 0
1947+
"baseNetAmount" : 1.815
19921948
} ]
19931949
},
19941950
"_links" : {
19951951
"self" : {
1996-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-03-01Z/testPartner%3AtestWorkspace%3AtestProject"
1952+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject%3A1"
19971953
}
19981954
}
19991955
} ]
@@ -2005,7 +1961,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
20051961
},
20061962
"page" : {
20071963
"size" : 10,
2008-
"totalElements" : 2,
1964+
"totalElements" : 1,
20091965
"totalPages" : 1,
20101966
"number" : 0
20111967
}
@@ -2040,7 +1996,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
20401996
<div class="listingblock">
20411997
<div class="title">Example Request</div>
20421998
<div class="content">
2043-
<pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">GET /api/meshobjects/meshchargebacks/2025-04-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
1999+
<pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">GET /api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%253AtestWorkspace%253AtestProject%253A1 HTTP/1.1
20442000
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
20452001
Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json
20462002
Host: mesh-billing-url</code></pre>
@@ -2049,7 +2005,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
20492005
<div class="listingblock">
20502006
<div class="title">Example Curl Request</div>
20512007
<div class="content">
2052-
<pre class="highlightjs highlight"><code data-lang="bash" class="language-bash hljs">$ curl 'https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-04-01Z/testPartner%253AtestWorkspace%253AtestProject' -i -u 'valid_username:valid_password' -X GET \
2008+
<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%253A1' -i -u 'valid_username:valid_password' -X GET \
20532009
-H 'Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json'</code></pre>
20542010
</div>
20552011
</div>
@@ -2099,6 +2055,21 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
20992055
<td class="tableblock halign-left valign-top"><p class="tableblock">Finalization state of the meshChargeback. Value is 'true' for finalized and 'false' for preview meshChargebacks.</p></td>
21002056
</tr>
21012057
<tr>
2058+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.finalizationDate</code></p></td>
2059+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
2060+
<td class="tableblock halign-left valign-top"><p class="tableblock">The date when the meshChargeback was finalized. Can be null in case of preview meshChargebacks.</p></td>
2061+
</tr>
2062+
<tr>
2063+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.cancellationDate</code></p></td>
2064+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
2065+
<td class="tableblock halign-left valign-top"><p class="tableblock">If an update to an already finalized meshChargeback comes in, the old meshChargeback gets cancelled. The cancellationDate provides the date at which this cancellation happened.</p></td>
2066+
</tr>
2067+
<tr>
2068+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.version</code></p></td>
2069+
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
2070+
<td class="tableblock halign-left valign-top"><p class="tableblock">If an update to an already finalized meshChargeback comes in, the old meshChargeback gets cancelled and a new meshChargeback is created. The version is incremented in that case. For an initial or a preview meshChargeback, the version is 1.</p></td>
2071+
</tr>
2072+
<tr>
21022073
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec</code></p></td>
21032074
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Object</code></p></td>
21042075
<td class="tableblock halign-left valign-top"><p class="tableblock">All fields in this section describe the meshChargeback.</p></td>
@@ -2255,68 +2226,56 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
22552226
Expires: 0
22562227
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
22572228
X-Frame-Options: DENY
2258-
Content-Length: 1852
2229+
Content-Length: 1452
22592230

22602231
{
22612232
"kind" : "meshChargeback",
22622233
"apiVersion" : "v3",
22632234
"metadata" : {
2264-
"name" : "2025-04-01Z/testPartner:testWorkspace:testProject",
2265-
"createdOn" : "2025-04-09T12:08:16.210065300Z",
2266-
"finalized" : true
2235+
"name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
2236+
"createdOn" : "2025-03-02T00:00:00Z",
2237+
"finalized" : true,
2238+
"finalizationDate" : "2025-03-02T00:00:00Z",
2239+
"version" : 1
22672240
},
22682241
"spec" : {
22692242
"projectIdentifier" : "testProject",
2270-
"period" : "2025-04-01Z",
2243+
"period" : "2025-02-01Z",
22712244
"tags" : {
22722245
"paymentIdentifier" : [ "123" ]
22732246
},
22742247
"workspaceIdentifier" : "testWorkspace"
22752248
},
22762249
"status" : {
22772250
"timeframe" : {
2278-
"from" : "2025-04-01T00:00:00Z",
2279-
"to" : "2025-05-01T00:00:00Z"
2251+
"from" : "2025-02-01T00:00:00Z",
2252+
"to" : "2025-03-01T00:00:00Z"
22802253
},
22812254
"lineItems" : [ {
22822255
"reportCategory" : "BILLING",
2283-
"platformTenantId" : "test1-localProjectId",
2284-
"platformFullIdentifier" : "test1-instance.test1-location",
2285-
"reportId" : "test1-reportId",
2286-
"entryDate" : "2019-08-03T00:07:01.289Z",
2287-
"period" : "2019-07-01Z",
2256+
"platformTenantId" : "test1-id",
2257+
"platformFullIdentifier" : "test1-platform.location",
2258+
"reportId" : "TenantUsageReports/test1-platform.location:test1-id:2025-02-01Z:1",
2259+
"entryDate" : "2025-03-02T00:00:00Z",
2260+
"period" : "2025-02-01Z",
22882261
"netAmount" : 1.65,
2289-
"baseNetAmount" : 1.65,
2290-
"baseCurrency" : "EUR",
2291-
"exchangeRate" : 1,
2292-
"currency" : "EUR",
2293-
"sellerId" : "Operations",
2294-
"sellerProductGroup" : "Platform Team"
2295-
}, {
2296-
"reportCategory" : "BILLING",
2297-
"platformTenantId" : "test2-localProjectId",
2298-
"platformFullIdentifier" : "test2-instance.test2-location",
2299-
"reportId" : "test2-reportId",
2300-
"entryDate" : "2019-08-03T00:07:01.289Z",
2301-
"period" : "2019-07-01Z",
2302-
"netAmount" : 3.12,
2303-
"baseNetAmount" : 3.12,
2262+
"baseNetAmount" : 1.815,
23042263
"baseCurrency" : "EUR",
2305-
"exchangeRate" : 1,
2306-
"currency" : "EUR",
2264+
"exchangeRate" : 1.1,
2265+
"currency" : "USD",
23072266
"sellerId" : "Operations",
23082267
"sellerProductGroup" : "Platform Team"
23092268
} ],
23102269
"netAmounts" : [ {
2311-
"currency" : "EUR",
2312-
"amount" : 4.77,
2270+
"currency" : "USD",
2271+
"amount" : 1.65,
23132272
"baseCurrency" : "EUR",
2314-
"baseNetAmount" : 4.77
2273+
"baseNetAmount" : 1.815
23152274
} ]
23162275
},
23172276
"_links" : {
23182277
"self" : {
2319-
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-04-01Z/testPartner%3AtestWorkspace%3AtestProject"
2278+
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject%3A1"
23202279
}
23212280
}
23222281
}</code></pre>
@@ -2603,7 +2562,7 @@ <h5 id="_put_meshresourceusagereports"><a class="link" href="#_put_meshresourceu
26032562
</div>
26042563
<div id="footer">
26052564
<div id="footer-text">
2606-
Last updated 2025-04-09 12:06:25 UTC
2565+
Last updated 2025-04-16 12:43:45 UTC
26072566
</div>
26082567
</div>
26092568
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">

0 commit comments

Comments
 (0)