Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 7 additions & 3 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,14 @@ jobs:
steps:
- name: Check out head branch
uses: actions/checkout@v4
- name: Run OpenAPI Validate Action
uses: swaggerexpert/swagger-editor-validate@v1
- name: Setup Node.js
uses: actions/setup-node@v4
with:
definition-file: openapi/task_execution_service.openapi.yaml
node-version: '20'
- name: Install Spectral
run: npm install -g @stoplight/spectral-cli
- name: Validate OpenAPI definition
run: spectral lint openapi/task_execution_service.openapi.yaml --ruleset .spectral.yaml

diff:
name: Show OpenAPI differences relative to target branch
Expand Down
3 changes: 3 additions & 0 deletions .spectral.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
extends: spectral:oas
rules:
info-contact: off
10 changes: 5 additions & 5 deletions openapi/task_execution_service.openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@
/service-info:
get:
tags:
- TaskService

Check warning on line 77 in openapi/task_execution_service.openapi.yaml

View workflow job for this annotation

GitHub Actions / Validate OpenAPI definition

operation-tag-defined Operation tags must be defined in global tags.
summary: GetServiceInfo
description: |-
Provides information about the service, this structure is based on the
Expand All @@ -83,7 +83,7 @@
by the TES server.
operationId: GetServiceInfo
responses:
200:
'200':
description: ""
content:
application/json:
Expand All @@ -95,7 +95,7 @@
/tasks:
get:
tags:
- TaskService

Check warning on line 98 in openapi/task_execution_service.openapi.yaml

View workflow job for this annotation

GitHub Actions / Validate OpenAPI definition

operation-tag-defined Operation tags must be defined in global tags.
summary: ListTasks
description: |-
List tasks tracked by the TES server. This includes queued, active and completed tasks.
Expand Down Expand Up @@ -180,7 +180,7 @@
- $ref: '#/components/parameters/view'

responses:
200:
'200':
description: ""
content:
application/json:
Expand All @@ -193,7 +193,7 @@

post:
tags:
- TaskService

Check warning on line 196 in openapi/task_execution_service.openapi.yaml

View workflow job for this annotation

GitHub Actions / Validate OpenAPI definition

operation-tag-defined Operation tags must be defined in global tags.
summary: CreateTask
description: |-
Create a new task. The user provides a Task document, which the server
Expand All @@ -206,7 +206,7 @@
$ref: '#/components/schemas/tesTask'
required: true
responses:
200:
'200':
description: ""
content:
application/json:
Expand All @@ -219,7 +219,7 @@
/tasks/{id}:
get:
tags:
- TaskService

Check warning on line 222 in openapi/task_execution_service.openapi.yaml

View workflow job for this annotation

GitHub Actions / Validate OpenAPI definition

operation-tag-defined Operation tags must be defined in global tags.
summary: GetTask
description: |-
Get a single task, based on providing the exact task ID string.
Expand All @@ -233,7 +233,7 @@
type: string
- $ref: '#/components/parameters/view'
responses:
200:
'200':
description: ""
content:
application/json:
Expand All @@ -245,7 +245,7 @@
/tasks/{id}:cancel:
post:
tags:
- TaskService

Check warning on line 248 in openapi/task_execution_service.openapi.yaml

View workflow job for this annotation

GitHub Actions / Validate OpenAPI definition

operation-tag-defined Operation tags must be defined in global tags.
summary: CancelTask
description: Cancel a task based on providing an exact task ID.
operationId: CancelTask
Expand All @@ -257,7 +257,7 @@
schema:
type: string
responses:
200:
'200':
description: ""
content:
application/json:
Expand Down Expand Up @@ -600,7 +600,7 @@
Size of the file in bytes. Note, this is currently coded as a string
because official JSON doesn't support int64 numbers.
format: int64
example:

Check failure on line 603 in openapi/task_execution_service.openapi.yaml

View workflow job for this annotation

GitHub Actions / Validate OpenAPI definition

oas3-valid-schema-example "example" property type must be string
- "1024"
description: |-
OutputFileLog describes a single output file. This describes
Expand Down Expand Up @@ -641,7 +641,7 @@
priorty queue to which the job is assigned.
items:
type: string
example: us-west-1

Check failure on line 644 in openapi/task_execution_service.openapi.yaml

View workflow job for this annotation

GitHub Actions / Validate OpenAPI definition

oas3-valid-schema-example "example" property type must be array
backend_parameters:
type: object
additionalProperties:
Expand Down Expand Up @@ -883,7 +883,7 @@
description: Arbitrary logging metadata included by the implementation.
example:
host: worker-001
slurmm_id: 123456

Check failure on line 886 in openapi/task_execution_service.openapi.yaml

View workflow job for this annotation

GitHub Actions / Validate OpenAPI definition

oas3-valid-schema-example "slurmm_id" property type must be string
start_time:
type: string
description: When the task started, in RFC 3339 format.
Expand Down
Loading