Document the /nmdcschema/typecodes API endpoint (reverse engineered)

[eecavanna]

In this branch, I added some documentation to an API endpoint that lacked it. The API endpoint was introduced via #386 (to resolve issue #385).

Fixes #747

Type of change

• Added missing documentation

How Has This Been Tested?

• I read it back to myself and it made sense to me

Configuration Details: none

Definition of Done (DoD) Checklist:

• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas

[sujaypatil96]

Sorry for the late review on this PR @eecavanna.

The docstring looks good, but I had a quick qualm with the /nmdcschema/typecodes endpoint itself, and I'm happy to make an issue for it.

So running:

curl -X 'GET' \
  'https://api.microbiomedata.org/nmdcschema/typecodes' \
  -H 'accept: application/json'

I'm seeing the below in the output:

  {
    "id": "nmdc:NucleotideSequencing_typecode",
    "schema_class": "nmdc:NucleotideSequencing",
    "name": "dgns"
  }

Under "name" ideally, I should see both dgns and omprc, so perhaps something like this:

  {
    "id": "nmdc:NucleotideSequencing_typecode",
    "schema_class": "nmdc:NucleotideSequencing",
    "name": "dgns"
  },
  {
    "id": "nmdc:NucleotideSequencing_typecode",
    "schema_class": "nmdc:NucleotideSequencing",
    "name": "omprc"
  }

Here's the line from the schema YAML that has indication that there are two typecodes associated with NucleotideSequencing.

Right?

[aclum]

This should be a different endpoint IMO, allowable typecodes will be different going forward that the current typecode the minter returns.