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

Rel 984674 import service staging governance correct loadfile paths in relativity import samples openapi #29

Merged
merged 2 commits into from
Aug 28, 2024
Merged

Rel 984674 import service staging governance correct loadfile paths in relativity import samples openapi #29

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ceb211
REL-984674 OpenAPI doc changes
annasojkapal Aug 27, 2024
cbc8788
REL-984674 remove DiagnosticJob from OpanAPI
annasojkapal Aug 27, 2024
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
223 changes: 132 additions & 91 deletions OpenAPI/openapidoc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -624,6 +624,121 @@
}
}
},
"/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/sources/{sourceID}/delete": {
"post": {
"tags": [
"Import Source Module"
],
"summary": "",
"description": "Deletes the parent folder of the data source's load file if it is located in \\StructuredData\\Import\\.",
"operationId": "Import.Services.V1.IImportSourceController.DeleteParentFolderAsync",
"parameters": [
{
"$ref": "#/components/parameters/X-CSRF-Header"
},
{
"$ref": "#/components/parameters/workspaceID"
},
{
"$ref": "#/components/parameters/importJobID"
},
{
"$ref": "#/components/parameters/sourceID"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {}
},
"required": false
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
},
"400": {
"description": "Bad Request. Validation exception."
}
}
}
},
"/import-service/v1/workspaces/{workspaceID}/import-jobs/location": {
"get": {
"tags": [
"Import Job Module"
],
"summary": "",
"description": "Gets the default location for the import files upload.",
"operationId": "Import.Services.V1.ImportJobController.GetDefaultLocationForWorkspaceAsync",
"parameters": [
{
"$ref": "#/components/parameters/X-CSRF-Header"
},
{
"$ref": "#/components/parameters/workspaceID"
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResponse.String"
}
}
}
},
"400": {
"description": "Bad Request. Validation exception."
}
}
}
},
"/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/location": {
"get": {
"tags": [
"Import Job Module"
],
"summary": "",
"description": "Gets the default location for the import files upload.",
"operationId": "Import.Services.V1.ImportJobController.GetDefaultLocationForJobAsync",
"parameters": [
{
"$ref": "#/components/parameters/X-CSRF-Header"
},
{
"$ref": "#/components/parameters/workspaceID"
},
{
"$ref": "#/components/parameters/importJobID"
}
],
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ValueResponse.String"
}
}
}
},
"400": {
"description": "Bad Request. Validation exception."
}
}
}
},
"/import-service/v1/workspaces/{workspaceID}/import-jobs/{importJobID}/sources/": {
"get": {
"tags": [
Expand Down Expand Up @@ -865,47 +980,6 @@
}
}
}
},
"/import-private/v1/DiagnosticJob/Execute": {
"post": {
"tags": [
"Diagnostic Job Module"
],
"summary": "",
"description": "Create, configure, and execute simple import job for diagnostic purpose.",
"operationId": "Import.Services.V1.IDiagnosticJobController.ExecuteAsync",
"parameters": [
{
"$ref": "#/components/parameters/X-CSRF-Header"
}
],
"requestBody": {
"description": "",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DiagnosticJobSettings"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "Successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DiagnosticJobResponse"
}
}
}
},
"400": {
"description": "Bad Request. Validation exception."
}
}
}
}
},
"components": {
Expand Down Expand Up @@ -1138,10 +1212,17 @@
"type": "object",
"properties": {
"State": {
"$ref": "#/components/schemas/DataSourceState",
"description": "Indicates in what state currently DataSource is."
"$ref": "#/components/schemas/DataSourceState"
},
"DataSourceSettings": { "$ref": "#/components/schemas/DataSourceSettings" },
"IsParentFolderDeleted": {
"type": "boolean",
"description": "Gets or sets a value indicating whether the source load file's parent folder is deleted.",
"example": true
},
"DataSourceSettings": { "$ref": "#/components/schemas/DataSourceSettings" }
"JobLevelErrors": {
"$ref": "#/components/schemas/ImportError"
}
}
},
"ValueResponse.ImportDocumentSettings": {
Expand Down Expand Up @@ -1249,50 +1330,6 @@
}
}
},
"DiagnosticJobResponse": {
"type": "object",
"properties": {
"InformationMessage": {
"type": "string",
"example": "Diagnostic Import Job was properly started. Use the dedicated api endpoints to monitor job progress and state."
},
"IsSuccess": {
"type": "boolean",
"example": true
},
"ErrorMessage": {
"type": "string",
"example": ""
},
"ErrorCode": {
"type": "string",
"example": ""
},
"ImportJobID": {
"description": "Import job identification GUID number.",
"type": "string",
"format": "uuid",
"example": "00000000-0000-0000-0000-000000000000"
}
}
},
"DiagnosticJobSettings": {
"type": "object",
"properties": {
"WorkspaceID": {
"type": "integer",
"description": "Indicates the WorkspaceID for which the import will be executed. If not provided the Relativity Starter Template workspace is used.",
"nullable": true,
"example": 1003663
},
"FileSharePath": {
"type": "string",
"description": "Custom provided fileshare location where dataset (load file) will be generated. When not provided the default fileshare location for selected workspace is used.",
"nullable": true,
"example": "\\\\files\\T001\\StructuredData\\Import\\EDDS1015024\\DiagnosticJob"
}
}
},
"ImportDocumentSettings": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -1549,7 +1586,7 @@
"FileTypeSettings": {
"type": "object",
"properties": {
"ValidateFileType": {
"DoNotValidateFileType": {
"type": "boolean",
"description": "Indicates if file type validation should be run in import service.",
"example": false
Expand Down Expand Up @@ -1578,7 +1615,7 @@
"type": "boolean",
"example": true
},
"ValidateFileType": {
"DoNotValidateFileType": {
"type": "boolean",
"example": true
},
Expand Down Expand Up @@ -1657,6 +1694,10 @@
"LineNumber": {
"type": "integer",
"example": 1
},
"ObjectIdentifier": {
"type": "string",
"description": "Document identifier"
}
}
},
Expand Down Expand Up @@ -1814,4 +1855,4 @@
}
}
}
}
}
Loading