Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

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

[Hub Generated] Review request for Microsoft.IoTCentral to add version 2018-09-01 #5495

Merged
merged 12 commits into from
Apr 17, 2019
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
{
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"api-version": "2018-09-01",
"applicationTemplateId": "iotc-default@1.0.0"
},
"responses": {
"200": {
"description": "Returns the application templates details",
"headers": {
"code": "200"
},
"body": {
"value": {
"manifestId": "iotc-default",
"manifestVersion": "1.0.0",
"name": "IoT Central Default template",
"title": "IoT Central Default template",
"order": 1,
"description": "Description for IoT Central Default template"
}
},
"default": {
"description": "Error message returned for an unexpected response",
"headers": {},
"body": {
"error": {
"code": "Error code",
"message": "Error message",
"target": "Error target"
}
}
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
{
"parameters": {
"subscriptionId": "00000000-0000-0000-0000-000000000000",
"api-version": "2018-09-01"
},
"responses": {
"200": {
"description": "Returns the application templates details",
"headers": {
"code": "200"
},
"body": {
"value": [
{
"manifestId": "iotc-default",
"manifestVersion": "1.0.0",
"name": "IoT Central Default template",
"title": "IoT Central Default template",
"order": 1,
"description": "Description for IoT Central Default template"
}
],
"nextLink": null
},
"default": {
"description": "Error message returned for an unexpected response",
"headers": {},
"body": {
"error": {
"code": "Error code",
"message": "Error message",
"target": "Error target"
}
}
}
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -410,6 +410,86 @@
"deprecated": false
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/applicationTemplates/{applicationTemplateId}": {
"get": {
"tags": [
"Apps"
],
"description": "Get a single application template.",
"operationId": "Apps_Template",
"x-ms-examples": {
"Apps_Template": {
"$ref": "./examples/Apps_Template.json"
}
},
"parameters": [
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/subscriptionId"
},
{
"$ref": "#/parameters/applicationTemplateId"
}
],
"responses": {
"200": {
"description": "The body contains the filtered IoT Central application template.",
"schema": {
"$ref": "#/definitions/AppTemplate"
}
},
"default": {
"description": "DefaultErrorResponse",
"schema": {
"$ref": "#/definitions/ErrorDetails"
}
}
},
"deprecated": false
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/applicationTemplates": {
"get": {
"tags": [
"Apps"
],
"description": "Get all available application templates.",
kawayiboy marked this conversation as resolved.
Show resolved Hide resolved
"operationId": "Apps_ListTemplates",
"x-ms-examples": {
"Apps_ListTemplates": {
"$ref": "./examples/Apps_Templates.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"parameters": [
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/subscriptionId"
}
],
"responses": {
"200": {
"description": "The body contains all the of the filtered IoT Central application templates.",
kawayiboy marked this conversation as resolved.
Show resolved Hide resolved
"schema": {
"$ref": "#/definitions/AppTemplatesResult"
}
},
"default": {
"description": "DefaultErrorResponse",
"schema": {
"$ref": "#/definitions/ErrorDetails"
}
}
},
"deprecated": false
}
},
"/providers/Microsoft.IoTCentral/operations": {
"get": {
"tags": [
Expand Down Expand Up @@ -585,6 +665,7 @@
"description": "Error details.",
"properties": {
"error": {
"description": "Error response body.",
"x-ms-client-flatten": true,
"$ref": "#/definitions/ErrorResponseBody"
}
Expand Down Expand Up @@ -733,6 +814,60 @@
"readOnly": true
}
}
},
"AppTemplate": {
kawayiboy marked this conversation as resolved.
Show resolved Hide resolved
"description": "IoT Central Application Template.",
"type": "object",
"properties": {
"manifestId": {
kawayiboy marked this conversation as resolved.
Show resolved Hide resolved
"description": "The ID of the template.",
"type": "string",
"readOnly": true
},
"manifestVersion": {
"description": "The version of the template.",
"type": "string",
"readOnly": true
},
"name": {
kawayiboy marked this conversation as resolved.
Show resolved Hide resolved
"description": "The name of the template.",
"type": "string",
"readOnly": true
},
"title": {
kawayiboy marked this conversation as resolved.
Show resolved Hide resolved
"description": "The title of the template.",
"type": "string",
"readOnly": true
},
kawayiboy marked this conversation as resolved.
Show resolved Hide resolved
"order": {
"description": "The order of the template in the templates list.",
"type": "number",
"readOnly": true
},
"description": {
"description": "The description of the template.",
"type": "string",
"readOnly": true
}
}
},
"AppTemplatesResult": {
"description": "A list of IoT Central Application Templates with a next link.",
"type": "object",
"properties": {
"nextLink": {
"description": "The link used to get the next page of IoT Central application templates.",
"type": "string"
},
"value": {
"description": "A list of IoT Central Application Templates.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/AppTemplate"
}
}
}
}
},
"parameters": {
Expand All @@ -758,6 +893,14 @@
"type": "string",
"x-ms-parameter-location": "method"
},
"applicationTemplateId": {
"name": "applicationTemplateId",
"in": "path",
"description": "The combination id of manifestId and manifestVersion of the IoT Central application template.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
},
"resourceName": {
"name": "resourceName",
"in": "path",
Expand Down