Skip to content

Commit

Permalink
chore: update edge documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
some-ci committed Dec 9, 2024
1 parent d03fbf1 commit 41b70e8
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/reference/api/load-time-series-data.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Load time series data."
sidebar_label: "Load time series data."
hide_title: true
hide_table_of_contents: true
api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-12-05T17:24:43.057Z","end":"2024-12-05T17:24:43.057Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-12-09T10:59:40.221Z","end":"2024-12-09T10:59:40.221Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
sidebar_class_name: "post api-method"
info_path: reference/api/fix-inventory-core-rest-api
custom_edit_url: null
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Load time series data."
sidebar_label: "Load time series data."
hide_title: true
hide_table_of_contents: true
api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-12-05T17:24:43.426Z","end":"2024-12-05T17:24:43.426Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
api: {"parameters":[{"name":"timeseries","description":"The name of the time series.","in":"path","required":true,"schema":{"type":"string","example":"some_name"}}],"requestBody":{"description":"Parameters of the time series request.","content":{"application/json":{"schema":{"type":"object","properties":{"start":{"type":"string","format":"date-time","description":"The start of the time series. If not defined 7 days from now into the past."},"end":{"type":"string","format":"date-time","description":"The end of the time series. If not defined now."},"group":{"type":"array","items":{"type":"string"},"description":"Reduce the available groups to the set of defined ones."},"filter":{"type":"array","items":{"type":"string"},"description":"Filter available group members by predicate.\nOnly time series values with matching group criteria will be selected.\n","example":"group_var_foo == \"bla\""},"granularity":{"type":"string","format":"duration","description":"The granularity of the time series.\nThis can be either a duration or the number of items for the time window that is selected.\nThe granularity can not go below one hour.\nIt defaults to (end-start) / 20.\n"}}}}}},"tags":["timeseries"],"responses":{"400":{"description":"A required property is missing or the request can not be read.","content":{"text/plain":{"schema":{"type":"string"}}}},"default":{"description":"The time series data","content":{"application/json":{"schema":{"type":"object","additionalProperties":true},"example":"{\n \"time\": \"2021-01-01T00:00:00Z\",\n \"value\": 1\n}\n"}}}},"description":"Load time series data.","method":"post","path":"/timeseries/{timeseries}","servers":[{"url":"https://{host}:{port}","variables":{"host":{"default":"localhost"},"port":{"default":"8900"}}}],"jsonRequestBodyExample":{"start":"2024-12-09T10:59:40.584Z","end":"2024-12-09T10:59:40.584Z","group":["string"],"filter":"group_var_foo == \"bla\"","granularity":"string"},"info":{"title":"Fix Inventory Core REST API","version":"V1"},"postman":{"name":"Load time series data.","description":{"type":"text/plain"},"url":{"path":["timeseries",":timeseries"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The name of the time series.","type":"text/plain"},"type":"any","value":"","key":"timeseries"}]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"text/plain"}],"method":"POST","body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}}}}
sidebar_class_name: "post api-method"
info_path: version-4.X/reference/api/fix-inventory-core-rest-api
custom_edit_url: null
Expand Down

0 comments on commit 41b70e8

Please sign in to comment.