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.

Sign up for GitHub

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

Jump to bottom

Splitting summary and description in OpenAPI output #2608

Merged
merged 9 commits into from
Jun 17, 2024
Merged

Splitting summary and description in OpenAPI output #2608

merged 9 commits into from
Jun 17, 2024

Conversation

l-trotta
Copy link
Contributor

@l-trotta l-trotta commented Jun 6, 2024

Requirements: summary should contain the first sentence of description, while description should contain the remaining phrases.

@l-trotta l-trotta marked this pull request as draft June 6, 2024 15:58
@l-trotta l-trotta requested a review from a team June 6, 2024 15:59
swallez
swallez requested changes Jun 7, 2024
View reviewed changes
Copy link
Member

@swallez swallez left a comment

Choose a reason for hiding this comment

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

I left lots of nitpicking comments to improve your Rust-fu 😉

compiler-rs/clients_schema_to_openapi/src/paths.rs Outdated Show resolved Hide resolved
compiler-rs/clients_schema_to_openapi/src/paths.rs Outdated Show resolved Hide resolved
compiler-rs/clients_schema_to_openapi/src/paths.rs Outdated Show resolved Hide resolved
compiler-rs/clients_schema_to_openapi/src/paths.rs Outdated Show resolved Hide resolved
compiler-rs/clients_schema_to_openapi/src/paths.rs Outdated Show resolved Hide resolved
Anaethelion
Anaethelion reviewed Jun 7, 2024
View reviewed changes
Copy link
Contributor

@Anaethelion Anaethelion left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Left some comments, looks cleaner with the segmenter.
Some of @swallez comments might still apply.

compiler-rs/clients_schema_to_openapi/src/paths.rs Show resolved Hide resolved
compiler-rs/clients_schema_to_openapi/src/paths.rs Show resolved Hide resolved
This was referenced Jun 12, 2024
Closed
Closed
swallez
swallez approved these changes Jun 17, 2024
View reviewed changes
Copy link
Member

@swallez swallez left a comment

Choose a reason for hiding this comment

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

LGTM once we handle the additional pathological case.

compiler-rs/clients_schema_to_openapi/src/paths.rs Show resolved Hide resolved
@l-trotta l-trotta marked this pull request as ready for review June 17, 2024 16:20
@l-trotta l-trotta merged commit 3120d62 into main Jun 17, 2024
8 checks passed
@l-trotta l-trotta deleted the better-summary-oapi branch June 17, 2024 17:09
flobernd pushed a commit that referenced this pull request Jun 18, 2024
@l-trotta @flobernd
Splitting summary and description in OpenAPI output (#2608)
a5126c4 
* test

* further test

* refactoring

* linter

* using segmenter to split sentences

* removing newlines + unit test

* comment

* handled specific case
@pquentin pquentin mentioned this pull request Aug 1, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Anaethelion Anaethelion Anaethelion left review comments

@swallez swallez swallez approved these changes

Assignees
No one assigned
Labels
compiler
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@l-trotta @swallez @Anaethelion