Service Registry Specification
GA4GH Service Registry API Specification Version 1.0.0
More information on GitHub.
get /service-info
Show information about the registry
Description:
Response Code: 200
Description:
Display service information about this service registry.
Use type: org.ga4gh:service-registry:1.0.0 when implementing this specification directly.
Schema:
{
"$ref": "https://raw.githubusercontent.com/ga4gh-discovery/ga4gh-service-info/develop/service-info.yaml#/components/schemas/Service"
}Response Code: 401
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized (RFC 7235)"
}Response Code: 403
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Forbidden (RFC 7231)"
}Response Code: 500
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Internal server error (RFC 7231)"
}Response Code: default
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unexpected error (RFC 7231)"
}get /services
List services in the registry
Description:
Response Code: 200
Description: List of services
Schema:
{
"allOf": [
{
"$ref": "#/components/schemas/Service"
},
{
"properties": {
"url": {
"example": "https://example.com",
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}
],
"description": "GA4GH service with a URL"
}Response Code: 401
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized (RFC 7235)"
}Response Code: 403
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Forbidden (RFC 7231)"
}Response Code: 500
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Internal server error (RFC 7231)"
}Response Code: default
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unexpected error (RFC 7231)"
}get /services/types
List types of services exposed by the registry
Description: List all distinct values of the type field of exposed services (see Service).
Response Code: 401
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized (RFC 7235)"
}Response Code: 403
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Forbidden (RFC 7231)"
}Response Code: 500
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Internal server error (RFC 7231)"
}Response Code: default
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unexpected error (RFC 7231)"
}get /services/{serviceId}
Show information about a specific service
Description:
Response Code: 200
Description: Information about a service with the given ID
Schema:
{
"allOf": [
{
"$ref": "#/components/schemas/Service"
},
{
"properties": {
"url": {
"example": "https://example.com",
"format": "uri",
"type": "string"
}
},
"required": [
"url"
],
"type": "object"
}
],
"description": "GA4GH service with a URL"
}Response Code: 401
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unauthorized (RFC 7235)"
}Response Code: 403
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Forbidden (RFC 7231)"
}Response Code: 404
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Not found (RFC 7231)"
}Response Code: 500
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Internal server error (RFC 7231)"
}Response Code: default
Schema:
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
},
"description": "Unexpected error (RFC 7231)"
}