Latest OAS3.0 with latest from master branch of the original author #1
Conversation
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
…and remove duplicated parameters (generated by the path parameter search: RspecApiDocumentation::DSL.extract_route_parameters!)
…pen-api-parameters Fix: Issues zipmark#191 zipmark#402 and zipmark#403: Add example property and remove duplicated parameters
Remove unneeded default values
…nums-to-api-blueprint Add parameter/attribute defaults, enums and annotations for API Blueprint
…r-required Fix Open Api: issue with multiple required fields
…nt-api_template-explanation Fix zipmark#394 API Blueprint: Add api_explanation in template
When we use `config.disable_dsl_status!` than we can not `expect(status).to eq 200` but we can `expect(status_code).to_eq 200`
Add comment about response_status
Get rid of deprecated .should syntax in readme
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.
What is OAS3.0?
It is latest specification for Open API, which we use for documenting our APIs.
OAS3.0
Why do we need that?
As Open API 2.0 does not support JWT based Authentication on API docs.
We cannot try out the request on the Docs.
Also no point in delivering OAS2.0 when 3..0 is out and is drastically simpler and different from OAS2.0
What are we doing here
This is forked from [OAS3.0] (https://github.com/aadityataparia/rspec_api_documentation/tree/aadi/oas3) because we want to generate OAS3.0 base documentation.
but this is 22 commits behind the master branch from the original author.
Original project is https://github.com/zipmark/rspec_api_documentation.
The original author is not keen to merge the OAS3.0 work into his master.
So we forked from the OAS3.0 work done by a good samaritan and rebased that on top of the master branch of the original author. So we get latest update with OAS3.0