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 parameter description in aggregation responses #101

Closed
wants to merge 1 commit into from

Conversation

bonaparten
Copy link
Contributor

@bonaparten bonaparten commented Jan 21, 2021

Description

Add descriptions of the response parameters in the docs.

Corresponding issue

#88

New or changed dependencies

none

Checklist

@bonaparten bonaparten changed the title WIP: add parameter description for aggregation endpoints WIP: add parameter description in aggregation responses Jan 21, 2021
@bonaparten bonaparten requested a review from FabiKo117 January 27, 2021 10:15
@bonaparten bonaparten force-pushed the extend-docs-response-parameters branch from 8dee58f to 2d7ef42 Compare January 27, 2021 10:16
@bonaparten bonaparten changed the title WIP: add parameter description in aggregation responses add parameter description in aggregation responses Jan 27, 2021
@bonaparten bonaparten linked an issue Jan 27, 2021 that may be closed by this pull request
1 task
@bonaparten bonaparten added this to the 1.4 milestone Jan 27, 2021
@FabiKo117
Copy link
Contributor

Can we potentially shift this PR to 2.0 and do #16 first, as there would be a change in the structure and therefore also of some response objects?

I guess those response parameters are not thaaat important, that they would be needed in the next minor release, so they could also wait until the next major release.

@bonaparten
Copy link
Contributor Author

Can we potentially shift this PR to 2.0 and do #16 first, as there would be a change in the structure and therefore also of some response objects?

I guess those response parameters are not thaaat important, that they would be needed in the next minor release, so they could also wait until the next major release.

No problem with that. We can wait until we solve #16.

@FabiKo117 FabiKo117 modified the milestones: 1.4, 2.0 Feb 1, 2021
@FabiKo117 FabiKo117 added the documentation Improvements or additions to documentation label Feb 1, 2021
@bonaparten bonaparten changed the title add parameter description in aggregation responses WIP: add parameter description in aggregation responses Feb 10, 2021
@bonaparten bonaparten force-pushed the extend-docs-response-parameters branch from 2d7ef42 to 1915784 Compare February 10, 2021 13:44
@bonaparten bonaparten self-assigned this Feb 10, 2021
@bonaparten bonaparten changed the title WIP: add parameter description in aggregation responses add parameter description in aggregation responses Feb 10, 2021
@bonaparten bonaparten added the waiting An issue or PR which is waiting for an upstream bugfix, further information or is somehow blocked. label Feb 15, 2021
@bonaparten bonaparten force-pushed the extend-docs-response-parameters branch from 1915784 to 00025d6 Compare February 24, 2021 10:50
@bonaparten bonaparten mentioned this pull request May 12, 2021
2 tasks
@bonaparten bonaparten closed this May 17, 2021
@bonaparten bonaparten reopened this May 17, 2021
@bonaparten
Copy link
Contributor Author

#194 solves #88.

@bonaparten bonaparten closed this May 17, 2021
@bonaparten bonaparten deleted the extend-docs-response-parameters branch May 17, 2021 11:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation waiting An issue or PR which is waiting for an upstream bugfix, further information or is somehow blocked.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend docs on response parameters
2 participants