Description accidentally moved to root

[gaurav]

Until PR #339, a single description would be chosen for each clique and placed in id, e.g.:

{
  "NCBIGene:73": {
    "id": {
      "identifier": "NCBIGene:73",
      "label": "ACTG1P1",
      "description": "actin gamma 1 pseudogene 1"
    },
    "equivalent_identifiers": [
      {
        "identifier": "NCBIGene:73",
        "label": "ACTG1P1",
        "description": "actin gamma 1 pseudogene 1"
      },
      {
        "identifier": "HGNC:146",
        "label": "ACTG1P1"
      },
      {
        "identifier": "UMLS:C2829478",
        "label": "ACTG1P1 gene"
      }
    ],
    "type": [
      "biolink:Gene",
      "biolink:GeneOrGeneProduct",
      "biolink:GenomicEntity",
      "biolink:ChemicalEntityOrGeneOrGeneProduct",
      "biolink:PhysicalEssence",
      "biolink:OntologyClass",
      "biolink:BiologicalEntity",
      "biolink:ThingWithTaxon",
      "biolink:NamedThing",
      "biolink:PhysicalEssenceOrOccurrent",
      "biolink:MacromolecularMachineMixin"
    ]
  },

However, in PR #339 (released in NodeNorm 2.3.27) I inadvertently changed this so that the description now appears on the root object, i.e.:

{
  "NCBIGene:73": {
    "id": {
      "identifier": "NCBIGene:73",
      "label": "ACTG1P1"
    },
    "equivalent_identifiers": [
      {
        "identifier": "NCBIGene:73",
        "label": "ACTG1P1",
        "description": "actin gamma 1 pseudogene 1",
        "taxa": [
          "NCBITaxon:9606"
        ]
      },
      {
        "identifier": "HGNC:146",
        "label": "ACTG1P1"
      },
      {
        "identifier": "UMLS:C2829478",
        "label": "ACTG1P1 gene"
      }
    ],
    "description": "actin gamma 1 pseudogene 1",
    "taxa": [
      "NCBITaxon:9606"
    ],
    "type": [
      "biolink:Gene",
      "biolink:GeneOrGeneProduct",
      "biolink:GenomicEntity",
      "biolink:ChemicalEntityOrGeneOrGeneProduct",
      "biolink:PhysicalEssence",
      "biolink:OntologyClass",
      "biolink:BiologicalEntity",
      "biolink:ThingWithTaxon",
      "biolink:NamedThing",
      "biolink:PhysicalEssenceOrOccurrent",
      "biolink:MacromolecularMachineMixin"
    ]
  }
}

This was an unintentional change! I will fix this in the next version, by making two changes:

1. Moving description back into id.
2. Renaming the overall description to descriptions, and keeping that as a list of all the descriptions known for this clique.

[colleenXu]

Will the behavior of "description: false" for /get_normalized_nodes be updated as well?

I imagine setting that parameter to false will mean both the top-level descriptions and id.description will be not be in results.

[gaurav]

I imagine setting that parameter to false will mean both the top-level descriptions and id.description will be not be in results.

That's what made sense to me too -- both descriptions and id.descriptions will be present only if the description flag is set to true.