Define part of a request schema with a raw json schema

[lud-wj]

Hello,

For some route, I accept a body where one of the properties should comply to a JSON schema that is generated at compile time and will change over time. Is there a way to use a raw JSON string or a raw map as a schema in the operation call?

I have this error:

Must be one of:

- schema module, or schema struct
- list of schema modules, or schema structs
- boolean
- nil
- reference

Is there a way to achieve that?

Thanks!

[zorbash]

Hi @lud-wj please see this example

An option is to do something like:

alias OpenApiSpex.{Operation, Reference}

@index_operation struct(Operation, Jason.decode!(Application.compile_env(:my_app, :index_operation)))
def index_operation() do
  %Operation{
    tags: ["users"],
    summary: "List users",
    description: "List all useres",
    operationId: "UserController.index",
    responses: %{
      200 => response("User List Response", "application/json", Schemas.UsersResponse),
      422 => %Reference{"$ref": "#/components/responses/unprocessable_entity"}
    }
  }
end

[lud-wj]

Hello, thanks but I do not understand, you do not use the @index_operation attribute below. Is it automaticaly registered or something like that?

[zorbash]

@lud-wj The module attribute is not automatically registered. I put it there assuming you're already doing something similar for "should comply to a JSON schema that is generated at compile time".

[lud-wj]

I do something similar indeed, but that schema is only the request body schema.

I am not sure I can have a full operation as json, because the request body definition is a tuple:

request_body: {"User params", "application/json", SomeModule}

Sure, I can transform the json data to get an operation struct in the end, but there will not be a SomeModule, only a JSON schema. :request_body wants a OpenApiSpex.Schema though, and what I am looking for is a way to get just that from a raw JSON schema. Basically OpenApiSpex.Schema.from_json(Jason.decode!(json)). But I did not find from_json or anything alike.

I feel like :request_body should accept a valid JSON schema, not only an OpenApiSpex.Schema struct or module, don't you think?

[zorbash]

I can't find a way to load a schema from JSON.

Have you considered having any such JSON schemas in a complete OpenAPI spec file which only defines schemas and load it using OpenApiSpex.OpenApi.from_map(Jason.decode(open_api_schema))?

Also might be worth looking what OperationBuilder and RequestBody to overcome the tuple obstacle.

[lud-wj]

Well we want to use the library as usual, except for this route, so I do not feel like having everything in a normalized map.

And I guess the builder will have the same error as above.

Nevermind, I'll have to make a raw-json-to-OpenApiSpex.Schema transformer. Should be quick. Might as well open a PR with that.