Skip to content

DM-51484: Update authors API and SQL table name conventions #188

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

jonathansick
Copy link
Member

This PR makes some small but important changes to the SQL and API design conventions that will be good for the long run:

  • Changed the GET /authors/id/{id} endpoint to now be GET /authors/{id} to align with the other endpoints in the API.
  • Change SQL table names to be singlar instead of plural. This change requires a database migration (Alembic migration fb5ed49d63d5).

I originally wrote these for times-square and they've been successful.
Add them to ook too.
This removes the intermediate `/id/` path component, which we won't need
to support other API operations. This change will help us align with
new APIs that we'll be adding to Ook.
jonathansick added a commit to lsst-sqre/phalanx that referenced this pull request Jun 20, 2025
This convention is generally more popular and will be easier to maintain
going forwards.
The structure of authordb.yaml mixes people and collaborations, but
conceptually it's better to treat them separately.

We may add a collaborations API in the future.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant