Skip to content

Commit 926d2d1

Browse files
chore: update edge documentation (#245)
Co-authored-by: Matthias Veit <[email protected]>
1 parent cd98aae commit 926d2d1

27 files changed

+62
-96
lines changed

docs/reference/api/abort-a-batch-update.api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
id: abort-a-batch-update
33
title: "Abort a batch update"
4-
description: "**Experimental**: This API is not stable and might be subject of change.<br/>"
4+
description: "Abort a batch update."
55
sidebar_label: "Abort a batch update"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: {"description":"**Experimental**: This API is not stable and might be subject of change.<br/>\nAbort a batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"path","description":"A batch identifier is a string that uniquely identifies the batch update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"string","example":"Batch aborted."}}}}},"method":"delete","path":"/graph/{graph_id}/batch/{batch_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Abort a batch update","description":{"content":"**Experimental**: This API is not stable and might be subject of change.<br/>\nAbort a batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch",":batch_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) A batch identifier is a string that uniquely identifies the batch update.","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}}
8+
api: {"description":"Abort a batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"path","description":"A batch identifier is a string that uniquely identifies the batch update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"string","example":"Batch aborted."}}}}},"method":"delete","path":"/graph/{graph_id}/batch/{batch_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Abort a batch update","description":{"content":"Abort a batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch",":batch_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) A batch identifier is a string that uniquely identifies the batch update.","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"DELETE"}}
99
sidebar_class_name: "delete api-method"
1010
info_path: reference/api/fix-inventory-core-rest-api
1111
custom_edit_url: null
@@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem";
4040

4141
</MethodEndpoint>
4242

43-
**Experimental**: This API is not stable and might be subject of change.<br/> Abort a batch update.
43+
Abort a batch update.
4444

4545
<Heading
4646
id={"request"}

docs/reference/api/commit-a-batch-update.api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
id: commit-a-batch-update
33
title: "Commit a batch update"
4-
description: "**Experimental**: This API is not stable and might be subject of change.<br/>"
4+
description: "Commit a batch update."
55
sidebar_label: "Commit a batch update"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: {"description":"**Experimental**: This API is not stable and might be subject of change.<br/>\nCommit a batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"path","description":"A batch identifier is a string that uniquely identifies the batch update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"string","example":"Batch committed."}}}}},"method":"post","path":"/graph/{graph_id}/batch/{batch_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Commit a batch update","description":{"content":"**Experimental**: This API is not stable and might be subject of change.<br/>\nCommit a batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch",":batch_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) A batch identifier is a string that uniquely identifies the batch update.","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}}
8+
api: {"description":"Commit a batch update.\n","tags":["graph_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"batch_id","in":"path","description":"A batch identifier is a string that uniquely identifies the batch update.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Ok message","content":{"application/json":{"schema":{"type":"string","example":"Batch committed."}}}}},"method":"post","path":"/graph/{graph_id}/batch/{batch_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Commit a batch update","description":{"content":"Commit a batch update.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","batch",":batch_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) A batch identifier is a string that uniquely identifies the batch update.","type":"text/plain"},"type":"any","value":"","key":"batch_id"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"POST"}}
99
sidebar_class_name: "post api-method"
1010
info_path: reference/api/fix-inventory-core-rest-api
1111
custom_edit_url: null
@@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem";
4040

4141
</MethodEndpoint>
4242

43-
**Experimental**: This API is not stable and might be subject of change.<br/> Commit a batch update.
43+
Commit a batch update.
4444

4545
<Heading
4646
id={"request"}

docs/reference/api/create-a-new-node-under-the-given-parent-node.api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
id: create-a-new-node-under-the-given-parent-node
33
title: "Create a new node under the given parent node"
4-
description: "**Experimental**: This API is not stable and might be subject of change.<br/>"
4+
description: "Create a new node under the given parent node."
55
sidebar_label: "Create a new node under the given parent node"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: {"description":"**Experimental**: This API is not stable and might be subject of change.<br/>\nCreate a new node under the given parent node.\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}},{"name":"parent_node_id","in":"path","description":"The identifier of the parent node","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The node document to create.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}},"responses":{"200":{"description":"Return the created node","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}}},"method":"post","path":"/graph/{graph_id}/node/{node_id}/under/{parent_node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Create a new node under the given parent node","description":{"content":"**Experimental**: This API is not stable and might be subject of change.<br/>\nCreate a new node under the given parent node.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id","under",":parent_node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the parent node","type":"text/plain"},"type":"any","value":"","key":"parent_node_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
8+
api: {"description":"Create a new node under the given parent node.\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}},{"name":"parent_node_id","in":"path","description":"The identifier of the parent node","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"The node document to create.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}},"responses":{"200":{"description":"Return the created node","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"kind":{"type":"string","description":"The kind of this node."}},"example":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"title":"Node"}}}}},"method":"post","path":"/graph/{graph_id}/node/{node_id}/under/{parent_node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"id":"123456","reported":{"kind":"test.person","name":"Batman","city":"Gotham"}},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Create a new node under the given parent node","description":{"content":"Create a new node under the given parent node.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id","under",":parent_node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the parent node","type":"text/plain"},"type":"any","value":"","key":"parent_node_id"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
99
sidebar_class_name: "post api-method"
1010
info_path: reference/api/fix-inventory-core-rest-api
1111
custom_edit_url: null
@@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem";
4040

4141
</MethodEndpoint>
4242

43-
**Experimental**: This API is not stable and might be subject of change.<br/> Create a new node under the given parent node.
43+
Create a new node under the given parent node.
4444

4545
<Heading
4646
id={"request"}

docs/reference/api/delete-a-configuration-by-its-id.api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
id: delete-a-configuration-by-its-id
33
title: "Delete a configuration by its id"
4-
description: "**Experimental**: This API is not stable and might be subject of change.<br/>"
4+
description: "Delete a configuration identified by id with provided value."
55
sidebar_label: "Delete a configuration by its id"
66
hide_title: true
77
hide_table_of_contents: true
8-
api: {"description":"**Experimental**: This API is not stable and might be subject of change.<br/>\nDelete a configuration identified by id with provided value.\n","tags":["config"],"parameters":[{"name":"config_id","in":"path","required":true,"description":"the identifier of the config to get.","schema":{"type":"string"}}],"responses":{"204":{"description":"Signals success of this operation."}},"method":"delete","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a configuration by its id","description":{"content":"**Experimental**: This API is not stable and might be subject of change.<br/>\nDelete a configuration identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"method":"DELETE"}}
8+
api: {"description":"Delete a configuration identified by id with provided value.\n","tags":["config"],"parameters":[{"name":"config_id","in":"path","required":true,"description":"the identifier of the config to get.","schema":{"type":"string"}}],"responses":{"204":{"description":"Signals success of this operation."}},"method":"delete","path":"/config/{config_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a configuration by its id","description":{"content":"Delete a configuration identified by id with provided value.\n","type":"text/plain"},"url":{"path":["config",":config_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) the identifier of the config to get.","type":"text/plain"},"type":"any","value":"","key":"config_id"}]},"method":"DELETE"}}
99
sidebar_class_name: "delete api-method"
1010
info_path: reference/api/fix-inventory-core-rest-api
1111
custom_edit_url: null
@@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem";
4040

4141
</MethodEndpoint>
4242

43-
**Experimental**: This API is not stable and might be subject of change.<br/> Delete a configuration identified by id with provided value.
43+
Delete a configuration identified by id with provided value.
4444

4545
<Heading
4646
id={"request"}

docs/reference/api/delete-a-node-with-the-given-node-id.api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
id: delete-a-node-with-the-given-node-id
33
title: "Delete a node with the given node id."
4-
description: "**Experimental**: This API is not stable and might be subject of change.<br/>"
4+
description: "Delete a node with the given node id."
55
sidebar_label: "Delete a node with the given node id."
66
hide_title: true
77
hide_table_of_contents: true
8-
api: {"description":"**Experimental**: This API is not stable and might be subject of change.<br/>\nDelete a node with the given node id.\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Node is deleted"}},"method":"delete","path":"/graph/{graph_id}/node/{node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a node with the given node id.","description":{"content":"**Experimental**: This API is not stable and might be subject of change.<br/>\nDelete a node with the given node id.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"method":"DELETE"}}
8+
api: {"description":"Delete a node with the given node id.\n","tags":["node_management"],"parameters":[{"name":"graph_id","in":"path","example":"fix","description":"The identifier of the graph","required":true,"schema":{"type":"string"}},{"name":"node_id","in":"path","description":"The identifier of the node","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Node is deleted"}},"method":"delete","path":"/graph/{graph_id}/node/{node_id}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Delete a node with the given node id.","description":{"content":"Delete a node with the given node id.\n","type":"text/plain"},"url":{"path":["graph",":graph_id","node",":node_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The identifier of the graph","type":"text/plain"},"type":"any","value":"","key":"graph_id"},{"disabled":false,"description":{"content":"(Required) The identifier of the node","type":"text/plain"},"type":"any","value":"","key":"node_id"}]},"method":"DELETE"}}
99
sidebar_class_name: "delete api-method"
1010
info_path: reference/api/fix-inventory-core-rest-api
1111
custom_edit_url: null
@@ -40,7 +40,7 @@ import TabItem from "@theme/TabItem";
4040

4141
</MethodEndpoint>
4242

43-
**Experimental**: This API is not stable and might be subject of change.<br/> Delete a node with the given node id.
43+
Delete a node with the given node id.
4444

4545
<Heading
4646
id={"request"}

0 commit comments

Comments
 (0)