docs(openapi): remove deprecated POST /jobs/submit endpoint and SubmitJobRequest schema
This commit is contained in:
@@ -42,80 +42,6 @@
|
|||||||
}
|
}
|
||||||
],
|
],
|
||||||
"paths": {
|
"paths": {
|
||||||
"/jobs/submit": {
|
|
||||||
"post": {
|
|
||||||
"tags": ["Jobs"],
|
|
||||||
"summary": "Submit a new job",
|
|
||||||
"description": "Submits a Slurm job with the specified script and optional parameters.",
|
|
||||||
"operationId": "submitJob",
|
|
||||||
"requestBody": {
|
|
||||||
"required": true,
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/SubmitJobRequest"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"responses": {
|
|
||||||
"201": {
|
|
||||||
"description": "Job submitted successfully",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"allOf": [
|
|
||||||
{ "$ref": "#/components/schemas/ApiResponseSuccess" },
|
|
||||||
{
|
|
||||||
"type": "object",
|
|
||||||
"properties": {
|
|
||||||
"data": {
|
|
||||||
"$ref": "#/components/schemas/JobResponse"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"400": {
|
|
||||||
"description": "Invalid request body or missing required fields",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/ApiResponseError"
|
|
||||||
},
|
|
||||||
"examples": {
|
|
||||||
"invalid_body": {
|
|
||||||
"value": {
|
|
||||||
"success": false,
|
|
||||||
"error": "invalid request body"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"missing_script": {
|
|
||||||
"value": {
|
|
||||||
"success": false,
|
|
||||||
"error": "script is required"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"502": {
|
|
||||||
"description": "Slurm backend error",
|
|
||||||
"content": {
|
|
||||||
"application/json": {
|
|
||||||
"schema": {
|
|
||||||
"$ref": "#/components/schemas/ApiResponseError"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"/jobs": {
|
"/jobs": {
|
||||||
"get": {
|
"get": {
|
||||||
"tags": ["Jobs"],
|
"tags": ["Jobs"],
|
||||||
@@ -2034,52 +1960,7 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"SubmitJobRequest": {
|
|
||||||
"type": "object",
|
|
||||||
"required": ["script"],
|
|
||||||
"properties": {
|
|
||||||
"script": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Job script content"
|
|
||||||
},
|
|
||||||
"partition": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Target partition"
|
|
||||||
},
|
|
||||||
"qos": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Quality of Service"
|
|
||||||
},
|
|
||||||
"cpus": {
|
|
||||||
"type": "integer",
|
|
||||||
"format": "int32",
|
|
||||||
"description": "Number of CPUs required"
|
|
||||||
},
|
|
||||||
"memory": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Memory requirement (e.g. \"4G\")"
|
|
||||||
},
|
|
||||||
"time_limit": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Time limit (e.g. \"1:00:00\")"
|
|
||||||
},
|
|
||||||
"job_name": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Job name"
|
|
||||||
},
|
|
||||||
"environment": {
|
|
||||||
"type": "object",
|
|
||||||
"additionalProperties": {
|
|
||||||
"type": "string"
|
|
||||||
},
|
|
||||||
"description": "Environment variables"
|
|
||||||
},
|
|
||||||
"work_dir": {
|
|
||||||
"type": "string",
|
|
||||||
"description": "Job working directory"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"JobResponse": {
|
"JobResponse": {
|
||||||
"type": "object",
|
"type": "object",
|
||||||
"properties": {
|
"properties": {
|
||||||
|
|||||||
Reference in New Issue
Block a user