documentationpart

Documentation

Index

• type Location
  • func (strct *Location) MarshalJSON() ([]byte, error)
  • func (strct *Location) UnmarshalJSON(b []byte) error
• type Resource
  • func (strct *Resource) MarshalJSON() ([]byte, error)
  • func (strct *Resource) UnmarshalJSON(b []byte) error

Types

type Location

type Location struct {

	// The HTTP verb of a method.
	Method string `json:"Method,omitempty"`

	// The name of the targeted API entity.
	Name string `json:"Name,omitempty"`

	// The URL path of the target.
	Path string `json:"Path,omitempty"`

	// The HTTP status code of a response.
	StatusCode string `json:"StatusCode,omitempty"`

	// The type of API entity that the documentation content applies to.
	Type string `json:"Type,omitempty"`
}

Location

func (*Location) MarshalJSON

func (strct *Location) MarshalJSON() ([]byte, error)

func (*Location) UnmarshalJSON

func (strct *Location) UnmarshalJSON(b []byte) error

type Resource

type Resource struct {

	// The identifier of the documentation Part.
	DocumentationPartId string `json:"DocumentationPartId,omitempty"`

	// The location of the API entity that the documentation applies to.
	Location *Location `json:"Location"`

	// The documentation content map of the targeted API entity.
	Properties string `json:"Properties"`

	// Identifier of the targeted API entity
	RestApiId string `json:"RestApiId"`
}

Resource Resource Type definition for AWS::ApiGateway::DocumentationPart

func (*Resource) MarshalJSON

func (strct *Resource) MarshalJSON() ([]byte, error)

func (*Resource) UnmarshalJSON

func (strct *Resource) UnmarshalJSON(b []byte) error