-
Notifications
You must be signed in to change notification settings - Fork 44
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
Add docs for custom provider fields and query parameters #1164
Conversation
Codecov Report
@@ Coverage Diff @@
## master #1164 +/- ##
=======================================
Coverage 92.32% 92.32%
=======================================
Files 68 68
Lines 3894 3894
=======================================
Hits 3595 3595
Misses 299 299
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apart from the two small remarks it looks ok to me.
Thanks for expanding the documentation.
|
||
### More advanced usage | ||
!!! example | ||
Example JSON config file fragment for adding two fields to each of the `structures` and `references` endpoints, that will be served as, e.g., `_exmpl_cell_volume` if the `provider.prefix` is configured. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Example JSON config file fragment for adding two fields to each of the `structures` and `references` endpoints, that will be served as, e.g., `_exmpl_cell_volume` if the `provider.prefix` is configured. | |
Example JSON config file fragment for adding two fields to each of the `structures` and `references` endpoints, that will be served as, e.g., `_exmpl_cell_volume` if the `provider.prefix` is set to 'exmpl'. |
This seemed a bit clearer to me.
Thanks @JPBergsma, have addressed your comments and I'll merge myself without further review. |
d18c06f
to
6e19a16
Compare
Closes #1123.