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 #972

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

[API Docs] update latest API docs #972

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
8 changes: 4 additions & 4 deletions website/static/api/api_index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-12-18 15:56:31 UTC
Last updated 2024-12-24 10:26:40 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/api_key_login.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -591,7 +591,7 @@ <h3 id="api_key_login">API Key Login</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-12-18 15:56:31 UTC
Last updated 2024-12-24 10:26:40 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/api_keys.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ <h3 id="api_keys">API Keys</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-12-18 15:56:31 UTC
Last updated 2024-12-24 10:26:40 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-12-18 15:56:31 UTC
Last updated 2024-12-24 10:26:40 UTC
</div>
</div>
</body>
Expand Down
306 changes: 153 additions & 153 deletions website/static/api/index.html
View file
Open in desktop

Large diffs are not rendered by default.

32 changes: 16 additions & 16 deletions website/static/api/mesh_buildingblock.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-12-18T15:58:30.342491287Z"
"createdOn" : "2024-12-24T10:28:45.408745431Z"
},
"spec" : {
"displayName" : "parent block",
Expand Down Expand Up @@ -632,7 +632,7 @@ <h5 id="_list_meshbuildingblocks">List meshBuildingBlocks</h5>
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-12-18T15:58:30.393414176Z"
"createdOn" : "2024-12-24T10:28:45.451972349Z"
},
"spec" : {
"displayName" : "child block",
Expand Down Expand Up @@ -923,7 +923,7 @@ <h5 id="_get_meshbuildingblock">Get meshBuildingBlock</h5>
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-12-18T15:58:30.393414176Z"
"createdOn" : "2024-12-24T10:28:45.451972349Z"
},
"spec" : {
"displayName" : "child block",
Expand Down Expand Up @@ -1015,7 +1015,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
}],
"parentBuildingBlocks" : [{
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
"buildingBlockUuid": "13357249-73ee-4b21-b673-1237553baee7"
"buildingBlockUuid": "b21c386d-b293-444b-a5dd-43d9f1ede3da"
}]
}
}</code></pre>
Expand Down Expand Up @@ -1044,7 +1044,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
}],
"parentBuildingBlocks" : [{
"definitionUuid": "b23cfb9a-6974-444f-9d33-62134a632373",
"buildingBlockUuid": "13357249-73ee-4b21-b673-1237553baee7"
"buildingBlockUuid": "b21c386d-b293-444b-a5dd-43d9f1ede3da"
}]
}
} '</code></pre>
Expand Down Expand Up @@ -1172,7 +1172,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Location: https://mesh-backend-url/api/meshobjects/meshbuildingblocks/4990fba5-8583-42b3-9085-92950d8b5134
Location: https://mesh-backend-url/api/meshobjects/meshbuildingblocks/58fa4c89-c7f1-40dc-9073-a1eaa1124e54
Content-Type: application/vnd.meshcloud.api.meshbuildingblock.v1.hal+json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Expand All @@ -1187,12 +1187,12 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
"kind" : "meshBuildingBlock",
"apiVersion" : "v1",
"metadata" : {
"uuid" : "4990fba5-8583-42b3-9085-92950d8b5134",
"uuid" : "58fa4c89-c7f1-40dc-9073-a1eaa1124e54",
"definitionUuid" : "ef6aaf87-3f8c-477c-94f4-f3cf509728ca",
"definitionVersion" : 1,
"tenantIdentifier" : "my-workspace.my-project.my-platform.my-location",
"forcePurge" : false,
"createdOn" : "2024-12-18T15:58:31.454699726Z"
"createdOn" : "2024-12-24T10:28:46.560025112Z"
},
"spec" : {
"displayName" : "New BuildingBlock",
Expand All @@ -1202,7 +1202,7 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
"valueType" : "STRING"
} ],
"parentBuildingBlocks" : [ {
"buildingBlockUuid" : "13357249-73ee-4b21-b673-1237553baee7",
"buildingBlockUuid" : "b21c386d-b293-444b-a5dd-43d9f1ede3da",
"definitionUuid" : "b23cfb9a-6974-444f-9d33-62134a632373"
} ]
},
Expand All @@ -1212,13 +1212,13 @@ <h5 id="_post_meshbuildingblock">Post meshBuildingBlock</h5>
},
"_links" : {
"self" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/4990fba5-8583-42b3-9085-92950d8b5134"
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/58fa4c89-c7f1-40dc-9073-a1eaa1124e54"
},
"meshtenant" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshtenants/my-workspace.my-project.my-platform.my-location"
},
"forcePurge" : {
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/4990fba5-8583-42b3-9085-92950d8b5134/purge"
"href" : "https://mesh-backend-url/api/meshobjects/meshbuildingblocks/58fa4c89-c7f1-40dc-9073-a1eaa1124e54/purge"
}
}
}</code></pre>
Expand All @@ -1235,15 +1235,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/4990fba5-8583-42b3-9085-92950d8b5134 HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/58fa4c89-c7f1-40dc-9073-a1eaa1124e54 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/4990fba5-8583-42b3-9085-92950d8b5134' -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/58fa4c89-c7f1-40dc-9073-a1eaa1124e54' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
</div>
</div>
<div class="listingblock">
Expand Down Expand Up @@ -1273,15 +1273,15 @@ <h5 id="_purge_meshbuildingblock">Purge 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/4990fba5-8583-42b3-9085-92950d8b5134/purge HTTP/1.1
<pre class="highlight nowrap"><code class="language-http" data-lang="http">DELETE /api/meshobjects/meshbuildingblocks/58fa4c89-c7f1-40dc-9073-a1eaa1124e54/purge 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/4990fba5-8583-42b3-9085-92950d8b5134/purge' -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/58fa4c89-c7f1-40dc-9073-a1eaa1124e54/purge' -i -u 'valid_username:valid_password' -X DELETE</code></pre>
</div>
</div>
<div class="listingblock">
Expand Down Expand Up @@ -1673,7 +1673,7 @@ <h5 id="_update_sources_and_steps">Update Sources and Steps</h5>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-12-18 15:56:31 UTC
Last updated 2024-12-24 10:26:40 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/mesh_buildingblockrunner.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -453,7 +453,7 @@ <h3 id="mesh_buildingblockrunner">Building Block Runner API</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-12-18 15:56:31 UTC
Last updated 2024-12-24 10:26:40 UTC
</div>
</div>
</body>
Expand Down
4 changes: 2 additions & 2 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 @@ -677,7 +677,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
{
"message" : "MeshObjectCollection not-empty-collection cannot be deleted, because it is not empty",
"errorCode" : "BadRequest",
"errorId" : "82coC993zW"
"errorId" : "A7cKuq5brK"
}</code></pre>
</div>
</div>
Expand All @@ -686,7 +686,7 @@ <h4 id="_deletemeshobjectcollection">deleteMeshObjectCollection</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-12-18 15:56:31 UTC
Last updated 2024-12-24 10:26:40 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion 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 @@ -1524,7 +1524,7 @@ <h5 id="_meshexchangerate">meshExchangeRate</h5>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-12-18 15:56:31 UTC
Last updated 2024-12-24 10:26:40 UTC
</div>
</div>
</body>
Expand Down
Loading
Loading