search

materialsproject / public-docs

The latest documentation for the Materials Project.
https://docs.materialsproject.org
7 stars 13 forks source link

Clarify difference between `available_fields` and `search()` kwargs #1

Closed sgbaird closed 1 year ago

sgbaird commented 2 years ago

https://github.com/materialsproject/api/issues/614#issuecomment-1146385292

https://github.com/materialsproject/api/issues/613#issuecomment-1146383017

Hi @sgbaird, the available_fields property is meant to refer to the data available from the endpoint, not necessarily which fields you can use to query that data with. With the latest client release v0.24.0 (yesterday afternoon), the generic search method input arguments are meant to show which fields can be used.

Regarding

To query summary data with property filters use the search function. Filters for each of the fields in available_fields can be passed to it ... I think I missed that this statement only applies to the SummaryRester API. Or maybe I'm still misinterpreting.

sgbaird commented 2 years ago

@munrojm

janosh commented 1 year ago

Thanks @sgbaird! 👍