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

# Functions

NewCreateRouter creates a new http.Handler for the create router operation.
NewCreateRouterBadRequest creates CreateRouterBadRequest with default headers values.
NewCreateRouterCreated creates CreateRouterCreated with default headers values.
NewCreateRouterParams creates a new CreateRouterParams object There are no default values defined in the spec.
NewCreateRouterTooManyRequests creates CreateRouterTooManyRequests with default headers values.
NewCreateRouterUnauthorized creates CreateRouterUnauthorized with default headers values.
NewCreateTransitRouter creates a new http.Handler for the create transit router operation.
NewCreateTransitRouterBadRequest creates CreateTransitRouterBadRequest with default headers values.
NewCreateTransitRouterCreated creates CreateTransitRouterCreated with default headers values.
NewCreateTransitRouterParams creates a new CreateTransitRouterParams object There are no default values defined in the spec.
NewCreateTransitRouterTooManyRequests creates CreateTransitRouterTooManyRequests with default headers values.
NewCreateTransitRouterUnauthorized creates CreateTransitRouterUnauthorized with default headers values.
NewDeleteRouter creates a new http.Handler for the delete router operation.
NewDeleteRouterBadRequest creates DeleteRouterBadRequest with default headers values.
NewDeleteRouterConflict creates DeleteRouterConflict with default headers values.
NewDeleteRouterOK creates DeleteRouterOK with default headers values.
NewDeleteRouterParams creates a new DeleteRouterParams object There are no default values defined in the spec.
NewDeleteRouterTooManyRequests creates DeleteRouterTooManyRequests with default headers values.
NewDeleteRouterUnauthorized creates DeleteRouterUnauthorized with default headers values.
NewDeleteTransitRouter creates a new http.Handler for the delete transit router operation.
NewDeleteTransitRouterBadRequest creates DeleteTransitRouterBadRequest with default headers values.
NewDeleteTransitRouterConflict creates DeleteTransitRouterConflict with default headers values.
NewDeleteTransitRouterOK creates DeleteTransitRouterOK with default headers values.
NewDeleteTransitRouterParams creates a new DeleteTransitRouterParams object There are no default values defined in the spec.
NewDeleteTransitRouterTooManyRequests creates DeleteTransitRouterTooManyRequests with default headers values.
NewDeleteTransitRouterUnauthorized creates DeleteTransitRouterUnauthorized with default headers values.
NewDetailRouter creates a new http.Handler for the detail router operation.
NewDetailRouterNotFound creates DetailRouterNotFound with default headers values.
NewDetailRouterOK creates DetailRouterOK with default headers values.
NewDetailRouterParams creates a new DetailRouterParams object There are no default values defined in the spec.
NewDetailRouterTooManyRequests creates DetailRouterTooManyRequests with default headers values.
NewDetailRouterUnauthorized creates DetailRouterUnauthorized with default headers values.
NewDetailTransitRouter creates a new http.Handler for the detail transit router operation.
NewDetailTransitRouterNotFound creates DetailTransitRouterNotFound with default headers values.
NewDetailTransitRouterOK creates DetailTransitRouterOK with default headers values.
NewDetailTransitRouterParams creates a new DetailTransitRouterParams object There are no default values defined in the spec.
NewDetailTransitRouterTooManyRequests creates DetailTransitRouterTooManyRequests with default headers values.
NewDetailTransitRouterUnauthorized creates DetailTransitRouterUnauthorized with default headers values.
NewListRouters creates a new http.Handler for the list routers operation.
NewListRoutersBadRequest creates ListRoutersBadRequest with default headers values.
NewListRoutersOK creates ListRoutersOK with default headers values.
NewListRoutersParams creates a new ListRoutersParams object There are no default values defined in the spec.
NewListRoutersTooManyRequests creates ListRoutersTooManyRequests with default headers values.
NewListRoutersUnauthorized creates ListRoutersUnauthorized with default headers values.
NewListTransitRouters creates a new http.Handler for the list transit routers operation.
NewListTransitRoutersBadRequest creates ListTransitRoutersBadRequest with default headers values.
NewListTransitRoutersOK creates ListTransitRoutersOK with default headers values.
NewListTransitRoutersParams creates a new ListTransitRoutersParams object There are no default values defined in the spec.
NewListTransitRoutersTooManyRequests creates ListTransitRoutersTooManyRequests with default headers values.
NewListTransitRoutersUnauthorized creates ListTransitRoutersUnauthorized with default headers values.
NewPatchRouter creates a new http.Handler for the patch router operation.
NewPatchRouterBadRequest creates PatchRouterBadRequest with default headers values.
NewPatchRouterNotFound creates PatchRouterNotFound with default headers values.
NewPatchRouterOK creates PatchRouterOK with default headers values.
NewPatchRouterParams creates a new PatchRouterParams object There are no default values defined in the spec.
NewPatchRouterTooManyRequests creates PatchRouterTooManyRequests with default headers values.
NewPatchRouterUnauthorized creates PatchRouterUnauthorized with default headers values.
NewPatchTransitRouter creates a new http.Handler for the patch transit router operation.
NewPatchTransitRouterBadRequest creates PatchTransitRouterBadRequest with default headers values.
NewPatchTransitRouterNotFound creates PatchTransitRouterNotFound with default headers values.
NewPatchTransitRouterOK creates PatchTransitRouterOK with default headers values.
NewPatchTransitRouterParams creates a new PatchTransitRouterParams object There are no default values defined in the spec.
NewPatchTransitRouterTooManyRequests creates PatchTransitRouterTooManyRequests with default headers values.
NewPatchTransitRouterUnauthorized creates PatchTransitRouterUnauthorized with default headers values.
NewUpdateRouter creates a new http.Handler for the update router operation.
NewUpdateRouterBadRequest creates UpdateRouterBadRequest with default headers values.
NewUpdateRouterNotFound creates UpdateRouterNotFound with default headers values.
NewUpdateRouterOK creates UpdateRouterOK with default headers values.
NewUpdateRouterParams creates a new UpdateRouterParams object There are no default values defined in the spec.
NewUpdateRouterTooManyRequests creates UpdateRouterTooManyRequests with default headers values.
NewUpdateRouterUnauthorized creates UpdateRouterUnauthorized with default headers values.
NewUpdateTransitRouter creates a new http.Handler for the update transit router operation.
NewUpdateTransitRouterBadRequest creates UpdateTransitRouterBadRequest with default headers values.
NewUpdateTransitRouterNotFound creates UpdateTransitRouterNotFound with default headers values.
NewUpdateTransitRouterOK creates UpdateTransitRouterOK with default headers values.
NewUpdateTransitRouterParams creates a new UpdateTransitRouterParams object There are no default values defined in the spec.
NewUpdateTransitRouterTooManyRequests creates UpdateTransitRouterTooManyRequests with default headers values.
NewUpdateTransitRouterUnauthorized creates UpdateTransitRouterUnauthorized with default headers values.

# Constants

CreateRouterBadRequestCode is the HTTP code returned for type CreateRouterBadRequest.
CreateRouterCreatedCode is the HTTP code returned for type CreateRouterCreated.
CreateRouterTooManyRequestsCode is the HTTP code returned for type CreateRouterTooManyRequests.
CreateRouterUnauthorizedCode is the HTTP code returned for type CreateRouterUnauthorized.
CreateTransitRouterBadRequestCode is the HTTP code returned for type CreateTransitRouterBadRequest.
CreateTransitRouterCreatedCode is the HTTP code returned for type CreateTransitRouterCreated.
CreateTransitRouterTooManyRequestsCode is the HTTP code returned for type CreateTransitRouterTooManyRequests.
CreateTransitRouterUnauthorizedCode is the HTTP code returned for type CreateTransitRouterUnauthorized.
DeleteRouterBadRequestCode is the HTTP code returned for type DeleteRouterBadRequest.
DeleteRouterConflictCode is the HTTP code returned for type DeleteRouterConflict.
DeleteRouterOKCode is the HTTP code returned for type DeleteRouterOK.
DeleteRouterTooManyRequestsCode is the HTTP code returned for type DeleteRouterTooManyRequests.
DeleteRouterUnauthorizedCode is the HTTP code returned for type DeleteRouterUnauthorized.
DeleteTransitRouterBadRequestCode is the HTTP code returned for type DeleteTransitRouterBadRequest.
DeleteTransitRouterConflictCode is the HTTP code returned for type DeleteTransitRouterConflict.
DeleteTransitRouterOKCode is the HTTP code returned for type DeleteTransitRouterOK.
DeleteTransitRouterTooManyRequestsCode is the HTTP code returned for type DeleteTransitRouterTooManyRequests.
DeleteTransitRouterUnauthorizedCode is the HTTP code returned for type DeleteTransitRouterUnauthorized.
DetailRouterNotFoundCode is the HTTP code returned for type DetailRouterNotFound.
DetailRouterOKCode is the HTTP code returned for type DetailRouterOK.
DetailRouterTooManyRequestsCode is the HTTP code returned for type DetailRouterTooManyRequests.
DetailRouterUnauthorizedCode is the HTTP code returned for type DetailRouterUnauthorized.
DetailTransitRouterNotFoundCode is the HTTP code returned for type DetailTransitRouterNotFound.
DetailTransitRouterOKCode is the HTTP code returned for type DetailTransitRouterOK.
DetailTransitRouterTooManyRequestsCode is the HTTP code returned for type DetailTransitRouterTooManyRequests.
DetailTransitRouterUnauthorizedCode is the HTTP code returned for type DetailTransitRouterUnauthorized.
ListRoutersBadRequestCode is the HTTP code returned for type ListRoutersBadRequest.
ListRoutersOKCode is the HTTP code returned for type ListRoutersOK.
ListRoutersTooManyRequestsCode is the HTTP code returned for type ListRoutersTooManyRequests.
ListRoutersUnauthorizedCode is the HTTP code returned for type ListRoutersUnauthorized.
ListTransitRoutersBadRequestCode is the HTTP code returned for type ListTransitRoutersBadRequest.
ListTransitRoutersOKCode is the HTTP code returned for type ListTransitRoutersOK.
ListTransitRoutersTooManyRequestsCode is the HTTP code returned for type ListTransitRoutersTooManyRequests.
ListTransitRoutersUnauthorizedCode is the HTTP code returned for type ListTransitRoutersUnauthorized.
PatchRouterBadRequestCode is the HTTP code returned for type PatchRouterBadRequest.
PatchRouterNotFoundCode is the HTTP code returned for type PatchRouterNotFound.
PatchRouterOKCode is the HTTP code returned for type PatchRouterOK.
PatchRouterTooManyRequestsCode is the HTTP code returned for type PatchRouterTooManyRequests.
PatchRouterUnauthorizedCode is the HTTP code returned for type PatchRouterUnauthorized.
PatchTransitRouterBadRequestCode is the HTTP code returned for type PatchTransitRouterBadRequest.
PatchTransitRouterNotFoundCode is the HTTP code returned for type PatchTransitRouterNotFound.
PatchTransitRouterOKCode is the HTTP code returned for type PatchTransitRouterOK.
PatchTransitRouterTooManyRequestsCode is the HTTP code returned for type PatchTransitRouterTooManyRequests.
PatchTransitRouterUnauthorizedCode is the HTTP code returned for type PatchTransitRouterUnauthorized.
UpdateRouterBadRequestCode is the HTTP code returned for type UpdateRouterBadRequest.
UpdateRouterNotFoundCode is the HTTP code returned for type UpdateRouterNotFound.
UpdateRouterOKCode is the HTTP code returned for type UpdateRouterOK.
UpdateRouterTooManyRequestsCode is the HTTP code returned for type UpdateRouterTooManyRequests.
UpdateRouterUnauthorizedCode is the HTTP code returned for type UpdateRouterUnauthorized.
UpdateTransitRouterBadRequestCode is the HTTP code returned for type UpdateTransitRouterBadRequest.
UpdateTransitRouterNotFoundCode is the HTTP code returned for type UpdateTransitRouterNotFound.
UpdateTransitRouterOKCode is the HTTP code returned for type UpdateTransitRouterOK.
UpdateTransitRouterTooManyRequestsCode is the HTTP code returned for type UpdateTransitRouterTooManyRequests.
UpdateTransitRouterUnauthorizedCode is the HTTP code returned for type UpdateTransitRouterUnauthorized.

# Structs

CreateRouter swagger:route POST /routers Router createRouter Create a router resource Create a router resource.
CreateRouterBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
CreateRouterCreated The create request was successful and the resource has been added at the following location swagger:response createRouterCreated */.
CreateRouterParams contains all the bound params for the create router operation typically these are obtained from a http.Request swagger:parameters createRouter.
CreateRouterTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response createRouterTooManyRequests */.
CreateRouterUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response createRouterUnauthorized */.
CreateRouterURL generates an URL for the create router operation.
CreateTransitRouter swagger:route POST /transit-routers Router createTransitRouter Create a router resource Create a router resource.
CreateTransitRouterBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
CreateTransitRouterCreated The create request was successful and the resource has been added at the following location swagger:response createTransitRouterCreated */.
CreateTransitRouterParams contains all the bound params for the create transit router operation typically these are obtained from a http.Request swagger:parameters createTransitRouter.
CreateTransitRouterTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response createTransitRouterTooManyRequests */.
CreateTransitRouterUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response createTransitRouterUnauthorized */.
CreateTransitRouterURL generates an URL for the create transit router operation.
DeleteRouter swagger:route DELETE /routers/{id} Router deleteRouter Delete a router Delete a router by id.
DeleteRouterBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
DeleteRouterConflict The resource requested to be removed/altered cannot be as it is referenced by another object.
DeleteRouterOK The delete request was successful and the resource has been removed swagger:response deleteRouterOK */.
DeleteRouterParams contains all the bound params for the delete router operation typically these are obtained from a http.Request swagger:parameters deleteRouter.
DeleteRouterTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response deleteRouterTooManyRequests */.
DeleteRouterUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response deleteRouterUnauthorized */.
DeleteRouterURL generates an URL for the delete router operation.
DeleteTransitRouter swagger:route DELETE /transit-routers/{id} Router deleteTransitRouter Delete a router Delete a router by id.
DeleteTransitRouterBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
DeleteTransitRouterConflict The resource requested to be removed/altered cannot be as it is referenced by another object.
DeleteTransitRouterOK The delete request was successful and the resource has been removed swagger:response deleteTransitRouterOK */.
DeleteTransitRouterParams contains all the bound params for the delete transit router operation typically these are obtained from a http.Request swagger:parameters deleteTransitRouter.
DeleteTransitRouterTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response deleteTransitRouterTooManyRequests */.
DeleteTransitRouterUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response deleteTransitRouterUnauthorized */.
DeleteTransitRouterURL generates an URL for the delete transit router operation.
DetailRouter swagger:route GET /routers/{id} Router detailRouter Retrieves a single router Retrieves a single router by id.
DetailRouterNotFound The requested resource does not exist swagger:response detailRouterNotFound */.
DetailRouterOK A single router swagger:response detailRouterOK */.
DetailRouterParams contains all the bound params for the detail router operation typically these are obtained from a http.Request swagger:parameters detailRouter.
DetailRouterTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response detailRouterTooManyRequests */.
DetailRouterUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response detailRouterUnauthorized */.
DetailRouterURL generates an URL for the detail router operation.
DetailTransitRouter swagger:route GET /transit-routers/{id} Router detailTransitRouter Retrieves a single router Retrieves a single router by id.
DetailTransitRouterNotFound The requested resource does not exist swagger:response detailTransitRouterNotFound */.
DetailTransitRouterOK A single router swagger:response detailTransitRouterOK */.
DetailTransitRouterParams contains all the bound params for the detail transit router operation typically these are obtained from a http.Request swagger:parameters detailTransitRouter.
DetailTransitRouterTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response detailTransitRouterTooManyRequests */.
DetailTransitRouterUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response detailTransitRouterUnauthorized */.
DetailTransitRouterURL generates an URL for the detail transit router operation.
ListRouters swagger:route GET /routers Router listRouters List routers Retrieves a list of router resources; supports filtering, sorting, and pagination.
ListRoutersBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListRoutersOK A list of specifications swagger:response listRoutersOK */.
ListRoutersParams contains all the bound params for the list routers operation typically these are obtained from a http.Request swagger:parameters listRouters.
ListRoutersTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listRoutersTooManyRequests */.
ListRoutersUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listRoutersUnauthorized */.
ListRoutersURL generates an URL for the list routers operation.
ListTransitRouters swagger:route GET /transit-routers Router listTransitRouters List routers Retrieves a list of router resources; supports filtering, sorting, and pagination.
ListTransitRoutersBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListTransitRoutersOK A list of specifications swagger:response listTransitRoutersOK */.
ListTransitRoutersParams contains all the bound params for the list transit routers operation typically these are obtained from a http.Request swagger:parameters listTransitRouters.
ListTransitRoutersTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listTransitRoutersTooManyRequests */.
ListTransitRoutersUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listTransitRoutersUnauthorized */.
ListTransitRoutersURL generates an URL for the list transit routers operation.
PatchRouter swagger:route PATCH /routers/{id} Router patchRouter Update the supplied fields on a router Update the supplied fields on a router.
PatchRouterBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
PatchRouterNotFound The requested resource does not exist swagger:response patchRouterNotFound */.
PatchRouterOK The patch request was successful and the resource has been altered swagger:response patchRouterOK */.
PatchRouterParams contains all the bound params for the patch router operation typically these are obtained from a http.Request swagger:parameters patchRouter.
PatchRouterTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response patchRouterTooManyRequests */.
PatchRouterUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response patchRouterUnauthorized */.
PatchRouterURL generates an URL for the patch router operation.
PatchTransitRouter swagger:route PATCH /transit-routers/{id} Router patchTransitRouter Update the supplied fields on a router Update the supplied fields on a router.
PatchTransitRouterBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
PatchTransitRouterNotFound The requested resource does not exist swagger:response patchTransitRouterNotFound */.
PatchTransitRouterOK The patch request was successful and the resource has been altered swagger:response patchTransitRouterOK */.
PatchTransitRouterParams contains all the bound params for the patch transit router operation typically these are obtained from a http.Request swagger:parameters patchTransitRouter.
PatchTransitRouterTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response patchTransitRouterTooManyRequests */.
PatchTransitRouterUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response patchTransitRouterUnauthorized */.
PatchTransitRouterURL generates an URL for the patch transit router operation.
UpdateRouter swagger:route PUT /routers/{id} Router updateRouter Update all fields on a router Update all fields on a router by id.
UpdateRouterBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
UpdateRouterNotFound The requested resource does not exist swagger:response updateRouterNotFound */.
UpdateRouterOK The update request was successful and the resource has been altered swagger:response updateRouterOK */.
UpdateRouterParams contains all the bound params for the update router operation typically these are obtained from a http.Request swagger:parameters updateRouter.
UpdateRouterTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response updateRouterTooManyRequests */.
UpdateRouterUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response updateRouterUnauthorized */.
UpdateRouterURL generates an URL for the update router operation.
UpdateTransitRouter swagger:route PUT /transit-routers/{id} Router updateTransitRouter Update all fields on a router Update all fields on a router by id.
UpdateTransitRouterBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
UpdateTransitRouterNotFound The requested resource does not exist swagger:response updateTransitRouterNotFound */.
UpdateTransitRouterOK The update request was successful and the resource has been altered swagger:response updateTransitRouterOK */.
UpdateTransitRouterParams contains all the bound params for the update transit router operation typically these are obtained from a http.Request swagger:parameters updateTransitRouter.
UpdateTransitRouterTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response updateTransitRouterTooManyRequests */.
UpdateTransitRouterUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response updateTransitRouterUnauthorized */.
UpdateTransitRouterURL generates an URL for the update transit router operation.

# Interfaces

CreateRouterHandler interface for that can handle valid create router params.
CreateTransitRouterHandler interface for that can handle valid create transit router params.
DeleteRouterHandler interface for that can handle valid delete router params.
DeleteTransitRouterHandler interface for that can handle valid delete transit router params.
DetailRouterHandler interface for that can handle valid detail router params.
DetailTransitRouterHandler interface for that can handle valid detail transit router params.
ListRoutersHandler interface for that can handle valid list routers params.
ListTransitRoutersHandler interface for that can handle valid list transit routers params.
PatchRouterHandler interface for that can handle valid patch router params.
PatchTransitRouterHandler interface for that can handle valid patch transit router params.
UpdateRouterHandler interface for that can handle valid update router params.
UpdateTransitRouterHandler interface for that can handle valid update transit router params.

# Type aliases

CreateRouterHandlerFunc turns a function with the right signature into a create router handler.
CreateTransitRouterHandlerFunc turns a function with the right signature into a create transit router handler.
DeleteRouterHandlerFunc turns a function with the right signature into a delete router handler.
DeleteTransitRouterHandlerFunc turns a function with the right signature into a delete transit router handler.
DetailRouterHandlerFunc turns a function with the right signature into a detail router handler.
DetailTransitRouterHandlerFunc turns a function with the right signature into a detail transit router handler.
ListRoutersHandlerFunc turns a function with the right signature into a list routers handler.
ListTransitRoutersHandlerFunc turns a function with the right signature into a list transit routers handler.
PatchRouterHandlerFunc turns a function with the right signature into a patch router handler.
PatchTransitRouterHandlerFunc turns a function with the right signature into a patch transit router handler.
UpdateRouterHandlerFunc turns a function with the right signature into a update router handler.
UpdateTransitRouterHandlerFunc turns a function with the right signature into a update transit router handler.