{"openapi":"3.0.3","info":{"title":"API","version":"1.0.0","contact":{}},"paths":{"/status":{"get":{"operationId":"get~status_endpoint","summary":"Checks the health status of the annotator service","responses":{"200":{"description":"A successful network status check","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"}}}}}},"400":{"description":"An unsuccessful network status check","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean"},"error":{"type":"string"}}}}}}}}},"/version":{"get":{"operationId":"get~version_endpoint","summary":"Checks the version of the annotator service","responses":{"200":{"description":"Successful github commit hash generation","content":{"application/json":{"schema":{"type":"object","properties":{"version":{"type":"string"}}}}}}}}},"/curie":{"post":{"operationId":"post~batch_curie_endpoint","summary":"For a list of curie IDs, return the expanded annotation objects","parameters":[{"name":"raw","in":"query","description":"When true, return annotation fields in their original data structure before transformation. Useful for debugging. Defaults to false","required":false,"schema":{"type":"boolean"}},{"name":"fields","in":"query","description":"Comma-separated fields to override the default set of annotation fields, or passing \"fields=all\" to return all available fields from the original annotation source. Defaults to none","required":false,"schema":{"type":"string"}},{"name":"include_extra","in":"query","description":"When true, leverage external API(s) data to include additional annotation information in the response. Defaults to true","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"ids":{"description":"multiple association IDs separated by comma. Note that currently we only take the input ids up to 1000 maximum, the rest will be omitted. Type: string (list). Max: 1000.","type":"string"}},"required":["ids"]}}}},"responses":{"200":{"description":"A list of matching annotation objects","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A response indicating an improperly formatted query","content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"array","items":{"type":"string"}},"endpoint":{"type":"string"},"message":{"type":"string"},"supported_nodes":{"type":"array","items":{"type":"string"}}}}}}}}}},"/trapi":{"post":{"operationId":"post~trapi_endpoint","summary":"Provides an annotated response based off the TRAPI body provided","parameters":[{"name":"append","in":"query","description":"When true, append annotations to the existing \"attributes\" field, otherwise, overwrite the existing \"attributes\" field. Defaults to false","required":false,"schema":{"type":"boolean"}},{"name":"raw","in":"query","description":"When true, return annotation fields in their original data structure before transformation. Useful for debugging. Defaults to false","required":false,"schema":{"type":"boolean"}},{"name":"fields","in":"query","description":"Comma-separated fields to override the default set of annotation fields, or passing \"fields=all\" to return all available fields from the original annotation source. Defaults to none","required":false,"schema":{"type":"string"}},{"name":"include_extra","in":"query","description":"When true, leverage external API(s) data to include additional annotation information in the response. Defaults to true","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"object","properties":{"knowledge_graph":{"type":"object","properties":{"nodes":{"type":"object"},"edges":{"type":"object"}}}}}}}}}},"responses":{"200":{"description":"A list of matching annotation objects","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"A response indicating an improperly formatted query","content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"object","properties":{"message":{"type":"object","properties":{"knowledge_graph":{"type":"object","properties":{"nodes":{"type":"object"},"edges":{"type":"object"}}}}}}},"expected_structure":{"type":"object","properties":{"message":{"type":"object","properties":{"knowledge_graph":{"type":"object","properties":{"nodes":{"type":"object"},"edges":{"type":"object"}}}}}}},"endpoint":{"type":"string"},"message":{"type":"string"}}}}}}}}},"/annotator":{"post":{"operationId":"post~trapi_endpoint_mirror","summary":"Trapi Endpoint Mirror","deprecated":true,"responses":{"default":{"description":"OK"}}}},"/metadata/openapi":{"get":{"operationId":"get~metadata","summary":"Generates the auto-documented OpenAPI specification dynamically from the annotator application","responses":{"200":{"description":"Successful generation of the OpenAPI auto-generated documentation in yaml format","content":{"text/plain":{"schema":{"type":"string"}}}},"400":{"description":"Error occured during auto-generation of the OpenAPI documentation","content":{"application/json":{"schema":{"type":"object","properties":{"endpoint":{"type":"string"},"message":{"type":"string"},"exception":{"type":"string"}}}}}}}}},"/curie/{curie}":{"get":{"operationId":"get~curie_endpoint","summary":"Retrieve annotation objects based on a CURIE ID","parameters":[{"in":"path","description":"biological identifier using the CURIE format <node>:<id>.","example":"NCBIGene:695","schema":{"type":"string"},"required":true},{"name":"raw","in":"query","description":"When true, return annotation fields in their original data structure before transformation. Useful for debugging. Defaults to false","required":false,"schema":{"type":"boolean"}},{"name":"fields","in":"query","description":"Comma-separated fields to override the default set of annotation fields, or passing \"fields=all\" to return all available fields from the original annotation source. Defaults to none","required":false,"schema":{"type":"string"}},{"name":"include_extra","in":"query","description":"When true, leverage external API(s) data to include additional annotation information in the response. Defaults to true","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"A matching annotation object","content":{"application/json":{"schema":{"type":"object","properties":{"curie":{"type":"object"}}}}}},"400":{"description":"A response indicating an unknown or unsupported curie ID","content":{"application/json":{"schema":{"type":"object","properties":{"input":{"type":"string"},"message":{"type":"string"},"supported_nodes":{"type":"array","items":{"type":"string"}},"exception":{"type":"string"}}}}}}}}},"/annotator/{curie}":{"get":{"operationId":"get~curie_endpoint_mirror","summary":"Curie Endpoint Mirror","parameters":[{"name":"curie","schema":{"type":"string"},"required":true,"in":"path"}],"deprecated":true,"responses":{"default":{"description":"OK"}}}}},"tags":[],"servers":[],"security":[]}