Skip to content

Re-worked OpenAPI spec (CADC 15042) - #213

Open
andamian wants to merge 20 commits into
opencadc:mainfrom
andamian:CADC-15042
Open

Re-worked OpenAPI spec (CADC 15042)#213
andamian wants to merge 20 commits into
opencadc:mainfrom
andamian:CADC-15042

Conversation

@andamian

Copy link
Copy Markdown
Contributor

Renamed branch

@andamian
andamian requested a review from pdowler April 22, 2026 23:42
@andamian andamian changed the title Re-worked OpenPI spec (CADC 15042) Re-worked OpenAPI spec (CADC 15042) Apr 22, 2026
Comment thread gms/src/main/webapp/openapi/gms/gms-search.yaml Outdated
Comment thread gms/src/main/webapp/openapi/paths/groups-group-members.yaml Outdated
Comment thread gms/src/main/webapp/openapi/paths/groups-groupid.yaml Outdated
@@ -0,0 +1,134 @@
# Shared components for the GMS OpenAPI description (referenced from path fragments and the root document).
components:
parameters:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

parameter definition style:

I found one of:

- name: groupID
  in: path
...

or (eg)

- $ref: {defined elsewhere}

to be the most compact. See VOSI.git for examples of params defined in separate files.

Having

groupID:
  name: groupID
...

is either redundant or confusing when the two values differ.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That works in service parameters but not in components. In components the first occurrence is a key and the second one is the name. Although appears to be a repetition, that is not necessarily so as we could use a different value such as groupIDKey for example. Would that make the intention more obvious?

Comment thread gms/src/main/webapp/openapi/components.yaml Outdated
Comment thread gms/src/main/webapp/openapi.yaml
Comment thread gms/src/main/webapp/openapi.yaml
Comment thread gms/src/main/webapp/openapi/components.yaml Outdated
Comment thread gms/src/main/webapp/openapi/components.yaml
Comment thread gms/src/main/webapp/openapi/cadcvosi/availability.yaml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants