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

Add IOT central app templates api in swagger #5494

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
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,43 @@
"deprecated": false
}
},
"/subscriptions/{subscriptionId}/providers/Microsoft.IoTCentral/appTemplates": {
kawayiboy marked this conversation as resolved.
Show resolved Hide resolved
kawayiboy marked this conversation as resolved.
Show resolved Hide resolved
"get": {
kawayiboy marked this conversation as resolved.
Show resolved Hide resolved
"tags": [
"Apps"
],
"description": "Get all available application templates.",
"operationId": "Apps_Templates",
"x-ms-examples": {
"Apps_Templates": {
"$ref": "./examples/Apps_Templates.json"
}
},
"parameters": [
{
"$ref": "#/parameters/api-version"
},
{
"$ref": "#/parameters/subscriptionId"
}
],
"responses": {
"200": {
"description": "The body contains all the of the filtered IoT Central application templates.",
"schema": {
"$ref": "#/definitions/AppTemplatesResult"
}
},
"default": {
"description": "DefaultErrorResponse",
"schema": {
"$ref": "#/definitions/ErrorDetails"
}
}
},
"deprecated": false
}
},
"/providers/Microsoft.IoTCentral/operations": {
"get": {
"tags": [
Expand Down Expand Up @@ -733,6 +770,60 @@
"readOnly": true
}
}
},
"AppTemplate": {
"description": "IoT Central Application Template.",
"type": "object",
"properties": {
"manifestId": {
"description": "The ID of the template.",
"type": "string",
"readOnly": true
},
"manifestVersion": {
"description": "The version of the template.",
"type": "string",
"readOnly": true
},
"name": {
"description": "The name of the template.",
"type": "string",
"readOnly": true
},
"title": {
"description": "The title of the template.",
"type": "string",
"readOnly": true
},
"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 description objects.",
"type": "string"
},
"value": {
"description": "A list of IoT Central Application Templates.",
"type": "array",
"readOnly": true,
"items": {
"$ref": "#/definitions/AppTemplate"
}
}
}
}
},
"parameters": {
Expand Down