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

# Functions

NewCreateService creates a new http.Handler for the create service operation.
NewCreateServiceBadRequest creates CreateServiceBadRequest with default headers values.
NewCreateServiceCreated creates CreateServiceCreated with default headers values.
NewCreateServiceParams creates a new CreateServiceParams object There are no default values defined in the spec.
NewCreateServiceTooManyRequests creates CreateServiceTooManyRequests with default headers values.
NewCreateServiceUnauthorized creates CreateServiceUnauthorized with default headers values.
NewDeleteService creates a new http.Handler for the delete service operation.
NewDeleteServiceBadRequest creates DeleteServiceBadRequest with default headers values.
NewDeleteServiceConflict creates DeleteServiceConflict with default headers values.
NewDeleteServiceOK creates DeleteServiceOK with default headers values.
NewDeleteServiceParams creates a new DeleteServiceParams object There are no default values defined in the spec.
NewDeleteServiceTooManyRequests creates DeleteServiceTooManyRequests with default headers values.
NewDeleteServiceUnauthorized creates DeleteServiceUnauthorized with default headers values.
NewDetailService creates a new http.Handler for the detail service operation.
NewDetailServiceNotFound creates DetailServiceNotFound with default headers values.
NewDetailServiceOK creates DetailServiceOK with default headers values.
NewDetailServiceParams creates a new DetailServiceParams object There are no default values defined in the spec.
NewDetailServiceTooManyRequests creates DetailServiceTooManyRequests with default headers values.
NewDetailServiceUnauthorized creates DetailServiceUnauthorized with default headers values.
NewListServiceConfig creates a new http.Handler for the list service config operation.
NewListServiceConfigBadRequest creates ListServiceConfigBadRequest with default headers values.
NewListServiceConfigOK creates ListServiceConfigOK with default headers values.
NewListServiceConfigParams creates a new ListServiceConfigParams object There are no default values defined in the spec.
NewListServiceConfigTooManyRequests creates ListServiceConfigTooManyRequests with default headers values.
NewListServiceConfigUnauthorized creates ListServiceConfigUnauthorized with default headers values.
NewListServiceEdgeRouters creates a new http.Handler for the list service edge routers operation.
NewListServiceEdgeRoutersBadRequest creates ListServiceEdgeRoutersBadRequest with default headers values.
NewListServiceEdgeRoutersOK creates ListServiceEdgeRoutersOK with default headers values.
NewListServiceEdgeRoutersParams creates a new ListServiceEdgeRoutersParams object There are no default values defined in the spec.
NewListServiceEdgeRoutersTooManyRequests creates ListServiceEdgeRoutersTooManyRequests with default headers values.
NewListServiceEdgeRoutersUnauthorized creates ListServiceEdgeRoutersUnauthorized with default headers values.
NewListServiceIdentities creates a new http.Handler for the list service identities operation.
NewListServiceIdentitiesBadRequest creates ListServiceIdentitiesBadRequest with default headers values.
NewListServiceIdentitiesOK creates ListServiceIdentitiesOK with default headers values.
NewListServiceIdentitiesParams creates a new ListServiceIdentitiesParams object There are no default values defined in the spec.
NewListServiceIdentitiesTooManyRequests creates ListServiceIdentitiesTooManyRequests with default headers values.
NewListServiceIdentitiesUnauthorized creates ListServiceIdentitiesUnauthorized with default headers values.
NewListServices creates a new http.Handler for the list services operation.
NewListServicesBadRequest creates ListServicesBadRequest with default headers values.
NewListServiceServiceEdgeRouterPolicies creates a new http.Handler for the list service service edge router policies operation.
NewListServiceServiceEdgeRouterPoliciesBadRequest creates ListServiceServiceEdgeRouterPoliciesBadRequest with default headers values.
NewListServiceServiceEdgeRouterPoliciesOK creates ListServiceServiceEdgeRouterPoliciesOK with default headers values.
NewListServiceServiceEdgeRouterPoliciesParams creates a new ListServiceServiceEdgeRouterPoliciesParams object There are no default values defined in the spec.
NewListServiceServiceEdgeRouterPoliciesTooManyRequests creates ListServiceServiceEdgeRouterPoliciesTooManyRequests with default headers values.
NewListServiceServiceEdgeRouterPoliciesUnauthorized creates ListServiceServiceEdgeRouterPoliciesUnauthorized with default headers values.
NewListServiceServicePolicies creates a new http.Handler for the list service service policies operation.
NewListServiceServicePoliciesBadRequest creates ListServiceServicePoliciesBadRequest with default headers values.
NewListServiceServicePoliciesOK creates ListServiceServicePoliciesOK with default headers values.
NewListServiceServicePoliciesParams creates a new ListServiceServicePoliciesParams object There are no default values defined in the spec.
NewListServiceServicePoliciesTooManyRequests creates ListServiceServicePoliciesTooManyRequests with default headers values.
NewListServiceServicePoliciesUnauthorized creates ListServiceServicePoliciesUnauthorized with default headers values.
NewListServicesOK creates ListServicesOK with default headers values.
NewListServicesParams creates a new ListServicesParams object There are no default values defined in the spec.
NewListServicesTooManyRequests creates ListServicesTooManyRequests with default headers values.
NewListServicesUnauthorized creates ListServicesUnauthorized with default headers values.
NewListServiceTerminators creates a new http.Handler for the list service terminators operation.
NewListServiceTerminatorsBadRequest creates ListServiceTerminatorsBadRequest with default headers values.
NewListServiceTerminatorsOK creates ListServiceTerminatorsOK with default headers values.
NewListServiceTerminatorsParams creates a new ListServiceTerminatorsParams object There are no default values defined in the spec.
NewListServiceTerminatorsTooManyRequests creates ListServiceTerminatorsTooManyRequests with default headers values.
NewListServiceTerminatorsUnauthorized creates ListServiceTerminatorsUnauthorized with default headers values.
NewPatchService creates a new http.Handler for the patch service operation.
NewPatchServiceBadRequest creates PatchServiceBadRequest with default headers values.
NewPatchServiceNotFound creates PatchServiceNotFound with default headers values.
NewPatchServiceOK creates PatchServiceOK with default headers values.
NewPatchServiceParams creates a new PatchServiceParams object There are no default values defined in the spec.
NewPatchServiceTooManyRequests creates PatchServiceTooManyRequests with default headers values.
NewPatchServiceUnauthorized creates PatchServiceUnauthorized with default headers values.
NewUpdateService creates a new http.Handler for the update service operation.
NewUpdateServiceBadRequest creates UpdateServiceBadRequest with default headers values.
NewUpdateServiceNotFound creates UpdateServiceNotFound with default headers values.
NewUpdateServiceOK creates UpdateServiceOK with default headers values.
NewUpdateServiceParams creates a new UpdateServiceParams object There are no default values defined in the spec.
NewUpdateServiceTooManyRequests creates UpdateServiceTooManyRequests with default headers values.
NewUpdateServiceUnauthorized creates UpdateServiceUnauthorized with default headers values.

# Constants

CreateServiceBadRequestCode is the HTTP code returned for type CreateServiceBadRequest.
CreateServiceCreatedCode is the HTTP code returned for type CreateServiceCreated.
CreateServiceTooManyRequestsCode is the HTTP code returned for type CreateServiceTooManyRequests.
CreateServiceUnauthorizedCode is the HTTP code returned for type CreateServiceUnauthorized.
DeleteServiceBadRequestCode is the HTTP code returned for type DeleteServiceBadRequest.
DeleteServiceConflictCode is the HTTP code returned for type DeleteServiceConflict.
DeleteServiceOKCode is the HTTP code returned for type DeleteServiceOK.
DeleteServiceTooManyRequestsCode is the HTTP code returned for type DeleteServiceTooManyRequests.
DeleteServiceUnauthorizedCode is the HTTP code returned for type DeleteServiceUnauthorized.
DetailServiceNotFoundCode is the HTTP code returned for type DetailServiceNotFound.
DetailServiceOKCode is the HTTP code returned for type DetailServiceOK.
DetailServiceTooManyRequestsCode is the HTTP code returned for type DetailServiceTooManyRequests.
DetailServiceUnauthorizedCode is the HTTP code returned for type DetailServiceUnauthorized.
ListServiceConfigBadRequestCode is the HTTP code returned for type ListServiceConfigBadRequest.
ListServiceConfigOKCode is the HTTP code returned for type ListServiceConfigOK.
ListServiceConfigTooManyRequestsCode is the HTTP code returned for type ListServiceConfigTooManyRequests.
ListServiceConfigUnauthorizedCode is the HTTP code returned for type ListServiceConfigUnauthorized.
ListServiceEdgeRoutersBadRequestCode is the HTTP code returned for type ListServiceEdgeRoutersBadRequest.
ListServiceEdgeRoutersOKCode is the HTTP code returned for type ListServiceEdgeRoutersOK.
ListServiceEdgeRoutersTooManyRequestsCode is the HTTP code returned for type ListServiceEdgeRoutersTooManyRequests.
ListServiceEdgeRoutersUnauthorizedCode is the HTTP code returned for type ListServiceEdgeRoutersUnauthorized.
ListServiceIdentitiesBadRequestCode is the HTTP code returned for type ListServiceIdentitiesBadRequest.
ListServiceIdentitiesOKCode is the HTTP code returned for type ListServiceIdentitiesOK.
ListServiceIdentitiesTooManyRequestsCode is the HTTP code returned for type ListServiceIdentitiesTooManyRequests.
ListServiceIdentitiesUnauthorizedCode is the HTTP code returned for type ListServiceIdentitiesUnauthorized.
ListServicesBadRequestCode is the HTTP code returned for type ListServicesBadRequest.
ListServiceServiceEdgeRouterPoliciesBadRequestCode is the HTTP code returned for type ListServiceServiceEdgeRouterPoliciesBadRequest.
ListServiceServiceEdgeRouterPoliciesOKCode is the HTTP code returned for type ListServiceServiceEdgeRouterPoliciesOK.
ListServiceServiceEdgeRouterPoliciesTooManyRequestsCode is the HTTP code returned for type ListServiceServiceEdgeRouterPoliciesTooManyRequests.
ListServiceServiceEdgeRouterPoliciesUnauthorizedCode is the HTTP code returned for type ListServiceServiceEdgeRouterPoliciesUnauthorized.
ListServiceServicePoliciesBadRequestCode is the HTTP code returned for type ListServiceServicePoliciesBadRequest.
ListServiceServicePoliciesOKCode is the HTTP code returned for type ListServiceServicePoliciesOK.
ListServiceServicePoliciesTooManyRequestsCode is the HTTP code returned for type ListServiceServicePoliciesTooManyRequests.
ListServiceServicePoliciesUnauthorizedCode is the HTTP code returned for type ListServiceServicePoliciesUnauthorized.
ListServicesOKCode is the HTTP code returned for type ListServicesOK.
ListServicesTooManyRequestsCode is the HTTP code returned for type ListServicesTooManyRequests.
ListServicesUnauthorizedCode is the HTTP code returned for type ListServicesUnauthorized.
ListServiceTerminatorsBadRequestCode is the HTTP code returned for type ListServiceTerminatorsBadRequest.
ListServiceTerminatorsOKCode is the HTTP code returned for type ListServiceTerminatorsOK.
ListServiceTerminatorsTooManyRequestsCode is the HTTP code returned for type ListServiceTerminatorsTooManyRequests.
ListServiceTerminatorsUnauthorizedCode is the HTTP code returned for type ListServiceTerminatorsUnauthorized.
PatchServiceBadRequestCode is the HTTP code returned for type PatchServiceBadRequest.
PatchServiceNotFoundCode is the HTTP code returned for type PatchServiceNotFound.
PatchServiceOKCode is the HTTP code returned for type PatchServiceOK.
PatchServiceTooManyRequestsCode is the HTTP code returned for type PatchServiceTooManyRequests.
PatchServiceUnauthorizedCode is the HTTP code returned for type PatchServiceUnauthorized.
UpdateServiceBadRequestCode is the HTTP code returned for type UpdateServiceBadRequest.
UpdateServiceNotFoundCode is the HTTP code returned for type UpdateServiceNotFound.
UpdateServiceOKCode is the HTTP code returned for type UpdateServiceOK.
UpdateServiceTooManyRequestsCode is the HTTP code returned for type UpdateServiceTooManyRequests.
UpdateServiceUnauthorizedCode is the HTTP code returned for type UpdateServiceUnauthorized.

# Structs

CreateService swagger:route POST /services Service createService Create a services resource Create a services resource.
CreateServiceBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
CreateServiceCreated The create request was successful and the resource has been added at the following location swagger:response createServiceCreated */.
CreateServiceParams contains all the bound params for the create service operation typically these are obtained from a http.Request swagger:parameters createService.
CreateServiceTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response createServiceTooManyRequests */.
CreateServiceUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response createServiceUnauthorized */.
CreateServiceURL generates an URL for the create service operation.
DeleteService swagger:route DELETE /services/{id} Service deleteService Delete a service Delete a service by id.
DeleteServiceBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
DeleteServiceConflict The resource requested to be removed/altered cannot be as it is referenced by another object.
DeleteServiceOK The delete request was successful and the resource has been removed swagger:response deleteServiceOK */.
DeleteServiceParams contains all the bound params for the delete service operation typically these are obtained from a http.Request swagger:parameters deleteService.
DeleteServiceTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response deleteServiceTooManyRequests */.
DeleteServiceUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response deleteServiceUnauthorized */.
DeleteServiceURL generates an URL for the delete service operation.
DetailService swagger:route GET /services/{id} Service detailService Retrieves a single service Retrieves a single service by id.
DetailServiceNotFound The requested resource does not exist swagger:response detailServiceNotFound */.
DetailServiceOK A single service swagger:response detailServiceOK */.
DetailServiceParams contains all the bound params for the detail service operation typically these are obtained from a http.Request swagger:parameters detailService.
DetailServiceTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response detailServiceTooManyRequests */.
DetailServiceUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response detailServiceUnauthorized */.
DetailServiceURL generates an URL for the detail service operation.
ListServiceConfig swagger:route GET /services/{id}/configs Service listServiceConfig List configs associated to a specific service Retrieves a list of config resources associated to a specific service; supports filtering, sorting, and pagination.
ListServiceConfigBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListServiceConfigOK A list of configs swagger:response listServiceConfigOK */.
ListServiceConfigParams contains all the bound params for the list service config operation typically these are obtained from a http.Request swagger:parameters listServiceConfig.
ListServiceConfigTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listServiceConfigTooManyRequests */.
ListServiceConfigUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listServiceConfigUnauthorized */.
ListServiceConfigURL generates an URL for the list service config operation.
ListServiceEdgeRouters swagger:route GET /services/{id}/edge-routers Service listServiceEdgeRouters List accessible edge-routers Retrieves a list of edge-routers that may be used to access the given service.
ListServiceEdgeRoutersBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListServiceEdgeRoutersOK A list of edge routers swagger:response listServiceEdgeRoutersOK */.
ListServiceEdgeRoutersParams contains all the bound params for the list service edge routers operation typically these are obtained from a http.Request swagger:parameters listServiceEdgeRouters.
ListServiceEdgeRoutersTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listServiceEdgeRoutersTooManyRequests */.
ListServiceEdgeRoutersUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listServiceEdgeRoutersUnauthorized */.
ListServiceEdgeRoutersURL generates an URL for the list service edge routers operation.
ListServiceIdentities swagger:route GET /services/{id}/identities Service listServiceIdentities List identities with access Retrieves a list of identities that have access to this service.
ListServiceIdentitiesBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListServiceIdentitiesOK A list of identities swagger:response listServiceIdentitiesOK */.
ListServiceIdentitiesParams contains all the bound params for the list service identities operation typically these are obtained from a http.Request swagger:parameters listServiceIdentities.
ListServiceIdentitiesTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listServiceIdentitiesTooManyRequests */.
ListServiceIdentitiesUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listServiceIdentitiesUnauthorized */.
ListServiceIdentitiesURL generates an URL for the list service identities operation.
ListServices swagger:route GET /services Service listServices List services Retrieves a list of config resources; supports filtering, sorting, and pagination.
ListServicesBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListServiceServiceEdgeRouterPolicies swagger:route GET /services/{id}/service-edge-router-policies Service listServiceServiceEdgeRouterPolicies List service edge router policies that affect a specific service Retrieves a list of service edge router policy resources that affect a specific service; supports filtering, sorting, and pagination.
ListServiceServiceEdgeRouterPoliciesBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListServiceServiceEdgeRouterPoliciesOK A list of service edge router policies swagger:response listServiceServiceEdgeRouterPoliciesOK */.
ListServiceServiceEdgeRouterPoliciesParams contains all the bound params for the list service service edge router policies operation typically these are obtained from a http.Request swagger:parameters listServiceServiceEdgeRouterPolicies.
ListServiceServiceEdgeRouterPoliciesTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listServiceServiceEdgeRouterPoliciesTooManyRequests */.
ListServiceServiceEdgeRouterPoliciesUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listServiceServiceEdgeRouterPoliciesUnauthorized */.
ListServiceServiceEdgeRouterPoliciesURL generates an URL for the list service service edge router policies operation.
ListServiceServicePolicies swagger:route GET /services/{id}/service-policies Service listServiceServicePolicies List service policies that affect a specific service Retrieves a list of service policy resources that affect specific service; supports filtering, sorting, and pagination.
ListServiceServicePoliciesBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListServiceServicePoliciesOK A list of service policies swagger:response listServiceServicePoliciesOK */.
ListServiceServicePoliciesParams contains all the bound params for the list service service policies operation typically these are obtained from a http.Request swagger:parameters listServiceServicePolicies.
ListServiceServicePoliciesTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listServiceServicePoliciesTooManyRequests */.
ListServiceServicePoliciesUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listServiceServicePoliciesUnauthorized */.
ListServiceServicePoliciesURL generates an URL for the list service service policies operation.
ListServicesOK A list of services swagger:response listServicesOK */.
ListServicesParams contains all the bound params for the list services operation typically these are obtained from a http.Request swagger:parameters listServices.
ListServicesTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listServicesTooManyRequests */.
ListServicesUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listServicesUnauthorized */.
ListServicesURL generates an URL for the list services operation.
ListServiceTerminators swagger:route GET /services/{id}/terminators Service listServiceTerminators List of terminators assigned to a service Retrieves a list of terminator resources that are assigned specific service; supports filtering, sorting, and pagination.
ListServiceTerminatorsBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
ListServiceTerminatorsOK A list of terminators swagger:response listServiceTerminatorsOK */.
ListServiceTerminatorsParams contains all the bound params for the list service terminators operation typically these are obtained from a http.Request swagger:parameters listServiceTerminators.
ListServiceTerminatorsTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response listServiceTerminatorsTooManyRequests */.
ListServiceTerminatorsUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response listServiceTerminatorsUnauthorized */.
ListServiceTerminatorsURL generates an URL for the list service terminators operation.
PatchService swagger:route PATCH /services/{id} Service patchService Update the supplied fields on a service Update the supplied fields on a service.
PatchServiceBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
PatchServiceNotFound The requested resource does not exist swagger:response patchServiceNotFound */.
PatchServiceOK The patch request was successful and the resource has been altered swagger:response patchServiceOK */.
PatchServiceParams contains all the bound params for the patch service operation typically these are obtained from a http.Request swagger:parameters patchService.
PatchServiceTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response patchServiceTooManyRequests */.
PatchServiceUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response patchServiceUnauthorized */.
PatchServiceURL generates an URL for the patch service operation.
UpdateService swagger:route PUT /services/{id} Service updateService Update all fields on a service Update all fields on a service by id.
UpdateServiceBadRequest The supplied request contains invalid fields or could not be parsed (json and non-json bodies).
UpdateServiceNotFound The requested resource does not exist swagger:response updateServiceNotFound */.
UpdateServiceOK The update request was successful and the resource has been altered swagger:response updateServiceOK */.
UpdateServiceParams contains all the bound params for the update service operation typically these are obtained from a http.Request swagger:parameters updateService.
UpdateServiceTooManyRequests The resource requested is rate limited and the rate limit has been exceeded swagger:response updateServiceTooManyRequests */.
UpdateServiceUnauthorized The supplied session does not have the correct access rights to request this resource swagger:response updateServiceUnauthorized */.
UpdateServiceURL generates an URL for the update service operation.

# Interfaces

CreateServiceHandler interface for that can handle valid create service params.
DeleteServiceHandler interface for that can handle valid delete service params.
DetailServiceHandler interface for that can handle valid detail service params.
ListServiceConfigHandler interface for that can handle valid list service config params.
ListServiceEdgeRoutersHandler interface for that can handle valid list service edge routers params.
ListServiceIdentitiesHandler interface for that can handle valid list service identities params.
ListServiceServiceEdgeRouterPoliciesHandler interface for that can handle valid list service service edge router policies params.
ListServiceServicePoliciesHandler interface for that can handle valid list service service policies params.
ListServicesHandler interface for that can handle valid list services params.
ListServiceTerminatorsHandler interface for that can handle valid list service terminators params.
PatchServiceHandler interface for that can handle valid patch service params.
UpdateServiceHandler interface for that can handle valid update service params.

# Type aliases

CreateServiceHandlerFunc turns a function with the right signature into a create service handler.
DeleteServiceHandlerFunc turns a function with the right signature into a delete service handler.
DetailServiceHandlerFunc turns a function with the right signature into a detail service handler.
ListServiceConfigHandlerFunc turns a function with the right signature into a list service config handler.
ListServiceEdgeRoutersHandlerFunc turns a function with the right signature into a list service edge routers handler.
ListServiceIdentitiesHandlerFunc turns a function with the right signature into a list service identities handler.
ListServiceServiceEdgeRouterPoliciesHandlerFunc turns a function with the right signature into a list service service edge router policies handler.
ListServiceServicePoliciesHandlerFunc turns a function with the right signature into a list service service policies handler.
ListServicesHandlerFunc turns a function with the right signature into a list services handler.
ListServiceTerminatorsHandlerFunc turns a function with the right signature into a list service terminators handler.
PatchServiceHandlerFunc turns a function with the right signature into a patch service handler.
UpdateServiceHandlerFunc turns a function with the right signature into a update service handler.