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(specs): add type: object to 3 schemas #4392

Merged
merged 4 commits into from
Jan 23, 2025
Merged

fix(specs): add type: object to 3 schemas #4392

merged 4 commits into from
Jan 23, 2025

Conversation

kai687
Copy link
Contributor

@kai687 kai687 commented Jan 23, 2025

🧭 What and Why

I found some schemas without specified type property.
3 of them are type: object which is probably implied since they had the properties: field.
1 schema didn't have a type defined which made it type: any but it should be a string.
This helps with me rendering method parameters etc.

🎟 JIRA Ticket:

Changes included:

Search API

Added type: object to:

  • standardEntries
  • userData
  • source

(was implied before since all of them had properties)

Recommend API

Added type: string to:

  • facetName

(was unspecified before and rendered in the docs as type: any).

Explicit is better than implicit, so this commit adds `type: object`
to 3 schemas standardEntries, userData, and source.
@algolia-bot
Copy link
Collaborator

algolia-bot commented Jan 23, 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 d9402b6014781d8665fd7c5fcd9c287f3a9cb841
🍃 Generated commit c9d047aba164ebbb515de8b741559e08110fb001
🌲 Generated branch generated/fix/specs/type
📊 Benchmark results

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

Language Req/s
javascript 1665
go 1643
php 1481
csharp 1412
java 1085
python 1063
ruby 817
swift 753

@kai687 kai687 marked this pull request as ready for review January 23, 2025 12:31
@kai687 kai687 requested a review from a team as a code owner January 23, 2025 12:31
@kai687 kai687 requested review from millotp and shortcuts January 23, 2025 12:31
@kai687 kai687 marked this pull request as draft January 23, 2025 12:33
@kai687
Copy link
Contributor Author

kai687 commented Jan 23, 2025

Found more in other APIs... actually only Recommend API.

@kai687 kai687 marked this pull request as ready for review January 23, 2025 12:50
Copy link
Collaborator

@millotp millotp left a comment

Choose a reason for hiding this comment

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

thanks !

@millotp millotp merged commit 872a965 into main Jan 23, 2025
29 checks passed
@millotp millotp deleted the fix/specs/type branch January 23, 2025 13:56
algolia-bot added a commit that referenced this pull request Jan 23, 2025
algolia-bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Jan 23, 2025
algolia-bot added a commit to algolia/algoliasearch-client-dart that referenced this pull request Jan 23, 2025
algolia-bot added a commit to algolia/algoliasearch-client-go that referenced this pull request Jan 23, 2025
algolia-bot added a commit to algolia/algoliasearch-client-java that referenced this pull request Jan 23, 2025
algolia-bot added a commit to algolia/algoliasearch-client-javascript that referenced this pull request Jan 23, 2025
algolia-bot added a commit to algolia/algoliasearch-client-kotlin that referenced this pull request Jan 23, 2025
algolia-bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Jan 23, 2025
algolia-bot added a commit to algolia/algoliasearch-client-python that referenced this pull request Jan 23, 2025
algolia-bot added a commit to algolia/algoliasearch-client-ruby that referenced this pull request Jan 23, 2025
algolia-bot added a commit to algolia/algoliasearch-client-scala that referenced this pull request Jan 23, 2025
algolia-bot added a commit to algolia/algoliasearch-client-swift that referenced this pull request Jan 23, 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