# Functions
NewBesecAPI creates a new Besec instance.
NewCreatePlan creates a new http.Handler for the create plan operation.
NewCreatePlanCreated creates CreatePlanCreated with default headers values.
NewCreatePlanDefault creates CreatePlanDefault with default headers values.
NewCreatePlanParams creates a new CreatePlanParams object
There are no default values defined in the spec.
NewCreatePlanRevision creates a new http.Handler for the create plan revision operation.
NewCreatePlanRevisionDefault creates CreatePlanRevisionDefault with default headers values.
NewCreatePlanRevisionOK creates CreatePlanRevisionOK with default headers values.
NewCreatePlanRevisionParams creates a new CreatePlanRevisionParams object
There are no default values defined in the spec.
NewCreateProject creates a new http.Handler for the create project operation.
NewCreateProjectCreated creates CreateProjectCreated with default headers values.
NewCreateProjectDefault creates CreateProjectDefault with default headers values.
NewCreateProjectParams creates a new CreateProjectParams object
There are no default values defined in the spec.
NewDeletePlan creates a new http.Handler for the delete plan operation.
NewDeletePlanDefault creates DeletePlanDefault with default headers values.
NewDeletePlanNoContent creates DeletePlanNoContent with default headers values.
NewDeletePlanParams creates a new DeletePlanParams object
There are no default values defined in the spec.
NewDeleteProject creates a new http.Handler for the delete project operation.
NewDeleteProjectDefault creates DeleteProjectDefault with default headers values.
NewDeleteProjectNoContent creates DeleteProjectNoContent with default headers values.
NewDeleteProjectParams creates a new DeleteProjectParams object
There are no default values defined in the spec.
NewGetAuthConfig creates a new http.Handler for the get auth config operation.
NewGetAuthConfigDefault creates GetAuthConfigDefault with default headers values.
NewGetAuthConfigOK creates GetAuthConfigOK with default headers values.
NewGetAuthConfigParams creates a new GetAuthConfigParams object
There are no default values defined in the spec.
NewGetPlan creates a new http.Handler for the get plan operation.
NewGetPlanDefault creates GetPlanDefault with default headers values.
NewGetPlanOK creates GetPlanOK with default headers values.
NewGetPlanParams creates a new GetPlanParams object
There are no default values defined in the spec.
NewGetPlanRevision creates a new http.Handler for the get plan revision operation.
NewGetPlanRevisionDefault creates GetPlanRevisionDefault with default headers values.
NewGetPlanRevisionOK creates GetPlanRevisionOK with default headers values.
NewGetPlanRevisionParams creates a new GetPlanRevisionParams object
There are no default values defined in the spec.
NewGetPlanRevisionPracticeResponses creates a new http.Handler for the get plan revision practice responses operation.
NewGetPlanRevisionPracticeResponsesDefault creates GetPlanRevisionPracticeResponsesDefault with default headers values.
NewGetPlanRevisionPracticeResponsesOK creates GetPlanRevisionPracticeResponsesOK with default headers values.
NewGetPlanRevisionPracticeResponsesParams creates a new GetPlanRevisionPracticeResponsesParams object
There are no default values defined in the spec.
NewGetPlanVersions creates a new http.Handler for the get plan versions operation.
NewGetPlanVersionsDefault creates GetPlanVersionsDefault with default headers values.
NewGetPlanVersionsOK creates GetPlanVersionsOK with default headers values.
NewGetPlanVersionsParams creates a new GetPlanVersionsParams object
There are no default values defined in the spec.
NewGetPractices creates a new http.Handler for the get practices operation.
NewGetPracticesDefault creates GetPracticesDefault with default headers values.
NewGetPracticesOK creates GetPracticesOK with default headers values.
NewGetPracticesParams creates a new GetPracticesParams object
There are no default values defined in the spec.
NewGetProject creates a new http.Handler for the get project operation.
NewGetProjectDefault creates GetProjectDefault with default headers values.
NewGetProjectOK creates GetProjectOK with default headers values.
NewGetProjectParams creates a new GetProjectParams object
There are no default values defined in the spec.
NewListPracticesVersions creates a new http.Handler for the list practices versions operation.
NewListPracticesVersionsDefault creates ListPracticesVersionsDefault with default headers values.
NewListPracticesVersionsOK creates ListPracticesVersionsOK with default headers values.
NewListPracticesVersionsParams creates a new ListPracticesVersionsParams object
There are no default values defined in the spec.
NewListProjects creates a new http.Handler for the list projects operation.
NewListProjectsDefault creates ListProjectsDefault with default headers values.
NewListProjectsOK creates ListProjectsOK with default headers values.
NewListProjectsParams creates a new ListProjectsParams object
There are no default values defined in the spec.
NewLoggedIn creates a new http.Handler for the logged in operation.
NewLoggedInDefault creates LoggedInDefault with default headers values.
NewLoggedInOK creates LoggedInOK with default headers values.
NewLoggedInParams creates a new LoggedInParams object
There are no default values defined in the spec.
NewUpdateProject creates a new http.Handler for the update project operation.
NewUpdateProjectDefault creates UpdateProjectDefault with default headers values.
NewUpdateProjectOK creates UpdateProjectOK with default headers values.
NewUpdateProjectParams creates a new UpdateProjectParams object
There are no default values defined in the spec.
# Constants
CreatePlanCreatedCode is the HTTP code returned for type CreatePlanCreated.
CreatePlanRevisionOKCode is the HTTP code returned for type CreatePlanRevisionOK.
CreateProjectCreatedCode is the HTTP code returned for type CreateProjectCreated.
DeletePlanNoContentCode is the HTTP code returned for type DeletePlanNoContent.
DeleteProjectNoContentCode is the HTTP code returned for type DeleteProjectNoContent.
GetAuthConfigOKCode is the HTTP code returned for type GetAuthConfigOK.
GetPlanOKCode is the HTTP code returned for type GetPlanOK.
GetPlanRevisionOKCode is the HTTP code returned for type GetPlanRevisionOK.
GetPlanRevisionPracticeResponsesOKCode is the HTTP code returned for type GetPlanRevisionPracticeResponsesOK.
GetPlanVersionsOKCode is the HTTP code returned for type GetPlanVersionsOK.
GetPracticesOKCode is the HTTP code returned for type GetPracticesOK.
GetProjectOKCode is the HTTP code returned for type GetProjectOK.
ListPracticesVersionsOKCode is the HTTP code returned for type ListPracticesVersionsOK.
ListProjectsOKCode is the HTTP code returned for type ListProjectsOK.
LoggedInOKCode is the HTTP code returned for type LoggedInOK.
UpdateProjectOKCode is the HTTP code returned for type UpdateProjectOK.
# Structs
BesecAPI the besec API */.
CreatePlan swagger:route POST /plan createPlan
CreatePlan create plan API
*/.
CreatePlanBody create plan body
swagger:model CreatePlanBody.
CreatePlanCreated Created
swagger:response createPlanCreated
*/.
CreatePlanCreatedBody create plan created body
swagger:model CreatePlanCreatedBody.
CreatePlanDefault error
swagger:response createPlanDefault
*/.
CreatePlanParams contains all the bound params for the create plan operation typically these are obtained from a http.Request
swagger:parameters createPlan.
CreatePlanRevision swagger:route POST /plan/{id} createPlanRevision
CreatePlanRevision create plan revision API
*/.
CreatePlanRevisionBody create plan revision body
swagger:model CreatePlanRevisionBody.
CreatePlanRevisionDefault error
swagger:response createPlanRevisionDefault
*/.
CreatePlanRevisionOK OK
swagger:response createPlanRevisionOK
*/.
CreatePlanRevisionParams contains all the bound params for the create plan revision operation typically these are obtained from a http.Request
swagger:parameters createPlanRevision.
CreatePlanRevisionURL generates an URL for the create plan revision operation.
CreatePlanURL generates an URL for the create plan operation.
CreateProject swagger:route POST /project createProject
CreateProject create project API
*/.
CreateProjectCreated Created
swagger:response createProjectCreated
*/.
CreateProjectDefault error
swagger:response createProjectDefault
*/.
CreateProjectParams contains all the bound params for the create project operation typically these are obtained from a http.Request
swagger:parameters createProject.
CreateProjectURL generates an URL for the create project operation.
DeletePlan swagger:route DELETE /plan/{id} deletePlan
Delete this plan and all of the revisions associated with it
*/.
DeletePlanDefault error
swagger:response deletePlanDefault
*/.
DeletePlanNoContent Deleted
swagger:response deletePlanNoContent
*/.
DeletePlanParams contains all the bound params for the delete plan operation typically these are obtained from a http.Request
swagger:parameters deletePlan.
DeletePlanURL generates an URL for the delete plan operation.
DeleteProject swagger:route DELETE /project/{id} deleteProject
DeleteProject delete project API
*/.
DeleteProjectDefault error
swagger:response deleteProjectDefault
*/.
DeleteProjectNoContent Deleted
swagger:response deleteProjectNoContent
*/.
DeleteProjectParams contains all the bound params for the delete project operation typically these are obtained from a http.Request
swagger:parameters deleteProject.
DeleteProjectURL generates an URL for the delete project operation.
GetAuthConfig swagger:route GET /auth getAuthConfig
GetAuthConfig get auth config API
*/.
GetAuthConfigDefault error
swagger:response getAuthConfigDefault
*/.
GetAuthConfigOK OK
swagger:response getAuthConfigOK
*/.
GetAuthConfigParams contains all the bound params for the get auth config operation typically these are obtained from a http.Request
swagger:parameters getAuthConfig.
GetAuthConfigURL generates an URL for the get auth config operation.
GetPlan swagger:route GET /plan/{id} getPlan
GetPlan get plan API
*/.
GetPlanDefault error
swagger:response getPlanDefault
*/.
GetPlanOK OK
swagger:response getPlanOK
*/.
GetPlanOKBody get plan o k body
swagger:model GetPlanOKBody.
GetPlanParams contains all the bound params for the get plan operation typically these are obtained from a http.Request
swagger:parameters getPlan.
GetPlanRevision swagger:route GET /plan/{id}/revision/{revId} getPlanRevision
GetPlanRevision get plan revision API
*/.
GetPlanRevisionDefault error
swagger:response getPlanRevisionDefault
*/.
GetPlanRevisionOK OK
swagger:response getPlanRevisionOK
*/.
GetPlanRevisionParams contains all the bound params for the get plan revision operation typically these are obtained from a http.Request
swagger:parameters getPlanRevision.
GetPlanRevisionPracticeResponses swagger:route GET /plan/{id}/revision/{revId}/responses getPlanRevisionPracticeResponses
GetPlanRevisionPracticeResponses get plan revision practice responses API
*/.
GetPlanRevisionPracticeResponsesDefault error
swagger:response getPlanRevisionPracticeResponsesDefault
*/.
GetPlanRevisionPracticeResponsesOK OK
swagger:response getPlanRevisionPracticeResponsesOK
*/.
GetPlanRevisionPracticeResponsesParams contains all the bound params for the get plan revision practice responses operation typically these are obtained from a http.Request
swagger:parameters getPlanRevisionPracticeResponses.
GetPlanRevisionPracticeResponsesURL generates an URL for the get plan revision practice responses operation.
GetPlanRevisionURL generates an URL for the get plan revision operation.
GetPlanURL generates an URL for the get plan operation.
GetPlanVersions swagger:route GET /plan/{id}/versions getPlanVersions
GetPlanVersions get plan versions API
*/.
GetPlanVersionsDefault error
swagger:response getPlanVersionsDefault
*/.
GetPlanVersionsOK OK
swagger:response getPlanVersionsOK
*/.
GetPlanVersionsParams contains all the bound params for the get plan versions operation typically these are obtained from a http.Request
swagger:parameters getPlanVersions.
GetPlanVersionsURL generates an URL for the get plan versions operation.
GetPractices swagger:route GET /practices/{version} getPractices
GetPractices get practices API
*/.
GetPracticesDefault error
swagger:response getPracticesDefault
*/.
GetPracticesOK OK
swagger:response getPracticesOK
*/.
GetPracticesParams contains all the bound params for the get practices operation typically these are obtained from a http.Request
swagger:parameters getPractices.
GetPracticesURL generates an URL for the get practices operation.
GetProject swagger:route GET /project/{id} getProject
GetProject get project API
*/.
GetProjectDefault error
swagger:response getProjectDefault
*/.
GetProjectOK OK
swagger:response getProjectOK
*/.
GetProjectParams contains all the bound params for the get project operation typically these are obtained from a http.Request
swagger:parameters getProject.
GetProjectURL generates an URL for the get project operation.
ListPracticesVersions swagger:route GET /practices listPracticesVersions
ListPracticesVersions list practices versions API
*/.
ListPracticesVersionsDefault error
swagger:response listPracticesVersionsDefault
*/.
ListPracticesVersionsOK OK
swagger:response listPracticesVersionsOK
*/.
ListPracticesVersionsParams contains all the bound params for the list practices versions operation typically these are obtained from a http.Request
swagger:parameters listPracticesVersions.
ListPracticesVersionsURL generates an URL for the list practices versions operation.
ListProjects swagger:route GET /project listProjects
ListProjects list projects API
*/.
ListProjectsDefault error
swagger:response listProjectsDefault
*/.
ListProjectsOK OK
swagger:response listProjectsOK
*/.
ListProjectsParams contains all the bound params for the list projects operation typically these are obtained from a http.Request
swagger:parameters listProjects.
ListProjectsURL generates an URL for the list projects operation.
LoggedIn swagger:route POST /auth loggedIn
Used to trigger one-time events like requesting access.
LoggedInDefault No access, access requested, invalid ID token, or internal error
swagger:response loggedInDefault
*/.
LoggedInOK OK
swagger:response loggedInOK
*/.
LoggedInParams contains all the bound params for the logged in operation typically these are obtained from a http.Request
swagger:parameters loggedIn.
LoggedInURL generates an URL for the logged in operation.
UpdateProject swagger:route PUT /project/{id} updateProject
UpdateProject update project API
*/.
UpdateProjectDefault error
swagger:response updateProjectDefault
*/.
UpdateProjectOK OK
swagger:response updateProjectOK
*/.
UpdateProjectParams contains all the bound params for the update project operation typically these are obtained from a http.Request
swagger:parameters updateProject.
UpdateProjectURL generates an URL for the update project operation.
# Interfaces
CreatePlanHandler interface for that can handle valid create plan params.
CreatePlanRevisionHandler interface for that can handle valid create plan revision params.
CreateProjectHandler interface for that can handle valid create project params.
DeletePlanHandler interface for that can handle valid delete plan params.
DeleteProjectHandler interface for that can handle valid delete project params.
GetAuthConfigHandler interface for that can handle valid get auth config params.
GetPlanHandler interface for that can handle valid get plan params.
GetPlanRevisionHandler interface for that can handle valid get plan revision params.
GetPlanRevisionPracticeResponsesHandler interface for that can handle valid get plan revision practice responses params.
GetPlanVersionsHandler interface for that can handle valid get plan versions params.
GetPracticesHandler interface for that can handle valid get practices params.
GetProjectHandler interface for that can handle valid get project params.
ListPracticesVersionsHandler interface for that can handle valid list practices versions params.
ListProjectsHandler interface for that can handle valid list projects params.
LoggedInHandler interface for that can handle valid logged in params.
UpdateProjectHandler interface for that can handle valid update project params.
# Type aliases
CreatePlanHandlerFunc turns a function with the right signature into a create plan handler.
CreatePlanRevisionHandlerFunc turns a function with the right signature into a create plan revision handler.
CreateProjectHandlerFunc turns a function with the right signature into a create project handler.
DeletePlanHandlerFunc turns a function with the right signature into a delete plan handler.
DeleteProjectHandlerFunc turns a function with the right signature into a delete project handler.
GetAuthConfigHandlerFunc turns a function with the right signature into a get auth config handler.
GetPlanHandlerFunc turns a function with the right signature into a get plan handler.
GetPlanRevisionHandlerFunc turns a function with the right signature into a get plan revision handler.
GetPlanRevisionPracticeResponsesHandlerFunc turns a function with the right signature into a get plan revision practice responses handler.
GetPlanVersionsHandlerFunc turns a function with the right signature into a get plan versions handler.
GetPracticesHandlerFunc turns a function with the right signature into a get practices handler.
GetProjectHandlerFunc turns a function with the right signature into a get project handler.
ListPracticesVersionsHandlerFunc turns a function with the right signature into a list practices versions handler.
ListProjectsHandlerFunc turns a function with the right signature into a list projects handler.
LoggedInHandlerFunc turns a function with the right signature into a logged in handler.
UpdateProjectHandlerFunc turns a function with the right signature into a update project handler.