Skip to content

fix(specs): Increase optionalWords visibility in docs #4559

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

Merged
merged 1 commit into from
Mar 5, 2025

Conversation

gazconroy
Copy link
Contributor

🧭 What and Why

🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DOC-1573

Changes included:

In common/schemas/IndexSettings, moved the description text from optionalWordsArray to optionalWords so that it’s visible when rendered by tools that are challenged by descriptions in oneOf (most of them)

Also updated:

  • In search/paths/advanced/getLogs, format of url should be uri-reference since that allows relative URLs
  • In search/paths/advanced/getLogs, maximum length of answer is 1,000 characters but the provided example was over 1,400 characters long
  • In common/schemas/CustomRequest, corrected a small typo

@gazconroy gazconroy requested a review from a team as a code owner March 4, 2025 15:10
@gazconroy gazconroy requested review from morganleroi and Fluf22 March 4, 2025 15:10
@algolia-bot
Copy link
Collaborator

algolia-bot commented Mar 4, 2025

💥 Breaking changes detected !!

Either this PR or a previous PR not released yet introduced breaking changes, be careful when merging.
You can find the details in the 'client java@17' CI job.

✔️ Code generated!

Name Link
🪓 Triggered by 89c6dd968cf4170116df923d374814379b5999a9
🍃 Generated commit 0fd6f72816904a22878030d1c0efc51712c25988
🌲 Generated branch generated/fix/search-optionalWords
📊 Benchmark results

Benchmarks performed on the method using a mock server, the results might not reflect the real-world performance.

Language Req/s
javascript 1659
go 1577
php 1435
csharp 1293
java 1088
python 1079
ruby 845
swift 338
scala 23

@gazconroy gazconroy requested a review from kai687 March 4, 2025 15:14
Copy link
Member

@shortcuts shortcuts left a comment

Choose a reason for hiding this comment

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

wonderful

@shortcuts
Copy link
Member

should I wait for @kai687 's review or can I merge?

@gazconroy
Copy link
Contributor Author

gazconroy commented Mar 5, 2025

@shortcuts Please merge. I just pinged Kai as an FYI. However, that "breaking changes" message is a little alarming!

@shortcuts
Copy link
Member

@shortcuts Please merge. I just pinged Kai as an FYI. However, that "breaking changes" message is a little alarming!

No worries on the breaking change message, it was for a previous PR!

@shortcuts shortcuts merged commit 97d2722 into main Mar 5, 2025
28 checks passed
@shortcuts shortcuts deleted the fix/search-optionalWords branch March 5, 2025 10:03
algolia-bot added a commit that referenced this pull request Mar 5, 2025
algolia-bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Mar 5, 2025
algolia-bot added a commit to algolia/algoliasearch-client-dart that referenced this pull request Mar 5, 2025
algolia-bot added a commit to algolia/algoliasearch-client-go that referenced this pull request Mar 5, 2025
algolia-bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Mar 5, 2025
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Mar 5, 2025
algolia-bot added a commit to algolia/algoliasearch-client-kotlin that referenced this pull request Mar 5, 2025
algolia-bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Mar 5, 2025
algolia-bot added a commit to algolia/algoliasearch-client-python that referenced this pull request Mar 5, 2025
algolia-bot added a commit to algolia/algoliasearch-client-ruby that referenced this pull request Mar 5, 2025
algolia-bot added a commit to algolia/algoliasearch-client-scala that referenced this pull request Mar 5, 2025
algolia-bot added a commit to algolia/algoliasearch-client-swift that referenced this pull request Mar 5, 2025
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.

3 participants