Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 2 commits into from
Nov 4, 2024
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4152f28
Document the `/nmdcschema/typecodes` API endpoint (reverse engineered)
eecavanna Nov 2, 2024
1e80fff
Add missing colon character to comment
eecavanna Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion nmdc_runtime/api/endpoints/nmdcschema.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from importlib.metadata import version
import re
from typing import List, Dict

import pymongo
from fastapi import APIRouter, Depends, HTTPException
Expand Down Expand Up @@ -50,7 +51,16 @@ def get_nmdc_schema_version():


@router.get("/nmdcschema/typecodes")
def get_nmdc_schema_typecodes():
def get_nmdc_schema_typecodes() -> List[Dict[str, str]]:
r"""
Returns a list of objects, each of which indicates (a) a schema class, and (b) the typecode
that the minter would use when generating a new ID for an instance of that schema class.

Each object has three properties:
- `id`: a string that consists of "nmdc:" + the class name + "_typecode"
- `schema_class`: a string that consists of "nmdc:" + the class name
- `name`: the typecode the minter would use when minting an ID for an instance of that class
"""
return typecodes()


Expand Down
Loading