endpoint

Documentation

Index

• func Builder() *builder
• type Endpoint
  • func New() *Endpoint
  • func (ep *Endpoint) HasParameter(name string) bool
  • func (ep *Endpoint) InitPathParameters() error
• type List
  • func NewList() *List
  • func (list *List) Append(ep *Endpoint)
  • func (list *List) AppendNew() *Endpoint
  • func (list *List) Len() int
  • func (list *List) ToIndentedJson() ([]byte, error)
  • func (list *List) ToJson() ([]byte, error)
  • func (list *List) ToSlice() []*Endpoint

Functions

func Builder

func Builder() *builder

Types

type Endpoint

type Endpoint struct {
	Path           string   `json:"path"`
	Verbs          []string `json:"verbs"`
	PathParameters []string `json:"pathParameters"`
	Description    string   `json:"description"`
}

Copyright © 2021 Remco Schoeman <remco.schoeman@logiqs.nl>

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

func New

func New() *Endpoint

func (*Endpoint) HasParameter

func (ep *Endpoint) HasParameter(name string) bool

func (*Endpoint) InitPathParameters

func (ep *Endpoint) InitPathParameters() error

InitPathParameters clears the PathParameters fields, and repopulates it from '{param}' parameter declarations in the Path field.

type List

type List struct {
	// contains filtered or unexported fields
}

func NewList

func NewList() *List

func (*List) Append

func (list *List) Append(ep *Endpoint)

func (*List) AppendNew

func (list *List) AppendNew() *Endpoint

func (*List) Len

func (list *List) Len() int

func (*List) ToIndentedJson

func (list *List) ToIndentedJson() ([]byte, error)

func (*List) ToJson

func (list *List) ToJson() ([]byte, error)

func (*List) ToSlice

func (list *List) ToSlice() []*Endpoint