cloapi

Documentation

Overview

Package cloapi provides an OpenAPI specced primitives.

Index

• func DecorateSchemaTmpl(doc *openapi3.T) error
• func ExecuteSchemaTmpl(src []byte, depl SchemaDeployment) (string, [32]byte, error)
• func LoadSchemaTmpl(file []byte) (*openapi3.T, error)
• type SchemaDeployment

Functions

func DecorateSchemaTmpl

func DecorateSchemaTmpl(doc *openapi3.T) error

DecorateSchemaTmpl will add project specific extensions and output it as go template file that needs to be executed to fill in deploy-time values.

func ExecuteSchemaTmpl

func ExecuteSchemaTmpl(src []byte, depl SchemaDeployment) (string, [32]byte, error)

ExecuteSchemaTmpl executes the schema template file using deployment parameters. It retrurns any error and the hash of the template src so it can be used for content-based versioning.

func LoadSchemaTmpl

func LoadSchemaTmpl(file []byte) (*openapi3.T, error)

LoadSchemaTmpl will parse the OpenAPI3 schema.

Types

type SchemaDeployment

type SchemaDeployment struct {
	Title                  string
	Description            string
	AwsProxyIntegrationURI string
	AwsAuthorizerURI       string
}

SchemaDeployment describes the data necessary to deploy the schema from its template.