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

fix(resource): allow empty string as query param value #745

Merged
merged 2 commits into from
Oct 6, 2023

Conversation

gdostie
Copy link
Contributor

@gdostie gdostie commented Sep 29, 2023

Making a few corrections to the Search API calls to /document and /html endpoints:

  • Added missing query parameters on getDocument (they were missing on the swagger doc as well, see SEARCHAPI-8913)
  • Allow to pass in the empty pipeline as parameter to getDocument (previously empty string query params we're removed so it was not possible)
  • Use POST endpoint for previewHTML instead of GET. Allows to pass in the full rest parameters in the body, which unlocks all the available features of this endpoint.

I also cleaned up the interfaces a bit by declaring a shared params interface and reusing it where possible. This way we avoid having to repeat the lengthy jsdocs everywhere. Still not perfect, but now we have a few repetitions less 🤷

Acceptance Criteria

  • My changes are publicly available, documented, and deployed in production. (i.e. on Swagger)
    Soon (see SEARCHAPI-8913)
  • JSDoc annotates each property added in the exported interfaces
  • The proposed changes are covered by unit tests
  • Commits containing breaking changes a properly identified as such
  • README.md is adjusted to reflect the proposed changes (if relevant)
  • My merge commit message will be conventional (See Conventional Commit)

@gdostie gdostie force-pushed the ADUI-9249/allow-empty-string-query-params branch 4 times, most recently from de4752d to b71c490 Compare September 29, 2023 15:43
@gdostie gdostie marked this pull request as ready for review September 29, 2023 15:45
@gdostie gdostie requested a review from a team September 29, 2023 15:45
@gdostie gdostie requested a review from a team as a code owner September 29, 2023 15:45
@gdostie gdostie force-pushed the ADUI-9249/allow-empty-string-query-params branch from b71c490 to 5e6a662 Compare September 29, 2023 15:55
@gdostie gdostie enabled auto-merge (squash) October 6, 2023 13:43
@gdostie gdostie merged commit 4b39e9e into master Oct 6, 2023
@gdostie gdostie deleted the ADUI-9249/allow-empty-string-query-params branch October 6, 2023 13:46
@github-actions
Copy link

github-actions bot commented Oct 6, 2023

🎉 This PR is included in version 47.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants