docs: update meshStack API docs from latest develop build

meshcloud · Jan 2, 2025 · 5f8fd59 · 5f8fd59
1 parent 1414673
commit 5f8fd59
Show file tree

Hide file tree

Showing 13 changed files with 187 additions and 187 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 2024-12-18 15:56:31 UTC
+Last updated 2025-01-02 13:34:38 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-12-18 15:56:31 UTC
+Last updated 2025-01-02 13:34:38 UTC
 </div>
 </div>
 </body>

diff --git a/website/static/billing-api/index.html b/website/static/billing-api/index.html
@@ -745,7 +745,7 @@ <h3 id="paging"><a class="link" href="#paging">Paging</a></h3>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>size</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The amount of elements in a single page (default={default-page-size}).
+<td class="tableblock halign-left valign-top"><p class="tableblock">The amount of elements in a single page (default=20).
 <strong>Note</strong>: You can size up to {max-page-size}. Greater values will be automatically lowered to this value.</p></td>
 </tr>
 </tbody>
@@ -1048,14 +1048,14 @@ <h3 id="mesh_objects"><a class="link" href="#mesh_objects">meshObjects</a></h3>
 
 {
   "_links" : {
-    "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{?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"
     }
@@ -1143,7 +1143,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>size</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The amount of elements in a single page (default={default-page-size}). See <a href="#paging">Paging information</a>.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The amount of elements in a single page (default=20). See <a href="#paging">Paging information</a>.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
@@ -1228,7 +1228,7 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
       "apiVersion" : "v2",
       "metadata" : {
         "name" : "gcp1.gcp-ffm:project:2018-01-01Z",
-        "lastModified" : "2024-12-18T15:57:55.476548100Z",
+        "lastModified" : "2025-01-02T13:36:12.075479600Z",
         "finalized" : true
       },
       "spec" : {
@@ -1241,8 +1241,8 @@ <h5 id="_list_meshtenantusagereports"><a class="link" href="#_list_meshtenantusa
       "status" : {
         "projectIdentifier" : "testProject",
         "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"
         },
         "netAmounts" : [ {
           "currency" : "EUR",
@@ -1473,7 +1473,7 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
   "apiVersion" : "v2",
   "metadata" : {
     "name" : "gcp1.gcp-ffm:project:2018-01-01Z",
-    "lastModified" : "2024-12-18T15:57:55.476548100Z",
+    "lastModified" : "2025-01-02T13:36:12.075479600Z",
     "finalized" : true
   },
   "spec" : {
@@ -1486,8 +1486,8 @@ <h5 id="_get_meshtenantusagereport"><a class="link" href="#_get_meshtenantusager
   "status" : {
     "projectIdentifier" : "testProject",
     "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"
     },
     "netAmounts" : [ {
       "currency" : "EUR",
@@ -1575,7 +1575,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>size</code></p></td>
-<td class="tableblock halign-left valign-top"><p class="tableblock">The amount of elements in a single page (default={default-page-size}). See <a href="#paging">Paging information</a>.</p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The amount of elements in a single page (default=20). See <a href="#paging">Paging information</a>.</p></td>
 </tr>
 <tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>sort</code></p></td>
@@ -1659,22 +1659,22 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
       "kind" : "meshChargeback",
       "apiVersion" : "v3",
       "metadata" : {
-        "name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-12-18T15:57:53.024736400Z",
+        "name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
+        "createdOn" : "2025-01-02T13:36:09.321482800Z",
         "finalized" : true
       },
       "spec" : {
         "projectIdentifier" : "testProject",
-        "period" : "2024-12-01Z",
+        "period" : "2025-01-01Z",
         "tags" : {
           "paymentIdentifier" : [ "123" ]
         },
         "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" : [ {
           "reportCategory" : "BILLING",
@@ -1714,27 +1714,27 @@ <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"
         }
       }
     }, {
       "kind" : "meshChargeback",
       "apiVersion" : "v3",
       "metadata" : {
-        "name" : "2024-11-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-12-18T15:57:53.026423600Z",
+        "name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
+        "createdOn" : "2025-01-02T13:36:09.323212200Z",
         "finalized" : true
       },
       "spec" : {
         "projectIdentifier" : "testProject",
-        "period" : "2024-11-01Z",
+        "period" : "2024-12-01Z",
         "tags" : { },
         "workspaceIdentifier" : "testWorkspace"
       },
       "status" : {
         "timeframe" : {
-          "from" : "2024-11-01T00:00:00Z",
-          "to" : "2024-12-01T00:00:00Z"
+          "from" : "2024-12-01T00:00:00Z",
+          "to" : "2025-01-01T00:00:00Z"
         },
         "lineItems" : [ ],
         "netAmounts" : [ {
@@ -1746,7 +1746,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
       },
       "_links" : {
         "self" : {
-          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-11-01Z/testPartner%3AtestWorkspace%3AtestProject"
+          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-12-01Z/testPartner%3AtestWorkspace%3AtestProject"
         }
       }
     } ]
@@ -1793,7 +1793,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-12-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-01-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>
@@ -1802,7 +1802,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-12-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-01-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>
@@ -2014,22 +2014,22 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
   "kind" : "meshChargeback",
   "apiVersion" : "v3",
   "metadata" : {
-    "name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
-    "createdOn" : "2024-12-18T15:57:53.024736400Z",
+    "name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
+    "createdOn" : "2025-01-02T13:36:09.321482800Z",
     "finalized" : true
   },
   "spec" : {
     "projectIdentifier" : "testProject",
-    "period" : "2024-12-01Z",
+    "period" : "2025-01-01Z",
     "tags" : {
       "paymentIdentifier" : [ "123" ]
     },
     "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" : [ {
       "reportCategory" : "BILLING",
@@ -2069,7 +2069,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
   },
   "_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"
     }
   }
 }</code></pre>
@@ -2356,7 +2356,7 @@ <h5 id="_put_meshresourceusagereports"><a class="link" href="#_put_meshresourceu
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-12-18 15:56:31 UTC
+Last updated 2025-01-02 13:34:38 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
@@ -592,22 +592,22 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
       "kind" : "meshChargeback",
       "apiVersion" : "v3",
       "metadata" : {
-        "name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-12-18T15:57:53.024736400Z",
+        "name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
+        "createdOn" : "2025-01-02T13:36:09.321482800Z",
         "finalized" : true
       },
       "spec" : {
         "projectIdentifier" : "testProject",
-        "period" : "2024-12-01Z",
+        "period" : "2025-01-01Z",
         "tags" : {
           "paymentIdentifier" : [ "123" ]
         },
         "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" : [ {
           "reportCategory" : "BILLING",
@@ -647,27 +647,27 @@ <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"
         }
       }
     }, {
       "kind" : "meshChargeback",
       "apiVersion" : "v3",
       "metadata" : {
-        "name" : "2024-11-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-12-18T15:57:53.026423600Z",
+        "name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
+        "createdOn" : "2025-01-02T13:36:09.323212200Z",
         "finalized" : true
       },
       "spec" : {
         "projectIdentifier" : "testProject",
-        "period" : "2024-11-01Z",
+        "period" : "2024-12-01Z",
         "tags" : { },
         "workspaceIdentifier" : "testWorkspace"
       },
       "status" : {
         "timeframe" : {
-          "from" : "2024-11-01T00:00:00Z",
-          "to" : "2024-12-01T00:00:00Z"
+          "from" : "2024-12-01T00:00:00Z",
+          "to" : "2025-01-01T00:00:00Z"
         },
         "lineItems" : [ ],
         "netAmounts" : [ {
@@ -679,7 +679,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
       },
       "_links" : {
         "self" : {
-          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-11-01Z/testPartner%3AtestWorkspace%3AtestProject"
+          "href" : "https://mesh-billing-url/api/meshobjects/meshchargebacks/2024-12-01Z/testPartner%3AtestWorkspace%3AtestProject"
         }
       }
     } ]
@@ -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-12-01Z/testPartner%253AtestWorkspace%253AtestProject HTTP/1.1
+<pre class="highlight nowrap"><code class="language-http" data-lang="http">GET /api/meshobjects/meshchargebacks/2025-01-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>
@@ -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-12-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-01-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>
@@ -947,22 +947,22 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
   "kind" : "meshChargeback",
   "apiVersion" : "v3",
   "metadata" : {
-    "name" : "2024-12-01Z/testPartner:testWorkspace:testProject",
-    "createdOn" : "2024-12-18T15:57:53.024736400Z",
+    "name" : "2025-01-01Z/testPartner:testWorkspace:testProject",
+    "createdOn" : "2025-01-02T13:36:09.321482800Z",
     "finalized" : true
   },
   "spec" : {
     "projectIdentifier" : "testProject",
-    "period" : "2024-12-01Z",
+    "period" : "2025-01-01Z",
     "tags" : {
       "paymentIdentifier" : [ "123" ]
     },
     "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" : [ {
       "reportCategory" : "BILLING",
@@ -1002,7 +1002,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</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"
     }
   }
 }</code></pre>
@@ -1013,7 +1013,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-12-18 15:56:31 UTC
+Last updated 2025-01-02 13:34:38 UTC
 </div>
 </div>
 </body>