Repository navigation
Document optional Swagger response schemas - #59
Merged
Merged
Conversation
Danger ReportNo issues found. |
dblock
force-pushed
the
docs/swagger-integration-42
branch
from
October 27, 2026 02:39
4959fa7 to
863e385
Compare
|
coverage: 100.0%. remained the same — dblock:docs/swagger-integration-42 into ruby-grape:master |
Show documentation-only Entity schemas alongside Rabl rendering, including the response root envelope, parser loading, and the normal JSON fallback for Swagger endpoints. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
dblock
force-pushed
the
docs/swagger-integration-42
branch
from
October 27, 2026 09:59
863e385 to
0e2a46e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes
Document optional grape-swagger integration using documentation-only Entity response models while keeping Rabl rendering. Show explicit parser loading and a nested schema matching the template root envelope. Explain that Rabl templates, layouts, partials, and conditional fields do not automatically become static Swagger schemas. No runtime or dependency changes.
Validation
Executed the README configuration with a database-free User fixture and the local grape-rabl implementation. Verified both HTTP responses, the Swagger 2.0 endpoint response reference, the nested root-envelope model reference, and integer/string attribute types against the actual Rabl output.
Verified with Grape 4.0.1, grape-swagger 2.2.0, and grape-swagger-entity 0.7.1. Hosted CI and Danger pass.
Closes #42.
Created by Copilot, an AI, on behalf of @dblock.