Issue/359

[zoten]

Issue #359

[mbuhot]

Looks like CI is complaining about formatting:

** (Mix) mix format failed due to --check-formatted.
The following files were not formatted:

* test/open_api/decode_yaml_test.exs
* test/cast_test.exs
* lib/open_api_spex/open_api/decode.ex

[zoten]

Thanks!
Please note that the 2 failing tests are there to highlight the second question in the referenced issue, I'll fix or remove them as you prefer if everything is ok. I think it is (otherwise messages with additionalProperties would risk to bomb the beam with atom consumption) but better to ask!

[moxley]

Can you fix the typo in the module name? Should be DecodeYamlTest

[moxley]

This test file looks like it's testing the OpenApiSpex.OpenApi.Decode module, and there is already a test file (DecodeTest) for it. Could you move them to the DecodeTest file?

The Decode module is agnostic to the original file format the api spec was stored in. I don't see a need to bring in the yamerl dependency. YAML and JSON parse to identical Elixir data structures.

[zoten]

Ok! I've been misleaded by reading the comment on DecodeTest about decomposing and testing also yaml, so I thought to put a skeleton for it, but you're totally right

[moxley]

It's probably better to move these tests to test/cast/object_test.exs. There is already a test there that does what this test is doing.

[zoten]

Thanks, didn't see it!
I'll move those two tests there, since it's not exactly what the other tests are doing: this is about resolving references (that is the main point of the issue), while the already present tests use schemas defined in-place, so I think at least the first is useful (the nested one may be overkill since normal schema resolution is already well tested?)

[moxley]

This is fine, but it's good practice to use map literal syntax to put key values on a struct, like this:

%{schema | additionalProperties: %Reference{"$ref": reference}}

That way, if there is a typo in additionalProperties:, the runtime will raise an exception.

Plus, the syntax is shorter.

[zoten]

I code in elixir since some months now and never realized this! Super thanks!

[moxley]

Thanks @zoten !!!