Skip to content
8 changes: 4 additions & 4 deletions openapi/uws/uws-responses.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ job-listing:
content:
text/xml:
schema:
type: string
type: object
xml:
name: jobs
prefix: uws
namespace: http://www.ivoa.net/xml/UWS/v1.0
example: |
example: |
<uws:jobs xmlns:uws="http://www.ivoa.net/xml/UWS/v1.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1">
<uws:jobref id="loqqxg8jlah0r8wp">
<uws:phase>PENDING</uws:phase>
Expand All @@ -38,12 +38,12 @@ job:
content:
text/xml:
schema:
type: string
type: object
xml:
name: job
prefix: uws
namespace: http://www.ivoa.net/xml/UWS/v1.0
example: |
example: |
<uws:job xmlns:uws="http://www.ivoa.net/xml/UWS/v1.0" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1">
<uws:jobId>loqqxg8jlah0r8wp</uws:jobId>
<uws:ownerId>somebody</uws:ownerId>
Expand Down
9 changes: 9 additions & 0 deletions openapi/vosi/vosi-auth-read.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# request header
name: x-vosi-auth-read
in: header
description: flag indicating that the resource requires authentication to read
required: false
schema:
type: string
enum: ["true", "false", "null"]

4 changes: 2 additions & 2 deletions openapi/vosi/vosi-capabilities.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,12 @@ components:
content:
text/xml:
schema:
type: string
type: object
xml:
name: capabilities
prefix: vosi
namespace: http://www.ivoa.net/xml/VOSICapabilities/v1.0
example: |
example: |
<vosi:capabilities xmlns:vosi="http://www.ivoa.net/xml/VOSICapabilities/v1.0"
xmlns:vr="http://www.ivoa.net/xml/VOResource/v1.0"
xmlns:vs="http://www.ivoa.net/xml/VODataService/v1.1"
Expand Down
10 changes: 10 additions & 0 deletions openapi/vosi/vosi-group-read.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# request header
name: x-vosi-group-read
in: header
description: a GMS group identifier indicating a group with read permission, or literal null
required: false
schema:
oneOf:
- type: string
format: uri
- type: "null"
10 changes: 10 additions & 0 deletions openapi/vosi/vosi-group-write.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# request header
name: x-vosi-group-write
in: header
description: a GMS group identifier indicating a group with write permission, or literal null
required: false
schema:
oneOf:
- type: string
format: uri
- type: "null"
7 changes: 7 additions & 0 deletions openapi/vosi/vosi-owner.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# request header
name: x-vosi-owner
in: header
description: identifier for the owner of the schema or table
required: false
schema:
type: string
55 changes: 41 additions & 14 deletions openapi/vosi/vosi-table.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ post:
required: true
schema:
type: string
- $ref: ./vosi-auth-read.yaml
- $ref: ./vosi-group-read.yaml
- $ref: ./vosi-group-write.yaml
- $ref: ./vosi-owner.yaml
requestBody:
description: a table description
$ref: '#/components/schemas/tableDoc'
Expand Down Expand Up @@ -65,6 +69,10 @@ put:
required: true
schema:
type: string
- $ref: ./vosi-auth-read.yaml
- $ref: ./vosi-group-read.yaml
- $ref: ./vosi-group-write.yaml
- $ref: ./vosi-owner.yaml
requestBody:
description: a table description
$ref: '#/components/schemas/tableDoc'
Expand Down Expand Up @@ -112,14 +120,36 @@ components:
schemas:
tableDoc:
description: metadata for the specified schema or table
headers:
x-vosi-auth-read:
description: flag indicating that the resource requires authentication to read
required: false
schema:
type: string
enum: ["true", "false"]
x-vosi-group-read:
description: a GMS group identifier indicating a group with read permission
required: false
schema:
type: string
x-vosi-group-write:
description: a GMS group identifier indicating a group with write permission
required: false
schema:
type: string
x-vosi-owner:
description: identifier for the owner of the schema or table
required: false
schema:
type: string
content:
text/xml:
schema:
type: object
xml:
name: table
prefix: vosi
namespace: http://www.ivoa.net/xml/VOSITables/v1.0
type: object
xml:
name: table
prefix: vosi
namespace: http://www.ivoa.net/xml/VOSITables/v1.0
example: |
<vosi:table xmlns:vosi="http://www.ivoa.net/xml/VOSITables/v1.0"
xmlns:vs="http://www.ivoa.net/xml/VODataService/v1.1"
Expand Down Expand Up @@ -148,18 +178,18 @@ components:
<description>recommended sort order when listing schemas</description>
<dataType xsi:type="vs:VOTableType">int</dataType>
</column>
</vosi:table>
</vosi:table>
application/x-votable+xml:
schema:
type: object
xml:
name: VOTABLE
namespace: http://www.ivoa.net/xml/VOTable/v1.3
type: object
xml:
name: VOTABLE
namespace: http://www.ivoa.net/xml/VOTable/v1.3
example: |
<VOTABLE xmlns="http://www.ivoa.net/xml/VOTable/v1.3"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="1.4">
<RESOURCE type="results">
<TABLE>
<TABLE>
<FIELD name="schema_name" datatype="char" arraysize="64*">
<DESCRIPTION>schema name for reference to tap_schema.schemas</DESCRIPTION>
</FIELD>
Expand All @@ -172,9 +202,6 @@ components:
<FIELD name="schema_index" datatype="int">
<DESCRIPTION>recommended sort order when listing schemas</DESCRIPTION>
</FIELD>
<!--data goes here-->
</TABLE>
</RESOURCE>
</VOTABLE>


12 changes: 5 additions & 7 deletions openapi/vosi/vosi-tableset.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,11 +29,11 @@ components:
content:
text/xml:
schema:
type: string
xml:
name: tableset
prefix: vosi
namespace: http://www.ivoa.net/xml/VOSITables/v1.0
type: object
xml:
name: tableset
prefix: vosi
namespace: http://www.ivoa.net/xml/VOSITables/v1.0
example: |
<vosi:tableset xmlns:vosi="http://www.ivoa.net/xml/VOSITables/v1.0"
xmlns:vs="http://www.ivoa.net/xml/VODataService/v1.1"
Expand Down Expand Up @@ -63,6 +63,4 @@ components:
<description>description of foreign key columns in this tableset</description>
</table>
</schema>
...
</vosi:tableset>

Loading