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

Update the service-info to use the ga4gh discovery standard in progress (resolves #264) #277

Merged
merged 2 commits into from
Jun 17, 2019
Merged

Update the service-info to use the ga4gh discovery standard in progress (resolves #264) #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
df8c448
Update the service-info to use the ga4gh discovery standard in progress
briandoconnor Jun 3, 2019
1ee9de3
fix build problem (by adding dist: trusty)
dglazer Jun 17, 2019
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
1 change: 1 addition & 0 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
dist: trusty
language: python
python:
- '2.7'
Expand Down
27 changes: 16 additions & 11 deletions openapi/data_repository_service.swagger.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -322,25 +322,30 @@ definitions:
ServiceInfo:
type: object
required:
- id
- name
- version
description: >-
Useful information about the running service.
properties:
version:
id:
type: string
description: Service version
title:
description: Unique ID of this service. Reverse domain name notation is recommended, though not required.
name:
type: string
description: Service name
description: Name of this specific service.
description:
type: string
description: Service description
contact:
type: object
description: Maintainer contact info
license:
type: object
description: License information for the exposed API
description: Description of the service.
documentationUrl:
Copy link
Member

Choose a reason for hiding this comment

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

I feel it might be worth adding an explicit schemaURL to allow machine code to detect the OpenAPI/Swagger schema used by the service and self-configure. This could point to the GA4GH spec YAML or a local copy that may provide non-breaking extensions.

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

Copy link
Member

Choose a reason for hiding this comment

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

I like it, but I think that should be done GA4GH-wide, and we should be consistent -- maybe open an issue in https://github.com/ga4gh-discovery/ga4gh-service-info? (Not sure how they're handling enhancement requests there.)

Copy link
Member

Choose a reason for hiding this comment

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

PR ga4gh-discovery/ga4gh-service-info#27 added.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep, that's right @dglazer, any changes folks want for this should go to https://github.com/ga4gh-discovery/ga4gh-service-info

I'll make my best attempt to keep these in sync but I suspect the powers that be will allow us to bring in last minute changes to /service-info when that finalizes and before we cut an official 1.0 on our APIs.

type: string
description: URL of the documentation of this service (RFC 3986 format).
contactUrl:
type: string
description: 'URL of the contact for the host/maintainer of this service, e.g. a link to a contact form (RFC 3986 format), or an email (RFC 2368 format).'
version:
type: string
description: Version of the service.
ContentsObject:
type: object
properties:
Expand Down