Skip to content
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

Jump to bottom

schemaUrl to document the API schema used by the service #26

Open
susheel opened this issue Jun 9, 2019 · 0 comments · May be fixed by #27
Open

schemaUrl to document the API schema used by the service #26

susheel opened this issue Jun 9, 2019 · 0 comments · May be fixed by #27
Labels
feature New feature or request
Milestone
1.1.0

Comments

@susheel
Copy link

susheel commented Jun 9, 2019

I feel it may be worth adding the explicit URL to the API schema used by the service. This would allow clients to detect the API schema used by the service and self-configure. This could point to the GA4GH YAML spec or a local copy that may add non-breaking extensions. See example below:

schemaUrl:
  type: string
  description: URL of the schema of this service (RFC 3986 format).

Related GA4GH DRS /service-info PR #277 discussion.
susheel added a commit to susheel/ga4gh-service-info that referenced this issue Jun 9, 2019
@susheel
Added schemaUrl property
4ae74db 
Resolves ga4gh-discovery#26
@susheel susheel linked a pull request Jun 9, 2019 that will close this issue
Open
@mcupak mcupak added the feature New feature or request label Jul 4, 2019
@mcupak mcupak added this to the 1.1.0 milestone Sep 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
feature New feature or request
Projects
None yet
Milestone
1.1.0
Development

Successfully merging a pull request may close this issue.

schemaUrl Property to document the API schema used by the service susheel/ga4gh-service-info
2 participants
@susheel @mcupak