AshOaskit.Generators.Shared (AshOasKit v0.4.1)

View Source

Compatibility entry point for the shared generator. See AshOaskit.Generators.Generator.generate/2.

Summary

Types

opts()
version()

Functions

generate(domains, opts)

Generate an OpenAPI specification from the given domains.

Types

opts()

@type opts() :: keyword()

version()

@type version() :: String.t()

Functions

generate(domains, opts)

@spec generate([module()], opts()) :: map()

Generate an OpenAPI specification from the given domains.

Delegates to AshOaskit.Generators.Generator.generate/2.

Options

  • :version - OpenAPI version ("3.0" or "3.1")
  • :title - API title
  • :api_version - API version string
  • :description - API description
  • :terms_of_service - Terms of service URL
  • :contact - Contact information map
  • :license - License information map
  • :servers - List of server URLs or server objects
  • :security - Security requirements