ruby-grape / ruby-grape/grape-swagger

The generated swagger_doc.json filename is malformatted.

Open
#870 0 comments 3 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

See https://github.com/ruby-grape/grape-swagger/pull/869 for proposed tests and how they fail.

Basically, running rake oapi:fetch generates a file called swagger_doc_swagger_doc.json and does not honor any API versions as intended by https://github.com/ruby-grape/grape-swagger/pull/846

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

Start with the proposed tests and failures in pull request #869, then inspect the behavior of rake oapi:fetch and the API-version intent described in pull request #846. Done means the generated file is named swagger_doc.json rather than swagger_doc_swagger_doc.json and honors API versions as intended.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.