Validates OpenAPI Specification on upload and redesigns spec entry #45
Conversation
This file contains 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
This will require users to enter specs a bit differently, since there is
a couple of problems with the way we're handling this at the moment:
Before
------
```
// Request body as JSON:
{ "spec": { "openapi": "3.0.0" } } // etc.
```
This will break under certain circumstances as param mapping will not
accept this in Phoenix (since server lists can be maps with multiple
keys). It also omits the whole "we know whether this is YAML or JSON at
runtime".
After
-----
```
// Request body as JSON:
{ "json": " {\"openapi\": \"3.0.0\"}" } // etc.
```
This allows for knowing what spec we're parsing and will also open up
other entrypoints more easily (e.g. fetching from a URL, uploading
directly etc.)
...or: how I figured out my editor at home is misconfigured
Pull Request Test Coverage Report for Build e734412cf822148dbb96ea1d3b2287972fedebfd-PR-45
💛 - Coveralls |
floriank
changed the title
asaaki
approved these changes
Oct 16, 2021
| @doc """ | ||
| parses a given string to a map | ||
| """ | ||
| @spec parse_to_map(any(), :yaml | :json) :: :error | any() |
There was a problem hiding this comment.
If the doc says string, shouldn't it be also in the spec?
Suggested change
| @spec parse_to_map(any(), :yaml | :json) :: :error | any() | |
| @spec parse_to_map(String.t(), :yaml | :json) :: :error | any() |
Comment on lines
-23
to
+25
| @spec parse(String.t(), :yaml | :json) :: Specification.t() | ||
| @spec parse(term(), :yaml | :json) :: Specification.t() |
There was a problem hiding this comment.
What's the reason for this spec change?
Also shouldn't parse/2 and parse_to_map/2 have the same definition for the inputs?
| """ | ||
| @spec parse(String.t(), :yaml | :json) :: Specification.t() | ||
| @spec parse(term(), :yaml | :json) :: Specification.t() | ||
| def parse(str, atom) do |
There was a problem hiding this comment.
I think this function could now be shortened to something like this:
def parse(str, atom) do
str
|> parse_to_map(atom)
|> case do
{:ok, decoded} ->
decoded |> build_specification()
{:error, _err} ->
Specification.unsupported()
end
end
Comment on lines
-41
to
+61
| @spec build_specification(map()) :: Specification.t() | ||
| @spec build_specification(any()) :: Specification.t() |
There was a problem hiding this comment.
Same question as above about spec changes.
| @@ -69,6 +69,7 @@ defmodule MimicryApi.ProxyControllerTest do | |||
| end | |||
|
|
|||
| @tag server: "simple.yaml" | |||
| @tag :focus | |||
There was a problem hiding this comment.
Probably a local test leftover?
Suggested change
| @tag :focus |
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.
This will require users to enter specs a bit differently, since there is
a couple of problems with the way we're handling this at the moment:
Before
This will break under certain circumstances as param mapping will not
accept this in Phoenix (since server lists can be maps with multiple
keys). It also omits the whole "we know whether this is YAML or JSON at
runtime".
After
This allows for knowing what spec we're parsing and will also open up
other entrypoints more easily (e.g. fetching from a URL, uploading
directly etc.)
Bonus
This now also validates the OpenAPI specification given using the https://github.com/mimicry-tech/openapi-validator.
Fixes #15