Skip to content

Table permissions #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
pdowler wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Table permissions #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
90ce7a5
openapi spec for headers to convey table permissions
pdowler May 9, 2025
6a6ade3
update build workflow to v3
pdowler May 12, 2025
c1b2787
finish draft text for user managed tables and add some TODOs
pdowler May 12, 2025
d8eb175
Merge branch 'main' into vosi12-perms
pdowler May 20, 2025
75a937d
Merge branch 'main' into table-permissions
pdowler May 6, 2026
e79b959
fix example indentation
pdowler May 6, 2026
d16a62e
add x-vosi-owner output header
pdowler May 6, 2026
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
8 changes: 8 additions & 0 deletions openapi/vosi/vosi-anon-read.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# request header
name: x-vosi-anon-read
in: header
description: flag indicating that the resource allows anonymous read
required: false
schema:
type: boolean

7 changes: 7 additions & 0 deletions openapi/vosi/vosi-group-read.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# request header
name: x-vosi-group-read
in: header
description: a GMS group identifier indicating a group with read permission
required: false
schema:
type: string
7 changes: 7 additions & 0 deletions openapi/vosi/vosi-group-write.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# request header
name: x-vosi-group-write
in: header
description: a GMS group identifier indicating a group with write permission
required: false
schema:
type: string
56 changes: 40 additions & 16 deletions openapi/vosi/vosi-table.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ post:
required: true
schema:
type: string
- $ref: ./vosi-anon-read.yaml
- $ref: ./vosi-group-read.yaml
- $ref: ./vosi-group-write.yaml
requestBody:
description: a table description
$ref: '#/components/schemas/tableDoc'
Expand Down Expand Up @@ -65,6 +68,9 @@ put:
required: true
schema:
type: string
- $ref: ./vosi-anon-read.yaml
- $ref: ./vosi-group-read.yaml
- $ref: ./vosi-group-write.yaml
requestBody:
description: a table description
$ref: '#/components/schemas/tableDoc'
Expand Down Expand Up @@ -112,15 +118,36 @@ components:
schemas:
tableDoc:
description: metadata for the specified schema or table
headers:
x-vosi-owner:
description: identifier for the owner of the schema or table
required: false
schema:
type: string
x-vosi-anon-read:
description: flag indicating that the resource allows anonymous read
required: false
schema:
type: boolean
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
content:
text/xml:
schema:
type: object
xml:
name: table
prefix: vosi
namespace: http://www.ivoa.net/xml/VOSITables/v1.0
example: |
type: string
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"
xmlns:vte="http://www.opencadc.org/xml/VOSITables-ext/v0.1"
Expand Down Expand Up @@ -148,18 +175,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
example: |
type: string
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 +199,6 @@ components:
<FIELD name="schema_index" datatype="int">
<DESCRIPTION>recommended sort order when listing schemas</DESCRIPTION>
</FIELD>
<!--data goes here-->
</TABLE>
</RESOURCE>
</VOTABLE>


13 changes: 6 additions & 7 deletions openapi/vosi/vosi-tableset.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,12 @@ components:
content:
text/xml:
schema:
type: string
xml:
name: tableset
prefix: vosi
namespace: http://www.ivoa.net/xml/VOSITables/v1.0
example: |
type: string
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"
xmlns:vte="http://www.opencadc.org/xml/VOSITables-ext/v0.1"
Expand Down Expand Up @@ -63,6 +63,5 @@ components:
<description>description of foreign key columns in this tableset</description>
</table>
</schema>
...
</vosi:tableset>

Loading