Skip to content

Commit

Permalink
Better Query Api Paths (#3527)
Browse files Browse the repository at this point in the history 
* change rest api methods

Signed-off-by: Chris Martin <chris@cmartinit.co.uk>

* Update docs-readme.md

---------

Signed-off-by: Chris Martin <chris@cmartinit.co.uk>
Co-authored-by: Chris Martin <chris@cmartinit.co.uk>
  • Loading branch information
@d80tb7
d80tb7 and d80tb7 authored Apr 22, 2024
1 parent ab210ed commit 72e971c
Show file tree
Hide file tree
Showing 6 changed files with 244 additions and 245 deletions.
122 changes: 61 additions & 61 deletions client/DotNet/Armada.Client/ClientGenerated.cs
View file

Large diffs are not rendered by default.

96 changes: 48 additions & 48 deletions pkg/api/api.swagger.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ func SwaggerJsonTemplate() string {
" }\n" +
" }\n" +
" },\n" +
" \"/v1/job/jobdetails\": {\n" +
" \"/v1/job/details\": {\n" +
" \"post\": {\n" +
" \"tags\": [\n" +
" \"Jobs\"\n" +
Expand Down Expand Up @@ -245,28 +245,26 @@ func SwaggerJsonTemplate() string {
" }\n" +
" }\n" +
" },\n" +
" \"/v1/job/jobrundetails\": {\n" +
" \"/v1/job/preempt\": {\n" +
" \"post\": {\n" +
" \"tags\": [\n" +
" \"Jobs\"\n" +
" \"Submit\"\n" +
" ],\n" +
" \"operationId\": \"GetJobRunDetails\",\n" +
" \"operationId\": \"PreemptJobs\",\n" +
" \"parameters\": [\n" +
" {\n" +
" \"name\": \"body\",\n" +
" \"in\": \"body\",\n" +
" \"required\": true,\n" +
" \"schema\": {\n" +
" \"$ref\": \"#/definitions/apiJobRunDetailsRequest\"\n" +
" \"$ref\": \"#/definitions/apiJobPreemptRequest\"\n" +
" }\n" +
" }\n" +
" ],\n" +
" \"responses\": {\n" +
" \"200\": {\n" +
" \"description\": \"A successful response.\",\n" +
" \"schema\": {\n" +
" \"$ref\": \"#/definitions/apiJobRunDetailsResponse\"\n" +
" }\n" +
" \"schema\": {}\n" +
" },\n" +
" \"default\": {\n" +
" \"description\": \"An unexpected error response.\",\n" +
Expand All @@ -277,58 +275,28 @@ func SwaggerJsonTemplate() string {
" }\n" +
" }\n" +
" },\n" +
" \"/v1/job/jobstatus\": {\n" +
" \"/v1/job/reprioritize\": {\n" +
" \"post\": {\n" +
" \"tags\": [\n" +
" \"Jobs\"\n" +
" \"Submit\"\n" +
" ],\n" +
" \"operationId\": \"GetJobStatus\",\n" +
" \"operationId\": \"ReprioritizeJobs\",\n" +
" \"parameters\": [\n" +
" {\n" +
" \"name\": \"body\",\n" +
" \"in\": \"body\",\n" +
" \"required\": true,\n" +
" \"schema\": {\n" +
" \"$ref\": \"#/definitions/apiJobStatusRequest\"\n" +
" \"$ref\": \"#/definitions/apiJobReprioritizeRequest\"\n" +
" }\n" +
" }\n" +
" ],\n" +
" \"responses\": {\n" +
" \"200\": {\n" +
" \"description\": \"A successful response.\",\n" +
" \"schema\": {\n" +
" \"$ref\": \"#/definitions/apiJobStatusResponse\"\n" +
" }\n" +
" },\n" +
" \"default\": {\n" +
" \"description\": \"An unexpected error response.\",\n" +
" \"schema\": {\n" +
" \"$ref\": \"#/definitions/runtimeError\"\n" +
" }\n" +
" }\n" +
" }\n" +
" }\n" +
" },\n" +
" \"/v1/job/preempt\": {\n" +
" \"post\": {\n" +
" \"tags\": [\n" +
" \"Submit\"\n" +
" ],\n" +
" \"operationId\": \"PreemptJobs\",\n" +
" \"parameters\": [\n" +
" {\n" +
" \"name\": \"body\",\n" +
" \"in\": \"body\",\n" +
" \"required\": true,\n" +
" \"schema\": {\n" +
" \"$ref\": \"#/definitions/apiJobPreemptRequest\"\n" +
" \"$ref\": \"#/definitions/apiJobReprioritizeResponse\"\n" +
" }\n" +
" }\n" +
" ],\n" +
" \"responses\": {\n" +
" \"200\": {\n" +
" \"description\": \"A successful response.\",\n" +
" \"schema\": {}\n" +
" },\n" +
" \"default\": {\n" +
" \"description\": \"An unexpected error response.\",\n" +
Expand All @@ -339,27 +307,27 @@ func SwaggerJsonTemplate() string {
" }\n" +
" }\n" +
" },\n" +
" \"/v1/job/reprioritize\": {\n" +
" \"/v1/job/status\": {\n" +
" \"post\": {\n" +
" \"tags\": [\n" +
" \"Submit\"\n" +
" \"Jobs\"\n" +
" ],\n" +
" \"operationId\": \"ReprioritizeJobs\",\n" +
" \"operationId\": \"GetJobStatus\",\n" +
" \"parameters\": [\n" +
" {\n" +
" \"name\": \"body\",\n" +
" \"in\": \"body\",\n" +
" \"required\": true,\n" +
" \"schema\": {\n" +
" \"$ref\": \"#/definitions/apiJobReprioritizeRequest\"\n" +
" \"$ref\": \"#/definitions/apiJobStatusRequest\"\n" +
" }\n" +
" }\n" +
" ],\n" +
" \"responses\": {\n" +
" \"200\": {\n" +
" \"description\": \"A successful response.\",\n" +
" \"schema\": {\n" +
" \"$ref\": \"#/definitions/apiJobReprioritizeResponse\"\n" +
" \"$ref\": \"#/definitions/apiJobStatusResponse\"\n" +
" }\n" +
" },\n" +
" \"default\": {\n" +
Expand Down Expand Up @@ -552,6 +520,38 @@ func SwaggerJsonTemplate() string {
" }\n" +
" }\n" +
" }\n" +
" },\n" +
" \"/v1/run/details\": {\n" +
" \"post\": {\n" +
" \"tags\": [\n" +
" \"Jobs\"\n" +
" ],\n" +
" \"operationId\": \"GetJobRunDetails\",\n" +
" \"parameters\": [\n" +
" {\n" +
" \"name\": \"body\",\n" +
" \"in\": \"body\",\n" +
" \"required\": true,\n" +
" \"schema\": {\n" +
" \"$ref\": \"#/definitions/apiJobRunDetailsRequest\"\n" +
" }\n" +
" }\n" +
" ],\n" +
" \"responses\": {\n" +
" \"200\": {\n" +
" \"description\": \"A successful response.\",\n" +
" \"schema\": {\n" +
" \"$ref\": \"#/definitions/apiJobRunDetailsResponse\"\n" +
" }\n" +
" },\n" +
" \"default\": {\n" +
" \"description\": \"An unexpected error response.\",\n" +
" \"schema\": {\n" +
" \"$ref\": \"#/definitions/runtimeError\"\n" +
" }\n" +
" }\n" +
" }\n" +
" }\n" +
" }\n" +
" },\n" +
" \"definitions\": {\n" +
Expand Down
96 changes: 48 additions & 48 deletions pkg/api/api.swagger.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
}
}
},
"/v1/job/jobdetails": {
"/v1/job/details": {
"post": {
"tags": [
"Jobs"
Expand Down Expand Up @@ -234,28 +234,26 @@
}
}
},
"/v1/job/jobrundetails": {
"/v1/job/preempt": {
"post": {
"tags": [
"Jobs"
"Submit"
],
"operationId": "GetJobRunDetails",
"operationId": "PreemptJobs",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/apiJobRunDetailsRequest"
"$ref": "#/definitions/apiJobPreemptRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/apiJobRunDetailsResponse"
}
"schema": {}
},
"default": {
"description": "An unexpected error response.",
Expand All @@ -266,58 +264,28 @@
}
}
},
"/v1/job/jobstatus": {
"/v1/job/reprioritize": {
"post": {
"tags": [
"Jobs"
"Submit"
],
"operationId": "GetJobStatus",
"operationId": "ReprioritizeJobs",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/apiJobStatusRequest"
"$ref": "#/definitions/apiJobReprioritizeRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/apiJobStatusResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/runtimeError"
}
}
}
}
},
"/v1/job/preempt": {
"post": {
"tags": [
"Submit"
],
"operationId": "PreemptJobs",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/apiJobPreemptRequest"
"$ref": "#/definitions/apiJobReprioritizeResponse"
}
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {}
},
"default": {
"description": "An unexpected error response.",
Expand All @@ -328,27 +296,27 @@
}
}
},
"/v1/job/reprioritize": {
"/v1/job/status": {
"post": {
"tags": [
"Submit"
"Jobs"
],
"operationId": "ReprioritizeJobs",
"operationId": "GetJobStatus",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/apiJobReprioritizeRequest"
"$ref": "#/definitions/apiJobStatusRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/apiJobReprioritizeResponse"
"$ref": "#/definitions/apiJobStatusResponse"
}
},
"default": {
Expand Down Expand Up @@ -541,6 +509,38 @@
}
}
}
},
"/v1/run/details": {
"post": {
"tags": [
"Jobs"
],
"operationId": "GetJobRunDetails",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/apiJobRunDetailsRequest"
}
}
],
"responses": {
"200": {
"description": "A successful response.",
"schema": {
"$ref": "#/definitions/apiJobRunDetailsResponse"
}
},
"default": {
"description": "An unexpected error response.",
"schema": {
"$ref": "#/definitions/runtimeError"
}
}
}
}
}
},
"definitions": {
Expand Down
Loading

0 comments on commit 72e971c

Please sign in to comment.