Doc based specs fixes #224
Merged
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
Before: ``` ** (MatchError) no match of right hand side value: nil ``` After: ``` ** (RuntimeError) No docs found for function Elixir.SppWeb.Api.MessageController.indexb/2 ```
The shape of a response in the `@doc responses:` keyword-list/map was:
```elixir
{http_status, {description, mime_type, schema}}
```
A fourth element of the inner tuple was previously accepted (maybe it ignored?), but a recent
revision of OpenApiSpex made it a raised exception:
```
** (FunctionClauseError) no function clause matching in anonymous fn/1 in OpenApiSpex.Controller.build_responses/1
```
This commit change passes an optional forth element to the `opts` argument of `Operation.response/4`.
|
Looks like a dialyzer error coming from now that |
moxley
force-pushed
the
doc_based_specs_fixes
branch
from
d2ce695 to
2755daf
Compare
moxley
force-pushed
the
doc_based_specs_fixes
branch
from
2755daf to
2aa1641
Compare
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.
Fix #1
More informative exception when docs are missing for controller action
Before:
After:
Fix #2
Allow response spec to have 4th "opts" argument
The shape of a response in the
@doc responses:keyword-list/map was:A fourth element of the inner tuple was previously accepted (maybe it ignored?), but a recent
revision of OpenApiSpex made it a raised exception:
This commit change passes an optional fourth element to the
optsargument ofOperation.response/4.