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.

Sign up for GitHub

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

Renaming definitions from Bulk Jobs to Import Jobs #22488

Merged
merged 2 commits into from
Feb 8, 2023
Merged

Renaming definitions from Bulk Jobs to Import Jobs #22488

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53347e1
Renaming definitions from Bulk Jobs to Import Jobs
abhinav-ghai Feb 7, 2023
cc1848b
Rename files to exclude Bulk from examples
abhinav-ghai Feb 7, 2023
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
54 changes: 27 additions & 27 deletions ...gitaltwins/data-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/digitaltwins.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1251,9 +1251,9 @@
"ImportJobs"
],
"operationId": "ImportJobs_List",
"description": "Retrieves all bulk import jobs.\nStatus codes:\n* 200 OK",
"description": "Retrieves all import jobs.\nStatus codes:\n* 200 OK",
"x-ms-examples": {
"Get all bulk jobs": {
"Get all import jobs": {
"$ref": "./examples/BulkImportJobList.json"
}
},
Expand All @@ -1269,7 +1269,7 @@
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/BulkImportJobCollection"
"$ref": "#/definitions/ImportJobCollection"
}
},
"default": {
Expand Down Expand Up @@ -1298,23 +1298,23 @@
"ImportJobs"
],
"operationId": "ImportJobs_Add",
"description": "Creates a bulk import job.\nStatus codes:\n* 201 Created\n* 400 Bad Request\n * JobLimitReached - The maximum number of bulk import jobs allowed has been reached.\n * ValidationFailed - The bulk job request is not valid.",
"description": "Creates an import job.\nStatus codes:\n* 201 Created\n* 400 Bad Request\n * JobLimitReached - The maximum number of import jobs allowed has been reached.\n * ValidationFailed - The import job request is not valid.",
"x-ms-examples": {
"Add a job": {
"$ref": "./examples/BulkImportJobPut.json"
}
},
"parameters": [
{
"$ref": "#/parameters/bulkImportJobId"
"$ref": "#/parameters/importJobId"
},
{
"name": "importJob",
"description": "The bulk import job being added.",
"description": "The import job being added.",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkImportJob"
"$ref": "#/definitions/ImportJob"
}
},
{
Expand All @@ -1325,7 +1325,7 @@
"201": {
"description": "Success",
"schema": {
"$ref": "#/definitions/BulkImportJob"
"$ref": "#/definitions/ImportJob"
}
},
"default": {
Expand All @@ -1341,15 +1341,15 @@
"ImportJobs"
],
"operationId": "ImportJobs_GetById",
"description": "Retrieves a bulk job.\nStatus codes:\n* 200 OK\n* 404 Not Found\n * BulkJobNotFound - The bulk job was not found.",
"description": "Retrieves an import job.\nStatus codes:\n* 200 OK\n* 404 Not Found\n * ImportJobNotFound - The import job was not found.",
"x-ms-examples": {
"Get a bulk job by id": {
"Get an import job by id": {
"$ref": "./examples/BulkImportJobGet.json"
}
},
"parameters": [
{
"$ref": "#/parameters/bulkImportJobId"
"$ref": "#/parameters/importJobId"
},
{
"$ref": "#/parameters/api-version"
Expand All @@ -1359,7 +1359,7 @@
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/BulkImportJob"
"$ref": "#/definitions/ImportJob"
}
},
"default": {
Expand All @@ -1375,15 +1375,15 @@
"ImportJobs"
],
"operationId": "ImportJobs_Delete",
"description": "Deletes a bulk import job.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * ValidationFailed - The bulk job request is not valid.",
"description": "Deletes an import job.\nStatus codes:\n* 204 No Content\n* 400 Bad Request\n * ValidationFailed - The import job request is not valid.",
"x-ms-examples": {
"Delete a bulk job": {
"Delete an import job": {
"$ref": "./examples/BulkImportJobDelete.json"
}
},
"parameters": [
{
"$ref": "#/parameters/bulkImportJobId"
"$ref": "#/parameters/importJobId"
},
{
"$ref": "#/parameters/api-version"
Expand Down Expand Up @@ -1416,15 +1416,15 @@
"ImportJobs"
],
"operationId": "ImportJobs_Cancel",
"description": "Cancels a bulk import job.\nStatus codes:\n* 200 Request Accepted\n* 400 Bad Request\n * ValidationFailed - The bulk job request is not valid.",
"description": "Cancels an import job.\nStatus codes:\n* 200 Request Accepted\n* 400 Bad Request\n * ValidationFailed - The import job request is not valid.",
"x-ms-examples": {
"Cancel a job": {
"$ref": "./examples/BulkImportJobCancel.json"
}
},
"parameters": [
{
"$ref": "#/parameters/bulkImportJobId"
"$ref": "#/parameters/importJobId"
},
{
"$ref": "#/parameters/api-version"
Expand All @@ -1434,7 +1434,7 @@
"200": {
"description": "Success",
"schema": {
"$ref": "#/definitions/BulkImportJob"
"$ref": "#/definitions/ImportJob"
}
},
"default": {
Expand Down Expand Up @@ -1670,7 +1670,7 @@
}
}
},
"BulkImportJob": {
"ImportJob": {
"description": "A job which contains a reference to the operations to perform, results, and execution metadata.",
"type": "object",
"required": [
Expand All @@ -1679,7 +1679,7 @@
],
"properties": {
"id": {
"description": "The identifier of the bulk import job.",
"description": "The identifier of the import job.",
"type": "string",
"readOnly": true
},
Expand Down Expand Up @@ -1735,22 +1735,22 @@
},
"error": {
"$ref": "#/definitions/Error",
"description": "Details of the error(s) that occurred executing the bulk job."
"description": "Details of the error(s) that occurred executing the import job."
}
}
},
"BulkImportJobCollection": {
"description": "A collection of bulk import job objects.",
"ImportJobCollection": {
"description": "A collection of import job objects.",
"type": "object",
"required": [
"value"
],
"properties": {
"value": {
"description": "The list of bulk import job objects.",
"description": "The list of import job objects.",
"type": "array",
"items": {
"$ref": "#/definitions/BulkImportJob"
"$ref": "#/definitions/ImportJob"
}
},
"nextLink": {
Expand Down Expand Up @@ -1861,10 +1861,10 @@
"type": "string",
"x-ms-parameter-location": "method"
},
"bulkImportJobId": {
"importJobId": {
"name": "id",
"in": "path",
"description": "The id for the bulk import job. The id is unique within the service and case sensitive.",
"description": "The id for the import job. The id is unique within the service and case sensitive.",
"required": true,
"type": "string",
"x-ms-parameter-location": "method"
Expand Down
5 changes: 2 additions & 3 deletions ...plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobCancel.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
{
abhinav-ghai marked this conversation as resolved.
Show resolved Hide resolved
"parameters": {
"api-version": "2023-02-27-preview",
"id": "bulkimportjob1"
"id": "importjob1"
},
"responses": {
"200": {
"body": {
"id": "bulkimportjob1",
"id": "importjob1",
"inputBlobUri": "path to input blob",
"outputBlobUri": "path to output blob",
"createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
"lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
"finishedDateTime": null,
"purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
"status": "cancelling"
}
Expand Down
4 changes: 2 additions & 2 deletions ...ta-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobGet.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"parameters": {
"id": "bulkimportjob1",
"id": "importjob1",
"api-version": "2023-02-27-preview"
},
"responses": {
"200": {
"body": {
"id": "bulkimportjob1",
"id": "importjob1",
"inputBlobUri": "path to input blob",
"outputBlobUri": "path to output blob",
"createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
Expand Down
4 changes: 2 additions & 2 deletions ...a-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobList.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"body": {
"value": [
{
"id": "bulkimportjob1",
"id": "importjob1",
"inputBlobUri": "path to input blob",
"outputBlobUri": "path to output blob",
"createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
Expand All @@ -17,7 +17,7 @@
"status": "succeeded"
},
{
"id": "bulkimportjob2",
"id": "importjob2",
"inputBlobUri": "path to input blob",
"outputBlobUri": "path to output blob",
"createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
Expand Down
5 changes: 2 additions & 3 deletions ...ta-plane/Microsoft.DigitalTwins/preview/2023-02-27-preview/examples/BulkImportJobPut.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"parameters": {
"api-version": "2023-02-27-preview",
"id": "bulkimportjob1",
"id": "importjob1",
"importJob": {
"inputBlobUri": "path to input blob",
"outputBlobUri": "path to output blob"
Expand All @@ -10,12 +10,11 @@
"responses": {
"201": {
"body": {
"id": "bulkimportjob1",
"id": "importjob1",
"inputBlobUri": "path to input blob",
"outputBlobUri": "path to output blob",
"createdDateTime": "2022-01-01T00:00:00.0000000+00:00",
"lastActionDateTime": "2022-01-01T00:01:00.0000000+00:00",
"finishedDateTime": null,
"purgeDateTime": "2022-01-31T00:01:00.0000000+00:00",
"status": "notstarted"
}
Expand Down