translator_extensions

The Translator-specific metadata extensions used in the SmartAPI registry

x-translator

Status

This extension's schema has been written, and registry files currently contain this extension.

Description

This extension is inside the OpenAPI info object and contains basic API-level metadata. Currently, there are two (required) properties: component (KP, ARA, ARS, or Utility) and team (one or more Translator team names). Current properties include:

• infores: Information Resource CURIE identifying the Translator Resource (see the current inventory of Infores CURIEs and general information about them here).
• component: One of "KP", "ARA", "ARS", "Utility"
• team: List of contributing Translator teams (see schema file for the full list)
• biolink-version: One SemVer-formatted version number (e.g. '1.8.2', '2.2.16', etc.). This is the release of the Biolink Model that to which the Translator Resource is currently compliant."

Associated rules:

• if the API is tagged "translator" in the OpenAPI top-level tags, then the x-translator extension must be present (in OpenAPI info)
• if x-translator is present (in OpenAPI info), then the API must be tagged "translator" in the OpenAPI top-level tags

Examples

An example of a valid x-translator extension in YAML is:

  tags:
  - name: translator    ## required translator tag
  - name: biothings
  info:
    x-translator:      ## required x-translator extension
      infores: "infores:biolink-api"
      component: KP
      team:
      - "Service Provider"
      biolink-version: "2.2.16"

This same example in JSON and other examples of valid and invalid x-translator annotations (in JSON) are in this example file.

x-trapi

Status

This extension's schema has been started, and registry files currently contain this extension.

Description

This extension is inside the OpenAPI info object and contains basic API-level metadata. Currently, there are three (required) properties: version, operations and test_data_location, plus other optional ones:

• version: States the TRAPI standard version, as a SemVer formatted number (e.g. '1.1', '1.2', '1.3'), indicating that the Translator Resource is compliant with / built to this version. The TRAPI standard and its versions can be viewed here."
• operations: List of implemented operations, drawn from operation.json.
• rate_limit: Maximum number of requests allowed per minute from each client. -1 indicates no limit.
• batch_size_limit: Maximum number of CURIEs allowed in any 'ids', 'categories', or 'predicates' list. -1 indicates no limit.
• test_data_location: URL that resolves to SRI Testing harness compliant test data in some public internet location (e.g. in the API implementation source code repository).

Examples

An example of a valid x-trapi extension in YAML is:

  tags:
  - name: translator    ## required translator tag
  - name: biothings
  info:
    x-trapi:      ## required x-translator extension
      version: "1.2.0"
      operations:
      - OperationLookup
      test_data_location: "https://github.com/biothings/biothings.api/blob/master/test_data"  # just a fictional example link

This same example in JSON and other examples of valid and invalid instances (in JSON) are in this example file.