From 36c2d9f3108fd744231e51e8d3692f627dcc17b4 Mon Sep 17 00:00:00 2001 From: Bruno Gelatti Date: Thu, 23 Oct 2025 17:27:54 -0300 Subject: [PATCH 1/7] feat: add Create Device using Network endpoint documentation Added comprehensive documentation for the new network device creation endpoint supporting both immutable and mutable device types with detailed parameter specifications and examples. --- docs/api/create-device-using-network.api.mdx | 71 +++++++++ docs/api/sidebar/api-sidebar.ts | 6 + specs/tagoio-api.yaml | 152 +++++++++++++++++++ 3 files changed, 229 insertions(+) create mode 100644 docs/api/create-device-using-network.api.mdx diff --git a/docs/api/create-device-using-network.api.mdx b/docs/api/create-device-using-network.api.mdx new file mode 100644 index 0000000..1aba190 --- /dev/null +++ b/docs/api/create-device-using-network.api.mdx @@ -0,0 +1,71 @@ +--- +id: create-device-using-network +title: "Create Device using Network" +description: "Create either an immutable or a mutable device. Immutable devices require chunking parameters and are optimized for long-term, append-only storage. Mutable devices behave like classic devices and do not require chunk settings." +sidebar_label: "Create Device using Network" +hide_title: true +hide_table_of_contents: true +api: eJzlWVtv20YW/isHk4e0Aqm7fNFDAdcJdo02FyQ2isIy2iF5RE1NzjAzQytaQ/99cWZIipTiS9rsFovNS2TyzHfut+E9szw1bH7N3qJdK30LFzJFY9lNwBI0sRaFFUqyOTvXyC0CCrtCDVyCyPPS8ihDUBo41H8keCdi7MNF3n1iQOOnUmiEeFXKWyFTKLjmOVrUBrhMgGsEVViRi39hAkulIVMyDS3qPABeFCiTUMlsA8YqzVPsw5s9DhGu+B1CJm4R4owbI+LmHXFIFEhlu4KAQWuFTE2fBUwVqDkpfJGwOYudyq8cwJURMq1sxAJGEGjsjyrZsPk9i5W0KC395EWRidiBDP4wZLp7ZuIV5px+KYnvlmx+fc+ssBmyOdvZyTMCZ2iyecDspiASFf2Bsa24Co0J+UvyHGuSgASQGFul6Tep9VuBWqik+VMjCUiwNwErNClqBRqSySHN72tuxmohU7bv/0q6ii1+5nnh5H+zgaXQxrbiwZucbWsFDqFRljkp0Zw5jLeKH52EEPLSWIgQXjYnXroI2WdqOrLt4LdtEz2p63lNChevHBu7arRq48+WM36ynExmo2SaRKen8XSYYIwzx67thUdMkPANC9gakcIqV9KuWMA+lVxb1F/IQheyHtVJlnDL64SAEJREUEtI+CYAwgzAQQZQI7bFr59tD4NkJ7As88idy4UUOck8DFjOP/vfk6N9Cd86ehLCYRqwCjRaLiR8NwwnR9+3RZgcbQNmUAv8reLzpG8+ohY8A0/uNM42dUYnIJZgCozFUmAC0cY5TjZZu1P97MeT48np+Hx0fH7mAtVVwYY319q55cshyVMD3MAtbsI7npUIXlQouNAUgMJi3kZr8rebd7e4eVrdS54So47wlqc/4WZEcjv+z0PxpG0c92TEtttt6+l1JVjDpWHS0AddkvE+yZhtbwh0V+TefNMS95+qYM+vW19btTo167GK9ffVq781C8c+C3lsxV3b8JFSGXL5kCs9PRjLbdmxo9Ul/oms/su5+3U5+l/KxIDdCSMoqp5tWHdAZMJuHjLu1gFXz5xJqgFxf56hV40FfKI+MjM0BWHXujuZ8HAI73dctut4B82NulY33vcawjao1XnzfGX2VfhqBR4SyWWHiw2Ln+2gyLhwHfrrrM/uF3ohARZO8AWbw+JhRyxYUFOTNp66IWq9bVTzJA9p1z7RcpM/VHlqwQIYDBJcConAq+m8GnWiDSxoVCIcNywR8cLPS/5nA9Ll03idWE2OiAOPYyy8sprLFCFCu0aUQONJfbrtCy9lO0IWDAYDV/PEclf2ok1d5eA75TKKZ987wC17RkQ96qBH3PItnPKIuuM/pa6PV42mUNL4EB0PR/Rft+B0VzjwK1cCg4P9sX7l0+l529bjNVyjKTP7NJ3nf/Hq8RI+S2KejOLx6Gh0PI2Hw1HMxxMenbpxQt2ifOI4Hx1Nh7NlGE3GcTiNT0chx8lpGEfROOYRH50kJ74/VAX5S7V8v0R7J+RoV64iFso47bhdsTkbCGkx9evuoHLkoKlhBvUdauO6UKkzNmcrawszHwx4IfqlCXHUtzxVfaFcGzqkwTJct2huCDMutbAbB/peq6XI8NKb5vqmTfCRPOiN77MkvNyzIC/ET3jYy8+gTQ92xS0IA6UUn0qkTWSjSt1cUfwDJa37VGychyiiqTgY2vU9qYd7aaCgCwcW1EW/I1bAqB6zFfLE9ZvPYcuvOBpPpjMeJsdDHk5xnITRySQJZ/HQvTg6PnEhUl0tPF/R+r7mUU0roj6cObXgYudyAz80GD94FLerpftGoXmyA7azwkPqvxKmyPjmrafqqtY1zzKZTU95Mg5PRpM4nCZHR2G0PB6Hs+EJzqLTE77ECZmnipbnm6c6UOnwgHmoM2iEwtO2AkJIT8DjWJXSdu6IKt27Ej0WAnw0Qz5DHibJOAmn8dEkPDmdzsLTcTSbJnx6fDzmbuSgAvZhd7H0ukb4n5mb6on7202uQi6Vc3e1SF7yVF28g7P3Fwc+f/HixQvo9f6p1uTf0iDYlTCQqLjMUVoX9L3eQl7SbtR+SIFhikxYyv/1SsSrKmo2qnypcdfwKlgh3UJTXQH2ARayEqvQ6k4kaGAKiVguUaO0HsvMFzKEXq9dN3q9OZAwVZpplbfLU1CJslElxFxCitbT7Ha7uixRCycpiEEnLInDWWYU3Eq1piuLMx/P/m0fflXlDtfxrlKhCfhDBp1sJgYXxom0r0VTet7R3MDvuMhcwIplbVe1lv6iqLUeNpkn2pXqQIgzybONEcZLMe/1vmhIXlEFbfbeefWrGjoMw4V0EfTRa+6ozt5fwGuZFEpICx8wpTFS/rJCCTl3N9i8jgKKDTqxi8/Aec7dAHBygV+I/S7MC5owtKBSox0szwArRn04XyllsL7LowNLlWVqTRxrKgMRN5iAquyVoko1L1Yi5lmFOV9Ib60rKWim+mi5RQOvubEwIpuBN+lVnSo1NqxXWBfA3XxFaeJ5VjZEbixqCR34fo3a6119+Jm4/P7g4DD4ve3T1yVNXfALfgPxCIRE85hPyNQZVEgmLw+5El5hkalNIw0ljFmpMktcJXAyqLV0gXL14eemz3TizQ8SKudCGjAYO2krxxITz4NaC01cvpiN+sP+sBp1eUxDKjUIGuByLlsdodopqrW9dIPL7itFp0C2vlL8f3zMqTpia2feBn5Ova9m4GvWKjPU2luWc231JmArGprn1+z+nqLrSmfbLT3+VKKmQfaG+pYWruPSFBvUM8CuCZ57s4eX/h6zbnMHq8uuJ565DfVR2pvWXP/+3cdLFrCo+hiVq4TOaL6m+1S+ZnPmPm25WuoWH3p2zzIu05KnROsx6d+/ARyyhvs= +sidebar_class_name: "post api-method" +info_path: docs/api/tagoio-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + + + + + + + + + + +Create either an immutable or a mutable device. Immutable devices require chunking parameters and are optimized for long-term, append-only storage. Mutable devices behave like classic devices and do not require chunk settings. + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/sidebar/api-sidebar.ts b/docs/api/sidebar/api-sidebar.ts index 1af8419..a5bb00a 100644 --- a/docs/api/sidebar/api-sidebar.ts +++ b/docs/api/sidebar/api-sidebar.ts @@ -97,6 +97,12 @@ const sidebar: SidebarsConfig = { label: "Send Data using Network", className: "api-method post", }, + { + type: "doc", + id: "api/create-device-using-network", + label: "Create Device using Network", + className: "api-method post", + }, ], }, { diff --git a/specs/tagoio-api.yaml b/specs/tagoio-api.yaml index a1d0376..14e3dd8 100644 --- a/specs/tagoio-api.yaml +++ b/specs/tagoio-api.yaml @@ -9289,6 +9289,158 @@ paths: required: true schema: type: string + /integration/network/device: + post: + tags: + - Network Ingest + summary: Create Device using Network + description: Create either an immutable or a mutable device. Immutable devices require chunking parameters and are optimized for long-term, append-only storage. Mutable devices behave like classic devices and do not require chunk settings. + operationId: createDeviceUsingNetwork + requestBody: + content: + application/json: + schema: + oneOf: + - title: "Immutable Device Creation" + type: object + required: ["name", "type", "connector", "chunk_period", "chunk_retention"] + properties: + name: + type: string + description: "Device name" + example: "My first immutable device" + type: + type: string + enum: ["immutable"] + description: "Device type - must be 'immutable' for immutable devices" + example: "immutable" + connector: + type: string + description: "Connector ID for the device" + example: "5f5a8f3351d4db99c40dece5" + chunk_period: + type: string + enum: ["day", "week", "month", "quarter"] + description: "Chunk period for data storage - one of day, week, month, quarter" + example: "quarter" + chunk_retention: + type: number + minimum: 0 + maximum: 36 + description: "Number of chunks to retain (0-36)" + example: 36 + serie_number: + type: string + description: "Serial number - only required if specified by the network" + example: "AB87392C17CA" + tags: + type: array + description: "Device tags as key-value string pairs" + items: + type: object + properties: + key: + type: string + description: "Tag key" + example: "tagKey1" + value: + type: string + description: "Tag value" + example: "value1" + example: + - key: "tagKey1" + value: "value1" + - key: "tagKey2" + value: "value2" + - title: "Mutable Device Creation" + type: object + required: ["name", "type", "connector"] + properties: + name: + type: string + description: "Device name" + example: "My first device" + type: + type: string + enum: ["mutable"] + description: "Device type - must be 'mutable' for mutable devices" + example: "mutable" + connector: + type: string + description: "Connector ID for the device" + example: "5f5a8f3351d4db99c40dece5" + serie_number: + type: string + description: "Serial number - only required if specified by the network" + example: "AB87392C12CA" + active: + type: boolean + description: "Device active status" + example: true + tags: + type: array + description: "Device tags" + items: + type: object + properties: + key: + type: string + example: "tagKey1" + value: + type: string + example: "value1" + example: + - key: "tagKey1" + value: "value1" + - key: "tagKey2" + value: "value2" + visible: + type: boolean + description: "Device visibility status" + example: true + + examples: + Create Immutable Device: + value: + name: "My first immutable device" + type: "immutable" + connector: "5f5a8f3351d4db99c40dece5" + chunk_period: "quarter" + chunk_retention: 36 + serie_number: "AB87392C17CA" + Create Mutable Device: + value: + name: "My first device" + type: "mutable" + connector: "5f5a8f3351d4db99c40dece5" + serie_number: "AB87392C12CA" + text/plain: + examples: + Create Immutable Device: + value: "{\r\n \"name\": \"My first immutable device\",\r\n \"type\": \"immutable\",\r\n \"connector\": \"5f5a8f3351d4db99c40dece5\",\r\n \"chunk_period\": \"quarter\", //define a chunk period by \"day\",\"week\", \"month\", \"quarter\"\r\n \"chunk_retention\": 36, //acceptable range between 0-36\r\n \"serie_number\": \"AB87392C17CA\" //only if required by network (optional)\r\n }" + Create Mutable Device: + value: "{\r\n \"name\": \"My first device\",\r\n \"type\": \"mutable\",\r\n \"connector\": \"5f5a8f3351d4db99c40dece5\",\r\n \"serie_number\": \"AB87392C12CA\" //only if required by network (optional)\r\n }" + responses: + '201': + description: >- + Mutable device created / Immutable device created + content: + application/json: + schema: + type: object + properties: + result: + type: object + properties: + deviceID: + type: string + example: 5dcad1c216174c001ca23ab9 + token: + type: string + example: 5a16405f-b32c-4c91-ae39-cbb2caba18d8 + status: + type: boolean + example: true /integration/network/data: post: tags: From a02d172e80d7e692ae1e54f03620c9b7955eada6 Mon Sep 17 00:00:00 2001 From: Bruno Gelatti Date: Thu, 23 Oct 2025 17:32:48 -0300 Subject: [PATCH 2/7] fix: add Network-Token security requirement to device creation endpoint Added missing security configuration specifying Network-Token authentication for the Create Device using Network endpoint. --- docs/api/create-device-using-network.api.mdx | 2 +- specs/tagoio-api.yaml | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api/create-device-using-network.api.mdx b/docs/api/create-device-using-network.api.mdx index 1aba190..e6476bc 100644 --- a/docs/api/create-device-using-network.api.mdx +++ b/docs/api/create-device-using-network.api.mdx @@ -5,7 +5,7 @@ description: "Create either an immutable or a mutable device. Immutable devices sidebar_label: "Create Device using Network" hide_title: true hide_table_of_contents: true -api: eJzlWVtv20YW/isHk4e0Aqm7fNFDAdcJdo02FyQ2isIy2iF5RE1NzjAzQytaQ/99cWZIipTiS9rsFovNS2TyzHfut+E9szw1bH7N3qJdK30LFzJFY9lNwBI0sRaFFUqyOTvXyC0CCrtCDVyCyPPS8ihDUBo41H8keCdi7MNF3n1iQOOnUmiEeFXKWyFTKLjmOVrUBrhMgGsEVViRi39hAkulIVMyDS3qPABeFCiTUMlsA8YqzVPsw5s9DhGu+B1CJm4R4owbI+LmHXFIFEhlu4KAQWuFTE2fBUwVqDkpfJGwOYudyq8cwJURMq1sxAJGEGjsjyrZsPk9i5W0KC395EWRidiBDP4wZLp7ZuIV5px+KYnvlmx+fc+ssBmyOdvZyTMCZ2iyecDspiASFf2Bsa24Co0J+UvyHGuSgASQGFul6Tep9VuBWqik+VMjCUiwNwErNClqBRqSySHN72tuxmohU7bv/0q6ii1+5nnh5H+zgaXQxrbiwZucbWsFDqFRljkp0Zw5jLeKH52EEPLSWIgQXjYnXroI2WdqOrLt4LdtEz2p63lNChevHBu7arRq48+WM36ynExmo2SaRKen8XSYYIwzx67thUdMkPANC9gakcIqV9KuWMA+lVxb1F/IQheyHtVJlnDL64SAEJREUEtI+CYAwgzAQQZQI7bFr59tD4NkJ7As88idy4UUOck8DFjOP/vfk6N9Cd86ehLCYRqwCjRaLiR8NwwnR9+3RZgcbQNmUAv8reLzpG8+ohY8A0/uNM42dUYnIJZgCozFUmAC0cY5TjZZu1P97MeT48np+Hx0fH7mAtVVwYY319q55cshyVMD3MAtbsI7npUIXlQouNAUgMJi3kZr8rebd7e4eVrdS54So47wlqc/4WZEcjv+z0PxpG0c92TEtttt6+l1JVjDpWHS0AddkvE+yZhtbwh0V+TefNMS95+qYM+vW19btTo167GK9ffVq781C8c+C3lsxV3b8JFSGXL5kCs9PRjLbdmxo9Ul/oms/su5+3U5+l/KxIDdCSMoqp5tWHdAZMJuHjLu1gFXz5xJqgFxf56hV40FfKI+MjM0BWHXujuZ8HAI73dctut4B82NulY33vcawjao1XnzfGX2VfhqBR4SyWWHiw2Ln+2gyLhwHfrrrM/uF3ohARZO8AWbw+JhRyxYUFOTNp66IWq9bVTzJA9p1z7RcpM/VHlqwQIYDBJcConAq+m8GnWiDSxoVCIcNywR8cLPS/5nA9Ll03idWE2OiAOPYyy8sprLFCFCu0aUQONJfbrtCy9lO0IWDAYDV/PEclf2ok1d5eA75TKKZ987wC17RkQ96qBH3PItnPKIuuM/pa6PV42mUNL4EB0PR/Rft+B0VzjwK1cCg4P9sX7l0+l529bjNVyjKTP7NJ3nf/Hq8RI+S2KejOLx6Gh0PI2Hw1HMxxMenbpxQt2ifOI4Hx1Nh7NlGE3GcTiNT0chx8lpGEfROOYRH50kJ74/VAX5S7V8v0R7J+RoV64iFso47bhdsTkbCGkx9evuoHLkoKlhBvUdauO6UKkzNmcrawszHwx4IfqlCXHUtzxVfaFcGzqkwTJct2huCDMutbAbB/peq6XI8NKb5vqmTfCRPOiN77MkvNyzIC/ET3jYy8+gTQ92xS0IA6UUn0qkTWSjSt1cUfwDJa37VGychyiiqTgY2vU9qYd7aaCgCwcW1EW/I1bAqB6zFfLE9ZvPYcuvOBpPpjMeJsdDHk5xnITRySQJZ/HQvTg6PnEhUl0tPF/R+r7mUU0roj6cObXgYudyAz80GD94FLerpftGoXmyA7azwkPqvxKmyPjmrafqqtY1zzKZTU95Mg5PRpM4nCZHR2G0PB6Hs+EJzqLTE77ECZmnipbnm6c6UOnwgHmoM2iEwtO2AkJIT8DjWJXSdu6IKt27Ej0WAnw0Qz5DHibJOAmn8dEkPDmdzsLTcTSbJnx6fDzmbuSgAvZhd7H0ukb4n5mb6on7202uQi6Vc3e1SF7yVF28g7P3Fwc+f/HixQvo9f6p1uTf0iDYlTCQqLjMUVoX9L3eQl7SbtR+SIFhikxYyv/1SsSrKmo2qnypcdfwKlgh3UJTXQH2ARayEqvQ6k4kaGAKiVguUaO0HsvMFzKEXq9dN3q9OZAwVZpplbfLU1CJslElxFxCitbT7Ha7uixRCycpiEEnLInDWWYU3Eq1piuLMx/P/m0fflXlDtfxrlKhCfhDBp1sJgYXxom0r0VTet7R3MDvuMhcwIplbVe1lv6iqLUeNpkn2pXqQIgzybONEcZLMe/1vmhIXlEFbfbeefWrGjoMw4V0EfTRa+6ozt5fwGuZFEpICx8wpTFS/rJCCTl3N9i8jgKKDTqxi8/Aec7dAHBygV+I/S7MC5owtKBSox0szwArRn04XyllsL7LowNLlWVqTRxrKgMRN5iAquyVoko1L1Yi5lmFOV9Ib60rKWim+mi5RQOvubEwIpuBN+lVnSo1NqxXWBfA3XxFaeJ5VjZEbixqCR34fo3a6119+Jm4/P7g4DD4ve3T1yVNXfALfgPxCIRE85hPyNQZVEgmLw+5El5hkalNIw0ljFmpMktcJXAyqLV0gXL14eemz3TizQ8SKudCGjAYO2krxxITz4NaC01cvpiN+sP+sBp1eUxDKjUIGuByLlsdodopqrW9dIPL7itFp0C2vlL8f3zMqTpia2feBn5Ova9m4GvWKjPU2luWc231JmArGprn1+z+nqLrSmfbLT3+VKKmQfaG+pYWruPSFBvUM8CuCZ57s4eX/h6zbnMHq8uuJ565DfVR2pvWXP/+3cdLFrCo+hiVq4TOaL6m+1S+ZnPmPm25WuoWH3p2zzIu05KnROsx6d+/ARyyhvs= +api: eJzlWetv20YS/1cGmw9pBVJv+aEPBVwnuDPaPJDYKArLaFfkSNqa3GV2l1Z4gv73w+ySFCnFstPmrjjcl0QmZ2d+855ZbpjlS8Omt+wt2rXS93All2gsuwtYjCbSIrNCSTZllxq5RUBhV6iBSxBpmls+TxCUBg7VHzE+iAi7cJW2nxjQ+CkXGiFa5fJeyCVkXPMULWoDXMbANYLKrEjFvzCGhdKQKLkMLeo0AJ5lKONQyaQAY5XmS+zCmz0Jc1zxB4RE3CNECTdGRPU7khArkMq2gYBBa4Vcmi4LmMpQc1L4KmZTFjmVXzkGN0bIZWkjFjCDUa6FLdj0dlOZLrxW9yjZ9PZuexcwEoLG/qjigk03LFLSorT0k2dZIiInpveHIeNumIlWmHL6pSS+Wzi2VtgE2ZTtLOmhgHMFeSVgtsiIRM3/wMgyL1VojMmjkqdYkQQEQGJklabfpPhvGWqh4vpPjQSQ2N4FLNNkCivQECbHabqppBmrhVyy/Qgp0ZVi8TNPM4f/TQELoY1tRIx3CttWChyyRpmnpER95jAiS3l0EkJIc2NhjvCyPvHSxdC+UNPCtmO/bZroSV0vK1K4euXE2FWtVZP/ZDHhZ4vRaDKIx/H8/Dwa92OMcOLENb1wxAQxL1jA1ogUeKmSdsUC9inn2qL+Qp66oPZcHbKYW16lDISgJIJaQMyLAIhnAI5lABXHJvzq2fYwSHaAZZ7O3blUSJES5n7AUv7Z/x6d7CN86+gJhONpwCrQaLmQ8F0/HJ1834QwOtlStmmBv5VynvTNR9SCJ+DJncZJUeV8DGIBJsNILATGMC+c42Sd1zvVL348Ox2dDy8Hp5cXLlBdnaxlc62dW74cknxpgBu4xyJ84EmO4KFCxoWmABQW0ya3On/beXePxdPqXvMlCWqBt3z5ExYDwu3kP4+LJ23ycU8GbLvdNp7elsBqKbWQmj5okwz3SYZse0dMd0XuzTctcf+pCvb8uvW1VatVs45VrL+vXv2tWTj0WcgjKx6ahp8rlSCXj7nS04Ox3OYtO1qd45/I6r+cu1+Xo/+lTAzYgzCCourZhnUHRCJs8Zhxt45x+cyZpBwh9+cZelVbwCfqkZmhLgi71t3KhMdDeL/jsl3HO2hu1LXa8b7XELZBpc6b5yuzr8JXK/AYJJcdLjYsfra9LOHCdeivsz7bzPRMAswc8BmbwuxxR8xYUFGTNp66Jmq8rVXzJI9p1zzRcJM/VHpqxgLo9WJcCInAy/m9HHXmBcxoVCI+blgi4pmfl/zPmklbTu11EjU6IQk8ijDzymoulwhztGtECTSeVKebvvAomxEyY9DruZonFruyNy+qKgffKZdRPPneMdyyZ0TUUQcdccu3cMoRdYd/Sl0frxpNpqTxITrsD+i/dsFpL3ngl7IYegcbZvXKp9Pztq3jNVyjyRP7NJ2Xf/XqeAmfxBGPB9FwcDI4HUf9/iDiwxGfn7txwq+OR4/zwcm4P1mE89EwCsfR+SDkODoPo/l8GPE5H5zFZ74/lAX5S7V8v0R7J6RoV64iZso47bhdsSnrCWlx6RfiXunIXl3DDOoH1MZ1oVwnbMpW1mZm2uvxTHRzE+Kga/lSdYVybeiQBvNw3aC5263VH8lB3rY+CardetepM/ETHrbqC2jSg11xC8JALsWnHGnRKFSu6zuKf6CkfZ9qiXMABSzlvqFl35N6di8NZHTjwIKqprdgBYzKLVshj107+Rw23IaD4Wg84WF82ufhGIdxOD8bxeEk6rsXJ6dnLgL2LhGeVrS6sDmqaUnUhQunFlztPGrgh5rHD56LW8WW+0ahcbHFbGeFx9R/JUyW8OKtp2qr1jbPIp6Mz3k8DM8Goygcxycn4XxxOgwn/TOczM/P+AJHZJ73Wi1E8hVxUB4odXjEPFT4NULmaRsBIaQn4FGkcmlbl0Sl7m1Ex0KADybIJ8jDOB7G4Tg6GYVn5+NJeD6cT8YxH5+eDrmbKKg+fdjdG72uOPzPjEXVQP3tBlMhF8q5u9wTr/lSXb2Di/dXBz5/8eLFC+h0/qnW5N/cINiVMBCrKE9RWhf0nc5MXtPq03xIgWGyRFjK//VKRKsyagqVv9S462clWyHdvlLe8HUBZrKElWn1IGI0MIZYLBaoUVrPy0xnMoROp1k3Op0pEJgyzbRKm+UpKKEUKoeIS1ii9TS71a0qS9ShCQUJaIUlSbhIjIJ7qdZ0I3Hh49m/7cKvKt/xdbLLVKgD/lBAK5tJwJVxkPa1qEvPOxoL+AMXiQtYsajsqtbS3wM1tr8680SzUh2AuJA8KYwwHsW00/miIXlJFTTFe+dVryrWYRjOpIugj15zR3Xx/gpeyzhTQlr4gEuaEuUvK5SQcneFzasooNigE7v4DJzn3ILPyQV+3/WrLs9ogNCCSo12bHkCWArqwuVKKYPVVR0dWKgkUWuSWFEZmHODMajSXktUS82zlYh4UvKczqS31o0UNDJ9tNyigdfcWBiQzcCb9KZKlYo3rFdYFcDd+ERp4mWWNkRuLGoJLfbdimunc/PhZ5Ly+6NzQe/3pk9f5zRUwS/4DeARE4LmeT6BqTWHECaPh1wJrzBLVFGjoYQxK5UnsasEDoNaSxcoNx9+rvtMK978IKFSLqQBg5FDWzqWhHgZ1FpooPLFbNDtd/vlJMsjmkGpQdB8lnLZ6AjlylBu5bkbXHafKVoFsvER4v/ja07ZERsr8TbwY+imHHFvWaPMUGtvWM611buArWgmnt6yzYai60Yn2y09/pSjps8/d9S3tHAdlz79BNUMsGuCl97s4bW/pqza3MFmsuuJF24BPUp71xjb37/7eM0CNi+/NaUqpjOar+m6lK/ZlLlvW66Wur2Gnm1YwuUy50ui9TwpxHhOhmnOV/5yufzhPkyVr2TRQFiNQV4B+tdd736JdLPxU9t2W9P7V4+eqMcqT02epPvjfwNrr77l sidebar_class_name: "post api-method" info_path: docs/api/tagoio-api custom_edit_url: null diff --git a/specs/tagoio-api.yaml b/specs/tagoio-api.yaml index 14e3dd8..cc1cce8 100644 --- a/specs/tagoio-api.yaml +++ b/specs/tagoio-api.yaml @@ -9296,6 +9296,8 @@ paths: summary: Create Device using Network description: Create either an immutable or a mutable device. Immutable devices require chunking parameters and are optimized for long-term, append-only storage. Mutable devices behave like classic devices and do not require chunk settings. operationId: createDeviceUsingNetwork + security: + - Network-Token: [] requestBody: content: application/json: From 5dcf8f4b60222f69858e8ea9e28645ff1124c3e2 Mon Sep 17 00:00:00 2001 From: Bruno Gelatti Date: Thu, 23 Oct 2025 17:55:26 -0300 Subject: [PATCH 3/7] docs: improve endpoint description and add privilege requirements Enhanced documentation with structured bullet points for device types and added warning about required Network-Token privileges. --- docs/api/create-device-using-network.api.mdx | 13 ++++++++++--- specs/tagoio-api.yaml | 13 ++++++++++++- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/docs/api/create-device-using-network.api.mdx b/docs/api/create-device-using-network.api.mdx index e6476bc..db74c38 100644 --- a/docs/api/create-device-using-network.api.mdx +++ b/docs/api/create-device-using-network.api.mdx @@ -1,11 +1,11 @@ --- id: create-device-using-network title: "Create Device using Network" -description: "Create either an immutable or a mutable device. Immutable devices require chunking parameters and are optimized for long-term, append-only storage. Mutable devices behave like classic devices and do not require chunk settings." +description: "Create either an immutable or a mutable device." sidebar_label: "Create Device using Network" hide_title: true hide_table_of_contents: true -api: eJzlWetv20YS/1cGmw9pBVJv+aEPBVwnuDPaPJDYKArLaFfkSNqa3GV2l1Z4gv73w+ySFCnFstPmrjjcl0QmZ2d+855ZbpjlS8Omt+wt2rXS93All2gsuwtYjCbSIrNCSTZllxq5RUBhV6iBSxBpmls+TxCUBg7VHzE+iAi7cJW2nxjQ+CkXGiFa5fJeyCVkXPMULWoDXMbANYLKrEjFvzCGhdKQKLkMLeo0AJ5lKONQyaQAY5XmS+zCmz0Jc1zxB4RE3CNECTdGRPU7khArkMq2gYBBa4Vcmi4LmMpQc1L4KmZTFjmVXzkGN0bIZWkjFjCDUa6FLdj0dlOZLrxW9yjZ9PZuexcwEoLG/qjigk03LFLSorT0k2dZIiInpveHIeNumIlWmHL6pSS+Wzi2VtgE2ZTtLOmhgHMFeSVgtsiIRM3/wMgyL1VojMmjkqdYkQQEQGJklabfpPhvGWqh4vpPjQSQ2N4FLNNkCivQECbHabqppBmrhVyy/Qgp0ZVi8TNPM4f/TQELoY1tRIx3CttWChyyRpmnpER95jAiS3l0EkJIc2NhjvCyPvHSxdC+UNPCtmO/bZroSV0vK1K4euXE2FWtVZP/ZDHhZ4vRaDKIx/H8/Dwa92OMcOLENb1wxAQxL1jA1ogUeKmSdsUC9inn2qL+Qp66oPZcHbKYW16lDISgJIJaQMyLAIhnAI5lABXHJvzq2fYwSHaAZZ7O3blUSJES5n7AUv7Z/x6d7CN86+gJhONpwCrQaLmQ8F0/HJ1834QwOtlStmmBv5VynvTNR9SCJ+DJncZJUeV8DGIBJsNILATGMC+c42Sd1zvVL348Ox2dDy8Hp5cXLlBdnaxlc62dW74cknxpgBu4xyJ84EmO4KFCxoWmABQW0ya3On/beXePxdPqXvMlCWqBt3z5ExYDwu3kP4+LJ23ycU8GbLvdNp7elsBqKbWQmj5okwz3SYZse0dMd0XuzTctcf+pCvb8uvW1VatVs45VrL+vXv2tWTj0WcgjKx6ahp8rlSCXj7nS04Ox3OYtO1qd45/I6r+cu1+Xo/+lTAzYgzCCourZhnUHRCJs8Zhxt45x+cyZpBwh9+cZelVbwCfqkZmhLgi71t3KhMdDeL/jsl3HO2hu1LXa8b7XELZBpc6b5yuzr8JXK/AYJJcdLjYsfra9LOHCdeivsz7bzPRMAswc8BmbwuxxR8xYUFGTNp66Jmq8rVXzJI9p1zzRcJM/VHpqxgLo9WJcCInAy/m9HHXmBcxoVCI+blgi4pmfl/zPmklbTu11EjU6IQk8ijDzymoulwhztGtECTSeVKebvvAomxEyY9DruZonFruyNy+qKgffKZdRPPneMdyyZ0TUUQcdccu3cMoRdYd/Sl0frxpNpqTxITrsD+i/dsFpL3ngl7IYegcbZvXKp9Pztq3jNVyjyRP7NJ2Xf/XqeAmfxBGPB9FwcDI4HUf9/iDiwxGfn7txwq+OR4/zwcm4P1mE89EwCsfR+SDkODoPo/l8GPE5H5zFZ74/lAX5S7V8v0R7J6RoV64iZso47bhdsSnrCWlx6RfiXunIXl3DDOoH1MZ1oVwnbMpW1mZm2uvxTHRzE+Kga/lSdYVybeiQBvNw3aC5263VH8lB3rY+CardetepM/ETHrbqC2jSg11xC8JALsWnHGnRKFSu6zuKf6CkfZ9qiXMABSzlvqFl35N6di8NZHTjwIKqprdgBYzKLVshj107+Rw23IaD4Wg84WF82ufhGIdxOD8bxeEk6rsXJ6dnLgL2LhGeVrS6sDmqaUnUhQunFlztPGrgh5rHD56LW8WW+0ahcbHFbGeFx9R/JUyW8OKtp2qr1jbPIp6Mz3k8DM8Goygcxycn4XxxOgwn/TOczM/P+AJHZJ73Wi1E8hVxUB4odXjEPFT4NULmaRsBIaQn4FGkcmlbl0Sl7m1Ex0KADybIJ8jDOB7G4Tg6GYVn5+NJeD6cT8YxH5+eDrmbKKg+fdjdG72uOPzPjEXVQP3tBlMhF8q5u9wTr/lSXb2Di/dXBz5/8eLFC+h0/qnW5N/cINiVMBCrKE9RWhf0nc5MXtPq03xIgWGyRFjK//VKRKsyagqVv9S462clWyHdvlLe8HUBZrKElWn1IGI0MIZYLBaoUVrPy0xnMoROp1k3Op0pEJgyzbRKm+UpKKEUKoeIS1ii9TS71a0qS9ShCQUJaIUlSbhIjIJ7qdZ0I3Hh49m/7cKvKt/xdbLLVKgD/lBAK5tJwJVxkPa1qEvPOxoL+AMXiQtYsajsqtbS3wM1tr8680SzUh2AuJA8KYwwHsW00/miIXlJFTTFe+dVryrWYRjOpIugj15zR3Xx/gpeyzhTQlr4gEuaEuUvK5SQcneFzasooNigE7v4DJzn3ILPyQV+3/WrLs9ogNCCSo12bHkCWArqwuVKKYPVVR0dWKgkUWuSWFEZmHODMajSXktUS82zlYh4UvKczqS31o0UNDJ9tNyigdfcWBiQzcCb9KZKlYo3rFdYFcDd+ERp4mWWNkRuLGoJLfbdimunc/PhZ5Ly+6NzQe/3pk9f5zRUwS/4DeARE4LmeT6BqTWHECaPh1wJrzBLVFGjoYQxK5UnsasEDoNaSxcoNx9+rvtMK978IKFSLqQBg5FDWzqWhHgZ1FpooPLFbNDtd/vlJMsjmkGpQdB8lnLZ6AjlylBu5bkbXHafKVoFsvER4v/ja07ZERsr8TbwY+imHHFvWaPMUGtvWM611buArWgmnt6yzYai60Yn2y09/pSjps8/d9S3tHAdlz79BNUMsGuCl97s4bW/pqza3MFmsuuJF24BPUp71xjb37/7eM0CNi+/NaUqpjOar+m6lK/ZlLlvW66Wur2Gnm1YwuUy50ui9TwpxHhOhmnOV/5yufzhPkyVr2TRQFiNQV4B+tdd736JdLPxU9t2W9P7V4+eqMcqT02epPvjfwNrr77l +api: eJztGdtu20b2Vw4mD2kFUnf5oocCrhPsGm0uSGwUC8toR+QRNTU5w8wMraiC/n1xZkiKlGLZ6Wa3u8DmwaHIM+d+nw2zPDFsesveol0pfQ9XMkFj2V3AYjSRFrkVSrIpu9TILQIKu0QNXILIssLyeYqgNHCofsT4ICLsziSEcJW13xrQ+KkQGiFaFvJeyARyrnmGFrUBLmPgGkHlVmTiD4xhoTSkSiahRZ0FwPMcZRwqma7BWKV5UtJ5s0dljkv+gJCKe4Qo5caIqP5GVGIFUtk2M2DQWiET053JmfyHKiArjAWHiEOlHcdj9Su8VvcowSooDIJdCgMo41wJabswk9PpdMW1JCnBYdR7B3cE7BIh8gr2fEKuxYNIMUHgBqwusAseJZT/WMBUjpqTea5iNmX+/Ct3/MYImZTEWMAMRoUWds2mtxvW4oFNb++2dwEjVaCxP6p4zaYbFilpUVp65HmeisiR6f1uyBU2zERLzDg9KYnvFg6tFTZFNmU7m3tWwDkO+VDA7DonEDX/HSPLPFWhMSb/kzzDCiQgBiRGVml6JvP8mqMWKq5/aiQGCe1dwHJNqrACDfHkME03FTVjtZAJ2/fnkruSLH7mWe74f7OGhdDGNvzbm4RtKwEOUaMsMhKiPnMYPyU9OgmhN/0c4WV94qXz9n2ipsXbDv22qaInZb2sQOHqlSND/lZK1cQ/WUz42WI0mgzicTw/P4/G/RgjnDhyTSscUUHM1yxgK0RyvExJu2QB+1RwbVF/Iau40PNYHWcxt7wKbghBSQS1gJivAyCcATiUAVQYm+xX77aHTrJjWBbZ3J3LhBQZ8dwPWMY/++fRyT6Hbx08MeFwGgp3jZYLCd/1w9HJ900WRidbijYt8NeSzpO2+Yha8BQ8uJM4XVeZKQaxAJNjJBYCY5ivneFkHdc70S9+PDsdnQ8vB6eXF85RXVavaXOtnVm+7JI8MZRl7nEdPvC0QPCsQs6FJgcUFrMmtjp+23F3j+unxb3mCRFqMW958hOuB8S3o/88LB60ice9GbDtdtt4e1syVlOpidTwQRtkuA8yZNs7QrpLcm++aYr7d2Ww5+etr81arZx1LGP9dfnqL43CoY9CHlnx0FT8XKkUuXzMlB4ejOW2aOmRGoA/EdX/cux+XYz+hyIxYA/CCPKqZyvWHRCpsOvHlLt1iMt3TiVlw7vfz9CnWgM+UI/0DHVC2JXuViQ87sL7FZftKt5BcaOq1fb3vYKwDSpx3jxfmH0RvlqAx1hy0eF8w+Jn28tTLlyF/jrts81MzyTAzDE+Y1OYPW6IGQsqaJLGQ9dAja+1aB7kMemaJxpm8odKS81YAL1ejAshaYSImq3OfA0zapUIj2uWCHjm+yX/WCNp06mtTqRGJ0SBRxHmXljNZYIwR7tClEDtSXW6aQvPZdNDZgx6PZfzxGKX9ubrKsvBd8pFFE+/dwi37BkeddRAR8zyLYxyRNzhnxLX+6tGkytpvIsO+wP6r51w2qNoOdTF0DuYhatPPpyeN20dz+EaTZHap+E8/atXx1P4JI54PIiGg5PB6Tjq9wcRH474/Ny1E350PHqcD07G/ckinI+GUTiOzgchx9F5GM3nw4jP+eAsPvP1oUzIX8rl+ynaGyFDu3QZMVfGScftkk1ZT0iLiR+Ie6Uhe3UOM6gfUBtXhQqdsilbWpubaa/Hc9EtTIiDruWJ6grlytAhDBbhqgFztxurP5KBvG59EFSz9a5S5+InPCzVF9CEB7vkFoSBQopPBdKgsaalQblRgb+hpHmfcokzADksxb6hYd+DenQvDeS0G2FBldNbbAWM0i1bIo9dOfkcNsyGg+FoPOFhfNrn4RiHcTg/G8XhJOq7DyenZ84D9pYITwtaLVCOSloCdeHCiQVXO4sa+KHG8YPH4kaxZF8p1C62kO208Jj4r4TJU75+66HaorXVs4gn43MeD8OzwSgKx/HJSThfnA7DSf8MJ/PzM77AEannvVYLkX6FH5QHShkeUQ8lfk2rIQfbcAghPQCPIlVIu1tl7WRvc3TMBfhggnyCPIzjYRyOo5NReHY+noTnw/lkHPPx6emQu46C8tOH3d7odYXhf6Ytqhrqb9eYCrlQztzlnHjNE3X1Di7eXx3Y/MWLFy+g0/m7WrUWiLGKigyldU7f6czkNY0+zZfkGCZPhaX4Xy1FtCy9Zq2Klxp39axEK6SbV8oNn1sjlmzlWj2IGA2MIRaLBWqU1uMy05kModNp5o1OZwrETBlmWmXN9BSUrKxVARGXkKD1MLvRrUpLVKGJCyLQckuicJEaBfdSrWgjceH92X/tAi1la7yOdhkKtcMfEmhFMxG4Mo6lfSnq1POO2gL+wEXqHFYsKr2qlfR7oMb0V0eeaGaqAyYuJE/XRhjPxbTT+aIieQkVNMl741WfKtRhGM6k86CPXnIHdfH+Cl6XC2j4gAl1ifKXJW2auVu288oLyDfoxM4/A2c5N+BzMoGfd/2oy3NqILSgVKMdWp42Nt2XS6UMVqs6OrBQaapWRLGCMjDnBmNQpb4SVInm+VJEPC1xTmnvTtq6kYJapo+WWzTwmhsLA9IZeJXe7O/aYbXEKgHu2icKE0+z1CFyY1FLaKHvVlg7nZsPPxOV3x7tC3q/NW36uqCmCn7Bb8AeISHWPM4neGr1IcST54dMCa8wT9W65oYCxixVkcYuEzge1Eo6R7n58HNdZ1r+5hsJlXEhDRiMHLelYYmIp0GlhRoqn8wG3X63X3ayPKIelAoE9WcZl42KUI4M5VReuMZld03RSpCNS4j/3z399909lfW7McBvA980b8qG/JY1kiI1Ig07uybgLmBL6uCnt2yzoVi40el2S68/FajpsuqOqqwWrj+gi6qg6lh2JfvSO0l47ZeqVVE+mKN2FfzCjctHYe8aQ8b7dx+vWcDm5c1YpmI6o/mKlrt8xabM3cS5zO+mMHq3YSmXScETgvU4KSB4QYppdoN+FV4+uGu08pNcNzismjYvAP11y+gvgW42vsfcbmt4/+nRE3UT6KHJkrTt/idcvDYM sidebar_class_name: "post api-method" info_path: docs/api/tagoio-api custom_edit_url: null @@ -36,7 +36,14 @@ import Heading from "@theme/Heading"; -Create either an immutable or a mutable device. Immutable devices require chunking parameters and are optimized for long-term, append-only storage. Mutable devices behave like classic devices and do not require chunk settings. +Create either an immutable or a mutable device. + - Immutable devices require chunking parameters and are optimized for long-term, append-only storage. + - Mutable devices behave like classic devices and do not require chunk settings. + +You must have a Network and a Network-Token to use this endpoint. +:::warning +Your Network-Token must have the create device privilege as true. +::: - + Create either an immutable or a mutable device. + - Immutable devices require chunking parameters and are optimized for long-term, append-only storage. + - Mutable devices behave like classic devices and do not require chunk settings. + + You must have a Network and a Network-Token to use this endpoint. + + :::warning + + Your Network-Token must have the create device privilege as true. + + ::: operationId: createDeviceUsingNetwork security: - Network-Token: [] From 39908effbd521ac870acd164b61e2bafacb0b1c2 Mon Sep 17 00:00:00 2001 From: Bruno Gelatti Date: Fri, 24 Oct 2025 08:47:38 -0300 Subject: [PATCH 4/7] feat: add Create Network Token endpoint documentation Added documentation for the network token creation endpoint including request schema with privilege configuration and response examples. --- docs/api/create-network-token.api.mdx | 71 +++++++++++++++++++++++++++ docs/api/sidebar/api-sidebar.ts | 6 +++ specs/tagoio-api.yaml | 65 +++++++++++++++++++++++- 3 files changed, 141 insertions(+), 1 deletion(-) create mode 100644 docs/api/create-network-token.api.mdx diff --git a/docs/api/create-network-token.api.mdx b/docs/api/create-network-token.api.mdx new file mode 100644 index 0000000..58071e9 --- /dev/null +++ b/docs/api/create-network-token.api.mdx @@ -0,0 +1,71 @@ +--- +id: create-network-token +title: "Create a Token for the Network" +description: "Create a token for the network to use in network endpoints" +sidebar_label: "Create a Token for the Network" +hide_title: true +hide_table_of_contents: true +api: eJy1V1lv2zgQ/isE81DAkHzFR6yHAtk22A22aIMcKBZJgI6lscRGJlWSimsY/u+LISVZdo520W0ekkAcznzzzckNt5AaHt3yj2hXSj+wc5misfw+4AmaWIvCCiV5xN9pBIsMmFUPKNlCaWYzZLK6ZhUrDTIhmy8ok0IJaQ0PuCpQAyk6T3jEY6eqMnhN6njADcalFnbNo9sNv9BqIXIM/WF0e7+9D7jGbyUa+4dK1jza8GG/T39eQOluspWwGau+vcdHESMrtHgUOabIAx4raVFaUgNFkYvYYex9NaRrw02c4RLoP7sukEdczb9ibHnAC00eWYGGTjWaMrfPyeF3WBY50pGEJR15XEdjHvCKKB7xyWQ6nvYnw2kyhGTQ7/dns1kSw9BZquFGm4o47wiPrC5xG3DrOeLYx0mMo1k4nfUH4WgCw3A+RgyPB9N+PB9OZ9PkhG+3ATcWbGlacOdK5Qiyjdfpdj+/wBIFTGhMKL2c+zuf7w85bMho1BirhUzboF7maRtU/L522yfT9oDTV0L2DN3ERyNxu/m5GLZD/xMh3d7vjDhu/ktSRxv+CHn5W9H5tFiizRSVc6GMqwmwGY94T0iLqa/2XgWgZ5si14+ojQNX6pxHPLO2MFGvB4XolibEQddCqrpC8W3wnAyW4aolc79rHFeUh54wD7juHk2MoRB/45ofdrZT1pZnNgPLhGGlFN9KpMa2VqVmiZPpsj9RUi/bdcL5mkEcozFCpl7Uq3tjWAEpdncU78EKuCDjGUKCmgf8e7jL1DEOhsejMYTJtA/hCIdJOD85TsJx3HcHk+nJjBK5aqE/72jd5F/1tBLqslPnFjvfBdSwt42Ot16LoXvpISk0HvaUPU20Q/ffC1PksP7opfZd26dnkYxHM0iG4cngOA5HyWQSzhfTYTjun+B4PjuBBR4TPQdT5Mf0VBcqH16gB6UVmkrOybYSQkgvAHGsSmmZQWuFTE3L931Er6UADMYIY4QwSYZJOIonx+HJbDQOZ8P5eJTAaDodguvm1IYvd5Px7Lc3J0K9UI5OYX1jhVSdf2KnF+dPOD06Ojpinc5falVvCDYThiUqLpcorUuqTudOXme4/5GIN0UuLNXXKhNxVkVlrco3Glk9W1qLB60j1Y7QZexOVrAKrR5FgoaNWCIWC9QorddlojsZsk6nXZedTsQITJXGWi3b5R9UUNaqZDFIlqL1MmQ72Sv7O8kYoSADe2EnC6e5UexBqhUDQ2VG+eJPu+wfVe70OttVqjUJ9dTAXrWQgXPjIB160ZT2J5mvGTyCyGGeIxOLmle1kqiZWuwtd3Vmi3YneALiVEK+NsJ4FFGn8yyRUEkFbfM+ePVRrToMwzvpMujKe+6kTi/O2Vm1W7JLTIWSd/JzhpIt4YGEoM4Cyg26scvPwEVuWRrLgEJgCozFYu2tF7SRaEGlrJ1ayJsltsveZUoZZEpizc5C5blakcVm1WVzMJgwVfGVoko1FJmIIa90RnfSs3UjhcWEXVmwaNgZGMsGxBnzlN7UpVLrZqsM6waz28KoTLzNikMEY1FLtqe+W2vtdG4uP5CVLy/O3d6XdkzPStrS2Gf8H+CREoLmdf4A096cJ0weD4WSvcciV+sGDRWMyVSZJ64TOAxqJV2i3Fx+aPr4Xr75Qa2WIKRhBmOHtgosGfE2qHXTwuKb2aDb7/arZwPEtBBTA6b1ZwmyteMf7Gv1U6kqvsMeudkt2L/2yKqmm8XvtlfkINyu6zaoTbWc3fJWBbe28foRcR/wjJa56JZvNhS3G51vt/T5W4manmb3AX8ELYhF9ywL6ulF8+YB1+SD9ya8JjhBvY0+fTrQJGl2yItPV9c84PPqbbdUCd3RsKJnBKx4xN0r0nUe9+Sibxueg0xLoGHFvU4KCJTka3vaP7hpX/1DSOsjuW4hPBzO3h36Tavos1c2G79LbLeNvD968UYz7L00BYkW6n8B9Hs9OA== +sidebar_class_name: "post api-method" +info_path: docs/api/tagoio-api +custom_edit_url: null +--- + +import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint"; +import ParamsDetails from "@theme/ParamsDetails"; +import RequestSchema from "@theme/RequestSchema"; +import StatusCodes from "@theme/StatusCodes"; +import OperationTabs from "@theme/OperationTabs"; +import TabItem from "@theme/TabItem"; +import Heading from "@theme/Heading"; + + + + + + + + + + +Create a token for the network to use in network endpoints + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/api/sidebar/api-sidebar.ts b/docs/api/sidebar/api-sidebar.ts index a5bb00a..a399f61 100644 --- a/docs/api/sidebar/api-sidebar.ts +++ b/docs/api/sidebar/api-sidebar.ts @@ -103,6 +103,12 @@ const sidebar: SidebarsConfig = { label: "Create Device using Network", className: "api-method post", }, + { + type: "doc", + id: "api/create-network-token", + label: "Create Network Token", + className: "api-method post", + }, ], }, { diff --git a/specs/tagoio-api.yaml b/specs/tagoio-api.yaml index 40a212d..1acb9dc 100644 --- a/specs/tagoio-api.yaml +++ b/specs/tagoio-api.yaml @@ -9454,6 +9454,68 @@ paths: status: type: boolean example: true + /integration/network/token: + post: + tags: + - Network Ingest + summary: Create a Token for the Network + description: >- + Create a token for the network to use in network endpoints + operationId: createNetworkToken + security: + - Profile-Token: [] + requestBody: + content: + application/json: + schema: + type: object + required: ["name", "network"] + properties: + network: + type: string + example: 667570627d2ad1000999dca2 + name: + type: string + example: Token #1 + privilege: + type: object + example: { + createDevice: true + } + example: + - network: 667570627d2ad1000999dca2 + name: Token #1 + privilege: { + createDevice: true + } + examples: + Create a Token with Create Device privilege: + value: + - network: 667570627d2ad1000999dca2 + name: Token #1 + privilege: { + createDevice: true + } + '200': + description: Create a Token with Create Device privilege + content: + application/json: + schema: + type: object + properties: + result: + type: object + example: { + "name": "Token #5", + "network": "667570627d2ad1000999dca2", + "privilege": { + "createDevice": true + }, + "token": "e0e6ce49-7901-46a2-b5ee-3170cb2797d8" + } + status: + type: boolean + example: true /integration/network/data: post: tags: @@ -9511,4 +9573,5 @@ paths: example: 3 Data Added status: type: boolean - example: true \ No newline at end of file + example: true + \ No newline at end of file From 52519dc20a216010bbf55e06052d2615db7df5cf Mon Sep 17 00:00:00 2001 From: Bruno Gelatti Date: Fri, 24 Oct 2025 09:16:39 -0300 Subject: [PATCH 5/7] fix: correct response schema structure in Network Token endpoint Fixed OpenAPI specification by moving response schema from request body to proper responses section with detailed property definitions. --- docs/api/create-network-token.api.mdx | 6 +++--- specs/tagoio-api.yaml | 25 +++++++++++++++++-------- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/docs/api/create-network-token.api.mdx b/docs/api/create-network-token.api.mdx index 58071e9..44669b3 100644 --- a/docs/api/create-network-token.api.mdx +++ b/docs/api/create-network-token.api.mdx @@ -5,7 +5,7 @@ description: "Create a token for the network to use in network endpoints" sidebar_label: "Create a Token for the Network" hide_title: true hide_table_of_contents: true -api: eJy1V1lv2zgQ/isE81DAkHzFR6yHAtk22A22aIMcKBZJgI6lscRGJlWSimsY/u+LISVZdo520W0ekkAcznzzzckNt5AaHt3yj2hXSj+wc5misfw+4AmaWIvCCiV5xN9pBIsMmFUPKNlCaWYzZLK6ZhUrDTIhmy8ok0IJaQ0PuCpQAyk6T3jEY6eqMnhN6njADcalFnbNo9sNv9BqIXIM/WF0e7+9D7jGbyUa+4dK1jza8GG/T39eQOluspWwGau+vcdHESMrtHgUOabIAx4raVFaUgNFkYvYYex9NaRrw02c4RLoP7sukEdczb9ibHnAC00eWYGGTjWaMrfPyeF3WBY50pGEJR15XEdjHvCKKB7xyWQ6nvYnw2kyhGTQ7/dns1kSw9BZquFGm4o47wiPrC5xG3DrOeLYx0mMo1k4nfUH4WgCw3A+RgyPB9N+PB9OZ9PkhG+3ATcWbGlacOdK5Qiyjdfpdj+/wBIFTGhMKL2c+zuf7w85bMho1BirhUzboF7maRtU/L522yfT9oDTV0L2DN3ERyNxu/m5GLZD/xMh3d7vjDhu/ktSRxv+CHn5W9H5tFiizRSVc6GMqwmwGY94T0iLqa/2XgWgZ5si14+ojQNX6pxHPLO2MFGvB4XolibEQddCqrpC8W3wnAyW4aolc79rHFeUh54wD7juHk2MoRB/45ofdrZT1pZnNgPLhGGlFN9KpMa2VqVmiZPpsj9RUi/bdcL5mkEcozFCpl7Uq3tjWAEpdncU78EKuCDjGUKCmgf8e7jL1DEOhsejMYTJtA/hCIdJOD85TsJx3HcHk+nJjBK5aqE/72jd5F/1tBLqslPnFjvfBdSwt42Ot16LoXvpISk0HvaUPU20Q/ffC1PksP7opfZd26dnkYxHM0iG4cngOA5HyWQSzhfTYTjun+B4PjuBBR4TPQdT5Mf0VBcqH16gB6UVmkrOybYSQkgvAHGsSmmZQWuFTE3L931Er6UADMYIY4QwSYZJOIonx+HJbDQOZ8P5eJTAaDodguvm1IYvd5Px7Lc3J0K9UI5OYX1jhVSdf2KnF+dPOD06Ojpinc5falVvCDYThiUqLpcorUuqTudOXme4/5GIN0UuLNXXKhNxVkVlrco3Glk9W1qLB60j1Y7QZexOVrAKrR5FgoaNWCIWC9QorddlojsZsk6nXZedTsQITJXGWi3b5R9UUNaqZDFIlqL1MmQ72Sv7O8kYoSADe2EnC6e5UexBqhUDQ2VG+eJPu+wfVe70OttVqjUJ9dTAXrWQgXPjIB160ZT2J5mvGTyCyGGeIxOLmle1kqiZWuwtd3Vmi3YneALiVEK+NsJ4FFGn8yyRUEkFbfM+ePVRrToMwzvpMujKe+6kTi/O2Vm1W7JLTIWSd/JzhpIt4YGEoM4Cyg26scvPwEVuWRrLgEJgCozFYu2tF7SRaEGlrJ1ayJsltsveZUoZZEpizc5C5blakcVm1WVzMJgwVfGVoko1FJmIIa90RnfSs3UjhcWEXVmwaNgZGMsGxBnzlN7UpVLrZqsM6waz28KoTLzNikMEY1FLtqe+W2vtdG4uP5CVLy/O3d6XdkzPStrS2Gf8H+CREoLmdf4A096cJ0weD4WSvcciV+sGDRWMyVSZJ64TOAxqJV2i3Fx+aPr4Xr75Qa2WIKRhBmOHtgosGfE2qHXTwuKb2aDb7/arZwPEtBBTA6b1ZwmyteMf7Gv1U6kqvsMeudkt2L/2yKqmm8XvtlfkINyu6zaoTbWc3fJWBbe28foRcR/wjJa56JZvNhS3G51vt/T5W4manmb3AX8ELYhF9ywL6ulF8+YB1+SD9ya8JjhBvY0+fTrQJGl2yItPV9c84PPqbbdUCd3RsKJnBKx4xN0r0nUe9+Sibxueg0xLoGHFvU4KCJTka3vaP7hpX/1DSOsjuW4hPBzO3h36Tavos1c2G79LbLeNvD968UYz7L00BYkW6n8B9Hs9OA== +api: eJy1V1lv2zgQ/isE81DAkHwfsR4KZNtgN9hFG+RAsUgMdCyNJTYyqZJUXMPwf1+MKMmSc7S73b4khjic+eb+uOMWYsODO/4B7UbpB3YhYzSWLzweoQm1yKxQkgf8nUawyIBZ9YCSrZRmNkEmy2tWsdwgE7L+gjLKlJDWcI+rDDWQoouIBzwsVJUGb0gd97jBMNfCbnlwt+OXWq1Eir47DO4W+4XHNX7N0djfVLTlwY6HSlqUln5ClqUiLAz0vhiCu+MmTHAN9MtuM+QBV8svGFru9AiNEXktYY3c4yVm8jrTBNYKNHS3OjioMVYLGXOP4zdYZyl9mk5nk1l/OpxFQ4gG/X5/Pp9HIQz53nMGXr3tfNyTZfEoUozxOdC1/K4M33t8FCHywOoc9/t9Q+KuAftlbBU0XiWgZf45G4uDkSI2dUUUGthG2ISV39xF1lL5CGn+S9HtizBoNJmSxkEc9vv074VK/gHc3n8vs3YhaTR5ar8v9y/q5adr89WCa8NqR7yWXiqVIsimxboerevd18ABwHK5DEN/MBgM/OFwOPRHo9HIH4/HY3CHS14oMxZsbn7IsiuDNdpE0bDJlCncAZvwgPeEtBi7WdQrA9iz9QjSj6hNUaO5TnnAE2szE/R6kIlubnwcdC3EqisU33vPyWDubxoyi8NYu6Y6cbF0UaxmW+0RZOJP3PLjuXvGmvLMJmCZMCyX4muONHa3KtcsKmS67HeUNGkPc3q5ZRCGaIyQsRN16t4YlkGM3UOntWB5XJDxBCFCzT3+zT9kbYKD4Wg8AT+a9cEf4zDyl6ejyJ+E/eJgOjudU3mVA/7HHa1W0KuelkJddla4xS4OCTXsba3jrdNi6F58HBRaXi1lT+fNsfvvhclS2H5wUm3X2uFZRZPxHKKhfzoYhf44mk795Wo29Cf9U5ws56ewwhGF52jHfT885YXShxfCg9IKTROskG0UhJBOAMJQ5dIyg9YKGZuG721Er5UADCYIEwQ/ioaRPw6nI/90Pp748+FyMo5gPJsNgVMb0pi8Ouzt81++owj1ShXhFNbNS4jVxUd2dnnxJKYnJycnrNP5Q20q/mITYVikwnyN0hZF1ency5sE2x8p8CZLhaX+2iQiTMqsbFX+RiOrKEaDFhFZKhlMl7F7WcLKtHoUERo2ZpFYrVCjtE6XCe6lzzqdZl92OgEjMGUZa7Vutr9XQtmqnIUgWYzWyZDtqNX295IxQkEGWmknC2epUexBqg0DQ21G9eJOu+xvlR/0FrbLUqsL6qmBVreQgQtTQDr2om7tjzLdMngEkcIyRSZWVVzVRqJmatWinlVli+YkeALiTEK6NcI4FEGn82wgoZTymuZd8qqjSrXv+/eyqKBr53khdXZ5wc5L5suuMBZK3stPCUq2hgcSgqoKqDboxqE+vSJz69xYBpQCk2EoVltnPaOFrAW1si7UQlpT7C57lyhlkCmJVXRWKk3VhizWRJwtwWDEVBmvGFWsIUtECGmpM7iXLlq3UliM2LUFi4adg7FsQDFjLqS3VatUutkmwWrAHFgStYmzWcYQwVjUkrXUdyutnc7t1V9k5fOLe7f3uZnT85xICvuE/wM8UkLQnM7vYGrtecLk8FAq2XvMUrWt0VDDmETlaVRMggKD2siiUG6v/qrneKve3KJWaxDSMINhgbZMLBlxNmh0E2Fxw2zQ7Xf7JWGFkKgmDWCiP2uQB2p5TH+rh1zZfMczsvHO+rknYLndLH6zvSwFUVDYgkHtSnJ2xxsd3HiUVVRy4fGEyFxwx3c7ytutTvd7+vw1R00Px4XHH0ELimLxaPSq7UX75gG35IPzxr8hOF71KHlK7YnfuRvEMzL7quyiwTcvP17fcI8vy1fqWkV0R8OGXp6w4QEv3sPFlCoeBvRtx1OQcQ602LjTScmDnOLSZAYPBTMof5BX1ZHcNhAeL3LnCP0lt569sts53rHf1/Lu6MUbNTFw0pRQeoP9AxZXhQE= sidebar_class_name: "post api-method" info_path: docs/api/tagoio-api custom_edit_url: null @@ -54,7 +54,7 @@ Create a token for the network to use in network endpoints @@ -62,7 +62,7 @@ Create a token for the network to use in network endpoints diff --git a/specs/tagoio-api.yaml b/specs/tagoio-api.yaml index 1acb9dc..da3c6b1 100644 --- a/specs/tagoio-api.yaml +++ b/specs/tagoio-api.yaml @@ -9496,6 +9496,7 @@ paths: privilege: { createDevice: true } + responses: '200': description: Create a Token with Create Device privilege content: @@ -9505,14 +9506,22 @@ paths: properties: result: type: object - example: { - "name": "Token #5", - "network": "667570627d2ad1000999dca2", - "privilege": { - "createDevice": true - }, - "token": "e0e6ce49-7901-46a2-b5ee-3170cb2797d8" - } + properties: + name: + type: string + example: Token #1 + network: + type: string + example: 667570627d2ad1000999dca2 + privilege: + type: object + properties: + createDevice: + type: boolean + example: true + token: + type: string + example: aaabbbcc-1111-2222-3333-4444aaaabbbb status: type: boolean example: true From 707ad844a304271e1a7b54bd251833d9a1d9f4c6 Mon Sep 17 00:00:00 2001 From: Bruno Gelatti Date: Fri, 24 Oct 2025 09:40:07 -0300 Subject: [PATCH 6/7] refactor: rename privilege field to previlegies in Network Token endpoint Updated field name from singular privilege to plural previlegies for consistency across request and response schemas. --- docs/api/create-network-token.api.mdx | 6 +++--- specs/tagoio-api.yaml | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/api/create-network-token.api.mdx b/docs/api/create-network-token.api.mdx index 44669b3..c7936b6 100644 --- a/docs/api/create-network-token.api.mdx +++ b/docs/api/create-network-token.api.mdx @@ -5,7 +5,7 @@ description: "Create a token for the network to use in network endpoints" sidebar_label: "Create a Token for the Network" hide_title: true hide_table_of_contents: true -api: eJy1V1lv2zgQ/isE81DAkHwfsR4KZNtgN9hFG+RAsUgMdCyNJTYyqZJUXMPwf1+MKMmSc7S73b4khjic+eb+uOMWYsODO/4B7UbpB3YhYzSWLzweoQm1yKxQkgf8nUawyIBZ9YCSrZRmNkEmy2tWsdwgE7L+gjLKlJDWcI+rDDWQoouIBzwsVJUGb0gd97jBMNfCbnlwt+OXWq1Eir47DO4W+4XHNX7N0djfVLTlwY6HSlqUln5ClqUiLAz0vhiCu+MmTHAN9MtuM+QBV8svGFru9AiNEXktYY3c4yVm8jrTBNYKNHS3OjioMVYLGXOP4zdYZyl9mk5nk1l/OpxFQ4gG/X5/Pp9HIQz53nMGXr3tfNyTZfEoUozxOdC1/K4M33t8FCHywOoc9/t9Q+KuAftlbBU0XiWgZf45G4uDkSI2dUUUGthG2ISV39xF1lL5CGn+S9HtizBoNJmSxkEc9vv074VK/gHc3n8vs3YhaTR5ar8v9y/q5adr89WCa8NqR7yWXiqVIsimxboerevd18ABwHK5DEN/MBgM/OFwOPRHo9HIH4/HY3CHS14oMxZsbn7IsiuDNdpE0bDJlCncAZvwgPeEtBi7WdQrA9iz9QjSj6hNUaO5TnnAE2szE/R6kIlubnwcdC3EqisU33vPyWDubxoyi8NYu6Y6cbF0UaxmW+0RZOJP3PLjuXvGmvLMJmCZMCyX4muONHa3KtcsKmS67HeUNGkPc3q5ZRCGaIyQsRN16t4YlkGM3UOntWB5XJDxBCFCzT3+zT9kbYKD4Wg8AT+a9cEf4zDyl6ejyJ+E/eJgOjudU3mVA/7HHa1W0KuelkJddla4xS4OCTXsba3jrdNi6F58HBRaXi1lT+fNsfvvhclS2H5wUm3X2uFZRZPxHKKhfzoYhf44mk795Wo29Cf9U5ws56ewwhGF52jHfT885YXShxfCg9IKTROskG0UhJBOAMJQ5dIyg9YKGZuG721Er5UADCYIEwQ/ioaRPw6nI/90Pp748+FyMo5gPJsNgVMb0pi8Ouzt81++owj1ShXhFNbNS4jVxUd2dnnxJKYnJycnrNP5Q20q/mITYVikwnyN0hZF1ency5sE2x8p8CZLhaX+2iQiTMqsbFX+RiOrKEaDFhFZKhlMl7F7WcLKtHoUERo2ZpFYrVCjtE6XCe6lzzqdZl92OgEjMGUZa7Vutr9XQtmqnIUgWYzWyZDtqNX295IxQkEGWmknC2epUexBqg0DQ21G9eJOu+xvlR/0FrbLUqsL6qmBVreQgQtTQDr2om7tjzLdMngEkcIyRSZWVVzVRqJmatWinlVli+YkeALiTEK6NcI4FEGn82wgoZTymuZd8qqjSrXv+/eyqKBr53khdXZ5wc5L5suuMBZK3stPCUq2hgcSgqoKqDboxqE+vSJz69xYBpQCk2EoVltnPaOFrAW1si7UQlpT7C57lyhlkCmJVXRWKk3VhizWRJwtwWDEVBmvGFWsIUtECGmpM7iXLlq3UliM2LUFi4adg7FsQDFjLqS3VatUutkmwWrAHFgStYmzWcYQwVjUkrXUdyutnc7t1V9k5fOLe7f3uZnT85xICvuE/wM8UkLQnM7vYGrtecLk8FAq2XvMUrWt0VDDmETlaVRMggKD2siiUG6v/qrneKve3KJWaxDSMINhgbZMLBlxNmh0E2Fxw2zQ7Xf7JWGFkKgmDWCiP2uQB2p5TH+rh1zZfMczsvHO+rknYLndLH6zvSwFUVDYgkHtSnJ2xxsd3HiUVVRy4fGEyFxwx3c7ytutTvd7+vw1R00Px4XHH0ELimLxaPSq7UX75gG35IPzxr8hOF71KHlK7YnfuRvEMzL7quyiwTcvP17fcI8vy1fqWkV0R8OGXp6w4QEv3sPFlCoeBvRtx1OQcQ602LjTScmDnOLSZAYPBTMof5BX1ZHcNhAeL3LnCP0lt569sts53rHf1/Lu6MUbNTFw0pRQeoP9AxZXhQE= +api: eJy9V1tv2zYU/isE+1DAkHx3HOuhQNYGW7ChDXJBMSQBeiwdW2xkUiWpuIbh/z4cUpIl59at214SQzw85zv3j1tuYWl4dMM/ol0rfc/O5BKN5XcBT9DEWuRWKMkj/l4jWGTArLpHyRZKM5sik+U1q1hhkAlZf0GZ5EpIa3jAVY4aSNFZwiMeO1WlwStSxwNuMC60sBse3Wz5uVYLkWHoD6Obu91dwDV+K9DYX1Sy4dGWx0palJZ+Qp5nInYGel8Nwd1yE6e4AvplNznyiKv5V4wt93qExoS8lrBCHvASM3mdawJrBRq6Wx3s1RirhVzygON3WOUZfTo6mk6m/aPhNBlCMuj3+7PZLIlhyHeBN/Dibe/jjizjg8hwWZo+hF3f2JYB/IAPIkYeWV3gbrdrSNw0gD+PrgLHqxQcAHjKyt3ejJOpq8LpYGthU1Z+8xdZroVT6oA/QFb8x/h2LhQaTa6k8YLDfp/+PVPPP4A8+OfF1i4njabI7Otyf6NqfrpCXym7NrB2zGvpuVIZgmzarKvS+h5+CR4AzOfzOA4Hg8EgHA6Hw3A0Go3C8Xg8Bn84506ZsWAL80OWfSGs0KaKhk6ujHMHbMoj3hPS4tLPpF4Zwp6tR5F+QG1cnRY64xFPrc1N1OtBLrqFCXHQtbBUXaH4LnhKBotw3ZC524+3S6oUH0sfxWrG1R5BLn7HDT+cvyesKc9sCpYJwwopvhVI43ejCs0SJ9Nlv6Kkibuf1/MNgzhGY4RcelGv7q1hOSyxu++2FqyACzKeIiSoecC/h/usTXAwHI0nECbTPoRjHCbh/HiUhJO47w6OpsczKrBy0P+4o9UqetHTUqjLTpxb7GyfUMPe1TreeS2G7i0Pg0JLrKXs8cw5dP+DMHkGm49equ1aOzyLZDKeQTIMjwejOBwnR0fhfDEdhpP+MU7ms2NY4IjCc7DrXg9PeaH04ZnwoLRC0wxzso2CENILQByrQlpm0Fohl6bhexvRSyUAgwnCBCFMkmESjuOjUXg8G0/C2XA+GScwnk6HwKkNaVBe7Pf36f+wqQj3QrmACutnJizV2Sd2cn72KKpv3rx5wzqd39S6YjI2FYYlKi5WKK0rq07nVl6l2P5IoTd5Jix12DoVcVrmZaOKtxpZRTYaBIloU8lluozdyhJWrtWDSNCwMUvEYoEapfW6THQrQ9bpNDuz04kYgSkLWatVcwAEJZSNKlgMki3RehmynbQa/1YyRijIQCvxZOEkM4rdS7VmYKjRqGL8aZf9qYq9Xme7LLa6pB4baPULGTgzDtKhF3Vzf5LZhsEDiAzmGTKxqOKq1hI1U4sWCa1qWzRnwSMQJxKyjRHGo4g6nScDCaVU0DTvk1cdVarDMLyVroIuvedO6uT8jJ2WHJhd4FIoeSs/pyjZCu5JCKoqoNqgG/v6DFzmVoWxDCgFJsdYLDbeek4rWQtqZu3UQlaT7S57nyplkCmJVXQWKsvUmizWlJzNwWDCVBmvJaqlhjwVMWSlzuhW+mhdS2ExYZcWLBp2CsayAcWM+ZBeV61S6WbrFKsRs2dK1CbeZhlDBGNRS9ZS3620djrXF3+QlS/Pbt7el2ZOTwuiKewz/gvwSAlB8zpfwdTa9ITJ46FUsg+YZ2pTo6GGMakqssRNAodBraUrlOuLP+pJ3qo3v6rVCoQ0zGDs0JaJJSPeBg1voix+mA26/W6/JK0QE92kEUwEaAVyTy8PKXD1pCub73BGNl5cP/cYLPebxe+2l2cgHI11HGpb0rMb3ujgxvOsIpN3AU+JzkU3fLulvF3rbLejz98K1PSEvAv4A2hBUXTPx6DaX7Rx7nFDPnhvwiuCE1RPk8f0nhiev0FMI7cvyt41GOf5p8srHvB5+V5dqYTuaFjTGxTWPOLuZeymlHsc0Lctz0AuC6D3Evc6KXlQUFya3ODecYPyB3lVHclNA+HhKveO0F9y68kr261nHrtdLe+Pnr1RUwMvTQmld9hf3PuJOQ== sidebar_class_name: "post api-method" info_path: docs/api/tagoio-api custom_edit_url: null @@ -54,7 +54,7 @@ Create a token for the network to use in network endpoints @@ -62,7 +62,7 @@ Create a token for the network to use in network endpoints diff --git a/specs/tagoio-api.yaml b/specs/tagoio-api.yaml index da3c6b1..5e70179 100644 --- a/specs/tagoio-api.yaml +++ b/specs/tagoio-api.yaml @@ -9477,7 +9477,7 @@ paths: name: type: string example: Token #1 - privilege: + previlegies: type: object example: { createDevice: true @@ -9485,7 +9485,7 @@ paths: example: - network: 667570627d2ad1000999dca2 name: Token #1 - privilege: { + previlegies: { createDevice: true } examples: @@ -9493,7 +9493,7 @@ paths: value: - network: 667570627d2ad1000999dca2 name: Token #1 - privilege: { + previlegies: { createDevice: true } responses: @@ -9513,7 +9513,7 @@ paths: network: type: string example: 667570627d2ad1000999dca2 - privilege: + previlegies: type: object properties: createDevice: From 6c87ff8b95f3c6dd04ef7f2865acd24281baa9af Mon Sep 17 00:00:00 2001 From: Bruno Gelatti Date: Fri, 24 Oct 2025 10:04:36 -0300 Subject: [PATCH 7/7] docs: expand previlegies schema with property definitions Enhanced request body schema by defining createDevice property with explicit type and example instead of using inline example object. --- docs/api/create-network-token.api.mdx | 4 ++-- specs/tagoio-api.yaml | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/api/create-network-token.api.mdx b/docs/api/create-network-token.api.mdx index c7936b6..c6967c7 100644 --- a/docs/api/create-network-token.api.mdx +++ b/docs/api/create-network-token.api.mdx @@ -5,7 +5,7 @@ description: "Create a token for the network to use in network endpoints" sidebar_label: "Create a Token for the Network" hide_title: true hide_table_of_contents: true -api: eJy9V1tv2zYU/isE+1DAkHx3HOuhQNYGW7ChDXJBMSQBeiwdW2xkUiWpuIbh/z4cUpIl59at214SQzw85zv3j1tuYWl4dMM/ol0rfc/O5BKN5XcBT9DEWuRWKMkj/l4jWGTArLpHyRZKM5sik+U1q1hhkAlZf0GZ5EpIa3jAVY4aSNFZwiMeO1WlwStSxwNuMC60sBse3Wz5uVYLkWHoD6Obu91dwDV+K9DYX1Sy4dGWx0palJZ+Qp5nInYGel8Nwd1yE6e4AvplNznyiKv5V4wt93qExoS8lrBCHvASM3mdawJrBRq6Wx3s1RirhVzygON3WOUZfTo6mk6m/aPhNBlCMuj3+7PZLIlhyHeBN/Dibe/jjizjg8hwWZo+hF3f2JYB/IAPIkYeWV3gbrdrSNw0gD+PrgLHqxQcAHjKyt3ejJOpq8LpYGthU1Z+8xdZroVT6oA/QFb8x/h2LhQaTa6k8YLDfp/+PVPPP4A8+OfF1i4njabI7Otyf6NqfrpCXym7NrB2zGvpuVIZgmzarKvS+h5+CR4AzOfzOA4Hg8EgHA6Hw3A0Go3C8Xg8Bn84506ZsWAL80OWfSGs0KaKhk6ujHMHbMoj3hPS4tLPpF4Zwp6tR5F+QG1cnRY64xFPrc1N1OtBLrqFCXHQtbBUXaH4LnhKBotw3ZC524+3S6oUH0sfxWrG1R5BLn7HDT+cvyesKc9sCpYJwwopvhVI43ejCs0SJ9Nlv6Kkibuf1/MNgzhGY4RcelGv7q1hOSyxu++2FqyACzKeIiSoecC/h/usTXAwHI0nECbTPoRjHCbh/HiUhJO47w6OpsczKrBy0P+4o9UqetHTUqjLTpxb7GyfUMPe1TreeS2G7i0Pg0JLrKXs8cw5dP+DMHkGm49equ1aOzyLZDKeQTIMjwejOBwnR0fhfDEdhpP+MU7ms2NY4IjCc7DrXg9PeaH04ZnwoLRC0wxzso2CENILQByrQlpm0Fohl6bhexvRSyUAgwnCBCFMkmESjuOjUXg8G0/C2XA+GScwnk6HwKkNaVBe7Pf36f+wqQj3QrmACutnJizV2Sd2cn72KKpv3rx5wzqd39S6YjI2FYYlKi5WKK0rq07nVl6l2P5IoTd5Jix12DoVcVrmZaOKtxpZRTYaBIloU8lluozdyhJWrtWDSNCwMUvEYoEapfW6THQrQ9bpNDuz04kYgSkLWatVcwAEJZSNKlgMki3RehmynbQa/1YyRijIQCvxZOEkM4rdS7VmYKjRqGL8aZf9qYq9Xme7LLa6pB4baPULGTgzDtKhF3Vzf5LZhsEDiAzmGTKxqOKq1hI1U4sWCa1qWzRnwSMQJxKyjRHGo4g6nScDCaVU0DTvk1cdVarDMLyVroIuvedO6uT8jJ2WHJhd4FIoeSs/pyjZCu5JCKoqoNqgG/v6DFzmVoWxDCgFJsdYLDbeek4rWQtqZu3UQlaT7S57nyplkCmJVXQWKsvUmizWlJzNwWDCVBmvJaqlhjwVMWSlzuhW+mhdS2ExYZcWLBp2CsayAcWM+ZBeV61S6WbrFKsRs2dK1CbeZhlDBGNRS9ZS3620djrXF3+QlS/Pbt7el2ZOTwuiKewz/gvwSAlB8zpfwdTa9ITJ46FUsg+YZ2pTo6GGMakqssRNAodBraUrlOuLP+pJ3qo3v6rVCoQ0zGDs0JaJJSPeBg1voix+mA26/W6/JK0QE92kEUwEaAVyTy8PKXD1pCub73BGNl5cP/cYLPebxe+2l2cgHI11HGpb0rMb3ujgxvOsIpN3AU+JzkU3fLulvF3rbLejz98K1PSEvAv4A2hBUXTPx6DaX7Rx7nFDPnhvwiuCE1RPk8f0nhiev0FMI7cvyt41GOf5p8srHvB5+V5dqYTuaFjTGxTWPOLuZeymlHsc0Lctz0AuC6D3Evc6KXlQUFya3ODecYPyB3lVHclNA+HhKveO0F9y68kr261nHrtdLe+Pnr1RUwMvTQmld9hf3PuJOQ== +api: eJy9V9tu2zgQ/RWCeShgSL47jvVQINsGu8EWbZALikUSoGNpLLGRSZWk4hqG/30xpGRLTpN2t9t9SQxxOHPmfrjhFlLDo1v+Hu1K6Qd2LlM0lt8HPEETa1FYoSSP+BuNYJEBs+oBJVsozWyGTFbXrGKlQSbk7gvKpFBCWsMDrgrUQIrOEx7x2KmqDF6TOh5wg3GphV3z6HbDL7RaiBxDfxjd3m/vA67xS4nG/qaSNY82PFbSorT0E4oiF7Ez0PtsCO6GmzjDJdAvuy6QR1zNP2NsudcjNCbktYQl8oBXmMnrQhNYK9DQ3fpgr8ZYLWTKA45fYVnk9On4eDqZ9o+H02QIyaDf789msySGId8G3sCLt72PW7KMjyLHtDJ9CLsNzMfwLT6KuKl/rlSOIJsGrC5xu91uG59uG449j74Gz+sUHQBsQ/Bm7vdmnMyuapwOthI2Y9U3f5EVWjilzotHyMtfjM+HQqMplDRecNjv079n6v0HkAf/vhjbWdVoytx+X+4fVNVPV/CvLcuAW9/jL8EDgPl8HsfhYDAYhMPhcBiORqNROB6Px+AP59wpMxZsaX6sIdyFJdpM0VAqlHHugM14xHtCWkz9zOpVIezZ3ajSj6iNq9NS5zzimbWFiXo9KES3NCEOuhZS1RWKb4NvyWAZrhoy9/vxd0WV4mPpo1jPwJ1HUIg/cc0P5/Mpa8ozm4FlwrBSii8l0nheq1KzxMl02e8oaSLv5/l8zSCO0RghUy/q1b0yrIAUu/tua8EKuCDjGUKCmgf8a7jP2gQHw9F4AmEy7UM4xmESzk9GSTiJ++7geHoyowKrFsGPO1qvqhc9rYS67NS5xc73CTXs9U7Ha6/F0L30MCi05FrKns6cQ/ffClPksH7vpdqutcOzSCbjGSTD8GQwisNxcnwczhfTYTjpn+BkPjuBBY4oPAe78PvhqS5UPjwTHpRWaJphTrZREEJ6AYhjVUrLDForZGoavrcRvVQCMJggTBDCJBkm4Tg+HoUns/EknA3nk3EC4+l0CJzakAbl5X6/n/0Pm4pwL5QLqLB+ZkKqzj+w04vzJ1E9Ojo6Yp3OH2pVMx2bCcMSFZdLlNaVVadzJ68zbH+k0JsiF5Y6bJWJOKvyslblK42sJiMNAkW0quI6XcbuZAWr0OpRJGjYmCVisUCN0npdJrqTIet0mp3Z6USMwFSFrNWyOQCCCspalSwGyVK0XoZsJ63Gv5OMEQoy0Eo8WTjNjWIPUq0YGGo0qhh/2mV/qXKv19muim1XUk8NtPqFDJwbB+nQi11zf5D5msEjiBzmOTKxqOOqVhI1U4sWSa1rWzRnwRMQpxLytRHGo4g6nW8GEiqpoGneJ68+qlWHYXgnXQVdec+d1OnFOTurODK7xFQoeSc/ZijZEh5ICOoqoNqgG/v6DFzmlqWxDCgFpsBYLNbeekErWQtqZu3UQr4j4132JlPKIFMS6+gsVJ6rFVncUXY2B4MJU1W8UlSphiITMeSVzuhO+mjdSGExYVcWLBp2BsayAcWM+ZDe1K1S62arDOsRs2dK1CbeZhVDBGNRS9ZS3621djo3l+/IyqdnN2/vUzOnZyXRFPYR/wN4pISgeZ3fwdTa9ITJ46FUsrdY5Gq9Q0MNYzJV5ombBA6DWklXKDeX73aTvFVvflWrJQhpmMHYoa0SS0a8DRreRFn8MBt0+91+RVohJrpJI5gI0BLknl4eUuD6yVc13+GMbLzIfu6xWO03i19tr8hBOBrrONSmome3vNHBjedbTSbvA54RnYtu+WZDebvR+XZLn7+UqOmJeR/wR9CCouiel0G9v2jjPOCafPDehNcEJ6ifJk/pPTE8f4OYRmFflL1vMM6LD1fXPODz6j27VAnd0bCiNyqseMTdy9lNKfc4oG8bnoNMS6D3Evc6KXlQUlya3ODBcYPqB3lVH8l1A+HhKveO0F9y65tXNhvPPLbbnbw/evbGjhp4aUoovcP+Bm8llIw= sidebar_class_name: "post api-method" info_path: docs/api/tagoio-api custom_edit_url: null @@ -54,7 +54,7 @@ Create a token for the network to use in network endpoints diff --git a/specs/tagoio-api.yaml b/specs/tagoio-api.yaml index 5e70179..9048397 100644 --- a/specs/tagoio-api.yaml +++ b/specs/tagoio-api.yaml @@ -9479,9 +9479,10 @@ paths: example: Token #1 previlegies: type: object - example: { - createDevice: true - } + properties: + createDevice: + type: boolean + example: true example: - network: 667570627d2ad1000999dca2 name: Token #1