mirror of
https://github.com/portainer/portainer.git
synced 2025-07-21 14:29:40 +02:00
* feat(api): introduce swagger * feat(api): anottate api * chore(api): tag endpoints * chore(api): remove tags * chore(api): add docs for oauth auth * chore(api): document create endpoint api * chore(api): document endpoint inspect and list * chore(api): document endpoint update and snapshots * docs(endpointgroups): document groups api * docs(auth): document auth api * chore(build): introduce a yarn script to build api docs * docs(api): document auth * docs(customtemplates): document customtemplates api * docs(tags): document api * docs(api): document the use of token * docs(dockerhub): document dockerhub api * docs(edgegroups): document edgegroups api * docs(edgejobs): document api * docs(edgestacks): doc api * docs(http/upload): add security * docs(api): document edge templates * docs(edge): document edge jobs * docs(endpointgroups): change description * docs(endpoints): document missing apis * docs(motd): doc api * docs(registries): doc api * docs(resourcecontrol): api doc * docs(role): add swagger docs * docs(settings): add swagger docs * docs(api/status): add swagger docs * docs(api/teammembership): add swagger docs * docs(api/teams): add swagger docs * docs(api/templates): add swagger docs * docs(api/users): add swagger docs * docs(api/webhooks): add swagger docs * docs(api/webscokets): add swagger docs * docs(api/stacks): swagger * docs(api): fix missing apis * docs(swagger): regen * chore(build): remove docs from build * docs(api): update tags * docs(api): document tags * docs(api): add description * docs(api): rename jwt token * docs(api): add info about types * docs(api): document types * docs(api): update request types annotation * docs(api): doc registry and resource control * chore(docs): add snippet * docs(api): add description to role * docs(api): add types for settings * docs(status): add types * style(swagger): remove documented code * docs(http/upload): update docs with types * docs(http/tags): add types * docs(api/custom_templates): add types * docs(api/teammembership): add types * docs(http/teams): add types * docs(http/stacks): add types * docs(edge): add types to edgestack * docs(http/teammembership): remove double returns * docs(api/user): add types * docs(http): fixes to make file built * chore(snippets): add scope to swagger snippet * chore(deps): install swag * chore(swagger): remove handler * docs(api): add description * docs(api): ignore docs folder * docs(api): add contributing guidelines * docs(api): cleanup handler * chore(deps): require swaggo * fix(auth): fix typo * fix(docs): make http ids pascal case * feat(edge): add ids to http handlers * fix(docs): add ids * fix(docs): show correct api version * chore(deps): remove swaggo dependency * chore(docs): add install script for swag
107 lines
3.5 KiB
Go
107 lines
3.5 KiB
Go
package endpointgroups
|
|
|
|
import (
|
|
"errors"
|
|
"net/http"
|
|
|
|
"github.com/asaskevich/govalidator"
|
|
httperror "github.com/portainer/libhttp/error"
|
|
"github.com/portainer/libhttp/request"
|
|
"github.com/portainer/libhttp/response"
|
|
portainer "github.com/portainer/portainer/api"
|
|
)
|
|
|
|
type endpointGroupCreatePayload struct {
|
|
// Endpoint group name
|
|
Name string `validate:"required" example:"my-endpoint-group"`
|
|
// Endpoint group description
|
|
Description string `example:"description"`
|
|
// List of endpoint identifiers that will be part of this group
|
|
AssociatedEndpoints []portainer.EndpointID `example:"1,3"`
|
|
// List of tag identifiers to which this endpoint group is associated
|
|
TagIDs []portainer.TagID `example:"1,2"`
|
|
}
|
|
|
|
func (payload *endpointGroupCreatePayload) Validate(r *http.Request) error {
|
|
if govalidator.IsNull(payload.Name) {
|
|
return errors.New("Invalid endpoint group name")
|
|
}
|
|
if payload.TagIDs == nil {
|
|
payload.TagIDs = []portainer.TagID{}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// @summary Create an Endpoint Group
|
|
// @description Create a new endpoint group.
|
|
// @description **Access policy**: administrator
|
|
// @tags endpoint_groups
|
|
// @security jwt
|
|
// @accept json
|
|
// @produce json
|
|
// @param body body endpointGroupCreatePayload true "Endpoint Group details"
|
|
// @success 200 {object} portainer.EndpointGroup "Success"
|
|
// @failure 400 "Invalid request"
|
|
// @failure 500 "Server error"
|
|
// @router /endpoint_groups [post]
|
|
func (handler *Handler) endpointGroupCreate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
|
var payload endpointGroupCreatePayload
|
|
err := request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid request payload", err}
|
|
}
|
|
|
|
endpointGroup := &portainer.EndpointGroup{
|
|
Name: payload.Name,
|
|
Description: payload.Description,
|
|
UserAccessPolicies: portainer.UserAccessPolicies{},
|
|
TeamAccessPolicies: portainer.TeamAccessPolicies{},
|
|
TagIDs: payload.TagIDs,
|
|
}
|
|
|
|
err = handler.DataStore.EndpointGroup().CreateEndpointGroup(endpointGroup)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist the endpoint group inside the database", err}
|
|
}
|
|
|
|
endpoints, err := handler.DataStore.Endpoint().Endpoints()
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve endpoints from the database", err}
|
|
}
|
|
|
|
for _, id := range payload.AssociatedEndpoints {
|
|
for _, endpoint := range endpoints {
|
|
if endpoint.ID == id {
|
|
endpoint.GroupID = endpointGroup.ID
|
|
|
|
err := handler.DataStore.Endpoint().UpdateEndpoint(endpoint.ID, &endpoint)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to update endpoint", err}
|
|
}
|
|
|
|
err = handler.updateEndpointRelations(&endpoint, endpointGroup)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist endpoint relations changes inside the database", err}
|
|
}
|
|
|
|
break
|
|
}
|
|
}
|
|
}
|
|
|
|
for _, tagID := range endpointGroup.TagIDs {
|
|
tag, err := handler.DataStore.Tag().Tag(tagID)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve tag from the database", err}
|
|
}
|
|
|
|
tag.EndpointGroups[endpointGroup.ID] = true
|
|
|
|
err = handler.DataStore.Tag().UpdateTag(tagID, tag)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist tag changes inside the database", err}
|
|
}
|
|
}
|
|
|
|
return response.JSON(w, endpointGroup)
|
|
}
|