Skip to content

Added root openapi.yaml file to reference the managedAttribute and #52

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.

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

Merged
merged 8 commits into from
May 5, 2020
Merged

Added root openapi.yaml file to reference the managedAttribute and #52

merged 8 commits into from
May 5, 2020

Conversation

xuemeigan
Copy link
Collaborator

metadata yaml as well as generated html documentation files :
#51

For now we can only have one linked external doc due to below open PR:
OAI/OpenAPI-Specification#1034

metadata yaml as well as generated html documentation files :
#51
@cgendreau
Copy link
Collaborator

The PR should not include html files.

@xuemeigan
Copy link
Collaborator Author

xuemeigan commented Apr 28, 2020

Currently the path can link to the actual spec file. To see the individual spec in document format, I think we need the external doc link, which will point to the html file.

@cgendreau
Copy link
Collaborator

Paths should be included using the proper $ref:

paths:
  /v1/metadata: 
    $ref: 'metadata.yaml#/paths/~1v1~1metadata'
  /v1/managed-attribute:
    $ref: 'managedAttribute.yaml#/paths/~1v1~1managed-attribute'  

But we need 1 path element per $ref. It would also be ok to simply have 1 document named object-store-api.yaml

@cgendreau
Copy link
Collaborator

The id of the acMetadataCreator should not point to an agent, it's the identifier only.

@cgendreau cgendreau merged commit 5ba884c into DINA-Web:json-schema May 5, 2020
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