Skip to main content Link Search Menu Expand Document (external link)
schema-openapi

OpenApiCompiler overview

Based on https://github.com/effect/schema/blob/0.1.0/test/compiler/JSONSchema.ts

Added in v1.0.0

Table of contents

utils

annotate

Signature

export declare const annotate: (
  spec: OpenAPISchemaType
) => <A, I, R>(self: Schema.Schema<A, I, R>) => Schema.Schema<A, I, R>

Added in v1.0.0

getOpenApiAnnotation

Signature

export declare const getOpenApiAnnotation: (ast: AST.Annotated) => Option.Option<OpenAPISchemaType>

Added in v1.0.0

openAPISchemaFor

Signature

export declare const openAPISchemaFor: <A>(
  schema: Schema.Schema<any, A, any>,
  componentSchemaCallback?: ComponentSchemaCallback
) => OpenAPISchemaType

Added in v1.0.0

openAPISchemaForAst

Signature

export declare const openAPISchemaForAst: (
  ast: AST.AST,
  componentSchemaCallback: ComponentSchemaCallback
) => OpenAPISchemaType

Added in v1.0.0