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

✨ [OpenAPI] Improve OpenAPI Specification for New Authorization Endpoint #4209

Merged
merged 1 commit into from
Mar 4, 2025

Conversation

MDeLuise
Copy link
Contributor

@MDeLuise MDeLuise commented Mar 4, 2025

Summary

This pull request enhances the OpenAPI specification for the newly implemented authorization endpoint. The updates include a detailed explanation of the claim response object and the addition of example responses to improve clarity and usability for developers.

Changes Made

  • Enhanced Documentation: Improved the explanation of the claim response object to provide better context and understanding for users.
  • Added Example Responses: Included example responses for the authorization endpoint to illustrate the expected output and structure, making it easier for developers to implement and test their integrations.

Benefits

These improvements aim to:

  • Provide clearer guidance on how to interact with the authorization endpoint.
  • Facilitate a smoother integration process for developers by offering concrete examples.
  • Enhance overall API usability and developer experience.

@MDeLuise MDeLuise force-pushed the doc-missingExampleOpenApi branch from c49488b to a753097 Compare March 4, 2025 14:40
@Coduz Coduz added Enhancement This PR/Issue improves an part of Kapua Documentation Doc... What?? Joke! We will write some! labels Mar 4, 2025
@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

@Coduz Coduz merged commit 2d1fe3a into eclipse-kapua:develop Mar 4, 2025
28 checks passed
@MDeLuise MDeLuise deleted the doc-missingExampleOpenApi branch March 4, 2025 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Doc... What?? Joke! We will write some! Enhancement This PR/Issue improves an part of Kapua
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants