search

podaac / hydrocron

API for retreiving time series of SWOT data
https://podaac.github.io/hydrocron/
Apache License 2.0
16 stars 4 forks source link

Define 'fields' request parameter as optional #178

Open nikki-t opened 4 months ago

nikki-t commented 4 months ago

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?

frankinspace commented 4 months ago

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

torimcd commented 4 months ago

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