{"swagger":"2.0","info":{"title":"common","description":"Common models and resources used by all services.","license":{"name":"MIT","url":"http://opensource.org/licenses/MIT"},"version":"0.0.1"},"consumes":["application/json"],"produces":["application/json"],"paths":{"/_internal_/healthcheck":{"get":{"description":"Get the current health of the service.","parameters":[],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/health_check"}}}}},"/_internal_/probe/ready":{"get":{"description":"Endpoint for readiness probe.","parameters":[],"responses":{"200":{"description":"Service is ready and can receive traffic."},"400":{"description":"Service is not ready for receiving traffic."}}}},"/_internal_/probe/live":{"get":{"description":"Endpoint for liveliness probe.","parameters":[],"responses":{"200":{"description":"Service is live."}}}},"/_internal_/service":{"get":{"description":"Get information about the deployed service.","parameters":[],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/service_info"}}}}}},"definitions":{"audit":{"type":"object","description":"Basic audit information for a resource.","title":"audit","required":["created_at","created_by","updated_at","updated_by"],"properties":{"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string","format":"uuid"},"updated_at":{"type":"string","format":"date-time"},"updated_by":{"type":"string","format":"uuid"}}},"error_links":{"type":"object","description":"Links to further information about the occurred error.","title":"error_links","properties":{"about":{"$ref":"#/definitions/link"},"type":{"$ref":"#/definitions/link"}}},"error_source":{"type":"object","description":"Reference to the primary source of an error.","title":"error_source","required":["type","source"],"properties":{"type":{"type":"string","enum":["pointer","parameter","header"]},"source":{"description":"The source of the problem in the form specified by `type`.","type":"string"}}},"generic_error":{"type":"object","description":"An error returned on failed API requests.","title":"generic_error","required":["code","title","detail"],"properties":{"links":{"$ref":"#/definitions/error_links"},"code":{"description":"An app specific error code.","type":"string"},"title":{"description":"A short human readable summary of the problem.","type":"string"},"detail":{"description":"A human readable explanation of the problem.","type":"string"},"source":{"$ref":"#/definitions/error_source"},"meta":{"description":"Non-standard meta-information about the error."}}},"health_check":{"type":"object","description":"Indicating the health of a service.","title":"health_check","required":["status"],"properties":{"status":{"type":"string","enum":["running","starting","unhealthy"]},"message":{"description":"An optional message giving more detailed information about the current health.","type":"string"}}},"link_object":{"type":"object","description":"Represents a link with some meta information.","title":"link_object","required":["href"],"properties":{"href":{"description":"An URI-reference pointing to the links target.","type":"string"},"title":{"description":"A human-readable label for the link.","type":"string"},"type":{"description":"Optional media type of the link's target.","type":"string"}}},"page_response":{"type":"object","description":"Paging information returned from a paged request.","title":"page_response","required":["offset","limit","sort","total_results","total_pages"],"properties":{"offset":{"type":"integer","format":"int32"},"limit":{"type":"integer","format":"int32"},"sort":{"type":"array","items":{"$ref":"#/definitions/sort"}},"total_results":{"description":"Total number of results that can potentially be returned.","type":"integer","format":"int64"},"total_pages":{"description":"Total number of pages that can potentially be returned.","type":"integer","format":"int64"}}},"paging_form":{"type":"object","description":"Form containing paging information.","title":"paging_form","required":["offset","limit"],"properties":{"offset":{"description":"Offset of the current page. The pages are 0-indexed, meaning the first page starts at 0.","default":"0","type":"integer","format":"int32"},"limit":{"description":"The number of results to be returned by the api.","default":"25","type":"integer","format":"int32"},"sort":{"type":"array","items":{"$ref":"#/definitions/sort"}}}},"service_info":{"type":"object","description":"Information about a deployed service.","title":"service_info","required":["name","version","uri"],"properties":{"name":{"type":"string"},"version":{"type":"string"},"uri":{"description":"URI under which this service is deployed.","type":"string"},"title":{"description":"A human-readable title of the service.","type":"string"},"description":{"description":"A human-readable description of the service.","type":"string"}}},"sort":{"type":"object","description":"Single property to sort by.","title":"sort","required":["property","direction"],"properties":{"property":{"description":"The property by which the results should be sorted.","type":"string"},"direction":{"type":"string","enum":["asc","desc"]}}},"link":{"type":"object","description":"Represents a link to a resource.","title":"link","allOf":[{"type":"string"},{"$ref":"#/definitions/link_object"}]}}}