Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[API Docs] update latest API docs #829

Merged
merged 1 commit into from
Jul 3, 2024
Merged

[API Docs] update latest API docs #829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions website/static/api/api_index.html
View file
Open in desktop
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 @@ -549,12 +549,12 @@ <h3 id="_index">Index</h3>

{
"_links" : {
"meshobjects" : {
"href" : "https://mesh-backend-url/api/meshobjects"
},
"metadata" : {
"href" : "https://mesh-backend-url/api/metadata"
},
"meshobjects" : {
"href" : "https://mesh-backend-url/api/meshobjects"
},
"self" : {
"href" : "https://mesh-backend-url/api"
}
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-07-03 12:35:36 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/common_data_formats.html
View file
Open in desktop
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-07-03 12:35:36 UTC
</div>
</div>
</body>
Expand Down
1,811 changes: 1,471 additions & 340 deletions website/static/api/index.html
View file
Open in desktop

Large diffs are not rendered by default.

106 changes: 23 additions & 83 deletions website/static/api/mesh_buildingblock.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -582,7 +582,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.meshcloud.api.meshbuildingblock.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 @@ -601,7 +601,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-06-19T13:03:12.868470453Z"
"createdOn" : "2024-07-03T12:40:09.968171492Z"
},
"spec" : {
"displayName" : "parent block",
Expand Down Expand Up @@ -629,7 +629,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-06-19T13:03:12.879624543Z"
"createdOn" : "2024-07-03T12:40:09.977695812Z"
},
"spec" : {
"displayName" : "child block",
Expand Down Expand Up @@ -819,7 +819,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec.parentBuildingBlocks[]</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Array</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">List of inputs, which are set on the Building Block.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">List of parent building blocks, which are set on the Building Block.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec.parentBuildingBlocks[].buildingBlockUuid</code></p></td>
Expand Down Expand Up @@ -896,7 +896,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
Vary: Access-Control-Request-Headers
Content-Type: application/vnd.meshcloud.api.meshbuildingblock.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 @@ -913,7 +913,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-06-19T13:03:12.879624543Z"
"createdOn" : "2024-07-03T12:40:09.977695812Z"
},
"spec" : {
"displayName" : "child block",
Expand Down Expand Up @@ -997,7 +997,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
}],
"parentBuildingBlocks" : [{
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
"buildingBlockUuid": "e3867023-79e1-4e32-be15-11f89b1b0524"
"buildingBlockUuid": "58e645a0-bd4f-486b-a300-ff6fd3e4ad9a"
}]
}
}</code></pre>
Expand Down Expand Up @@ -1025,14 +1025,14 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
}],
"parentBuildingBlocks" : [{
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
"buildingBlockUuid": "e3867023-79e1-4e32-be15-11f89b1b0524"
"buildingBlockUuid": "58e645a0-bd4f-486b-a300-ff6fd3e4ad9a"
}]
}
} '</code></pre>
</div>
</div>
<table id="mesh_buildingblock_create_response_fields" class="tableblock frame-all grid-all stretch">
<caption class="title">Table 8. Response Fields</caption>
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 8. Request Fields</caption>
<colgroup>
<col style="width: 33.3333%;">
<col style="width: 33.3333%;">
Expand All @@ -1059,12 +1059,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Always contains the 'uuid' to uniquely identify the Building Block. It also contains additional meta information like the Building Block creation date.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.uuid</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The UUID to uniquely identify the Building Block.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Fixed fields that help identify the Building Block.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.definitionUuid</code></p></td>
Expand All @@ -1082,26 +1077,6 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
<td class="tableblock halign-left valign-top"><p class="tableblock">The full identifier of the tenant, this Building Block is created in.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.forcePurge</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Boolean</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Set to true, if an operator explicitly requested this Building Block to be purged.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.createdOn</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The Building Block has been created at this <a href="#data_types">date</a> (e.g. <code>2020-12-22T09:37:43Z</code>).</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.markedForDeletionOn</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If the Building Block has been marked for deletion, the <a href="#data_types">date</a> when a user requested the deletion is provided via this field. e.g. <code>2020-12-22T09:37:43Z</code></p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>metadata.markedForDeletionBy</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">If the Building Block has already been deleted, the username of the user who triggered the deletion is provided here.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">All fields in this section describe the Building Block.</p></td>
Expand Down Expand Up @@ -1134,7 +1109,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec.parentBuildingBlocks[]</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Array</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">List of inputs, which are set on the Building Block.</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">List of parent building blocks, which are required for the Building Block. If none given, an empty list needs to be provided.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>spec.parentBuildingBlocks[].buildingBlockUuid</code></p></td>
Expand All @@ -1146,44 +1121,9 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The UUID of the Building Block Definition of the parent Building Block.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>status</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">All fields in this section describe the current status of the Building Block.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>status.status</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The status of the Building Block. One of WAITING_FOR_DEPENDENT_INPUT, WAITING_FOR_OPERATOR_INPUT, PENDING, IN_PROGRESS, SUCCEEDED, FAILED.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>status.outputs[]</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Array</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">List of outputs, which are set on the Building Block.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>status.outputs[].key</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The key of the output as set on the related Building Block Definition.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>status.outputs[].value</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The value, which is set on this output.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>status.outputs[].valueType</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>String</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">The data type of the value. One of STRING, INTEGER, BOOLEAN, FILE, LIST, SINGLE_SELECT.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>_links</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>Object</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Available <a href="#mesh_buildingblock_links">links</a> on a Building Block.</p></td>
</tr>
</tbody>
</table>
<table id="mesh_buildingblock_create_links" class="tableblock frame-all grid-all stretch">
<table class="tableblock frame-all grid-all stretch">
<caption class="title">Table 9. Building Block Links</caption>
<colgroup>
<col style="width: 50%;">
Expand All @@ -1205,13 +1145,13 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
<div class="listingblock">
<div class="title">Example Response</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 201 Created
<pre class="highlight nowrap"><code class="language-http" data-lang="http">HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/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 @@ -1223,12 +1163,12 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
"apiVersion" : "v1",
"kind" : "meshBuildingBlock",
"metadata" : {
"uuid" : "9f16fd08-c275-439b-95ab-052ea2ed2477",
"uuid" : "65ebee9c-6fb1-4967-9ffe-66cc697f353a",
"definitionUuid" : "ef6aaf87-3f8c-477c-94f4-f3cf509728ca",
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-06-19T13:03:14.191347544Z",
"createdOn" : "2024-07-03T12:40:11.722932010Z",
"markedForDeletionOn" : null,
"markedForDeletionBy" : null
},
Expand All @@ -1240,7 +1180,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
"valueType" : "STRING"
} ],
"parentBuildingBlocks" : [ {
"buildingBlockUuid" : "e3867023-79e1-4e32-be15-11f89b1b0524",
"buildingBlockUuid" : "58e645a0-bd4f-486b-a300-ff6fd3e4ad9a",
"definitionUuid" : "b23cfb9a-6974-444f-9d33-62134a632373"
} ]
},
Expand All @@ -1250,7 +1190,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
},
"_links" : {
"self" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/9f16fd08-c275-439b-95ab-052ea2ed2477"
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/65ebee9c-6fb1-4967-9ffe-66cc697f353a"
},
"meshtenant" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location"
Expand All @@ -1268,15 +1208,15 @@ <h5 id="_delete_meshbuildingblock">Delete meshBuildingBlock</h5>
<div class="listingblock">
<div class="title">Example Request</div>
<div class="content">
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/9f16fd08-c275-439b-95ab-052ea2ed2477 HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/65ebee9c-6fb1-4967-9ffe-66cc697f353a HTTP/1.1
Authorization: Basic dmFsaWRfdXNlcm5hbWU6dmFsaWRfcGFzc3dvcmQ=
Host: mesh-backend-url</code></pre>
</div>
</div>
<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-backend-url/api/meshobjects/meshbuildingblocks/9f16fd08-c275-439b-95ab-052ea2ed2477' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
<pre class="highlight"><code class="language-bash" data-lang="bash">$ curl 'https://mesh-backend-url/api/meshobjects/meshbuildingblocks/65ebee9c-6fb1-4967-9ffe-66cc697f353a' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
</div>
</div>
<div class="listingblock">
Expand All @@ -1287,7 +1227,7 @@ <h5 id="_delete_meshbuildingblock">Delete meshBuildingBlock</h5>
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 @@ -1300,7 +1240,7 @@ <h5 id="_delete_meshbuildingblock">Delete meshBuildingBlock</h5>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-06-19 12:58:18 UTC
Last updated 2024-07-03 12:35:36 UTC
</div>
</div>
</body>
Expand Down
10 changes: 5 additions & 5 deletions website/static/api/mesh_object_collection.html
View file
Open in desktop
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" : "RxiyHY7EJQ"
}</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-07-03 12:35:36 UTC
</div>
</div>
</body>
Expand Down
6 changes: 3 additions & 3 deletions website/static/api/mesh_object_declarative_import.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -576,7 +576,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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sttomm can you review that whether this is related to library upgrades

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, it is related to upgrading to Spring Boot 3.0 (and especialyl Spring Security 6). Setting this header to 0 is the new recommendation by OWASP. So I think this change is a good one. It seems like the old default did more harm than good in the end. So it should be good, that it is set to 0 now. spring-projects/spring-security#9631

Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Expand Down Expand Up @@ -751,7 +751,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 @@ -1523,7 +1523,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-07-03 12:35:36 UTC
</div>
</div>
</body>
Expand Down
Loading
Loading