package
0.26.33
Repository: https://github.com/openziti/edge-api.git
Documentation: pkg.go.dev

# Functions

NewDetailSpec creates a new http.Handler for the detail spec operation.
NewDetailSpecBody creates a new http.Handler for the detail spec body operation.
NewDetailSpecBodyOK creates DetailSpecBodyOK with default headers values.
NewDetailSpecBodyParams creates a new DetailSpecBodyParams object There are no default values defined in the spec.
NewDetailSpecOK creates DetailSpecOK with default headers values.
NewDetailSpecParams creates a new DetailSpecParams object There are no default values defined in the spec.
NewListEnumeratedCapabilities creates a new http.Handler for the list enumerated capabilities operation.
NewListEnumeratedCapabilitiesOK creates ListEnumeratedCapabilitiesOK with default headers values.
NewListEnumeratedCapabilitiesParams creates a new ListEnumeratedCapabilitiesParams object There are no default values defined in the spec.
NewListRoot creates a new http.Handler for the list root operation.
NewListRootOK creates ListRootOK with default headers values.
NewListRootParams creates a new ListRootParams object There are no default values defined in the spec.
NewListSpecs creates a new http.Handler for the list specs operation.
NewListSpecsOK creates ListSpecsOK with default headers values.
NewListSpecsParams creates a new ListSpecsParams object There are no default values defined in the spec.
NewListSummary creates a new http.Handler for the list summary operation.
NewListSummaryOK creates ListSummaryOK with default headers values.
NewListSummaryParams creates a new ListSummaryParams object There are no default values defined in the spec.
NewListSummaryTooManyRequests creates ListSummaryTooManyRequests with default headers values.
NewListSummaryUnauthorized creates ListSummaryUnauthorized with default headers values.
NewListVersion creates a new http.Handler for the list version operation.
NewListVersionOK creates ListVersionOK with default headers values.
NewListVersionParams creates a new ListVersionParams object There are no default values defined in the spec.

# Constants

DetailSpecBodyOKCode is the HTTP code returned for type DetailSpecBodyOK.
DetailSpecOKCode is the HTTP code returned for type DetailSpecOK.
ListEnumeratedCapabilitiesOKCode is the HTTP code returned for type ListEnumeratedCapabilitiesOK.
ListRootOKCode is the HTTP code returned for type ListRootOK.
ListSpecsOKCode is the HTTP code returned for type ListSpecsOK.
ListSummaryOKCode is the HTTP code returned for type ListSummaryOK.
ListSummaryTooManyRequestsCode is the HTTP code returned for type ListSummaryTooManyRequests.
ListSummaryUnauthorizedCode is the HTTP code returned for type ListSummaryUnauthorized.
ListVersionOKCode is the HTTP code returned for type ListVersionOK.

# Structs

DetailSpec swagger:route GET /specs/{id} Informational detailSpec Return a single spec resource Returns single spec resource embedded within the controller for consumption/documentation/code geneartion */.
DetailSpecBody swagger:route GET /specs/{id}/spec Informational detailSpecBody Returns the spec's file Return the body of the specification (i.e.
DetailSpecBodyOK Returns the document that represents the specification swagger:response detailSpecBodyOK */.
DetailSpecBodyParams contains all the bound params for the detail spec body operation typically these are obtained from a http.Request swagger:parameters detailSpecBody.
DetailSpecBodyURL generates an URL for the detail spec body operation.
DetailSpecOK A single specification swagger:response detailSpecOK */.
DetailSpecParams contains all the bound params for the detail spec operation typically these are obtained from a http.Request swagger:parameters detailSpec.
DetailSpecURL generates an URL for the detail spec operation.
ListEnumeratedCapabilities swagger:route GET /enumerated-capabilities Informational listEnumeratedCapabilities Returns all capabilities this version of the controller is aware of, enabled or not.
ListEnumeratedCapabilitiesOK A typed and enumerated list of capabilities swagger:response listEnumeratedCapabilitiesOK */.
ListEnumeratedCapabilitiesParams contains all the bound params for the list enumerated capabilities operation typically these are obtained from a http.Request swagger:parameters listEnumeratedCapabilities.
ListEnumeratedCapabilitiesURL generates an URL for the list enumerated capabilities operation.
ListRoot swagger:route GET / Informational listRoot Returns version information */.
ListRootOK Version information for the controller swagger:response listRootOK */.
ListRootParams contains all the bound params for the list root operation typically these are obtained from a http.Request swagger:parameters listRoot.
ListRootURL generates an URL for the list root operation.
ListSpecs swagger:route GET /specs Informational listSpecs Returns a list of API specs Returns a list of spec files embedded within the controller for consumption/documentation/code geneartion */.
ListSpecsOK A list of specifications swagger:response listSpecsOK */.
ListSpecsParams contains all the bound params for the list specs operation typically these are obtained from a http.Request swagger:parameters listSpecs.
ListSpecsURL generates an URL for the list specs operation.
ListSummary swagger:route GET /summary Informational listSummary Returns a list of accessible resource counts This endpoint is usefull for UIs that wish to display UI elements with counts.
ListSummaryOK Entity counts scopped to the current identitie's access swagger:response listSummaryOK */.
ListSummaryParams contains all the bound params for the list summary operation typically these are obtained from a http.Request swagger:parameters listSummary.
ListSummaryTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listSummaryTooManyRequests */.
ListSummaryUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listSummaryUnauthorized */.
ListSummaryURL generates an URL for the list summary operation.
ListVersion swagger:route GET /version Informational listVersion Returns version information */.
ListVersionOK Version information for the controller swagger:response listVersionOK */.
ListVersionParams contains all the bound params for the list version operation typically these are obtained from a http.Request swagger:parameters listVersion.
ListVersionURL generates an URL for the list version operation.

# Interfaces

DetailSpecBodyHandler interface for that can handle valid detail spec body params.
DetailSpecHandler interface for that can handle valid detail spec params.
ListEnumeratedCapabilitiesHandler interface for that can handle valid list enumerated capabilities params.
ListRootHandler interface for that can handle valid list root params.
ListSpecsHandler interface for that can handle valid list specs params.
ListSummaryHandler interface for that can handle valid list summary params.
ListVersionHandler interface for that can handle valid list version params.

# Type aliases

DetailSpecBodyHandlerFunc turns a function with the right signature into a detail spec body handler.
DetailSpecHandlerFunc turns a function with the right signature into a detail spec handler.
ListEnumeratedCapabilitiesHandlerFunc turns a function with the right signature into a list enumerated capabilities handler.
ListRootHandlerFunc turns a function with the right signature into a list root handler.
ListSpecsHandlerFunc turns a function with the right signature into a list specs handler.
ListSummaryHandlerFunc turns a function with the right signature into a list summary handler.
ListVersionHandlerFunc turns a function with the right signature into a list version handler.