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.

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

Define 'fields' request parameter as optional #178

Open
nikki-t opened this issue May 8, 2024 · 2 comments
Open

Define 'fields' request parameter as optional #178

nikki-t opened this issue May 8, 2024 · 2 comments
Assignees

Comments

@nikki-t
Copy link
Collaborator

nikki-t commented May 8, 2024

The 'fields' parameter was defined as not required in the OpenAPI schema but the API code will error out if it is not included in the request. (I have updated the schema to require the 'fields' parameter for now so it matches the API functionality.)

It looks like we have a default value selected of: feature_id, time_str, wse, geometry but it is not getting passed to the API Lambda function.

Should the fields parameter be required? Does this subset still make sense or should we default to returning all available data fields?

@cassienickles - "I don't think the fields functionality should be required. To me, it should default to include all fields unless that is overburdensome for performance."

@frankinspace and @torimcd - What do you think?

@nikki-t nikki-t self-assigned this May 8, 2024
@frankinspace
Copy link
Member

I'm ok making it optional and defaulting to all fields

@torimcd
Copy link
Collaborator

torimcd commented May 8, 2024

I agree, I think that's the most expected behavior

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

No branches or pull requests

3 participants