docs: update meshStack API docs from latest develop build

meshcloud · Sep 5, 2024 · 73a85bc · 73a85bc
1 parent 8c58c01
commit 73a85bc
Show file tree

Hide file tree

Showing 13 changed files with 145 additions and 145 deletions.
diff --git a/website/static/billing-api/api_index.html b/website/static/billing-api/api_index.html
@@ -567,7 +567,7 @@ <h3 id="_index">Index</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-07 11:55:40 UTC
+Last updated 2024-09-05 09:23:02 UTC
 </div>
 </div>
 </body>

diff --git a/website/static/billing-api/cloud-resources.html b/website/static/billing-api/cloud-resources.html
@@ -728,7 +728,7 @@ <h4 id="resources-getExternalCloudResources">getExternalCloudResources</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-07 11:55:40 UTC
+Last updated 2024-09-05 09:23:02 UTC
 </div>
 </div>
 </body>

diff --git a/website/static/billing-api/common_data_formats.html b/website/static/billing-api/common_data_formats.html
@@ -519,7 +519,7 @@ <h3 id="paging">Paging</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-07 11:55:40 UTC
+Last updated 2024-09-05 09:23:02 UTC
 </div>
 </div>
 </body>

diff --git a/website/static/billing-api/index.html b/website/static/billing-api/index.html
@@ -1057,18 +1057,18 @@ <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: 541
+Content-Length: 578
 
 {
   "_links" : {
-    "meshchargebacks" : {
-      "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized}",
-      "templated" : true
-    },
     "meshtenantusagereports" : {
       "href" : "https://mesh-billing-url/api/meshobjects/meshtenantusagereports{?workspaceIdentifier,projectIdentifier,platformFullIdentifier,period,reportCategory,paymentIdentifier}",
       "templated" : true
     },
+    "meshchargebacks" : {
+      "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized,legacy,finalizedSince,cancelledSince}",
+      "templated" : true
+    },
     "self" : {
       "href" : "https://mesh-billing-url/api/meshobjects"
     }
@@ -1237,11 +1237,11 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
 {
   "_embedded" : {
     "meshTenantUsageReports" : [ {
-      "apiVersion" : "v2",
       "kind" : "meshTenantUsageReport",
+      "apiVersion" : "v2",
       "metadata" : {
         "name" : "gcp1.gcp-ffm:project:2018-01-01Z",
-        "lastModified" : "2024-08-07T11:57:20.584031600Z",
+        "lastModified" : "2024-09-05T09:24:28.969853800Z",
         "finalized" : true
       },
       "spec" : {
@@ -1254,8 +1254,8 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
       "status" : {
         "projectIdentifier" : "testProject",
         "timeframe" : {
-          "from" : "2024-08-01T00:00:00Z",
-          "to" : "2024-09-01T00:00:00Z"
+          "from" : "2024-09-01T00:00:00Z",
+          "to" : "2024-10-01T00:00:00Z"
         },
         "netAmounts" : [ {
           "currency" : "EUR",
@@ -1482,11 +1482,11 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
 Content-Length: 899
 
 {
-  "apiVersion" : "v2",
   "kind" : "meshTenantUsageReport",
+  "apiVersion" : "v2",
   "metadata" : {
     "name" : "gcp1.gcp-ffm:project:2018-01-01Z",
-    "lastModified" : "2024-08-07T11:57:20.584031600Z",
+    "lastModified" : "2024-09-05T09:24:28.969853800Z",
     "finalized" : true
   },
   "spec" : {
@@ -1499,8 +1499,8 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
   "status" : {
     "projectIdentifier" : "testProject",
     "timeframe" : {
-      "from" : "2024-08-01T00:00:00Z",
-      "to" : "2024-09-01T00:00:00Z"
+      "from" : "2024-09-01T00:00:00Z",
+      "to" : "2024-10-01T00:00:00Z"
     },
     "netAmounts" : [ {
       "currency" : "EUR",
@@ -1669,25 +1669,25 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
 {
   "_embedded" : {
     "meshChargebacks" : [ {
-      "apiVersion" : "v3",
       "kind" : "meshChargeback",
+      "apiVersion" : "v3",
       "metadata" : {
-        "name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-08-07T11:57:17.803683800Z",
+        "name" : "2024-09-01Z/testPartner:testWorkspace:testProject",
+        "createdOn" : "2024-09-05T09:24:26.892016300Z",
         "finalized" : true
       },
       "spec" : {
         "projectIdentifier" : "testProject",
-        "period" : "2024-08-01Z",
+        "period" : "2024-09-01Z",
         "tags" : {
           "paymentIdentifier" : [ "123" ]
         },
         "workspaceIdentifier" : "testWorkspace"
       },
       "status" : {
         "timeframe" : {
-          "from" : "2024-08-01T00:00:00Z",
-          "to" : "2024-09-01T00:00:00Z"
+          "from" : "2024-09-01T00:00:00Z",
+          "to" : "2024-10-01T00:00:00Z"
         },
         "lineItems" : [ {
           "reportCategory" : "BILLING",
@@ -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-08-01Z/testPartner%3AtestWorkspace%3AtestProject"
+          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-09-01Z/testPartner%3AtestWorkspace%3AtestProject"
         }
       }
     }, {
-      "apiVersion" : "v3",
       "kind" : "meshChargeback",
+      "apiVersion" : "v3",
       "metadata" : {
-        "name" : "2024-07-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-08-07T11:57:17.810727200Z",
+        "name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
+        "createdOn" : "2024-09-05T09:24:26.893467100Z",
         "finalized" : true
       },
       "spec" : {
         "projectIdentifier" : "testProject",
-        "period" : "2024-07-01Z",
+        "period" : "2024-08-01Z",
         "tags" : { },
         "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" : [ ],
         "netAmounts" : [ {
@@ -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-07-01Z/testPartner%3AtestWorkspace%3AtestProject"
+          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-08-01Z/testPartner%3AtestWorkspace%3AtestProject"
         }
       }
     } ]
@@ -1799,14 +1799,14 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
 <tbody>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Accept</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">meshApi is <a href="#versioning">versioned</a> and you should use  <code>application/vnd.meshcloud.api.meshchargeback.v3.hal+json</code> as an <code>Accept</code> header to be guaranteed the V1 response format of this endpoint. New versions might be added in future.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">meshApi is <a href="#versioning">versioned</a> and you should use  <code>application/vnd.meshcloud.api.meshchargeback.v3.hal+json</code> as an <code>Accept</code> header to be guaranteed the V3 response format of this endpoint. New versions might be added in future.</p></td>
 </tr>
 </tbody>
 </table>
 <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-08-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-09-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>
@@ -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-08-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-09-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>
@@ -2024,25 +2024,25 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
 Content-Length: 1852
 
 {
-  "apiVersion" : "v3",
   "kind" : "meshChargeback",
+  "apiVersion" : "v3",
   "metadata" : {
-    "name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
-    "createdOn" : "2024-08-07T11:57:17.803683800Z",
+    "name" : "2024-09-01Z/testPartner:testWorkspace:testProject",
+    "createdOn" : "2024-09-05T09:24:26.892016300Z",
     "finalized" : true
   },
   "spec" : {
     "projectIdentifier" : "testProject",
-    "period" : "2024-08-01Z",
+    "period" : "2024-09-01Z",
     "tags" : {
       "paymentIdentifier" : [ "123" ]
     },
     "workspaceIdentifier" : "testWorkspace"
   },
   "status" : {
     "timeframe" : {
-      "from" : "2024-08-01T00:00:00Z",
-      "to" : "2024-09-01T00:00:00Z"
+      "from" : "2024-09-01T00:00:00Z",
+      "to" : "2024-10-01T00:00:00Z"
     },
     "lineItems" : [ {
       "reportCategory" : "BILLING",
@@ -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-08-01Z/testPartner%3AtestWorkspace%3AtestProject"
+      "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-09-01Z/testPartner%3AtestWorkspace%3AtestProject"
     }
   }
 }</code></pre>
@@ -2654,7 +2654,7 @@ <h4 id="resources-getExternalCloudResources"><a class="link" href="#resources-ge
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-07 11:55:40 UTC
+Last updated 2024-09-05 09:23:02 UTC
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">