Packages

ex_open_api_utils

0.4.5
0.17.1 0.17.0 0.16.0 0.15.0 0.14.0 0.13.1 0.13.0 0.12.0 0.11.2 0.11.1 0.11.0 0.10.0 0.9.0 0.8.1 0.8.0 0.7.3 0.7.2 0.7.0 0.6.0 0.5.7 0.5.6 0.5.5 0.5.4 0.5.3 0.5.2 0.5.1 0.5.0 0.4.8 0.4.7 0.4.6 0.4.5 0.4.4 0.4.3 0.4.2 0.4.1 0.4.0 0.3.4 0.3.3 0.3.2 0.3.1 0.3.0 0.2.0 0.1.0

Elixir utilities for OpenAPI 3.1 schema generation from Ecto schemas

HexDocs

Current section

Files

Jump to
Readme
43 Versions
4 Dependencies
0 Dependants
Files
Activity
ex_open_api_utils lib ex_open_api_utils example tenant.ex
Raw

lib/ex_open_api_utils/example/tenant.ex 

defmodule ExOpenApiUtils.Example.Tenant do

  use ExOpenApiUtils

  use Ecto.Schema

  alias OpenApiSpex.Schema

  alias ExOpenApiUtils.Example.User



  schema("tenants") do

    open_api_property(

      schema: %Schema{

        type: :string,

        description: "The name of the tenant",

        minLength: 10,

        example: "organiztion"

      },

      key: :name

    )



    field(:name, :string)



    open_api_property(

      schema: %Schema{

        type: :array,

        description: "Users belonging to the tenant",

        items: ExOpenApiUtils.OpenApiSchema.UserResponse,

        example: [OpenApiSpex.Schema.example(ExOpenApiUtils.OpenApiSchema.UserResponse)],

        readOnly: true

      },

      key: :users

    )



    open_api_property(

      schema: %Schema{

        type: :array,

        description: "Users belonging to the tenant",

        items: ExOpenApiUtils.OpenApiSchema.UserRequest,

        example: [OpenApiSpex.Schema.example(ExOpenApiUtils.OpenApiSchema.UserRequest)],

        writeOnly: true

      },

      key: :users

    )



    has_many(:users, User, foreign_key: :owner_id)

  end



  open_api_schema(required: [:name], title: "Tenant", description: "The Tenant", tags: ["Tenant"])

end