From d9356fa96fc1b7ac2a875858288eebdd28e176da Mon Sep 17 00:00:00 2001 From: Patrick Dowler Date: Tue, 20 May 2025 13:35:39 -0700 Subject: [PATCH 01/11] add create index API as an async job this proposed solution is for a parameter-style UWS job that fits the current DAL landscape --- openapi/vosi-table-ops.yaml | 50 +++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 openapi/vosi-table-ops.yaml diff --git a/openapi/vosi-table-ops.yaml b/openapi/vosi-table-ops.yaml new file mode 100644 index 0000000..087216c --- /dev/null +++ b/openapi/vosi-table-ops.yaml @@ -0,0 +1,50 @@ +get: + operationId: table-ops-job-list + tags: + - Table Operations + summary: list async table update jobs + description: async job listing + parameters: + responses: + 200: + $ref: ../uws/uws-responses.yaml#/job-listing + 401: + $ref: ../vosi/vosi-std-responses.yaml#/not-authenticated + 403: + $ref: ../vosi/vosi-std-responses.yaml#/permission-denied +post: + operationId: table-ops-job-create + tags: + - Table Operations + summary: create async table update job + description: TAP asynchronous table update (create UWS Job) + parameters: + - name: TABLE + in: query + description: a single table name as provided in tap_schema + required: true + schema: + type: string + - name: INDEX + in: query + description: create index operation; value is a column name in the table + required: false + schema: + type: string + - name: UNIQUE + in: query + description: qualifier for INDEX to create a unique index + required: false + schema: + type: boolean + responses: + 303: + $ref: ../uws/uws-responses.yaml#/created + 401: + $ref: ../vosi/vosi-std-responses.yaml#/not-authenticated + 403: + $ref: ../vosi/vosi-std-responses.yaml#/permission-denied + 404: + $ref: ./vosi-std-responses.yaml#/not-found + 405: + $ref: ./vosi-std-responses.yaml#/not-implemented From c42c229ee81096b25c854dd58163062fd931680c Mon Sep 17 00:00:00 2001 From: Patrick Dowler Date: Wed, 21 May 2025 10:06:43 -0700 Subject: [PATCH 02/11] remove 405 response and fix references to other vosi components --- openapi/vosi-table-ops.yaml | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/openapi/vosi-table-ops.yaml b/openapi/vosi-table-ops.yaml index 087216c..a7394d9 100644 --- a/openapi/vosi-table-ops.yaml +++ b/openapi/vosi-table-ops.yaml @@ -9,9 +9,9 @@ get: 200: $ref: ../uws/uws-responses.yaml#/job-listing 401: - $ref: ../vosi/vosi-std-responses.yaml#/not-authenticated + $ref: ./vosi-std-responses.yaml#/not-authenticated 403: - $ref: ../vosi/vosi-std-responses.yaml#/permission-denied + $ref: ./vosi-std-responses.yaml#/permission-denied post: operationId: table-ops-job-create tags: @@ -41,10 +41,8 @@ post: 303: $ref: ../uws/uws-responses.yaml#/created 401: - $ref: ../vosi/vosi-std-responses.yaml#/not-authenticated + $ref: ./vosi-std-responses.yaml#/not-authenticated 403: - $ref: ../vosi/vosi-std-responses.yaml#/permission-denied + $ref: ./vosi-std-responses.yaml#/permission-denied 404: $ref: ./vosi-std-responses.yaml#/not-found - 405: - $ref: ./vosi-std-responses.yaml#/not-implemented From 8335dc969f86400c1c67cfa69b03da1589c6ac63 Mon Sep 17 00:00:00 2001 From: Patrick Dowler Date: Tue, 31 Mar 2026 14:39:14 -0700 Subject: [PATCH 03/11] restructure openapi from main --- openapi/{ => vosi}/vosi-table-ops.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename openapi/{ => vosi}/vosi-table-ops.yaml (100%) diff --git a/openapi/vosi-table-ops.yaml b/openapi/vosi/vosi-table-ops.yaml similarity index 100% rename from openapi/vosi-table-ops.yaml rename to openapi/vosi/vosi-table-ops.yaml From 992c7290fa2d979589b997fbf59a8103cf8cc6a4 Mon Sep 17 00:00:00 2001 From: Patrick Dowler Date: Tue, 31 Mar 2026 14:44:44 -0700 Subject: [PATCH 04/11] add openapi-linter and rename openapi-example add global tags to openapi example --- openapi-linter | 8 ++++++++ openapi-example.yaml => openapi.yaml | 11 ++++++++--- 2 files changed, 16 insertions(+), 3 deletions(-) create mode 100755 openapi-linter rename openapi-example.yaml => openapi.yaml (71%) diff --git a/openapi-linter b/openapi-linter new file mode 100755 index 0000000..c4b88e3 --- /dev/null +++ b/openapi-linter @@ -0,0 +1,8 @@ +#!/bin/bash + +if [[ "$1" == "-it" ]]; then + docker run -it --rm -v $PWD:/work:ro dshanley/vacuum /bin/bash +else + docker run --rm -v $PWD:/work:ro dshanley/vacuum lint --no-clip -d openapi.yaml +fi + diff --git a/openapi-example.yaml b/openapi.yaml similarity index 71% rename from openapi-example.yaml rename to openapi.yaml index 211a8c8..080b563 100644 --- a/openapi-example.yaml +++ b/openapi.yaml @@ -5,15 +5,20 @@ info: description: This is an example of using VOSI-1.2 components. servers: - url: /example + +tags: + - name: VOSI Capabilities + - name: VOSI Table Metadata + paths: # notes: this is how another service like TAP would include VOSI endpoints using # a local copy; the commented out $ref to a standard location would also work /tables: - $ref: ./vosi-tableset.yaml + $ref: ./openapi/vosi/vosi-tableset.yaml #$ref: https://ivoa.net/std/VOSI/vosi-tableset.yaml /tables/{name}: - $ref: ./vosi-table.yaml + $ref: ./openapi/vosi/vosi-table.yaml #$ref: https://ivoa.net/std/VOSI/vosi-table.yaml /capabilities: - $ref: ./paths/vosi-capabilities.yaml + $ref: ./openapi/vosi/vosi-capabilities.yaml #$ref: https://ivoa.net/std/VOSI/vosi-capabilities.yaml From 77b697a6a966147545afc0a4e914ef8b98d66d0a Mon Sep 17 00:00:00 2001 From: Patrick Dowler Date: Wed, 1 Apr 2026 11:33:11 -0700 Subject: [PATCH 05/11] update table-ops openapi spec to include INDEX_TYPE add table-ops job and phase using UWS pattern --- openapi.yaml | 9 ++++ openapi/vosi/vosi-table-ops-job-phase.yaml | 55 ++++++++++++++++++++++ openapi/vosi/vosi-table-ops-job.yaml | 28 +++++++++++ openapi/vosi/vosi-table-ops.yaml | 41 +++++++++++----- 4 files changed, 120 insertions(+), 13 deletions(-) create mode 100644 openapi/vosi/vosi-table-ops-job-phase.yaml create mode 100644 openapi/vosi/vosi-table-ops-job.yaml diff --git a/openapi.yaml b/openapi.yaml index 080b563..cef1277 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -9,6 +9,7 @@ servers: tags: - name: VOSI Capabilities - name: VOSI Table Metadata + - name: VOSI Table Operations paths: # notes: this is how another service like TAP would include VOSI endpoints using @@ -19,6 +20,14 @@ paths: /tables/{name}: $ref: ./openapi/vosi/vosi-table.yaml #$ref: https://ivoa.net/std/VOSI/vosi-table.yaml + /capabilities: $ref: ./openapi/vosi/vosi-capabilities.yaml #$ref: https://ivoa.net/std/VOSI/vosi-capabilities.yaml + + /table-ops: + $ref: ./openapi/vosi/vosi-table-ops.yaml + /table-ops/{jobID}: + $ref: ./openapi/vosi/vosi-table-ops-job.yaml + /table-ops/{jobID}/phase: + $ref: ./openapi/vosi/vosi-table-ops-job-phase.yaml diff --git a/openapi/vosi/vosi-table-ops-job-phase.yaml b/openapi/vosi/vosi-table-ops-job-phase.yaml new file mode 100644 index 0000000..8379060 --- /dev/null +++ b/openapi/vosi/vosi-table-ops-job-phase.yaml @@ -0,0 +1,55 @@ +get: + operationId: vosi-table-ops-job-phase-get + tags: + - VOSI Table Operations + summary: get a UWS job phase + description: job phase resource + parameters: + - name: jobID + in: path + description: unique job identifier generated by the server + required: true + type: string + example: a1b2c3 + responses: + '200': + description: the current phase + content: + text/plain: + schema: + type: string + example: "PENDING" + +post: + operationId: vosi-table-ops-job-phase-update + tags: + - VOSI Table Operations + summary: change a UWS job phase + description: update job + parameters: + - name: jobID + in: path + description: unique job identifier generated by the server + required: true + type: string + example: a1b2c3 + - name: PHASE + in: query + description: attempt to change the phase + required: true + schema: + type: string + enum: [ABORT, RUN] + example: RUN + responses: + '200': + description: phase change successful + '400': + $ref: ../uws/uws-responses.yaml#/invalid-phase-change + '401': + $ref: ../vosi/vosi-std-responses.yaml#/not-authenticated + '403': + $ref: ../vosi/vosi-std-responses.yaml#/permission-denied + '404': + $ref: ../vosi/vosi-std-responses.yaml#/not-found + diff --git a/openapi/vosi/vosi-table-ops-job.yaml b/openapi/vosi/vosi-table-ops-job.yaml new file mode 100644 index 0000000..f46065d --- /dev/null +++ b/openapi/vosi/vosi-table-ops-job.yaml @@ -0,0 +1,28 @@ +get: + operationId: vosi-table-ops-job-get + tags: + - VOSI Table Operations + summary: get a UWS job description + description: job resource + parameters: + - name: jobID + in: path + description: unique job identifier generated by the server + required: true + type: string + example: a1b2c3 + - name: WAIT + in: query + description: wait for the specified time in seconds or until the phase changes + required: false + type: integer + example: WAIT=60 + responses: + '200': + $ref: ../uws/uws-responses.yaml#/job + '401': + $ref: ../vosi/vosi-std-responses.yaml#/not-authenticated + '403': + $ref: ../vosi/vosi-std-responses.yaml#/permission-denied + '404': + $ref: ../vosi/vosi-std-responses.yaml#/not-found diff --git a/openapi/vosi/vosi-table-ops.yaml b/openapi/vosi/vosi-table-ops.yaml index a7394d9..c573451 100644 --- a/openapi/vosi/vosi-table-ops.yaml +++ b/openapi/vosi/vosi-table-ops.yaml @@ -1,21 +1,23 @@ get: - operationId: table-ops-job-list + operationId: vosi-table-ops-job-list tags: - - Table Operations + - VOSI Table Operations summary: list async table update jobs description: async job listing parameters: responses: - 200: + '200': $ref: ../uws/uws-responses.yaml#/job-listing - 401: + '401': $ref: ./vosi-std-responses.yaml#/not-authenticated - 403: + '403': $ref: ./vosi-std-responses.yaml#/permission-denied + '404': + $ref: ./vosi-std-responses.yaml#/not-found post: - operationId: table-ops-job-create + operationId: vosi-table-ops-job-create tags: - - Table Operations + - VOSI Table Operations summary: create async table update job description: TAP asynchronous table update (create UWS Job) parameters: @@ -27,22 +29,35 @@ post: type: string - name: INDEX in: query - description: create index operation; value is a column name in the table + description: | + create index operation; value is a column name in the table + or a comma-separated list of columns required: false schema: type: string + - name: INDEX_TYPE + in: query + description: | + qualifier to create a specialised index: a value of long-lat + requires 2 numeric columns which are used as longitude,latitude + pairs (spherical coordinates); a value of x-y requires 2 numeric + columns which are used as x,y pairs (cartesian coordinates) + required: false + schema: + type: string + enum: [long-lat,x-y] - name: UNIQUE in: query - description: qualifier for INDEX to create a unique index + description: qualifier to create a unique index required: false schema: type: boolean responses: - 303: + '303': $ref: ../uws/uws-responses.yaml#/created - 401: + '401': $ref: ./vosi-std-responses.yaml#/not-authenticated - 403: + '403': $ref: ./vosi-std-responses.yaml#/permission-denied - 404: + '404': $ref: ./vosi-std-responses.yaml#/not-found From 0b2f692d58db07d065eb2c97feab50930be0fa1f Mon Sep 17 00:00:00 2001 From: Patrick Dowler Date: Wed, 1 Apr 2026 11:34:26 -0700 Subject: [PATCH 06/11] add copy of uws-responses.yaml to repo --- openapi/uws/uws-responses.yaml | 61 ++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 openapi/uws/uws-responses.yaml diff --git a/openapi/uws/uws-responses.yaml b/openapi/uws/uws-responses.yaml new file mode 100644 index 0000000..e4515cc --- /dev/null +++ b/openapi/uws/uws-responses.yaml @@ -0,0 +1,61 @@ +# UWS create job response +created: + description: standard UWS 1.1 redirect to the created job URL + headers: + location: + schema: + type: string + format: uri +invalid-phase-change: + description: the requested phase change is invalid + content: + text/plain: + schema: + type: string +job-listing: + description: list of jobs owned by the caller + content: + text/xml: + schema: + type: object + xml: + name: jobs + prefix: uws + namespace: http://www.ivoa.net/xml/UWS/v1.0 + example: | + + + PENDING + TEST + somebody + 2024-07-16T16:38:33.090Z + + ... + + +job: + description: a single UWS Job + content: + text/xml: + schema: + type: object + xml: + name: job + prefix: uws + namespace: http://www.ivoa.net/xml/UWS/v1.0 + example: | + + loqqxg8jlah0r8wp + somebody + PENDING + 2024-07-17T16:38:33.089Z + 2024-07-16T16:38:33.090Z + + + 28800 + 2024-07-23T16:38:33.089Z + + + + + From ef8203485e601dae0948f4f7c9af6ef261efd0fc Mon Sep 17 00:00:00 2001 From: Patrick Dowler Date: Thu, 9 Apr 2026 08:49:01 -0700 Subject: [PATCH 07/11] add reusable UWS job list params to openapi/uws --- openapi/uws/uws-after-param.yaml | 8 ++++++++ openapi/uws/uws-last-param.yaml | 11 +++++++++++ openapi/uws/uws-phase-param.yaml | 7 +++++++ openapi/uws/uws-responses.yaml | 2 +- openapi/vosi/vosi-table-ops.yaml | 3 +++ 5 files changed, 30 insertions(+), 1 deletion(-) create mode 100644 openapi/uws/uws-after-param.yaml create mode 100644 openapi/uws/uws-last-param.yaml create mode 100644 openapi/uws/uws-phase-param.yaml diff --git a/openapi/uws/uws-after-param.yaml b/openapi/uws/uws-after-param.yaml new file mode 100644 index 0000000..c5afec8 --- /dev/null +++ b/openapi/uws/uws-after-param.yaml @@ -0,0 +1,8 @@ +name: AFTER +in: query +description: list jobs with creationTime after the specified value +required: false +schema: + type: string + format: date-time + example: "2017-07-21T17:32:28Z" diff --git a/openapi/uws/uws-last-param.yaml b/openapi/uws/uws-last-param.yaml new file mode 100644 index 0000000..93a53b7 --- /dev/null +++ b/openapi/uws/uws-last-param.yaml @@ -0,0 +1,11 @@ +name: LAST +in: query +description: | + limit the number of jobs listed to the specified value; use of LAST + also causes the server to return jobs in order of creationTime (descending) + with the most recent jobs first +required: false +schema: + type: integer + minimum: 0 + example: 10 diff --git a/openapi/uws/uws-phase-param.yaml b/openapi/uws/uws-phase-param.yaml new file mode 100644 index 0000000..610991b --- /dev/null +++ b/openapi/uws/uws-phase-param.yaml @@ -0,0 +1,7 @@ +name: PHASE +in: query +description: list jobs in this execution phase +required: false +schema: + type: string + example: "EXECUTING" diff --git a/openapi/uws/uws-responses.yaml b/openapi/uws/uws-responses.yaml index e4515cc..6fd58db 100644 --- a/openapi/uws/uws-responses.yaml +++ b/openapi/uws/uws-responses.yaml @@ -31,7 +31,7 @@ job-listing: 2024-07-16T16:38:33.090Z ... - + job: description: a single UWS Job diff --git a/openapi/vosi/vosi-table-ops.yaml b/openapi/vosi/vosi-table-ops.yaml index c573451..413972b 100644 --- a/openapi/vosi/vosi-table-ops.yaml +++ b/openapi/vosi/vosi-table-ops.yaml @@ -5,6 +5,9 @@ get: summary: list async table update jobs description: async job listing parameters: + - $ref: ../uws/uws-phase-param.yaml + - $ref: ../uws/uws-after-param.yaml + - $ref: ../uws/uws-last-param.yaml responses: '200': $ref: ../uws/uws-responses.yaml#/job-listing From 21d3afc6c8b81a7f46b9b1f6ebe89cd2a0b32dc0 Mon Sep 17 00:00:00 2001 From: Patrick Dowler Date: Thu, 9 Apr 2026 09:58:49 -0700 Subject: [PATCH 08/11] refactor more common uws components --- openapi/uws/uws-jobid-param.yaml | 7 +++++++ openapi/uws/uws-phase-change-param.yaml | 8 ++++++++ openapi/uws/uws-wait-param.yaml | 8 ++++++++ openapi/vosi/vosi-table-ops-job-phase.yaml | 23 +++------------------- openapi/vosi/vosi-table-ops-job.yaml | 14 ++----------- 5 files changed, 28 insertions(+), 32 deletions(-) create mode 100644 openapi/uws/uws-jobid-param.yaml create mode 100644 openapi/uws/uws-phase-change-param.yaml create mode 100644 openapi/uws/uws-wait-param.yaml diff --git a/openapi/uws/uws-jobid-param.yaml b/openapi/uws/uws-jobid-param.yaml new file mode 100644 index 0000000..2c03a07 --- /dev/null +++ b/openapi/uws/uws-jobid-param.yaml @@ -0,0 +1,7 @@ +name: jobID +in: path +description: unique job identifier generated by the server +required: true +schema: + type: string + example: a1b2c3 diff --git a/openapi/uws/uws-phase-change-param.yaml b/openapi/uws/uws-phase-change-param.yaml new file mode 100644 index 0000000..7a0f156 --- /dev/null +++ b/openapi/uws/uws-phase-change-param.yaml @@ -0,0 +1,8 @@ +name: PHASE +in: query +description: attempt to change the phase +required: true +schema: + type: string + enum: [ABORT, RUN] + example: RUN diff --git a/openapi/uws/uws-wait-param.yaml b/openapi/uws/uws-wait-param.yaml new file mode 100644 index 0000000..704166e --- /dev/null +++ b/openapi/uws/uws-wait-param.yaml @@ -0,0 +1,8 @@ +name: WAIT +in: query +description: wait for the specified time in seconds or until the phase changes +required: false +schema: + type: integer + example: WAIT=60 + diff --git a/openapi/vosi/vosi-table-ops-job-phase.yaml b/openapi/vosi/vosi-table-ops-job-phase.yaml index 8379060..5c382f9 100644 --- a/openapi/vosi/vosi-table-ops-job-phase.yaml +++ b/openapi/vosi/vosi-table-ops-job-phase.yaml @@ -5,12 +5,7 @@ get: summary: get a UWS job phase description: job phase resource parameters: - - name: jobID - in: path - description: unique job identifier generated by the server - required: true - type: string - example: a1b2c3 + - $ref: ../uws/uws-jobid-param.yaml responses: '200': description: the current phase @@ -27,20 +22,8 @@ post: summary: change a UWS job phase description: update job parameters: - - name: jobID - in: path - description: unique job identifier generated by the server - required: true - type: string - example: a1b2c3 - - name: PHASE - in: query - description: attempt to change the phase - required: true - schema: - type: string - enum: [ABORT, RUN] - example: RUN + - $ref: ../uws/uws-jobid-param.yaml + - $ref: ../uws/uws-phase-change-param.yaml responses: '200': description: phase change successful diff --git a/openapi/vosi/vosi-table-ops-job.yaml b/openapi/vosi/vosi-table-ops-job.yaml index f46065d..fb12a57 100644 --- a/openapi/vosi/vosi-table-ops-job.yaml +++ b/openapi/vosi/vosi-table-ops-job.yaml @@ -5,18 +5,8 @@ get: summary: get a UWS job description description: job resource parameters: - - name: jobID - in: path - description: unique job identifier generated by the server - required: true - type: string - example: a1b2c3 - - name: WAIT - in: query - description: wait for the specified time in seconds or until the phase changes - required: false - type: integer - example: WAIT=60 + - $ref: ../uws/uws-jobid-param.yaml + - $ref: ../uws/uws-wait-param.yaml responses: '200': $ref: ../uws/uws-responses.yaml#/job From dd135b36b4e1019b9ab4ad2807c03fb9835f4f8a Mon Sep 17 00:00:00 2001 From: Patrick Dowler Date: Wed, 15 Apr 2026 13:38:47 -0700 Subject: [PATCH 09/11] combine unique into INDEX_TYPE param specify multi-values explicitly with type: array specify serialisation with explode fix UWS WAIT param example --- openapi/uws/uws-wait-param.yaml | 2 +- openapi/vosi/vosi-table-ops.yaml | 29 +++++++++++++++++------------ 2 files changed, 18 insertions(+), 13 deletions(-) diff --git a/openapi/uws/uws-wait-param.yaml b/openapi/uws/uws-wait-param.yaml index 704166e..31fadab 100644 --- a/openapi/uws/uws-wait-param.yaml +++ b/openapi/uws/uws-wait-param.yaml @@ -4,5 +4,5 @@ description: wait for the specified time in seconds or until the phase changes required: false schema: type: integer - example: WAIT=60 + example: 60 diff --git a/openapi/vosi/vosi-table-ops.yaml b/openapi/vosi/vosi-table-ops.yaml index 413972b..b54b4a0 100644 --- a/openapi/vosi/vosi-table-ops.yaml +++ b/openapi/vosi/vosi-table-ops.yaml @@ -28,33 +28,38 @@ post: in: query description: a single table name as provided in tap_schema required: true + explode: false schema: type: string - name: INDEX in: query description: | create index operation; value is a column name in the table - or a comma-separated list of columns - required: false + or a comma-separated list of columns; order matters + required: true + # style: form (default), explode: false, and type: array + # means multiple values are in a comma separated list + explode: false schema: - type: string + type: array + items: + type: string - name: INDEX_TYPE in: query description: | qualifier to create a specialised index: a value of long-lat requires 2 numeric columns which are used as longitude,latitude pairs (spherical coordinates); a value of x-y requires 2 numeric - columns which are used as x,y pairs (cartesian coordinates) + columns which are used as x,y pairs (cartesian coordinates); required: false + # style: form (default), explode: true, and type: array + # means the normal zero or more param=value + explode: true schema: - type: string - enum: [long-lat,x-y] - - name: UNIQUE - in: query - description: qualifier to create a unique index - required: false - schema: - type: boolean + type: array + items: + type: string + enum: [long-lat,x-y,unique] responses: '303': $ref: ../uws/uws-responses.yaml#/created From 302970d88be1206ee7affcbea5cb12af71e5c6bf Mon Sep 17 00:00:00 2001 From: Patrick Dowler Date: Wed, 15 Apr 2026 15:30:12 -0700 Subject: [PATCH 10/11] tweak to table-ops INDEX parameter --- openapi/vosi/vosi-table-ops.yaml | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/openapi/vosi/vosi-table-ops.yaml b/openapi/vosi/vosi-table-ops.yaml index b54b4a0..3c72366 100644 --- a/openapi/vosi/vosi-table-ops.yaml +++ b/openapi/vosi/vosi-table-ops.yaml @@ -37,13 +37,9 @@ post: create index operation; value is a column name in the table or a comma-separated list of columns; order matters required: true - # style: form (default), explode: false, and type: array - # means multiple values are in a comma separated list - explode: false schema: - type: array - items: - type: string + type: string + #pattern: ?? - name: INDEX_TYPE in: query description: | From 93b1243e74670057a5beba7e605cb1de63b8263c Mon Sep 17 00:00:00 2001 From: Patrick Dowler Date: Fri, 24 Apr 2026 08:28:10 -0700 Subject: [PATCH 11/11] openapi lint improvements --- openapi/uws/uws-responses.yaml | 52 ++++++++++++++--------------- openapi/vosi/vosi-capabilities.yaml | 8 ++--- openapi/vosi/vosi-tableset.yaml | 2 +- 3 files changed, 31 insertions(+), 31 deletions(-) diff --git a/openapi/uws/uws-responses.yaml b/openapi/uws/uws-responses.yaml index 6fd58db..426a6e7 100644 --- a/openapi/uws/uws-responses.yaml +++ b/openapi/uws/uws-responses.yaml @@ -17,45 +17,45 @@ job-listing: content: text/xml: schema: - type: object + type: string xml: name: jobs prefix: uws namespace: http://www.ivoa.net/xml/UWS/v1.0 - example: | - - - PENDING - TEST - somebody - 2024-07-16T16:38:33.090Z - - ... - + example: | + + + PENDING + TEST + somebody + 2024-07-16T16:38:33.090Z + + ... + job: description: a single UWS Job content: text/xml: schema: - type: object + type: string xml: name: job prefix: uws namespace: http://www.ivoa.net/xml/UWS/v1.0 - example: | - - loqqxg8jlah0r8wp - somebody - PENDING - 2024-07-17T16:38:33.089Z - 2024-07-16T16:38:33.090Z - - - 28800 - 2024-07-23T16:38:33.089Z - - - + example: | + + loqqxg8jlah0r8wp + somebody + PENDING + 2024-07-17T16:38:33.089Z + 2024-07-16T16:38:33.090Z + + + 28800 + 2024-07-23T16:38:33.089Z + + + diff --git a/openapi/vosi/vosi-capabilities.yaml b/openapi/vosi/vosi-capabilities.yaml index b60a382..8abd9bd 100644 --- a/openapi/vosi/vosi-capabilities.yaml +++ b/openapi/vosi/vosi-capabilities.yaml @@ -37,13 +37,13 @@ components: content: text/xml: schema: - type: object + type: string xml: name: capabilities prefix: vosi namespace: http://www.ivoa.net/xml/VOSICapabilities/v1.0 - example: | - @@ -53,4 +53,4 @@ components: ... - + diff --git a/openapi/vosi/vosi-tableset.yaml b/openapi/vosi/vosi-tableset.yaml index cf54408..be950cc 100644 --- a/openapi/vosi/vosi-tableset.yaml +++ b/openapi/vosi/vosi-tableset.yaml @@ -29,7 +29,7 @@ components: content: text/xml: schema: - type: object + type: string xml: name: tableset prefix: vosi