Skip to content

Commit

Permalink
IoTC 2011 Adding jobs, DTDLv2 templates, groups (Azure#11622)
Browse files Browse the repository at this point in the history
* Adding jobs, DTDLv2 templates, groups

* Spelling mistakes fix

* Trying to suppress email lint

* Small update to fix linter

* Added additional suppression for long running ops

* Again

* Updated again

* Removing the other suppressors

* New suppression without quotes

* back to just email suppression
  • Loading branch information
viv-liu authored and giromm2ms committed Dec 20, 2020
1 parent b09d871 commit b05de7a
Show file tree
Hide file tree
Showing 11 changed files with 817 additions and 478 deletions.
1 change: 1 addition & 0 deletions custom-words.txt
Original file line number Diff line number Diff line change
Expand Up @@ -496,6 +496,7 @@ deserializing
destinationshares
deterministically
devicecredentials
devicegroups
deviceprovisioningservices
devicetemplates
devspaces
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"title": "DeviceGroup List",
"description": "List all device groups in your application.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "475cad48-b7ff-4a09-b51e-1a9021385453",
"displayName": "DeviceGroupEntry1"
},
{
"id": "c2d5ae1d-2cb7-4f58-bf44-5e816aba0a0e",
"displayName": "DeviceGroupEntry2"
},
{
"id": "241ad72b-32aa-4216-aabe-91b240582c8d",
"displayName": "DeviceGroupEntry3"
},
{
"id": "241ad72b-32aa-4216-aabe-91b240582c8d",
"displayName": "DeviceGroupEntry4"
}
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
{
"title": "Execute a new job",
"description": "Create and execute a new job via its job definition.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"job_id": "myJobId",
"body": {
"displayName": "My Job",
"group": "475cad48-b7ff-4a09-b51e-1a9021385453",
"data": [
{
"type": "PropertyJobData",
"target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
"path": "componentName.propertyName",
"value": "updated value"
}
]
}
},
"responses": {
"200": {
"body": {
"id": "myJobId",
"displayName": "My Job",
"group": "475cad48-b7ff-4a09-b51e-1a9021385453",
"data": [
{
"type": "PropertyJobData",
"target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
"path": "componentName.propertyName",
"value": "updated value"
}
],
"status": "running"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
{
"title": "Get device statuses",
"description": "Get the list of individual device statuses by job ID.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"job_id": "myJobId"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "ylleedih6k",
"status": "completed"
},
{
"id": "t81v3k204k",
"status": "completed"
},
{
"id": "iotc-1",
"status": "completed"
},
{
"id": "iotc",
"status": "completed"
},
{
"id": "1c5cs18m7k1",
"status": "completed"
}
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"title": "Get a job by Id",
"description": "Get a job by Id",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"job_id": "myJobId"
},
"responses": {
"200": {
"body": {
"id": "myJobId",
"displayName": "My Job",
"group": "475cad48-b7ff-4a09-b51e-1a9021385453",
"data": [
{
"type": "PropertyJobData",
"target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
"path": "componentName.propertyName",
"value": "updated value"
}
],
"status": "running"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"title": "List jobs",
"description": "List all jobs in your application.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain"
},
"responses": {
"200": {
"body": {
"value": [
{
"id": "myJobId",
"displayName": "My Job",
"group": "475cad48-b7ff-4a09-b51e-1a9021385453",
"data": [
{
"type": "PropertyJobData",
"target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
"path": "componentName.propertyName",
"value": "updated value"
}
],
"status": "running"
}
]
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
{
"title": "Rerun a job on failed devices",
"description": "Execute a rerun of an existing job on all failed devices.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"job_id": "myJobId",
"rerun_id": "myJobRerunId"
},
"responses": {
"200": {
"body": {
"id": "myJobRerunId",
"displayName": "My Job",
"group": "475cad48-b7ff-4a09-b51e-1a9021385453",
"data": [
{
"type": "PropertyJobData",
"target": "urn:1dgygpt7t:modelDefinition:02uwtefvdy",
"path": "componentName.propertyName",
"value": "updated value"
}
],
"status": "running"
}
}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"title": "Resume a stopped job",
"description": "Resume execution of an existing stoppped job.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"job_id": "myJobId"
},
"responses": {
"204": {}
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"title": "Stop a running job",
"description": "Stop execution of a job that is currently running.",
"parameters": {
"centralDnsSuffixInPath": "azureiotcentral.com",
"subdomain": "appsubdomain",
"job_id": "myJobId"
},
"responses": {
"204": {}
}
}
Loading

0 comments on commit b05de7a

Please sign in to comment.