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 GitHub Actions committed Jun 25, 2024
1 parent 7879250 commit 0f31c40
Show file tree
Hide file tree
Showing 19 changed files with 3,491 additions and 3,397 deletions.
4 changes: 2 additions & 2 deletions website/static/api/api_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -539,7 +539,7 @@ <h3 id="_index">Index</h3>
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.meshcloud.api.v1.hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Expand All @@ -566,7 +566,7 @@ <h3 id="_index">Index</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-06-19 12:58:18 UTC
Last updated 2024-06-25 08:16:39 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/common_data_formats.html
Original file line number Diff line number Diff line change
Expand Up @@ -542,7 +542,7 @@ <h3 id="tags">Tags</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-06-19 12:58:18 UTC
Last updated 2024-06-25 08:16:39 UTC
</div>
</div>
</body>
Expand Down
963 changes: 422 additions & 541 deletions website/static/api/index.html

Large diffs are not rendered by default.

171 changes: 32 additions & 139 deletions website/static/api/mesh_buildingblock.html

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions website/static/api/mesh_object_collection.html
Original file line number Diff line number Diff line change
Expand Up @@ -550,7 +550,7 @@ <h4 id="mesh_object_collection_create">createMeshObjectCollection</h4>
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Expand Down Expand Up @@ -650,7 +650,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Expand All @@ -667,7 +667,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Expand All @@ -678,7 +678,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
{
"error" : "MeshBadRequestException",
"message" : "MeshObjectCollection not-empty-collection cannot be deleted, because it is not empty",
"errorId" : "Rys8SYbJow"
"errorId" : "jRsGhVQmnR"
}</code></pre>
</div>
</div>
Expand All @@ -687,7 +687,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-06-19 12:58:18 UTC
Last updated 2024-06-25 08:16:39 UTC
</div>
</div>
</body>
Expand Down
37 changes: 9 additions & 28 deletions website/static/api/mesh_object_declarative_import.html
Original file line number Diff line number Diff line change
Expand Up @@ -475,29 +475,10 @@ <h4 id="mesh_object_declarative_import">meshObject Declarative Import</h4>
</tr>
</tbody>
</table>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 2. Request Parameters</caption>
<colgroup>
<col style="width: 50%;">
<col style="width: 50%;">
</colgroup>
<thead>
<tr>
<th class="tableblock halign-left valign-top">Parameter</th>
<th class="tableblock halign-left valign-top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>meshObjectCollection</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">the name of the meshObjectCollection the meshObjects should be imported into (optional)</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>owner</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If meshObjectCollection parameter is provided, this is the owner of the meshObjectCollection (optional)</p></td>
</tr>
</tbody>
</table>
<div class="paragraph">
<div class="title">Request Parameters</div>
<p>Unresolved directive in mesh_object_declarative_import.adoc - include::/__w/meshfed-release/meshfed-release/meshfed/api/build/generated-snippets/import/request-parameters.adoc[]</p>
</div>
<div class="listingblock">
<div class="title">Example Request in YAML</div>
<div class="content">
Expand Down Expand Up @@ -576,7 +557,7 @@ <h4 id="mesh_object_declarative_import">meshObject Declarative Import</h4>
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.meshcloud.api.meshobjects.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Expand All @@ -600,7 +581,7 @@ <h4 id="mesh_object_declarative_import">meshObject Declarative Import</h4>
</div>
</div>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 3. Response Fields</caption>
<caption class="title">Table 2. Response Fields</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
Expand Down Expand Up @@ -751,7 +732,7 @@ <h4 id="mesh_object_declarative_import">meshObject Declarative Import</h4>
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.meshcloud.api.meshobjects.v1+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Expand Down Expand Up @@ -780,7 +761,7 @@ <h4 id="mesh_object_declarative_import">meshObject Declarative Import</h4>
Declarative deletion only works, if the respective resource is part of a <a href="#mesh_object_collection">meshObjectCollection</a> (<code><strong>Beta</strong></code>).</p>
</div>
<table id="supported_meshobjects" class="tableblock frame-all grid-all stretch">
<caption class="title">Table 4. Supported meshObjects</caption>
<caption class="title">Table 3. Supported meshObjects</caption>
<colgroup>
<col style="width: 25%;">
<col style="width: 25%;">
Expand Down Expand Up @@ -1523,7 +1504,7 @@ <h5 id="_meshexchangerate">meshExchangeRate</h5>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-06-19 12:58:18 UTC
Last updated 2024-06-25 08:16:39 UTC
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit 0f31c40

Please sign in to comment.