Skip to content

Commit

Permalink
docs: update meshStack API docs from latest develop build
Browse files Browse the repository at this point in the history
  • Loading branch information
github-merge-queue[bot] authored and tfelix committed Aug 1, 2024
1 parent dce1952 commit 5adc0c1
Show file tree
Hide file tree
Showing 13 changed files with 149 additions and 149 deletions.
2 changes: 1 addition & 1 deletion website/static/billing-api/api_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -567,7 +567,7 @@ <h3 id="_index">Index</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 12:32:20 UTC
Last updated 2024-08-01 11:22:52 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/billing-api/cloud-resources.html
Original file line number Diff line number Diff line change
Expand Up @@ -728,7 +728,7 @@ <h4 id="resources-getExternalCloudResources">getExternalCloudResources</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 12:32:20 UTC
Last updated 2024-08-01 11:22:52 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/billing-api/common_data_formats.html
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 2024-07-24 12:32:20 UTC
Last updated 2024-08-01 11:22:52 UTC
</div>
</div>
</body>
Expand Down
56 changes: 28 additions & 28 deletions website/static/billing-api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1241,7 +1241,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
"kind" : "meshTenantUsageReport",
"metadata" : {
"name" : "gcp1.gcp-ffm:project:2018-01-01Z",
"lastModified" : "2024-07-24T12:34:23.204005100Z",
"lastModified" : "2024-08-01T11:24:23.604971800Z",
"finalized" : true
},
"spec" : {
Expand All @@ -1254,8 +1254,8 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
"status" : {
"projectIdentifier" : "testProject",
"timeframe" : {
"from" : "2024-07-01T00:00:00Z",
"to" : "2024-08-01T00:00:00Z"
"from" : "2024-08-01T00:00:00Z",
"to" : "2024-09-01T00:00:00Z"
},
"netAmounts" : [ {
"currency" : "EUR",
Expand Down Expand Up @@ -1486,7 +1486,7 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
"kind" : "meshTenantUsageReport",
"metadata" : {
"name" : "gcp1.gcp-ffm:project:2018-01-01Z",
"lastModified" : "2024-07-24T12:34:23.204005100Z",
"lastModified" : "2024-08-01T11:24:23.604971800Z",
"finalized" : true
},
"spec" : {
Expand All @@ -1499,8 +1499,8 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
"status" : {
"projectIdentifier" : "testProject",
"timeframe" : {
"from" : "2024-07-01T00:00:00Z",
"to" : "2024-08-01T00:00:00Z"
"from" : "2024-08-01T00:00:00Z",
"to" : "2024-09-01T00:00:00Z"
},
"netAmounts" : [ {
"currency" : "EUR",
Expand Down Expand Up @@ -1664,30 +1664,30 @@ <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: 3374

{
"_embedded" : {
"meshChargebacks" : [ {
"apiVersion" : "v3",
"kind" : "meshChargeback",
"metadata" : {
"name" : "2024-07-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-07-24T12:34:21.345111200Z",
"name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-08-01T11:24:20.886902600Z",
"finalized" : true
},
"spec" : {
"projectIdentifier" : "testProject",
"period" : "2024-07-01Z",
"period" : "2024-08-01Z",
"tags" : {
"paymentIdentifier" : [ "123" ]
},
"workspaceIdentifier" : "testWorkspace"
},
"status" : {
"timeframe" : {
"from" : "2024-07-01T00:00:00Z",
"to" : "2024-08-01T00:00:00Z"
"from" : "2024-08-01T00:00:00Z",
"to" : "2024-09-01T00:00:00Z"
},
"lineItems" : [ {
"reportCategory" : "BILLING",
Expand Down Expand Up @@ -1727,27 +1727,27 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
},
"_links" : {
"self" : {
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-07-01Z/testPartner%3AtestWorkspace%3AtestProject"
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-08-01Z/testPartner%3AtestWorkspace%3AtestProject"
}
}
}, {
"apiVersion" : "v3",
"kind" : "meshChargeback",
"metadata" : {
"name" : "2024-06-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-07-24T12:34:21.347343100Z",
"name" : "2024-07-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-08-01T11:24:20.888950Z",
"finalized" : true
},
"spec" : {
"projectIdentifier" : "testProject",
"period" : "2024-06-01Z",
"period" : "2024-07-01Z",
"tags" : { },
"workspaceIdentifier" : "testWorkspace"
},
"status" : {
"timeframe" : {
"from" : "2024-06-01T00:00:00Z",
"to" : "2024-07-01T00:00:00Z"
"from" : "2024-07-01T00:00:00Z",
"to" : "2024-08-01T00:00:00Z"
},
"lineItems" : [ ],
"netAmounts" : [ {
Expand All @@ -1759,7 +1759,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
},
"_links" : {
"self" : {
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-06-01Z/testPartner%3AtestWorkspace%3AtestProject"
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-07-01Z/testPartner%3AtestWorkspace%3AtestProject"
}
}
} ]
Expand Down Expand Up @@ -1806,7 +1806,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/2024-07-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
<pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">GET /api/meshobjects/meshchargebacks/2024-08-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json
Host: mesh-billing-url</code></pre>
Expand All @@ -1815,7 +1815,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/2024-07-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/2024-08-01Z/testPartner%253AtestWorkspace%253AtestProject' -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 @@ -2027,22 +2027,22 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
"apiVersion" : "v3",
"kind" : "meshChargeback",
"metadata" : {
"name" : "2024-07-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-07-24T12:34:21.345111200Z",
"name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-08-01T11:24:20.886902600Z",
"finalized" : true
},
"spec" : {
"projectIdentifier" : "testProject",
"period" : "2024-07-01Z",
"period" : "2024-08-01Z",
"tags" : {
"paymentIdentifier" : [ "123" ]
},
"workspaceIdentifier" : "testWorkspace"
},
"status" : {
"timeframe" : {
"from" : "2024-07-01T00:00:00Z",
"to" : "2024-08-01T00:00:00Z"
"from" : "2024-08-01T00:00:00Z",
"to" : "2024-09-01T00:00:00Z"
},
"lineItems" : [ {
"reportCategory" : "BILLING",
Expand Down Expand Up @@ -2082,7 +2082,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
},
"_links" : {
"self" : {
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-07-01Z/testPartner%3AtestWorkspace%3AtestProject"
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-08-01Z/testPartner%3AtestWorkspace%3AtestProject"
}
}
}</code></pre>
Expand Down Expand Up @@ -2648,7 +2648,7 @@ <h4 id="resources-getExternalCloudResources"><a class="link" href="#resources-ge
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 12:32:20 UTC
Last updated 2024-08-01 11:22:52 UTC
</div>
</div>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">
Expand Down
44 changes: 22 additions & 22 deletions website/static/billing-api/mesh_chargeback.html
Original file line number Diff line number Diff line change
Expand Up @@ -584,30 +584,30 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 3377
Content-Length: 3374

{
"_embedded" : {
"meshChargebacks" : [ {
"apiVersion" : "v3",
"kind" : "meshChargeback",
"metadata" : {
"name" : "2024-07-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-07-24T12:34:21.345111200Z",
"name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-08-01T11:24:20.886902600Z",
"finalized" : true
},
"spec" : {
"projectIdentifier" : "testProject",
"period" : "2024-07-01Z",
"period" : "2024-08-01Z",
"tags" : {
"paymentIdentifier" : [ "123" ]
},
"workspaceIdentifier" : "testWorkspace"
},
"status" : {
"timeframe" : {
"from" : "2024-07-01T00:00:00Z",
"to" : "2024-08-01T00:00:00Z"
"from" : "2024-08-01T00:00:00Z",
"to" : "2024-09-01T00:00:00Z"
},
"lineItems" : [ {
"reportCategory" : "BILLING",
Expand Down Expand Up @@ -647,27 +647,27 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
},
"_links" : {
"self" : {
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-07-01Z/testPartner%3AtestWorkspace%3AtestProject"
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-08-01Z/testPartner%3AtestWorkspace%3AtestProject"
}
}
}, {
"apiVersion" : "v3",
"kind" : "meshChargeback",
"metadata" : {
"name" : "2024-06-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-07-24T12:34:21.347343100Z",
"name" : "2024-07-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-08-01T11:24:20.888950Z",
"finalized" : true
},
"spec" : {
"projectIdentifier" : "testProject",
"period" : "2024-06-01Z",
"period" : "2024-07-01Z",
"tags" : { },
"workspaceIdentifier" : "testWorkspace"
},
"status" : {
"timeframe" : {
"from" : "2024-06-01T00:00:00Z",
"to" : "2024-07-01T00:00:00Z"
"from" : "2024-07-01T00:00:00Z",
"to" : "2024-08-01T00:00:00Z"
},
"lineItems" : [ ],
"netAmounts" : [ {
Expand All @@ -679,7 +679,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
},
"_links" : {
"self" : {
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-06-01Z/testPartner%3AtestWorkspace%3AtestProject"
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-07-01Z/testPartner%3AtestWorkspace%3AtestProject"
}
}
} ]
Expand Down Expand Up @@ -726,7 +726,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
<div class="listingblock">
<div class="title">Example Request</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/meshobjects/meshchargebacks/2024-07-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/meshobjects/meshchargebacks/2024-08-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json
Host: mesh-billing-url</code></pre>
Expand All @@ -735,7 +735,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
<div class="listingblock">
<div class="title">Example Curl Request</div>
<div class="content">
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-07-01Z/testPartner%253AtestWorkspace%253AtestProject' -i -u 'valid_username:valid_password' -X GET \
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-08-01Z/testPartner%253AtestWorkspace%253AtestProject' -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 @@ -947,22 +947,22 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
"apiVersion" : "v3",
"kind" : "meshChargeback",
"metadata" : {
"name" : "2024-07-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-07-24T12:34:21.345111200Z",
"name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
"createdOn" : "2024-08-01T11:24:20.886902600Z",
"finalized" : true
},
"spec" : {
"projectIdentifier" : "testProject",
"period" : "2024-07-01Z",
"period" : "2024-08-01Z",
"tags" : {
"paymentIdentifier" : [ "123" ]
},
"workspaceIdentifier" : "testWorkspace"
},
"status" : {
"timeframe" : {
"from" : "2024-07-01T00:00:00Z",
"to" : "2024-08-01T00:00:00Z"
"from" : "2024-08-01T00:00:00Z",
"to" : "2024-09-01T00:00:00Z"
},
"lineItems" : [ {
"reportCategory" : "BILLING",
Expand Down Expand Up @@ -1002,7 +1002,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
},
"_links" : {
"self" : {
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-07-01Z/testPartner%3AtestWorkspace%3AtestProject"
"href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-08-01Z/testPartner%3AtestWorkspace%3AtestProject"
}
}
}</code></pre>
Expand All @@ -1013,7 +1013,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-07-24 12:32:20 UTC
Last updated 2024-08-01 11:22:52 UTC
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit 5adc0c1

Please sign in to comment.