{"name":"common","description":"Common models and resources used by all services.","info":{"license":{"name":"MIT","url":"http://opensource.org/licenses/MIT"}},"enums":{"health_status":{"description":"The status of a service.","values":[{"name":"running","description":"The service is running and healthy."},{"name":"starting","description":"The service is not yet running."},{"name":"unhealthy","description":"The service has encountered errors and is not running property."}]},"error_source_type":{"description":"Type of an error source.","values":[{"name":"pointer","description":"Indicating a [JSON pointer](https://tools.ietf.org/html/rfc6901) to the value that has caused the error."},{"name":"parameter","description":"Indicating an URI query parameter causing the error."},{"name":"header","description":"Indicating a request header causing the error."}]},"sort_direction":{"description":"The direction in which to sort by a property.","values":[{"name":"asc","description":"Sort ascending."},{"name":"desc","description":"Sort descending."}]}},"interfaces":{},"models":{"health_check":{"description":"Indicating the health of a service.","fields":[{"name":"status","type":"health_status"},{"name":"message","type":"string","required":false,"description":"An optional message giving more detailed information about the current health."}]},"link_object":{"description":"Represents a link with some meta information.","fields":[{"name":"href","type":"string","description":"An URI-reference pointing to the links target."},{"name":"title","type":"string","required":false,"description":"A human-readable label for the link."},{"name":"type","type":"string","required":false,"description":"Optional media type of the link's target."}]},"error_links":{"description":"Links to further information about the occurred error.","fields":[{"name":"about","type":"link","required":false,"description":"A link that leads to further details about this particular occurrence of the problem."},{"name":"type","type":"link","required":false,"description":"A link that identifies the type of the error that this particular error is an instance of."}]},"error_source":{"description":"Reference to the primary source of an error.","fields":[{"name":"type","type":"error_source_type"},{"name":"source","type":"string","description":"The source of the problem in the form specified by `type`."}]},"generic_error":{"description":"An error returned on failed API requests.","fields":[{"name":"links","type":"error_links","required":false},{"name":"code","type":"string","description":"An app specific error code."},{"name":"title","type":"string","description":"A short human readable summary of the problem."},{"name":"detail","type":"string","description":"A human readable explanation of the problem."},{"name":"source","type":"error_source","required":false},{"name":"meta","type":"object","required":false,"description":"Non-standard meta-information about the error."}]},"service_info":{"plural":"service_infos","description":"Information about a deployed service.","fields":[{"name":"name","type":"string"},{"name":"version","type":"string"},{"name":"uri","type":"string","description":"URI under which this service is deployed."},{"name":"title","type":"string","required":false,"description":"A human-readable title of the service."},{"name":"description","type":"string","required":false,"description":"A human-readable description of the service."}]},"audit":{"description":"Basic audit information for a resource.","fields":[{"name":"created_at","type":"date-time-iso8601"},{"name":"created_by","type":"uuid"},{"name":"updated_at","type":"date-time-iso8601"},{"name":"updated_by","type":"uuid"}]},"sort":{"description":"Single property to sort by.","fields":[{"name":"property","type":"string","description":"The property by which the results should be sorted."},{"name":"direction","type":"sort_direction","description":"The direction in which the results should be sorted."}]},"paging_form":{"description":"Form containing paging information.","fields":[{"name":"offset","type":"integer","required":false,"default":0,"description":"Offset of the current page. The pages are 0-indexed, meaning the first page starts at 0."},{"name":"limit","type":"integer","required":false,"default":25,"description":"The number of results to be returned by the api."},{"name":"sort","type":"[sort]","required":false,"description":"Defines multiple properties for the results to be sorted by. The order of the definition defines the priority. If omitted, the service will use an implementation dependent default sort."}]},"page_response":{"description":"Paging information returned from a paged request.","fields":[{"name":"offset","type":"integer"},{"name":"limit","type":"integer"},{"name":"sort","type":"[sort]"},{"name":"total_results","type":"long","description":"Total number of results that can potentially be returned."},{"name":"total_pages","type":"long","description":"Total number of pages that can potentially be returned."}]}},"unions":{"link":{"description":"Represents a link to a resource.","types":[{"type":"string","description":"An URI-reference pointing to the links target."},{"type":"link_object"}]}},"resources":{"health_check":{"path":"/_internal_","operations":[{"method":"GET","path":"/healthcheck","description":"Get the current health of the service.","responses":{"200":{"type":"health_check"}}},{"method":"GET","path":"/probe/ready","description":"Endpoint for readiness probe.","responses":{"200":{"description":"Service is ready and can receive traffic.","type":"unit"},"400":{"description":"Service is not ready for receiving traffic.","type":"unit"}}},{"method":"GET","path":"/probe/live","description":"Endpoint for liveliness probe.","responses":{"200":{"description":"Service is live.","type":"unit"}}}]},"service_info":{"path":"/_internal_","operations":[{"method":"GET","path":"/service","description":"Get information about the deployed service.","responses":{"200":{"type":"service_info"}}}]}},"attributes":[],"annotations":{}}