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

Add docs for custom provider fields and query parameters #1164

Merged
merged 4 commits into from
May 9, 2022

Conversation

ml-evs
Copy link
Member

@ml-evs ml-evs commented May 9, 2022

Closes #1123.

@ml-evs ml-evs added the docs Issues pertaining to documentation. label May 9, 2022
@ml-evs ml-evs requested review from CasperWA and JPBergsma as code owners May 9, 2022 12:10
@codecov
Copy link

codecov bot commented May 9, 2022

Codecov Report

Merging #1164 (a42bdf7) into master (255a402) will not change coverage.
The diff coverage is n/a.

❗ Current head a42bdf7 differs from pull request most recent head d18c06f. Consider uploading reports for the commit d18c06f to get more accurate results

@@           Coverage Diff           @@
##           master    #1164   +/-   ##
=======================================
  Coverage   92.32%   92.32%           
=======================================
  Files          68       68           
  Lines        3894     3894           
=======================================
  Hits         3595     3595           
  Misses        299      299           
Flag Coverage Δ
project 92.32% <ø> (ø)
validator 92.32% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 255a402...d18c06f. Read the comment docs.

Copy link
Contributor

@JPBergsma JPBergsma left a 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.

docs/getting_started/setting_up_an_api.md Show resolved Hide resolved

### 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

@ml-evs
Copy link
Member Author

ml-evs commented May 9, 2022

Thanks @JPBergsma, have addressed your comments and I'll merge myself without further review.

@ml-evs ml-evs force-pushed the ml-evs/add_provider_fields_docs branch from d18c06f to 6e19a16 Compare May 9, 2022 14:51
@ml-evs ml-evs merged commit 23958d8 into master May 9, 2022
@ml-evs ml-evs deleted the ml-evs/add_provider_fields_docs branch May 9, 2022 14:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Issues pertaining to documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add missing documentation for serving custom query params and fields
2 participants