path

Documentation

Index

• type DeletePathInputs
  • func NewDeletePathInputs(cmd *cobra.Command) *DeletePathInputs
  • func (p *DeletePathInputs) ReadAll()
• type GetPathInputs
  • func NewGetPathInputs(cmd *cobra.Command) *GetPathInputs
  • func (p *GetPathInputs) ReadAll()
• type IPathInputs
• type PostPathInputs
  • func NewPostPathInputs(cmd *cobra.Command) *PostPathInputs
  • func (p *PostPathInputs) ReadAll()
• type PutPathInputs
  • func NewPutPathInputs(cmd *cobra.Command) *PutPathInputs
  • func (p *PutPathInputs) ReadAll()
• type RootPathInputs
  • func (p *RootPathInputs) GetDescription() string
  • func (p *RootPathInputs) GetFileName() string
  • func (p *RootPathInputs) GetOperationID() string
  • func (p *RootPathInputs) GetParameters() generate.Parameters
  • func (p *RootPathInputs) GetResponses() generate.Responses
  • func (p *RootPathInputs) GetSecurity() []string
  • func (p *RootPathInputs) GetSummary() string
  • func (p *RootPathInputs) GetTags() []string
  • func (p *RootPathInputs) ReadDescription()
  • func (p *RootPathInputs) ReadFileName()
  • func (p *RootPathInputs) ReadOperationID()
  • func (p *RootPathInputs) ReadParameters()
  • func (p *RootPathInputs) ReadResponses()
  • func (p *RootPathInputs) ReadSecurity()
  • func (p *RootPathInputs) ReadSummary()
  • func (p *RootPathInputs) ReadTags()
  • func (p *RootPathInputs) SetDescription(description string)
  • func (p *RootPathInputs) SetFileName(fileName string)
  • func (p *RootPathInputs) SetOperationID(operationID string)
  • func (p *RootPathInputs) SetParameters(parameters generate.Parameters)
  • func (p *RootPathInputs) SetResponses(responses generate.Responses)
  • func (p *RootPathInputs) SetSecurity(security []string)
  • func (p *RootPathInputs) SetSummary(summary string)
  • func (p *RootPathInputs) SetTags(tags []string)
• type WritePathInputs
  • func (p *WritePathInputs) GetRequestBody() generate.RequestBody
  • func (p *WritePathInputs) ReadRequestBody()
  • func (p *WritePathInputs) SetRequestBody(requestBody generate.RequestBody)

Types

type DeletePathInputs

type DeletePathInputs struct {
	WritePathInputs
}

func NewDeletePathInputs

func NewDeletePathInputs(cmd *cobra.Command) *DeletePathInputs

func (*DeletePathInputs) ReadAll

func (p *DeletePathInputs) ReadAll()

The ReadAll method reads all the input required to define an endpoint.

type GetPathInputs

type GetPathInputs struct {
	RootPathInputs
}

func NewGetPathInputs

func NewGetPathInputs(cmd *cobra.Command) *GetPathInputs

func (*GetPathInputs) ReadAll

func (p *GetPathInputs) ReadAll()

The ReadAll method reads all the input required to define an endpoint.

type IPathInputs

type IPathInputs interface {
	ReadAll()
}

type PostPathInputs

type PostPathInputs struct {
	WritePathInputs
}

func NewPostPathInputs

func NewPostPathInputs(cmd *cobra.Command) *PostPathInputs

func (*PostPathInputs) ReadAll

func (p *PostPathInputs) ReadAll()

The ReadAll method reads all the input required to define an endpoint.

type PutPathInputs

type PutPathInputs struct {
	WritePathInputs
}

func NewPutPathInputs

func NewPutPathInputs(cmd *cobra.Command) *PutPathInputs

func (*PutPathInputs) ReadAll

func (p *PutPathInputs) ReadAll()

The ReadAll method reads all the input required to define an endpoint.

type RootPathInputs

type RootPathInputs struct {
	Cmd         *cobra.Command
	FileName    string
	OperationID string
	Summary     string
	Description string
	Tags        []string
	Security    []string
	Parameters  generate.Parameters
	Responses   generate.Responses
}

func (*RootPathInputs) GetDescription

func (p *RootPathInputs) GetDescription() string

func (*RootPathInputs) GetFileName

func (p *RootPathInputs) GetFileName() string

func (*RootPathInputs) GetOperationID

func (p *RootPathInputs) GetOperationID() string

func (*RootPathInputs) GetParameters

func (p *RootPathInputs) GetParameters() generate.Parameters

func (*RootPathInputs) GetResponses

func (p *RootPathInputs) GetResponses() generate.Responses

func (*RootPathInputs) GetSecurity

func (p *RootPathInputs) GetSecurity() []string

func (*RootPathInputs) GetSummary

func (p *RootPathInputs) GetSummary() string

func (*RootPathInputs) GetTags

func (p *RootPathInputs) GetTags() []string

func (*RootPathInputs) ReadDescription

func (p *RootPathInputs) ReadDescription()

The ReadDescription method takes input from the CLI to define the description of the endpoint.

func (*RootPathInputs) ReadFileName

func (p *RootPathInputs) ReadFileName()

The ReadFileName method takes input from the CLI to define the file name for the endpoint.

func (*RootPathInputs) ReadOperationID

func (p *RootPathInputs) ReadOperationID()

The ReadOperationID method takes input from the CLI to define the operation ID for the endpoint.

func (*RootPathInputs) ReadParameters

func (p *RootPathInputs) ReadParameters()

The ReadParameter method takes input from the CLI to define URL parameters. It supports parameter definitions on the CLI as well as definitions in other files using Ref.

func (*RootPathInputs) ReadResponses

func (p *RootPathInputs) ReadResponses()

The ReadResponses method takes input to define the response generate returned by the endpoint for each response code. Currently, it only supports the Ref schema in Content Parameter, but we plan to support response type definitions on the CLI in the future.

func (*RootPathInputs) ReadSecurity

func (p *RootPathInputs) ReadSecurity()

The ReadSecurity method takes input from the CLI to define the security generate required for the endpoint. It supports multiple security generate.

func (*RootPathInputs) ReadSummary

func (p *RootPathInputs) ReadSummary()

The ReadSummary method takes input from the CLI to define a summary for the endpoint.

func (*RootPathInputs) ReadTags

func (p *RootPathInputs) ReadTags()

The ReadTags method takes input from the CLI to define tags for the endpoint. It supports multiple tags.

func (*RootPathInputs) SetDescription

func (p *RootPathInputs) SetDescription(description string)

func (*RootPathInputs) SetFileName

func (p *RootPathInputs) SetFileName(fileName string)

func (*RootPathInputs) SetOperationID

func (p *RootPathInputs) SetOperationID(operationID string)

func (*RootPathInputs) SetParameters

func (p *RootPathInputs) SetParameters(parameters generate.Parameters)

func (*RootPathInputs) SetResponses

func (p *RootPathInputs) SetResponses(responses generate.Responses)

func (*RootPathInputs) SetSecurity

func (p *RootPathInputs) SetSecurity(security []string)

func (*RootPathInputs) SetSummary

func (p *RootPathInputs) SetSummary(summary string)

func (*RootPathInputs) SetTags

func (p *RootPathInputs) SetTags(tags []string)

type WritePathInputs

type WritePathInputs struct {
	RootPathInputs
	RequestBody generate.RequestBody
}

func (*WritePathInputs) GetRequestBody

func (p *WritePathInputs) GetRequestBody() generate.RequestBody

func (*WritePathInputs) ReadRequestBody

func (p *WritePathInputs) ReadRequestBody()

The ReadRequestBody method takes input from the CLI to define the request body for the endpoint.

func (*WritePathInputs) SetRequestBody

func (p *WritePathInputs) SetRequestBody(requestBody generate.RequestBody)