Skip to content

feat(event-handler): add description to request body in OpenAPI schema #3548

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
Merged
merged 1 commit into from
Dec 21, 2023
Merged

feat(event-handler): add description to request body in OpenAPI schema #3548

merged 1 commit into from
Dec 21, 2023

Conversation

rubenfonseca
Copy link
Contributor

@rubenfonseca rubenfonseca commented Dec 21, 2023 •
edited
Loading

Issue number: #3539

Summary

Changes

Please provide a summary of what's being changed

This PR adds support to expose the request body description directly on OpenAPI.

User experience

Please share what the user experience looks like before and after this change

Before this PR, certain API browsers like Redoc would fail to render the body description, even though it was part of the schema. After this change, we duplicate the body description on a higher level (still part of the OpenAPI specification) and that fixes the problem with Redoc.

image

Checklist

If your change doesn't seem to apply, please leave them unchecked.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

@rubenfonseca rubenfonseca requested a review from a team December 21, 2023 13:49
@pull-request-size pull-request-size bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Dec 21, 2023
@rubenfonseca rubenfonseca linked an issue Dec 21, 2023 that may be closed by this pull request
Bug: openAPI generation - operation requestBody description only on schema output, not at higher level needed for html #3539
Closed
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

leandrodamascena
leandrodamascena approved these changes Dec 21, 2023
View reviewed changes
Copy link
Contributor

@leandrodamascena leandrodamascena left a comment

Choose a reason for hiding this comment

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

APPROVED!

@leandrodamascena leandrodamascena changed the title feat(event-handler): add description to request body feat(event-handler): add description to request body in OpenAPI schema Dec 21, 2023
@rubenfonseca rubenfonseca merged commit 4f7fadb into develop Dec 21, 2023
@rubenfonseca rubenfonseca deleted the rf/openapi-request-body branch December 21, 2023 14:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leandrodamascena leandrodamascena leandrodamascena approved these changes

Assignees
No one assigned
Labels
event_handlers size/S Denotes a PR that changes 10-29 lines, ignoring generated files. tests
Projects
None yet
Milestone
No milestone
2 participants
@rubenfonseca @leandrodamascena