Skip to content

[Kraken API Docs] update latest API docs #1051

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2025
Merged

[Kraken API Docs] update latest API docs #1051

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion website/static/billing-api/api_index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -559,7 +559,7 @@ <h3 id="_index">Index</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-04-09 12:06:25 UTC
Last updated 2025-04-16 13:39:55 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/billing-api/common_data_formats.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ <h3 id="paging">Paging</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-04-09 12:06:25 UTC
Last updated 2025-04-16 13:39:55 UTC
</div>
</div>
</body>
Expand Down
173 changes: 66 additions & 107 deletions website/static/billing-api/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1099,7 +1099,7 @@ <h3 id="mesh_objects"><a class="link" href="#mesh_objects">meshObjects</a></h3>
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 673
Content-Length: 666

{
"_links" : {
Expand All @@ -1108,7 +1108,7 @@ <h3 id="mesh_objects"><a class="link" href="#mesh_objects">meshObjects</a></h3>
"templated" : true
},
"meshchargebacks" : {
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized,legacy,finalizedSince,cancelledSince}",
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized,finalizedSince,cancelledSince}",
"templated" : true
},
"self" : {
Expand Down Expand Up @@ -1320,7 +1320,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
"reportCategory" : "BILLING",
"platformType" : "Azure",
"platform" : "azure.prod",
"platformTenantId" : "3ce47185-bb38-4da7-99eb-cb69e72c65dd",
"platformTenantId" : "9355ab83-23ea-472c-88a0-af2395f60b28",
"version" : 2
},
"status" : {
Expand Down Expand Up @@ -1371,7 +1371,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
"reportCategory" : "BILLING",
"platformType" : "Azure",
"platform" : "azure.prod",
"platformTenantId" : "ff73e596-f784-4984-bad6-c99507cc30ad",
"platformTenantId" : "88daa065-aff6-4ca3-be3b-e3fe9c5096a3",
"version" : 1
},
"status" : {
Expand Down Expand Up @@ -1699,7 +1699,7 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
"reportCategory" : "BILLING",
"platformType" : "Azure",
"platform" : "azure.prod",
"platformTenantId" : "3ce47185-bb38-4da7-99eb-cb69e72c65dd",
"platformTenantId" : "9355ab83-23ea-472c-88a0-af2395f60b28",
"version" : 2
},
"status" : {
Expand Down Expand Up @@ -1898,102 +1898,58 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 3377
Content-Length: 1984

{
"_embedded" : {
"meshChargebacks" : [ {
"kind" : "meshChargeback",
"apiVersion" : "v3",
"metadata" : {
"name" : "2025-04-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2025-04-09T12:08:16.210065300Z",
"finalized" : true
"name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2025-03-02T00:00:00Z",
"finalized" : true,
"finalizationDate" : "2025-03-02T00:00:00Z",
"version" : 1
},
"spec" : {
"projectIdentifier" : "testProject",
"period" : "2025-04-01Z",
"period" : "2025-02-01Z",
"tags" : {
"paymentIdentifier" : [ "123" ]
},
"workspaceIdentifier" : "testWorkspace"
},
"status" : {
"timeframe" : {
"from" : "2025-04-01T00:00:00Z",
"to" : "2025-05-01T00:00:00Z"
"from" : "2025-02-01T00:00:00Z",
"to" : "2025-03-01T00:00:00Z"
},
"lineItems" : [ {
"reportCategory" : "BILLING",
"platformTenantId" : "test1-localProjectId",
"platformFullIdentifier" : "test1-instance.test1-location",
"reportId" : "test1-reportId",
"entryDate" : "2019-08-03T00:07:01.289Z",
"period" : "2019-07-01Z",
"platformTenantId" : "test1-id",
"platformFullIdentifier" : "test1-platform.location",
"reportId" : "TenantUsageReports/test1-platform.location:test1-id:2025-02-01Z:1",
"entryDate" : "2025-03-02T00:00:00Z",
"period" : "2025-02-01Z",
"netAmount" : 1.65,
"baseNetAmount" : 1.65,
"baseCurrency" : "EUR",
"exchangeRate" : 1,
"currency" : "EUR",
"sellerId" : "Operations",
"sellerProductGroup" : "Platform Team"
}, {
"reportCategory" : "BILLING",
"platformTenantId" : "test2-localProjectId",
"platformFullIdentifier" : "test2-instance.test2-location",
"reportId" : "test2-reportId",
"entryDate" : "2019-08-03T00:07:01.289Z",
"period" : "2019-07-01Z",
"netAmount" : 3.12,
"baseNetAmount" : 3.12,
"baseNetAmount" : 1.815,
"baseCurrency" : "EUR",
"exchangeRate" : 1,
"currency" : "EUR",
"exchangeRate" : 1.1,
"currency" : "USD",
"sellerId" : "Operations",
"sellerProductGroup" : "Platform Team"
} ],
"netAmounts" : [ {
"currency" : "EUR",
"amount" : 4.77,
"baseCurrency" : "EUR",
"baseNetAmount" : 4.77
} ]
},
"_links" : {
"self" : {
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-04-01Z/testPartner%3AtestWorkspace%3AtestProject"
}
}
}, {
"kind" : "meshChargeback",
"apiVersion" : "v3",
"metadata" : {
"name" : "2025-03-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2025-04-09T12:08:16.210990500Z",
"finalized" : true
},
"spec" : {
"projectIdentifier" : "testProject",
"period" : "2025-03-01Z",
"tags" : { },
"workspaceIdentifier" : "testWorkspace"
},
"status" : {
"timeframe" : {
"from" : "2025-03-01T00:00:00Z",
"to" : "2025-04-01T00:00:00Z"
},
"lineItems" : [ ],
"netAmounts" : [ {
"currency" : "EUR",
"amount" : 0,
"currency" : "USD",
"amount" : 1.65,
"baseCurrency" : "EUR",
"baseNetAmount" : 0
"baseNetAmount" : 1.815
} ]
},
"_links" : {
"self" : {
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-03-01Z/testPartner%3AtestWorkspace%3AtestProject"
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject%3A1"
}
}
} ]
Expand All @@ -2005,7 +1961,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
},
"page" : {
"size" : 10,
"totalElements" : 2,
"totalElements" : 1,
"totalPages" : 1,
"number" : 0
}
Expand Down Expand Up @@ -2040,7 +1996,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
<div class="listingblock">
<div class="title">Example Request</div>
<div class="content">
<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
<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
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json
Host: mesh-billing-url</code></pre>
Expand All @@ -2049,7 +2005,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
<div class="listingblock">
<div class="title">Example Curl Request</div>
<div class="content">
<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 \
<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 \
-H 'Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json'</code></pre>
</div>
</div>
Expand Down Expand Up @@ -2099,6 +2055,21 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
<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>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.finalizationDate</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<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>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.cancellationDate</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<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>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.version</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Number</code></p></td>
<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>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">All fields in this section describe the meshChargeback.</p></td>
Expand Down Expand Up @@ -2255,68 +2226,56 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 1852
Content-Length: 1452

{
"kind" : "meshChargeback",
"apiVersion" : "v3",
"metadata" : {
"name" : "2025-04-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2025-04-09T12:08:16.210065300Z",
"finalized" : true
"name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2025-03-02T00:00:00Z",
"finalized" : true,
"finalizationDate" : "2025-03-02T00:00:00Z",
"version" : 1
},
"spec" : {
"projectIdentifier" : "testProject",
"period" : "2025-04-01Z",
"period" : "2025-02-01Z",
"tags" : {
"paymentIdentifier" : [ "123" ]
},
"workspaceIdentifier" : "testWorkspace"
},
"status" : {
"timeframe" : {
"from" : "2025-04-01T00:00:00Z",
"to" : "2025-05-01T00:00:00Z"
"from" : "2025-02-01T00:00:00Z",
"to" : "2025-03-01T00:00:00Z"
},
"lineItems" : [ {
"reportCategory" : "BILLING",
"platformTenantId" : "test1-localProjectId",
"platformFullIdentifier" : "test1-instance.test1-location",
"reportId" : "test1-reportId",
"entryDate" : "2019-08-03T00:07:01.289Z",
"period" : "2019-07-01Z",
"platformTenantId" : "test1-id",
"platformFullIdentifier" : "test1-platform.location",
"reportId" : "TenantUsageReports/test1-platform.location:test1-id:2025-02-01Z:1",
"entryDate" : "2025-03-02T00:00:00Z",
"period" : "2025-02-01Z",
"netAmount" : 1.65,
"baseNetAmount" : 1.65,
"baseCurrency" : "EUR",
"exchangeRate" : 1,
"currency" : "EUR",
"sellerId" : "Operations",
"sellerProductGroup" : "Platform Team"
}, {
"reportCategory" : "BILLING",
"platformTenantId" : "test2-localProjectId",
"platformFullIdentifier" : "test2-instance.test2-location",
"reportId" : "test2-reportId",
"entryDate" : "2019-08-03T00:07:01.289Z",
"period" : "2019-07-01Z",
"netAmount" : 3.12,
"baseNetAmount" : 3.12,
"baseNetAmount" : 1.815,
"baseCurrency" : "EUR",
"exchangeRate" : 1,
"currency" : "EUR",
"exchangeRate" : 1.1,
"currency" : "USD",
"sellerId" : "Operations",
"sellerProductGroup" : "Platform Team"
} ],
"netAmounts" : [ {
"currency" : "EUR",
"amount" : 4.77,
"currency" : "USD",
"amount" : 1.65,
"baseCurrency" : "EUR",
"baseNetAmount" : 4.77
"baseNetAmount" : 1.815
} ]
},
"_links" : {
"self" : {
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-04-01Z/testPartner%3AtestWorkspace%3AtestProject"
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject%3A1"
}
}
}</code></pre>
Expand Down Expand Up @@ -2603,7 +2562,7 @@ <h5 id="_put_meshresourceusagereports"><a class="link" href="#_put_meshresourceu
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-04-09 12:06:25 UTC
Last updated 2025-04-16 13:39:55 UTC
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">
Expand Down
Loading
Loading