Skip to content

Conversation

@kai687
Copy link
Contributor

@kai687 kai687 commented Nov 17, 2025

🧭 What and Why

OpenAPI 3.1 allows for a summary field in the info object.
This makes it easier to render documentation from the specs, since I can use the summary directly.

🎟 JIRA Ticket:

Changes included:

  • Moves the first sentences from openapi.info.description to openapi.info.summary.

🧪 Test

@algolia-bot
Copy link
Collaborator

algolia-bot commented Nov 17, 2025

✔️ Code generated!

Name Link
🪓 Triggered by fe8f8ea37ec6e22ce6029d827695c6b00d13141f
🍃 Generated commit 64b763ee76ba3a8baec3c4aa2de9d399f3f1050f
🌲 Generated branch generated/fix/use-summary-field
📊 Benchmark results

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

Language Req/s
javascript 2398
go 2336
php 1966
csharp 1560
python 1382
java 1164
ruby 888
swift 836
scala 23

@kai687
Copy link
Contributor Author

kai687 commented Nov 17, 2025

So, this page seems to be wrong: https://api-clients-automation.netlify.app/docs/add-a-new-api/write-a-specification

The spec validation is surprised by the openapi.info.summary field which is valid in OpenAPI 3.1.

@kai687 kai687 marked this pull request as ready for review November 20, 2025 11:26
@kai687 kai687 requested a review from a team as a code owner November 20, 2025 11:26
@kai687 kai687 requested review from millotp and shortcuts November 20, 2025 11:26
@shortcuts shortcuts merged commit c286dce into main Nov 20, 2025
62 of 64 checks passed
@shortcuts shortcuts deleted the fix/use-summary-field branch November 20, 2025 12:24
algolia-bot added a commit that referenced this pull request Nov 20, 2025
Co-authored-by: Kai Welke <kai.welke@algolia.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-csharp that referenced this pull request Nov 20, 2025
algolia/api-clients-automation#5645

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-php that referenced this pull request Nov 20, 2025
algolia/api-clients-automation#5645

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
algolia-bot added a commit to algolia/algoliasearch-client-scala that referenced this pull request Nov 20, 2025
algolia/api-clients-automation#5645

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Kai Welke <kai.welke@algolia.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
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.

5 participants