Add consistent associations

bartfeenstra commented 1 year ago

This proposes to:

Use links to define associations with entities, and not to embed entities into responses that are not from a "get a single entity by ID here" endpoint.
Embed links for to-one relationships between entities
Use collection endpoint query parameters to retrieve to-many relationships

Changes

New optional query parameters for /award to filter based on to-many associations from centers, programs, and institutions.
Endpoint links from the /center/{centerId}, /program/{programId}, and /institution/{institutionId} endpoints to /award to serve as static documentation (not rendered by Redoc, as far as I can see).

vercel[bot] commented 1 year ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated
ioda	✅ Ready (Inspect)	Visit Preview	💬 Add your feedback	Feb 28, 2023 at 11:01AM (UTC)

bartfeenstra commented 1 year ago

There's a test failure because either the OpenAPI or JSON Schema tooling we're using cannot correctly merge the indicated definitions (allowed as per the OpenAPI spec, and maybe even JSON Schema itself). Redoc renders everything just fine, as per the OpenAPI specification.

I may look for different tooling to circumvent this problem.

bartfeenstra commented 1 year ago

Failures fixed in https://github.com/nihruk/ioda/pull/30 :)

nihruk / console

Add consistent associations #28

Changes