spec

Documentation

Overview

Package spec contains types and functions used for parsing, and validating a Specification.

Index

• Constants
• Variables
• func Validate(ctx context.Context, document []byte) error
• type Request
• type RequestBody
• type RequestType
• type Requests
• type Specification
  • func Parse(ctx context.Context, document []byte) (Specification, error)
  • func (s Specification) Validate(ctx context.Context) error

Constants

const (
	Version0_1 = "0.1"
)

Variables

var (
	//go:embed v0.1/schema.json
	JSONSchemaVersion0_1 []byte
)

Functions

func Validate

func Validate(ctx context.Context, document []byte) error

Validate loads the schema version specified in the document, and validates the document.

Types

type Request

type Request struct {
	Create RequestType    `json:"create,omitempty"`
	Read   RequestType    `json:"read"`
	Update []*RequestType `json:"update"`
	Delete RequestType    `json:"delete"`
}

type RequestBody

type RequestBody struct {
	Name     string   `json:"name"`
	Required []string `json:"required"`
}

type RequestType

type RequestType struct {
	Parameters  []string     `json:"parameters,omitempty"`
	RequestBody *RequestBody `json:"request_body,omitempty"`
	Response    string       `json:"response,omitempty"`
}

type Requests

type Requests []Request

type Specification

type Specification struct {
	// DataSources defines a slice of datasource.DataSource type.
	DataSources datasource.DataSources `json:"datasources,omitempty"`

	// Provider defines an instance of the provider.Provider type.
	Provider *provider.Provider `json:"provider,omitempty"`

	// Resources defines a slice of resource.Resource type.
	Resources resource.Resources `json:"resources,omitempty"`

	// Request(Parameters, Body) struct for CRUD
	Requests Requests `json:"requests,omitempty"`

	// Version defines the Provider Code Specification JSON schema version
	Version string `json:"version,omitempty"`
}

Specification defines the data source(s), provider, and resource(s) for a Terraform provider.

func Parse

func Parse(ctx context.Context, document []byte) (Specification, error)

Parse returns a Specification from the JSON document contents, or any validation errors.

func (Specification) Validate

func (s Specification) Validate(ctx context.Context) error

Validate delegates validation to each of datasource.DataSources, *provider.Provider and resource.Resources.