API Reference AshOasKit v#0.4.1

OpenAPI specification generator for Ash Framework domains.

Reads the Ash and AshJsonApi metadata used during spec generation.

Phoenix controller for serving OpenAPI specifications.

Conflict detection and stable operation identifiers for generated path maps.

Shared path and route string utilities.

Builds OpenAPI $ref objects pointing to component schemas.

Generates JSON:API compliant error response schemas for OpenAPI specs.

Builds OpenAPI filter schemas for Ash resources.

Main OpenAPI specification generator.

OpenAPI Info object and server configuration builder.

OpenAPI paths and operations builder.

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

Generates OpenAPI 3.0.3 documents. Prefer AshOaskit.spec(domains: domains, version: "3.0") for normalized output.

Generates OpenAPI 3.1.0 documents. Prefer AshOaskit.spec(domains: domains, version: "3.1") for normalized output.

Generates schemas for the included array in JSON:API responses.

Documents file uploads using AshJsonApi's multipart/x.ash+form-data protocol.

Generates and validates OpenAPI documents for Ash domains.

Behaviour for Phoenix controllers to provide OpenAPI metadata.

Extracts OpenAPI paths from Phoenix router for controllers implementing the AshOaskit.OpenApiController behaviour.

Generates detailed JSON:API query parameter schemas for OpenAPI specs.

Generates OpenAPI path operations for JSON:API relationship routes.

Operation builders for relationship routes.

Response schema builders for relationship routes.

Generates JSON:API resource identifier schemas for OpenAPI specifications.

Generates JSON:API response links schemas for OpenAPI specifications.

Generates JSON:API response meta schemas for OpenAPI specifications.

Collects AshJsonApi routes for a domain, including resource-level routes.

Router macro for serving OpenAPI specs with minimal configuration.

Plug for serving OpenAPI specifications via the Router macro.

Accumulator-based schema builder for recursive type handling.

Builds JSON:API resource objects and member/collection document components.

Embedded resource schema generation.

Property builders for attributes, calculations, and aggregates.

Relationship schema building for JSON:API responses.

Resource schema generation for JSON:API responses and inputs.

Adds null to a schema without discarding its constraints.

Generates OpenAPI security schemes and requirements for API specifications.

Builds OpenAPI sort parameter schemas for Ash resources.

Runtime support and behaviour for spec modules defined with use AshOaskit.

Behaviour for customizing OpenAPI spec generation.

Default AshOaskit.SpecBuilder implementation.

Provides support for modifying OpenAPI specifications after generation.

Builds OpenAPI tags for organizing operations in the specification.

Maps Ash types to JSON Schema types for OpenAPI 3.0 and 3.1.

Generate OpenAPI specification files from Ash domains.

Installs AshOaskit into your project.