Skip to content

CDA-117: Catalog endpoint ADR#1837

Open
zack-rma wants to merge 7 commits into
USACE:developfrom
zack-rma:docs/catalog-adr
Open

CDA-117: Catalog endpoint ADR#1837
zack-rma wants to merge 7 commits into
USACE:developfrom
zack-rma:docs/catalog-adr

Conversation

@zack-rma

Copy link
Copy Markdown
Collaborator

Summary

ADR for catalog endpoint improvements.

Related Issue

Closes #1717

Validation

Documentation only.

Checklist

  • AI tools used

@adamkorynta

Copy link
Copy Markdown
Collaborator

Should address the new QUERY HTTP method. Wouldn't be implemented in the short term, but design should take it into consideration.

@zack-rma
zack-rma marked this pull request as ready for review July 17, 2026 21:15
* - Catalog endpoint HTTP method type
- Catalog endpoints currently support `GET all` requests. Support for `QUERY` requests shall be implemented for
improved functionality.
- Introduced in `RFC 10008`, the `QUERY` HTTP method allows for significantly more complex queries without

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should reference a GitHub issue tracking this addition given it will not be implemented until proper support is available in library versions computable with deployment targets (unless they are back porting Javalin/Tomcat? I haven't looked at it myself)

* - Paging
- Catalog endpoints shall support paging.
- Efficient retrieval for larger data sets.
* - GetAll vs Catalog

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm struggling a bit with this definition as the current catalog data types already contain enough data for a POST even though we didn't implement them. For example the location endpoint getAll and the catalog/locations and the time series identifier getAll and catalog/timeseries endpoints.

I think it would be useful for discussion if examples were presented.

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.

Catalog Endpoint Improvements

2 participants