Skip to content

Update the OpenAPI information #35

Description

@gaurav

Currently, NodeNorm ES returns the same developer information as NodeNorm Redis on https://nodenorm-es.ci.transltr.io/webapp/openapi.json:

{
  "openapi": "3.1.0",
  "info": {
    "title": "Node Normalization",
    "version": "1.0.0",
    "x-translator": {
      "component": "Utility",
      "team": [
        "Standards Reference Implementation Team"
      ],
      "infores": "infores:sri-node-normalizer"
    },
    "x-trapi": {
      "version": "1.5.0",
      "operations": [
        "annotate_nodes"
      ]
    },
    "contact": {
      "email": "bizon@renci.org",
      "name": "Chris Bizon",
      "x-id": "https://github.com/cbizon",
      "x-role": "responsible developer"
    },
    "termsOfService": "https://toss.apps.renci.org/tos?service_long=Node+Normalization&provider_long=the+Translator+Consortium",
    "description": "Node Normalization takes a CURIE, and returns: <ol> <li>The preferred CURIE for this entity <li>All other known equivalent identifiers for the entity <li>Semantic types for the entity as defined by the <a href=\"https://biolink.github.io/biolink-model/\">BioLink Model</a> </ol> The data served by Node Normalization is created by <a href=\"https://github.com/TranslatorSRI/Babel\">Babel</a>, which attempts to find identifier equivalences, and makes sure that CURIE prefixes are BioLink Model Compliant.  To determine whether Node Normalization is likely to be useful, check /get_semantic_types, which lists the BioLink semantic types for which normalization has been attempted, and /get_curie_prefixes, which lists the number of times each prefix is used for a semantic type."
  },
  "tags": [
    {
      "name": "translator"
    },
    {
      "name": "health"
    },
    {
      "name": "metadata"
    }
  ],
  "servers": [
    {
      "description": "Default server",
      "url": "https://nodenorm-es.ci.transltr.io/",
      "x-maturity": "development",
      "x-location": "RENCI"
    },
    {
      "description": "Localhost",
      "url": "http://localhost:8000/",
      "x-maturity": "development",
      "x-location": "RENCI"
    }
  ]
}

We should update this:

  • Change Team to DOGSURF
  • Change contact to Everaldo
  • Doesn't actually support TRAPI 1.5.0
  • x-location shouldn't be RENCI

We can leave the infores:sri-node-normalizer and the termsOfService for now, but we should probably update them eventually.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions