{"openapi":"3.1.0","info":{"title":"The Summary(s4) RESTful Web services","description":"This is an API documentation for [s4](https://www.ebi.ac.uk/ebisearch/s4) RESTful Web services.","contact":{"name":"Web production in EMBL-EBI","url":"https://www.ebi.ac.uk/ebisearch/s4","email":"eb_eye@ebi.ac.uk"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"version":"all"},"externalDocs":{"description":"Summary(s4) RESTful Web services documentation","url":"https://www.ebi.ac.uk/ebisearch/rest-api"},"servers":[{"url":"https://www.ebi.ac.uk/ebisearch/summary","description":"EBI Search Summary(s4) Production server"}],"tags":[{"name":"Suggestion","description":"Retrieve a list of suggestions for a term"},{"name":"Identification","description":"Retrieve a set of term identifiers for a given term, within a pre-selected spine and/or term"},{"name":"Multiple References","description":"Fetch multiple reference"},{"name":"Summary Details","description":"Details summary of Gene, Protein, Protein Structure, Expression from Corresponding databases"}],"paths":{"/summary/api/suggestion":{"get":{"tags":["Suggestion"],"summary":"Suggested terms","description":"Retrieve a list of suggestions for a term","operationId":"getSuggestions","parameters":[{"name":"term","in":"query","description":"term for which suggestions should be generated - e.g. VAV_HUMAN, tpi1, 1n0w","required":true,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"default":{"description":"A list of suggested terms","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}}},"/summary/api/identification":{"get":{"tags":["Identification"],"summary":"Identify a set of summary terms","description":"Retrieve a set of term identifiers for a given term, within a pre-selected spine and/or term","operationId":"identify","parameters":[{"name":"term","in":"query","description":"term for which correlated entries will be pulled from protein and gene DB's - e.g. VAV_HUMAN, tpi1, 1n0w","required":true,"schema":{"type":"string"}},{"name":"spine","in":"query","description":"the chosen spine (optional) - e.g. molecular","required":false,"schema":{"type":"string"}},{"name":"tid","in":"query","description":"term identifier (optional) - e.g. protOrthVAV2HUMAN","required":false,"schema":{"type":"string"}}],"responses":{"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"default":{"description":"A list of summary term identifiers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SpineIdentification"}}}}}}}},"components":{"schemas":{"HttpStatusCode":{"properties":{"error":{"type":"boolean"},"is4xxClientError":{"type":"boolean"},"is5xxServerError":{"type":"boolean"},"is1xxInformational":{"type":"boolean"},"is2xxSuccessful":{"type":"boolean"},"is3xxRedirection":{"type":"boolean"}}},"ModelAndView":{"properties":{"view":{"$ref":"#/components/schemas/View"},"model":{"type":"object","additionalProperties":{"type":"object"}},"status":{"$ref":"#/components/schemas/HttpStatusCode"},"viewName":{"type":"string"},"empty":{"type":"boolean"},"reference":{"type":"boolean"},"modelMap":{"type":"object","additionalProperties":{"type":"object"},"properties":{"empty":{"type":"boolean"}}}}},"View":{"properties":{"contentType":{"type":"string"}}},"BreadcrumbLink":{"properties":{"label":{"type":"string"},"source":{"type":"string"}}},"DatabaseEntryReference":{"properties":{"identifier":{"type":"string"},"name":{"type":"string"},"extraNames":{"type":"array","items":{"type":"string"}},"label":{"type":"string"},"link":{"type":"string"},"databaseName":{"type":"string"}}},"ReferenceIdentification":{"properties":{"databaseEntryReference":{"$ref":"#/components/schemas/DatabaseEntryReference"},"species":{"$ref":"#/components/schemas/Species"}}},"Species":{"properties":{"commonName":{"type":"string"},"binomial":{"type":"string"},"taxonomyIdentifier":{"type":"string"}}},"SpeciesReferenceIdentification":{"properties":{"species":{"$ref":"#/components/schemas/Species"},"referenceIdentificationList":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceIdentification"}}}},"SpineIdentification":{"properties":{"spineIds":{"type":"array","items":{"type":"string"}},"termIdentificationMap":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/TermIdentification"}}},"breadcrumbLinks":{"type":"array","items":{"$ref":"#/components/schemas/BreadcrumbLink"}},"searchTerm":{"type":"string"}}},"TermIdentification":{"properties":{"internalId":{"type":"string"},"searchTerm":{"type":"string"},"identifiedTerm":{"type":"string"},"description":{"type":"string"},"references":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceIdentification"}},"organismsMultiReferences":{"type":"object","additionalProperties":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceIdentification"}}},"speciesReferenceIdentifications":{"type":"array","items":{"$ref":"#/components/schemas/SpeciesReferenceIdentification"}},"breadcrumbLinks":{"type":"array","items":{"$ref":"#/components/schemas/BreadcrumbLink"}},"score":{"type":"integer","format":"int32"}}}}}}