Skip to content

Document Swagger metadata with the existing Representable parser - #47

Merged
dblock merged 1 commit into
ruby-grape:masterfrom
dblock:docs/swagger-representers-4
Oct 27, 2026
Merged

dblock merged 1 commit into
ruby-grape:masterfrom
dblock:docs/swagger-representers-4

Conversation

@dblock

@dblock dblock commented Oct 27, 2026 •

Copy link
Copy Markdown
Member

Fixes #4.

Document optional grape-swagger-representable response schemas for Roar decorator classes. Put property types and descriptions in documentation:, register the parser before adding Swagger routes, and use the same product representer for the response and schema. Use product-oriented example names (ProductRepresenter, ProductsAPI), explain parser/module limitations, and distinguish response documentation from request validation.

Verified the exact README example with Grape 4.0.1, grape-swagger 2.2.0, and grape-swagger-representable 0.2.2: fetch the Swagger document before rendering any resource, assert its model reference and field types/descriptions, then verify the actual HTTP response. No duplicate parser or mandatory dependency changes.

Fix MongoDB 8.0 service startup failures on Linux 6.19+ by selecting Ubuntu 22.04 for those four matrix entries. Keep all seven Ruby/Mongoid/MongoDB/Grape combinations and coverage flags unchanged; other jobs retain their existing runners. Document the kernel restriction and runner selection.

AI-authored on behalf of @dblock.

@github-actions

github-actions Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

Danger Report

No issues found.

View run

@dblock
dblock force-pushed the docs/swagger-representers-4 branch from 9115180 to 8852539 Compare October 27, 2026 10:34
@dblock
dblock force-pushed the docs/swagger-representers-4 branch from 8852539 to b0f3d70 Compare October 27, 2026 11:27
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@dblock
dblock force-pushed the docs/swagger-representers-4 branch from b0f3d70 to 477d1c4 Compare October 27, 2026 11:33
@dblock
dblock merged commit b2cd30a into ruby-grape:master Oct 27, 2026
26 checks passed
@dblock
dblock deleted the docs/swagger-representers-4 branch October 27, 2026 11:36
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.

Add support for documentation fields

1 participant