Skip to content

Commit

Permalink
Add single execution history endpoint, refactor copy paste code for j… (
Browse files Browse the repository at this point in the history 
#23816)

* Add single execution history endpoint, refactor copy paste code for jobName and jobExecutionName path parameters

* Fix validation errors from ARM

* Fix validation errors

* Code review comments

* Fix validation error

* code review comments from Anand
  • Loading branch information
@trajkobal
trajkobal authored May 19, 2023
1 parent 719fee7 commit 45991aa
Show file tree
Hide file tree
Showing 2 changed files with 123 additions and 67 deletions.
141 changes: 74 additions & 67 deletions specification/app/resource-manager/Microsoft.App/preview/2023-04-01-preview/Jobs.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -111,12 +111,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Name of the Container Apps Job.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
"$ref": "#/parameters/JobNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
Expand Down Expand Up @@ -157,11 +152,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Name of the Container Apps Job.",
"required": true,
"type": "string"
"$ref": "#/parameters/JobNameParameter"
},
{
"name": "JobEnvelope",
Expand Down Expand Up @@ -224,11 +215,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Name of the Container Apps Job.",
"required": true,
"type": "string"
"$ref": "#/parameters/JobNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
Expand Down Expand Up @@ -281,11 +268,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Name of the Container Apps Job.",
"required": true,
"type": "string"
"$ref": "#/parameters/JobNameParameter"
},
{
"name": "JobEnvelope",
Expand Down Expand Up @@ -345,12 +328,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Name of the Container Apps Job.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
"$ref": "#/parameters/JobNameParameter"
},
{
"name": "template",
Expand Down Expand Up @@ -416,20 +394,10 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Name of the Container Apps Job.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
"$ref": "#/parameters/JobNameParameter"
},
{
"name": "jobExecutionName",
"in": "path",
"description": "Job execution name.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
"$ref": "#/parameters/JobExecutionNameParameter"
}
],
"responses": {
Expand Down Expand Up @@ -480,21 +448,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Name of the Container Apps Job.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
{
"name": "jobExecutionName",
"in": "body",
"description": "List of all job executions that should be stopped.",
"required": true,
"schema": {
"$ref": "#/definitions/JobExecutionNamesCollection"
}
"$ref": "#/parameters/JobNameParameter"
}
],
"responses": {
Expand Down Expand Up @@ -545,12 +499,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Name of the Container Apps Job.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
"$ref": "#/parameters/JobNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
Expand Down Expand Up @@ -587,6 +536,51 @@
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/executions/{jobExecutionName}": {
"get": {
"tags": [
"Jobs"
],
"summary": "Get details of a single job execution",
"operationId": "JobExecution",
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ResourceGroupNameParameter"
},
{
"$ref": "#/parameters/JobNameParameter"
},
{
"$ref": "#/parameters/JobExecutionNameParameter"
},
{
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/JobExecution"
}
},
"default": {
"description": "Common error response.",
"schema": {
"$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse"
}
}
},
"x-ms-examples": {
"Get a single Job Execution": {
"$ref": "./examples/Job_Execution_Get.json"
}
}
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.App/jobs/{jobName}/listSecrets": {
"post": {
"tags": [
Expand All @@ -605,12 +599,7 @@
"$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
},
{
"name": "jobName",
"in": "path",
"description": "Name of the Container Apps Job.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
"$ref": "#/parameters/JobNameParameter"
}
],
"responses": {
Expand All @@ -635,6 +624,24 @@
}
}
},
"parameters": {
"JobNameParameter": {
"name": "jobName",
"in": "path",
"description": "Job Name",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
},
"JobExecutionNameParameter": {
"name": "jobExecutionName",
"in": "path",
"description": "Job execution name.",
"required": true,
"type": "string",
"pattern": "^[-\\w\\._\\(\\)]+$"
}
},
"definitions": {
"JobConfiguration": {
"description": "Non versioned Container Apps Job configuration properties",
Expand Down Expand Up @@ -1008,7 +1015,7 @@
}
},
"JobExecution": {
"description": "Container Apps Jobs execution.",
"description": "Container Apps Job execution.",
"type": "object",
"properties": {
"name": {
Expand Down
49 changes: 49 additions & 0 deletions ...resource-manager/Microsoft.App/preview/2023-04-01-preview/examples/Job_Execution_Get.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
{
"parameters": {
"subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
"resourceGroupName": "rg",
"jobName": "testcontainerAppsJob0",
"jobExecutionName": "jobExecution1",
"api-version": "2023-04-01-preview"
},
"responses": {
"200": {
"headers": {},
"body": {
"name": "jobExecution1",
"status": "Running",
"startTime": "2023-02-13T20:37:30+00:00",
"endTime": "2023-02-13T20:47:30+00:00",
"template": {
"containers": [
{
"image": "repo/testcontainerAppsJob0:v4",
"name": "testcontainerAppsJob0",
"resources": {
"cpu": 0.2,
"memory": "100Mi"
}
}
],
"initContainers": [
{
"image": "repo/testcontainerAppsJob0:v4",
"name": "testinitcontainerAppsJob0",
"resources": {
"cpu": 0.2,
"memory": "100Mi"
},
"command": [
"/bin/sh"
],
"args": [
"-c",
"while true; do echo hello; sleep 10;done"
]
}
]
}
}
}
}
}

0 comments on commit 45991aa

Please sign in to comment.