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.

Sign up for GitHub

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

Jump to bottom

Add missing documentation for serving custom query params and fields #1123

Closed
ml-evs opened this issue Apr 18, 2022 · 0 comments · Fixed by #1164
Closed

Add missing documentation for serving custom query params and fields #1123

ml-evs opened this issue Apr 18, 2022 · 0 comments · Fixed by #1164
Labels
docs Issues pertaining to documentation. priority/low Issue or PR with a consensus of low priority server Issues pertaining to the example server implementation

Comments

@ml-evs
Copy link
Member

ml-evs commented Apr 18, 2022

#1096 added the ability to fully specify provider fields from the config file only. We need to add documentation for this at https://www.optimade.org/optimade-python-tools/latest/getting_started/setting_up_an_api/#serving-custom-fieldsproperties.

Once #1122 is merged, we should also add documentation for how to serve custom query parameters.
@ml-evs ml-evs added priority/low Issue or PR with a consensus of low priority docs Issues pertaining to documentation. server Issues pertaining to the example server implementation labels Apr 18, 2022
@ml-evs ml-evs mentioned this issue May 9, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Issues pertaining to documentation. priority/low Issue or PR with a consensus of low priority server Issues pertaining to the example server implementation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add docs for custom provider fields and query parameters Materials-Consortia/optimade-python-tools
1 participant
@ml-evs