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