openapi

Documentation

Index

• Constants
• func BoolPointer(v bool) *bool
• func StringPointer(v string) *string
• type ComponentsObject
• type InfoObject
• type MediaTypeObject
• type OpenAPI
  • func Generate(ctx context.Context, schema *proto.Schema, api *proto.Api) OpenAPI
  • func GenerateFlows(ctx context.Context, schema *proto.Schema) OpenAPI
  • func GenerateJob(ctx context.Context, schema *proto.Schema, jobName string) OpenAPI
  • func GenerateTasks(ctx context.Context, schema *proto.Schema) OpenAPI
• type OperationObject
• type ParameterObject
• type PathItemObject
• type RequestBodyObject
• type ResponseObject

Constants

const OpenApiSpecificationVersion = "3.1.0"

Functions

func BoolPointer

func BoolPointer(v bool) *bool

func StringPointer

func StringPointer(v string) *string

Types

type ComponentsObject

type ComponentsObject struct {
	Schemas map[string]jsonschema.JSONSchema `json:"schemas,omitempty"`
}

type InfoObject

type InfoObject struct {
	Title   string `json:"title"`
	Version string `json:"version"`
}

type MediaTypeObject

type MediaTypeObject struct {
	Schema jsonschema.JSONSchema `json:"schema,omitempty"`
}

type OpenAPI

type OpenAPI struct {
	OpenAPI    string                    `json:"openapi"`
	Info       InfoObject                `json:"info"`
	Paths      map[string]PathItemObject `json:"paths,omitempty"`
	Components *ComponentsObject         `json:"components,omitempty"`
}

OpenAPI spec object - https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md

func Generate

func Generate(ctx context.Context, schema *proto.Schema, api *proto.Api) OpenAPI

Generate creates an OpenAPI 3.1 spec for the passed api.

func GenerateFlows

func GenerateFlows(ctx context.Context, schema *proto.Schema) OpenAPI

GenerateFlows generates an openAPI schema for the Flows API for the given schema.

func GenerateJob

func GenerateJob(ctx context.Context, schema *proto.Schema, jobName string) OpenAPI

func GenerateTasks

func GenerateTasks(ctx context.Context, schema *proto.Schema) OpenAPI

GenerateTasks generates an openAPI schema for the Tasks API for the given schema.

type OperationObject

type OperationObject struct {
	OperationID *string                   `json:"operationId,omitempty"`
	RequestBody *RequestBodyObject        `json:"requestBody,omitempty"`
	Responses   map[string]ResponseObject `json:"responses,omitempty"`
}

type ParameterObject

type ParameterObject struct {
	Name        string                `json:"name"`
	In          string                `json:"in"`
	Required    bool                  `json:"required"`
	Description string                `json:"description"`
	Schema      jsonschema.JSONSchema `json:"schema"`
	Style       string                `json:"style,omitempty"`
	Explode     *bool                 `json:"explode,omitempty"`
}

type PathItemObject

type PathItemObject struct {
	Post       *OperationObject  `json:"post,omitempty"`
	Get        *OperationObject  `json:"get,omitempty"`
	Put        *OperationObject  `json:"put,omitempty"`
	Parameters []ParameterObject `json:"parameters,omitempty"`
}

type RequestBodyObject

type RequestBodyObject struct {
	Description string                     `json:"description"`
	Content     map[string]MediaTypeObject `json:"content,omitempty"`
	Required    *bool                      `json:"required,omitempty"`
}

type ResponseObject

type ResponseObject struct {
	Description string                     `json:"description"`
	Content     map[string]MediaTypeObject `json:"content,omitempty"`
}