docs: update meshStack API docs from latest develop build

meshcloud · Aug 7, 2024 · 5535d8a · 5535d8a
1 parent 2ee6daa
commit 5535d8a
Show file tree

Hide file tree

Showing 13 changed files with 124 additions and 106 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-01 11:22:52 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>

diff --git a/website/static/billing-api/cloud-resources.html b/website/static/billing-api/cloud-resources.html
@@ -707,18 +707,18 @@ <h4 id="resources-getExternalCloudResources">getExternalCloudResources</h4>
     "paged" : true,
     "unpaged" : false
   },
+  "last" : true,
   "totalPages" : 1,
   "totalElements" : 1,
-  "last" : true,
   "size" : 20,
   "number" : 0,
   "sort" : {
     "empty" : false,
     "sorted" : true,
     "unsorted" : false
   },
-  "numberOfElements" : 1,
   "first" : true,
+  "numberOfElements" : 1,
   "empty" : false
 }</code></pre>
 </div>
@@ -728,7 +728,7 @@ <h4 id="resources-getExternalCloudResources">getExternalCloudResources</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:52 UTC
+Last updated 2024-08-07 11:55:40 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-01 11:22:52 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>

diff --git a/website/static/billing-api/index.html b/website/static/billing-api/index.html
@@ -1061,14 +1061,14 @@ <h3 id="mesh_objects"><a class="link" href="#mesh_objects">meshObjects</a></h3>
 
 {
   "_links" : {
-    "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}",
       "templated" : true
     },
+    "meshtenantusagereports" : {
+      "href" : "https://mesh-billing-url/api/meshobjects/meshtenantusagereports{?workspaceIdentifier,projectIdentifier,platformFullIdentifier,period,reportCategory,paymentIdentifier}",
+      "templated" : true
+    },
     "self" : {
       "href" : "https://mesh-billing-url/api/meshobjects"
     }
@@ -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-08-01T11:24:23.604971800Z",
+        "lastModified" : "2024-08-07T11:57:20.584031600Z",
         "finalized" : true
       },
       "spec" : {
@@ -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-08-01T11:24:23.604971800Z",
+    "lastModified" : "2024-08-07T11:57:20.584031600Z",
     "finalized" : true
   },
   "spec" : {
@@ -1664,7 +1664,7 @@ <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" : {
@@ -1673,7 +1673,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
       "kind" : "meshChargeback",
       "metadata" : {
         "name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-08-01T11:24:20.886902600Z",
+        "createdOn" : "2024-08-07T11:57:17.803683800Z",
         "finalized" : true
       },
       "spec" : {
@@ -1735,7 +1735,7 @@ <h5 id="_list_meshchargebacks"><a class="link" href="#_list_meshchargebacks">Lis
       "kind" : "meshChargeback",
       "metadata" : {
         "name" : "2024-07-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-08-01T11:24:20.888950Z",
+        "createdOn" : "2024-08-07T11:57:17.810727200Z",
         "finalized" : true
       },
       "spec" : {
@@ -2028,7 +2028,7 @@ <h5 id="_get_meshchargeback"><a class="link" href="#_get_meshchargeback">Get mes
   "kind" : "meshChargeback",
   "metadata" : {
     "name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
-    "createdOn" : "2024-08-01T11:24:20.886902600Z",
+    "createdOn" : "2024-08-07T11:57:17.803683800Z",
     "finalized" : true
   },
   "spec" : {
@@ -2142,6 +2142,10 @@ <h5 id="_put_meshresourceusagereports"><a class="link" href="#_put_meshresourceu
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Content-Type</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">meshObject Import is <a href="#versioning">versioned</a> and <code>application/vnd.meshcloud.api.meshobjects.v1+yaml</code> or <code>application/vnd.meshcloud.api.meshobjects.v1+json</code> can be used as a <code>Content-Type</code>.</p></td>
 </tr>
+<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.meshobjects.v1+json</code> as an <code>Accept</code> header to be guaranteed the V1 response format of this endpoint. New versions will be added in future.</p></td>
+</tr>
 </tbody>
 </table>
 <table class="tableblock frame-all grid-all stretch">
@@ -2222,6 +2226,7 @@ <h5 id="_put_meshresourceusagereports"><a class="link" href="#_put_meshresourceu
 <pre class="highlightjs highlight nowrap"><code data-lang="http" class="language-http hljs">PUT /api/meshobjects/meshresourceusagereports/12345/2023-01-01Z HTTP/1.1
 Content-Type: application/vnd.meshcloud.api.meshobjects.v1+json;charset=UTF-8
 Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
+Accept: application/vnd.meshcloud.api.meshobjects.v1+json
 Content-Length: 755
 Host: mesh-billing-url
 
@@ -2258,6 +2263,7 @@ <h5 id="_put_meshresourceusagereports"><a class="link" href="#_put_meshresourceu
 <div class="content">
 <pre class="highlightjs highlight"><code data-lang="bash" class="language-bash hljs">$ curl 'https://mesh-billing-url/api/meshobjects/meshresourceusagereports/12345/2023-01-01Z' -i -u 'valid_username:valid_password' -X PUT \
     -H 'Content-Type: application/vnd.meshcloud.api.meshobjects.v1+json;charset=UTF-8' \
+    -H 'Accept: application/vnd.meshcloud.api.meshobjects.v1+json' \
     -d '{
     "apiVersion": "v1",
     "kind": "meshResourceUsageReport",
@@ -2625,18 +2631,18 @@ <h4 id="resources-getExternalCloudResources"><a class="link" href="#resources-ge
     "paged" : true,
     "unpaged" : false
   },
+  "last" : true,
   "totalPages" : 1,
   "totalElements" : 1,
-  "last" : true,
   "size" : 20,
   "number" : 0,
   "sort" : {
     "empty" : false,
     "sorted" : true,
     "unsorted" : false
   },
-  "numberOfElements" : 1,
   "first" : true,
+  "numberOfElements" : 1,
   "empty" : false
 }</code></pre>
 </div>
@@ -2648,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-01 11:22:52 UTC
+Last updated 2024-08-07 11:55:40 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
@@ -584,7 +584,7 @@ <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" : {
@@ -593,7 +593,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
       "kind" : "meshChargeback",
       "metadata" : {
         "name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-08-01T11:24:20.886902600Z",
+        "createdOn" : "2024-08-07T11:57:17.803683800Z",
         "finalized" : true
       },
       "spec" : {
@@ -655,7 +655,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
       "kind" : "meshChargeback",
       "metadata" : {
         "name" : "2024-07-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-08-01T11:24:20.888950Z",
+        "createdOn" : "2024-08-07T11:57:17.810727200Z",
         "finalized" : true
       },
       "spec" : {
@@ -948,7 +948,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
   "kind" : "meshChargeback",
   "metadata" : {
     "name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
-    "createdOn" : "2024-08-01T11:24:20.886902600Z",
+    "createdOn" : "2024-08-07T11:57:17.803683800Z",
     "finalized" : true
   },
   "spec" : {
@@ -1013,7 +1013,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:52 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>

diff --git a/website/static/billing-api/mesh_objects.html b/website/static/billing-api/mesh_objects.html
@@ -548,14 +548,14 @@ <h3 id="mesh_objects">meshObjects</h3>
 
 {
   "_links" : {
-    "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}",
       "templated" : true
     },
+    "meshtenantusagereports" : {
+      "href" : "https://mesh-billing-url/api/meshobjects/meshtenantusagereports{?workspaceIdentifier,projectIdentifier,platformFullIdentifier,period,reportCategory,paymentIdentifier}",
+      "templated" : true
+    },
     "self" : {
       "href" : "https://mesh-billing-url/api/meshobjects"
     }
@@ -728,7 +728,7 @@ <h5 id="_list_meshtenantusagereports">List meshTenantUsageReports</h5>
       "kind" : "meshTenantUsageReport",
       "metadata" : {
         "name" : "gcp1.gcp-ffm:project:2018-01-01Z",
-        "lastModified" : "2024-08-01T11:24:23.604971800Z",
+        "lastModified" : "2024-08-07T11:57:20.584031600Z",
         "finalized" : true
       },
       "spec" : {
@@ -973,7 +973,7 @@ <h5 id="_get_meshtenantusagereport">Get meshTenantUsageReport</h5>
   "kind" : "meshTenantUsageReport",
   "metadata" : {
     "name" : "gcp1.gcp-ffm:project:2018-01-01Z",
-    "lastModified" : "2024-08-01T11:24:23.604971800Z",
+    "lastModified" : "2024-08-07T11:57:20.584031600Z",
     "finalized" : true
   },
   "spec" : {
@@ -1151,7 +1151,7 @@ <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" : {
@@ -1160,7 +1160,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
       "kind" : "meshChargeback",
       "metadata" : {
         "name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-08-01T11:24:20.886902600Z",
+        "createdOn" : "2024-08-07T11:57:17.803683800Z",
         "finalized" : true
       },
       "spec" : {
@@ -1222,7 +1222,7 @@ <h5 id="_list_meshchargebacks">List meshChargebacks</h5>
       "kind" : "meshChargeback",
       "metadata" : {
         "name" : "2024-07-01Z/testPartner:testWorkspace:testProject",
-        "createdOn" : "2024-08-01T11:24:20.888950Z",
+        "createdOn" : "2024-08-07T11:57:17.810727200Z",
         "finalized" : true
       },
       "spec" : {
@@ -1515,7 +1515,7 @@ <h5 id="_get_meshchargeback">Get meshChargeback</h5>
   "kind" : "meshChargeback",
   "metadata" : {
     "name" : "2024-08-01Z/testPartner:testWorkspace:testProject",
-    "createdOn" : "2024-08-01T11:24:20.886902600Z",
+    "createdOn" : "2024-08-07T11:57:17.803683800Z",
     "finalized" : true
   },
   "spec" : {
@@ -1629,6 +1629,10 @@ <h5 id="_put_meshresourceusagereports">Put meshResourceUsageReports</h5>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Content-Type</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">meshObject Import is <a href="#versioning">versioned</a> and <code>application/vnd.meshcloud.api.meshobjects.v1+yaml</code> or <code>application/vnd.meshcloud.api.meshobjects.v1+json</code> can be used as a <code>Content-Type</code>.</p></td>
 </tr>
+<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.meshobjects.v1+json</code> as an <code>Accept</code> header to be guaranteed the V1 response format of this endpoint. New versions will be added in future.</p></td>
+</tr>
 </tbody>
 </table>
 <table class="tableblock frame-all grid-all stretch">
@@ -1709,6 +1713,7 @@ <h5 id="_put_meshresourceusagereports">Put meshResourceUsageReports</h5>
 <pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /api/meshobjects/meshresourceusagereports/12345/2023-01-01Z HTTP/1.1
 Content-Type: application/vnd.meshcloud.api.meshobjects.v1+json;charset=UTF-8
 Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
+Accept: application/vnd.meshcloud.api.meshobjects.v1+json
 Content-Length: 755
 Host: mesh-billing-url
 
@@ -1745,6 +1750,7 @@ <h5 id="_put_meshresourceusagereports">Put meshResourceUsageReports</h5>
 <div class="content">
 <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-billing-url/api/meshobjects/meshresourceusagereports/12345/2023-01-01Z' -i -u 'valid_username:valid_password' -X PUT \
     -H 'Content-Type: application/vnd.meshcloud.api.meshobjects.v1+json;charset=UTF-8' \
+    -H 'Accept: application/vnd.meshcloud.api.meshobjects.v1+json' \
     -d '{
     "apiVersion": "v1",
     "kind": "meshResourceUsageReport",
@@ -1848,7 +1854,7 @@ <h5 id="_put_meshresourceusagereports">Put meshResourceUsageReports</h5>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:52 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>

diff --git a/website/static/billing-api/mesh_resource_usage_report.html b/website/static/billing-api/mesh_resource_usage_report.html
@@ -492,6 +492,10 @@ <h5 id="_put_meshresourceusagereports">Put meshResourceUsageReports</h5>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><code>Content-Type</code></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">meshObject Import is <a href="#versioning">versioned</a> and <code>application/vnd.meshcloud.api.meshobjects.v1+yaml</code> or <code>application/vnd.meshcloud.api.meshobjects.v1+json</code> can be used as a <code>Content-Type</code>.</p></td>
 </tr>
+<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.meshobjects.v1+json</code> as an <code>Accept</code> header to be guaranteed the V1 response format of this endpoint. New versions will be added in future.</p></td>
+</tr>
 </tbody>
 </table>
 <table class="tableblock frame-all grid-all stretch">
@@ -572,6 +576,7 @@ <h5 id="_put_meshresourceusagereports">Put meshResourceUsageReports</h5>
 <pre class="highlight nowrap"><code class="language-http" data-lang="http">PUT /api/meshobjects/meshresourceusagereports/12345/2023-01-01Z HTTP/1.1
 Content-Type: application/vnd.meshcloud.api.meshobjects.v1+json;charset=UTF-8
 Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
+Accept: application/vnd.meshcloud.api.meshobjects.v1+json
 Content-Length: 755
 Host: mesh-billing-url
 
@@ -608,6 +613,7 @@ <h5 id="_put_meshresourceusagereports">Put meshResourceUsageReports</h5>
 <div class="content">
 <pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-billing-url/api/meshobjects/meshresourceusagereports/12345/2023-01-01Z' -i -u 'valid_username:valid_password' -X PUT \
     -H 'Content-Type: application/vnd.meshcloud.api.meshobjects.v1+json;charset=UTF-8' \
+    -H 'Accept: application/vnd.meshcloud.api.meshobjects.v1+json' \
     -d '{
     "apiVersion": "v1",
     "kind": "meshResourceUsageReport",
@@ -710,7 +716,7 @@ <h5 id="_put_meshresourceusagereports">Put meshResourceUsageReports</h5>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:52 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>

diff --git a/website/static/billing-api/mesh_tenant_usage_reports.html b/website/static/billing-api/mesh_tenant_usage_reports.html
@@ -605,7 +605,7 @@ <h5 id="_list_meshtenantusagereports">List meshTenantUsageReports</h5>
       "kind" : "meshTenantUsageReport",
       "metadata" : {
         "name" : "gcp1.gcp-ffm:project:2018-01-01Z",
-        "lastModified" : "2024-08-01T11:24:23.604971800Z",
+        "lastModified" : "2024-08-07T11:57:20.584031600Z",
         "finalized" : true
       },
       "spec" : {
@@ -850,7 +850,7 @@ <h5 id="_get_meshtenantusagereport">Get meshTenantUsageReport</h5>
   "kind" : "meshTenantUsageReport",
   "metadata" : {
     "name" : "gcp1.gcp-ffm:project:2018-01-01Z",
-    "lastModified" : "2024-08-01T11:24:23.604971800Z",
+    "lastModified" : "2024-08-07T11:57:20.584031600Z",
     "finalized" : true
   },
   "spec" : {
@@ -887,7 +887,7 @@ <h5 id="_get_meshtenantusagereport">Get meshTenantUsageReport</h5>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-08-01 11:22:52 UTC
+Last updated 2024-08-07 11:55:40 UTC
 </div>
 </div>
 </body>