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

Correct parameter name in docs #182

Merged
merged 1 commit into from
May 17, 2024
Merged

Conversation

sohomdatta1
Copy link
Contributor

Currently, the parameter names for the feed filtering API do not correspond to the parameters accepted by the API giving the appearance that the API is broken. For example, the docs give me the following command to filter for a specific page:

curl -X 'GET' \
  'https://copypatrol.wmcloud.org/api/feed/en?filter=all&filter_page=List%20of%20foreign%20recipients%20of%20the%20L%C3%A9gion%20d%27Honneur%20by%20country' \
  -H 'accept: application/json'

However, when the command is run, the default list of pages is returned and no filtering occurs. The correct command would have been

curl -X 'GET' \
  'https://copypatrol.wmcloud.org/api/feed/en?filter=all&filterPage=List%20of%20foreign%20recipients%20of%20the%20L%C3%A9gion%20d%27Honneur%20by%20country' \
  -H 'accept: application/json'

which filters the pages and provides only the page that matches the name provided in the query.

This patch fixes the parameter names in the OpenAPI docs to correspond to the actual API parameters.

Currently, the parameter names for the feed filtering API
do not correspond to the parameters actually accepted by the API
giving the appearance that the API is borken.

This patch fixes the parameter names in the OpenAPI docs to
correspond to the actual API parameters.

Signed-off-by: Sohom <[email protected]>
@sohomdatta1
Copy link
Contributor Author

sohomdatta1 commented May 17, 2024

cc @MusikAnimal (since I can't add you as a reviewer like in Gerrit)

@theresnotime theresnotime merged commit a39ea80 into wikimedia:master May 17, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants