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

Expound on field query param for the data json format and geojson format #2085

Merged
merged 3 commits into from
May 28, 2021

Conversation

WinnyTroy
Copy link
Contributor

Changes / Features implemented

  • Updated documentation

Closes #2052

Copy link
Contributor

@DavisRayM DavisRayM left a comment

Choose a reason for hiding this comment

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

Have a few comments

docs/data.rst Outdated
Comment on lines 290 to 293
Sort form data against a column(field)
----------------------------------------
Returns submitted data for a specific form in a sorted order. Use the `sort` parameter to filter the list of submissions.
The sort parameter is takes a field(form column) as the key and select value pairs as demonstrated below.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think the previous version was clear enough... I don't see the need to change it

docs/data.rst Outdated
Fetch data on select columns for a given form
---------------------------------------------------

Queries select column data specified by the user. Use the ``fields`` parameter to specify the column data that should be returned.
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
Queries select column data specified by the user. Use the ``fields`` parameter to specify the column data that should be returned.
Returns a list of the selected columns from the submitted data. Use the ``fields`` parameter....

Copy link
Contributor

@DavisRayM DavisRayM left a comment

Choose a reason for hiding this comment

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

LGTM

@DavisRayM DavisRayM merged commit f61afa5 into master May 28, 2021
@DavisRayM DavisRayM deleted the 2052_field_query_param branch May 28, 2021 07:45
@DavisRayM DavisRayM mentioned this pull request May 31, 2021
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation on the fields query param on the JSON Data endpoint
3 participants