Skip to content

[API Docs] update latest API docs #1104

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

Merged
merged 1 commit into from
Jun 18, 2025
Merged

[API Docs] update latest API docs #1104

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
2 changes: 1 addition & 1 deletion website/static/api/api_index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -566,7 +566,7 @@ <h3 id="_index">Index</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-06-11 13:53:07 UTC
Last updated 2025-06-18 09:00:05 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 2025-06-11 13:53:07 UTC
Last updated 2025-06-18 09:00:05 UTC
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion website/static/api/authentication.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,7 @@ <h3 id="_basic_authentication">Basic Authentication</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-06-11 13:53:07 UTC
Last updated 2025-06-18 09:00:05 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 2025-06-11 13:53:07 UTC
Last updated 2025-06-18 09:00:05 UTC
</div>
</div>
</body>
Expand Down
36 changes: 18 additions & 18 deletions website/static/api/deprecated_resources.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -460,25 +460,25 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshusers/{username}</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshusers</code><br>
<code>meshUser.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshUser.v2</code>, which features an updated set of <code>_links</code> reflecting the renaming of <code>meshCustomer</code> to <code>meshWorkspace</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshusers</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshusers/{username}</code><br>
<code>meshUser.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshUser.v2</code>, which features an updated set of <code>_links</code> reflecting the renaming of <code>meshCustomer</code> to <code>meshWorkspace</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomers</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomers/{identifier}</code><br>
<code>meshCustomer.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Replace all uses of the <code>meshCustomer</code> object with <code>meshWorkspace</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomers/{identifier}</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomers</code><br>
<code>meshCustomer.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Replace all uses of the <code>meshCustomer</code> object with <code>meshWorkspace</code>.</p></td>
</tr>
Expand All @@ -496,49 +496,49 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomerusergroups</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomerusergroups/{fullCustomerUserGroupIdentifier}</code><br>
<code>meshCustomerUserGroup.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Replace all uses of <code>meshCustomerUserGroup</code> object with <code>meshWorkspaceUserGroup</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-03-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomerusergroups/{fullCustomerUserGroupIdentifier}</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshcustomerusergroups</code><br>
<code>meshCustomerUserGroup.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Replace all uses of <code>meshCustomerUserGroup</code> object with <code>meshWorkspaceUserGroup</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshpaymentmethods/{identifier}</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshpaymentmethods</code><br>
<code>meshPaymentMethod.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshPaymentMethod.v2</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshpaymentmethods</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshpaymentmethods/{identifier}</code><br>
<code>meshPaymentMethod.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshPaymentMethod.v2</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshprojects/{fullProjectIdentifier}</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshprojects</code><br>
<code>meshProject.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please use <code>meshProject.v2</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshprojects</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshprojects/{fullProjectIdentifier}</code><br>
<code>meshProject.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please use <code>meshProject.v2</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
<code>meshTenant.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshTenant.v4</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
<code>meshTenant.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshTenant.v4</code>, which is owned by a <code>meshWorkspace</code> instead of a <code>meshCustomer</code>.</p></td>
</tr>
Expand All @@ -556,7 +556,7 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshbuildingblocks</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshbuildingblocks</code><br>
<code>meshBuildingBlock.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please use <code>meshBuildingBlock.v2</code>, which supports building blocks on workspace level as well.</p></td>
</tr>
Expand All @@ -568,7 +568,7 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-07-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshbuildingblocks</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshbuildingblocks</code><br>
<code>meshBuildingBlock.v1</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please use <code>meshBuildingBlock.v2</code>, which supports building blocks on workspace level as well.</p></td>
</tr>
Expand Down Expand Up @@ -610,19 +610,19 @@ <h3 id="_deprecated_meshobject_api_endpoints">Deprecated meshObject API Endpoint
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-11-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshtenants</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
<code>meshTenant.v3</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshTenant.v4</code>, which uses a UUID to identify a meshTenant.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-11-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants/{tenantIdentifier}</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
<code>meshTenant.v3</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshTenant.v4</code>, which uses a UUID to identify a meshTenant.</p></td>
</tr>
<tr>
<td class="tableblock halign-left valign-top"><p class="tableblock">2025-11-01</p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>GET /api/meshobjects/meshtenants</code><br>
<td class="tableblock halign-left valign-top"><p class="tableblock"><code>POST /api/meshobjects/meshtenants</code><br>
<code>meshTenant.v3</code></p></td>
<td class="tableblock halign-left valign-top"><p class="tableblock">Please upgrade to <code>meshTenant.v4</code>, which uses a UUID to identify a meshTenant.</p></td>
</tr>
Expand Down Expand Up @@ -739,7 +739,7 @@ <h3 id="_deprecated_meshobjects_in_declarative_import">Deprecated meshObjects in
</div>
<div id="footer">
<div id="footer-text">
Last updated 2025-06-11 13:53:07 UTC
Last updated 2025-06-18 09:00:05 UTC
</div>
</div>
</body>
Expand Down
Loading