ruby-grape / ruby-grape/grape-swagger

versioning with content negotiation

Open
#694 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
1.1k
Forks
479
Avg merge
2d 14h
Merged PRs (30d)
6

Description

Grape allows versioning with content negotiation, e.g.
vnd.vendor-and-or-resource-v1234+format
But grape-swagger doesn't seem to be able to use this. Can we add this or is this not something supported by swagger2?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review how grape-swagger currently handles versioning and compare the requested vendor media type format with Swagger 2.0 content-negotiation support. Done means determining whether the format is supported and, if so, documenting or implementing the required behavior with coverage for the example version string.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.