docs: update meshStack API docs from latest develop build

meshcloud · Feb 4, 2025 · 5645540 · 5645540
1 parent 1125432
commit 5645540
Show file tree

Hide file tree

Showing 13 changed files with 122 additions and 122 deletions.
diff --git a/website/static/billing-api/api_index.html b/website/static/billing-api/api_index.html
@@ -559,7 +559,7 @@ <h3 id="_index">Index</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 13:37:32 UTC
+Last updated 2025-02-04 10:42:37 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 2025-01-29 13:37:32 UTC
+Last updated 2025-02-04 10:42:37 UTC
 </div>
 </div>
 </body>

diff --git a/website/static/billing-api/index.html b/website/static/billing-api/index.html
@@ -1048,14 +1048,14 @@ <h3 id="mesh_objects"><a class="link" href="#mesh_objects">meshObjects</a></h3>
 
 {
   "_links" : {
-    "meshtenantusagereports" : {
-      "href" : "https://mesh-billing-url/api/meshobjects/meshtenantusagereports{?ownedByWorkspace,ownedByProject,isManaged,platform,platformType,platformTenantId,period,reportCategory,paymentMethodIdentifier,meshTenantId,finalizedAfter,cancelledAfter,status,showCancelled,sort}",
-      "templated" : true
-    },
     "meshchargebacks" : {
       "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks{?workspaceIdentifier,projectIdentifier,period,finalized,legacy,finalizedSince,cancelledSince}",
       "templated" : true
     },
+    "meshtenantusagereports" : {
+      "href" : "https://mesh-billing-url/api/meshobjects/meshtenantusagereports{?ownedByWorkspace,ownedByProject,isManaged,platform,platformType,platformTenantId,period,reportCategory,paymentMethodIdentifier,meshTenantId,finalizedAfter,cancelledAfter,status,showCancelled,sort}",
+      "templated" : true
+    },
     "self" : {
       "href" : "https://mesh-billing-url/api/meshobjects"
     }
@@ -1265,7 +1265,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
         "reportCategory" : "BILLING",
         "platformType" : "Azure",
         "platform" : "azure.prod",
-        "platformTenantId" : "26911025-b14f-4fe5-8aa5-1c7d4dedab64",
+        "platformTenantId" : "56de1468-60d7-4fff-858b-4b2b9ac473e2",
         "version" : 2
       },
       "status" : {
@@ -1316,7 +1316,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
         "reportCategory" : "BILLING",
         "platformType" : "Azure",
         "platform" : "azure.prod",
-        "platformTenantId" : "235fdeb9-bb47-494b-88ba-f87a14aaf570",
+        "platformTenantId" : "73073b84-7c94-4fdb-a1c3-3527f9237c54",
         "version" : 1
       },
       "status" : {
@@ -1644,7 +1644,7 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
     "reportCategory" : "BILLING",
     "platformType" : "Azure",
     "platform" : "azure.prod",
-    "platformTenantId" : "26911025-b14f-4fe5-8aa5-1c7d4dedab64",
+    "platformTenantId" : "56de1468-60d7-4fff-858b-4b2b9ac473e2",
     "version" : 2
   },
   "status" : {
@@ -1843,30 +1843,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: 3374
+Content-Length: 3377
 
 {
   "_embedded" : {
     "meshChargebacks" : [ {
       "kind" : "meshChargeback",
       "apiVersion" : "v3",
       "metadata" : {
-        "name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2025-01-29T13:38:58.602826Z",
+        "name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
+        "createdOn" : "2025-02-04T10:44:09.757598100Z",
         "finalized" : true
       },
       "spec" : {
         "projectIdentifier" : "testProject",
-        "period" : "2025-01-01Z",
+        "period" : "2025-02-01Z",
         "tags" : {
           "paymentIdentifier" : [ "123" ]
         },
         "workspaceIdentifier" : "testWorkspace"
       },
       "status" : {
         "timeframe" : {
-          "from" : "2025-01-01T00:00:00Z",
-          "to" : "2025-02-01T00:00:00Z"
+          "from" : "2025-02-01T00:00:00Z",
+          "to" : "2025-03-01T00:00:00Z"
         },
         "lineItems" : [ {
           "reportCategory" : "BILLING",
@@ -1906,27 +1906,27 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
       },
       "_links" : {
         "self" : {
-          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
+          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject"
         }
       }
     }, {
       "kind" : "meshChargeback",
       "apiVersion" : "v3",
       "metadata" : {
-        "name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2025-01-29T13:38:58.603682500Z",
+        "name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
+        "createdOn" : "2025-02-04T10:44:09.758530300Z",
         "finalized" : true
       },
       "spec" : {
         "projectIdentifier" : "testProject",
-        "period" : "2024-12-01Z",
+        "period" : "2025-01-01Z",
         "tags" : { },
         "workspaceIdentifier" : "testWorkspace"
       },
       "status" : {
         "timeframe" : {
-          "from" : "2024-12-01T00:00:00Z",
-          "to" : "2025-01-01T00:00:00Z"
+          "from" : "2025-01-01T00:00:00Z",
+          "to" : "2025-02-01T00:00:00Z"
         },
         "lineItems" : [ ],
         "netAmounts" : [ {
@@ -1938,7 +1938,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
       },
       "_links" : {
         "self" : {
-          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-12-01Z/testPartner%3AtestWorkspace%3AtestProject"
+          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
         }
       }
     } ]
@@ -1985,7 +1985,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-01-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 HTTP/1.1
 Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
 Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json
 Host: mesh-billing-url</code></pre>
@@ -1994,7 +1994,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-01-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' -i -u 'valid_username:valid_password' -X GET \
     -H 'Accept: application/vnd.meshcloud.api.meshchargeback.v3.hal+json'</code></pre>
 </div>
 </div>
@@ -2200,28 +2200,28 @@ <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: 1849
+Content-Length: 1852
 
 {
   "kind" : "meshChargeback",
   "apiVersion" : "v3",
   "metadata" : {
-    "name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
-    "createdOn" : "2025-01-29T13:38:58.602826Z",
+    "name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
+    "createdOn" : "2025-02-04T10:44:09.757598100Z",
     "finalized" : true
   },
   "spec" : {
     "projectIdentifier" : "testProject",
-    "period" : "2025-01-01Z",
+    "period" : "2025-02-01Z",
     "tags" : {
       "paymentIdentifier" : [ "123" ]
     },
     "workspaceIdentifier" : "testWorkspace"
   },
   "status" : {
     "timeframe" : {
-      "from" : "2025-01-01T00:00:00Z",
-      "to" : "2025-02-01T00:00:00Z"
+      "from" : "2025-02-01T00:00:00Z",
+      "to" : "2025-03-01T00:00:00Z"
     },
     "lineItems" : [ {
       "reportCategory" : "BILLING",
@@ -2261,7 +2261,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
   },
   "_links" : {
     "self" : {
-      "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
+      "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject"
     }
   }
 }</code></pre>
@@ -2548,7 +2548,7 @@ <h5 id="_put_meshresourceusagereports"><a class="link" href="#_put_meshresourceu
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 13:37:32 UTC
+Last updated 2025-02-04 10:42:37 UTC
 </div>
 </div>
 <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.15.6/styles/github.min.css">

diff --git a/website/static/billing-api/mesh_chargeback.html b/website/static/billing-api/mesh_chargeback.html
@@ -597,30 +597,30 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
 Expires: 0
 Strict-Transport-Security: max-age=31536000 ; includeSubDomains
 X-Frame-Options: DENY
-Content-Length: 3374
+Content-Length: 3377
 
 {
   "_embedded" : {
     "meshChargebacks" : [ {
       "kind" : "meshChargeback",
       "apiVersion" : "v3",
       "metadata" : {
-        "name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2025-01-29T13:38:58.602826Z",
+        "name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
+        "createdOn" : "2025-02-04T10:44:09.757598100Z",
         "finalized" : true
       },
       "spec" : {
         "projectIdentifier" : "testProject",
-        "period" : "2025-01-01Z",
+        "period" : "2025-02-01Z",
         "tags" : {
           "paymentIdentifier" : [ "123" ]
         },
         "workspaceIdentifier" : "testWorkspace"
       },
       "status" : {
         "timeframe" : {
-          "from" : "2025-01-01T00:00:00Z",
-          "to" : "2025-02-01T00:00:00Z"
+          "from" : "2025-02-01T00:00:00Z",
+          "to" : "2025-03-01T00:00:00Z"
         },
         "lineItems" : [ {
           "reportCategory" : "BILLING",
@@ -660,27 +660,27 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
       },
       "_links" : {
         "self" : {
-          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
+          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject"
         }
       }
     }, {
       "kind" : "meshChargeback",
       "apiVersion" : "v3",
       "metadata" : {
-        "name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2025-01-29T13:38:58.603682500Z",
+        "name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
+        "createdOn" : "2025-02-04T10:44:09.758530300Z",
         "finalized" : true
       },
       "spec" : {
         "projectIdentifier" : "testProject",
-        "period" : "2024-12-01Z",
+        "period" : "2025-01-01Z",
         "tags" : { },
         "workspaceIdentifier" : "testWorkspace"
       },
       "status" : {
         "timeframe" : {
-          "from" : "2024-12-01T00:00:00Z",
-          "to" : "2025-01-01T00:00:00Z"
+          "from" : "2025-01-01T00:00:00Z",
+          "to" : "2025-02-01T00:00:00Z"
         },
         "lineItems" : [ ],
         "netAmounts" : [ {
@@ -692,7 +692,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
       },
       "_links" : {
         "self" : {
-          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-12-01Z/testPartner%3AtestWorkspace%3AtestProject"
+          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
         }
       }
     } ]
@@ -739,7 +739,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/2025-01-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/meshobjects/meshchargebacks/2025-02-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>
@@ -748,7 +748,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/2025-01-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/2025-02-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>
@@ -954,28 +954,28 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
 Expires: 0
 Strict-Transport-Security: max-age=31536000 ; includeSubDomains
 X-Frame-Options: DENY
-Content-Length: 1849
+Content-Length: 1852
 
 {
   "kind" : "meshChargeback",
   "apiVersion" : "v3",
   "metadata" : {
-    "name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
-    "createdOn" : "2025-01-29T13:38:58.602826Z",
+    "name" : "2025-02-01Z/testPartner:testWorkspace:testProject",
+    "createdOn" : "2025-02-04T10:44:09.757598100Z",
     "finalized" : true
   },
   "spec" : {
     "projectIdentifier" : "testProject",
-    "period" : "2025-01-01Z",
+    "period" : "2025-02-01Z",
     "tags" : {
       "paymentIdentifier" : [ "123" ]
     },
     "workspaceIdentifier" : "testWorkspace"
   },
   "status" : {
     "timeframe" : {
-      "from" : "2025-01-01T00:00:00Z",
-      "to" : "2025-02-01T00:00:00Z"
+      "from" : "2025-02-01T00:00:00Z",
+      "to" : "2025-03-01T00:00:00Z"
     },
     "lineItems" : [ {
       "reportCategory" : "BILLING",
@@ -1015,7 +1015,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
   },
   "_links" : {
     "self" : {
-      "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-01-01Z/testPartner%3AtestWorkspace%3AtestProject"
+      "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2025-02-01Z/testPartner%3AtestWorkspace%3AtestProject"
     }
   }
 }</code></pre>
@@ -1026,7 +1026,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2025-01-29 13:37:32 UTC
+Last updated 2025-02-04 10:42:37 UTC
 </div>
 </div>
 </body>