mirror of
https://github.com/portainer/portainer.git
synced 2025-07-22 06:49: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
143 lines
5.1 KiB
Go
143 lines
5.1 KiB
Go
package endpointgroups
|
|
|
|
import (
|
|
"net/http"
|
|
"reflect"
|
|
|
|
httperror "github.com/portainer/libhttp/error"
|
|
"github.com/portainer/libhttp/request"
|
|
"github.com/portainer/libhttp/response"
|
|
portainer "github.com/portainer/portainer/api"
|
|
"github.com/portainer/portainer/api/bolt/errors"
|
|
"github.com/portainer/portainer/api/internal/tag"
|
|
)
|
|
|
|
type endpointGroupUpdatePayload struct {
|
|
// Endpoint group name
|
|
Name string `example:"my-endpoint-group"`
|
|
// Endpoint group description
|
|
Description string `example:"description"`
|
|
// List of tag identifiers associated to the endpoint group
|
|
TagIDs []portainer.TagID `example:"3,4"`
|
|
UserAccessPolicies portainer.UserAccessPolicies
|
|
TeamAccessPolicies portainer.TeamAccessPolicies
|
|
}
|
|
|
|
func (payload *endpointGroupUpdatePayload) Validate(r *http.Request) error {
|
|
return nil
|
|
}
|
|
|
|
// @id EndpointGroupUpdate
|
|
// @summary Update an endpoint group
|
|
// @description Update an endpoint group.
|
|
// @description **Access policy**: administrator
|
|
// @tags endpoint_groups
|
|
// @security jwt
|
|
// @accept json
|
|
// @produce json
|
|
// @param id path int true "EndpointGroup identifier"
|
|
// @param body body endpointGroupUpdatePayload true "EndpointGroup details"
|
|
// @success 200 {object} portainer.EndpointGroup "Success"
|
|
// @failure 400 "Invalid request"
|
|
// @failure 404 "EndpointGroup not found"
|
|
// @failure 500 "Server error"
|
|
// @router /endpoint_groups/:id [put]
|
|
func (handler *Handler) endpointGroupUpdate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
|
endpointGroupID, err := request.RetrieveNumericRouteVariableValue(r, "id")
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid endpoint group identifier route variable", err}
|
|
}
|
|
|
|
var payload endpointGroupUpdatePayload
|
|
err = request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid request payload", err}
|
|
}
|
|
|
|
endpointGroup, err := handler.DataStore.EndpointGroup().EndpointGroup(portainer.EndpointGroupID(endpointGroupID))
|
|
if err == errors.ErrObjectNotFound {
|
|
return &httperror.HandlerError{http.StatusNotFound, "Unable to find an endpoint group with the specified identifier inside the database", err}
|
|
} else if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find an endpoint group with the specified identifier inside the database", err}
|
|
}
|
|
|
|
if payload.Name != "" {
|
|
endpointGroup.Name = payload.Name
|
|
}
|
|
|
|
if payload.Description != "" {
|
|
endpointGroup.Description = payload.Description
|
|
}
|
|
|
|
tagsChanged := false
|
|
if payload.TagIDs != nil {
|
|
payloadTagSet := tag.Set(payload.TagIDs)
|
|
endpointGroupTagSet := tag.Set((endpointGroup.TagIDs))
|
|
union := tag.Union(payloadTagSet, endpointGroupTagSet)
|
|
intersection := tag.Intersection(payloadTagSet, endpointGroupTagSet)
|
|
tagsChanged = len(union) > len(intersection)
|
|
|
|
if tagsChanged {
|
|
removeTags := tag.Difference(endpointGroupTagSet, payloadTagSet)
|
|
|
|
for tagID := range removeTags {
|
|
tag, err := handler.DataStore.Tag().Tag(tagID)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find a tag inside the database", err}
|
|
}
|
|
delete(tag.EndpointGroups, endpointGroup.ID)
|
|
err = handler.DataStore.Tag().UpdateTag(tag.ID, tag)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist tag changes inside the database", err}
|
|
}
|
|
}
|
|
|
|
endpointGroup.TagIDs = payload.TagIDs
|
|
for _, tagID := range payload.TagIDs {
|
|
tag, err := handler.DataStore.Tag().Tag(tagID)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find a tag inside the database", err}
|
|
}
|
|
|
|
tag.EndpointGroups[endpointGroup.ID] = true
|
|
|
|
err = handler.DataStore.Tag().UpdateTag(tag.ID, tag)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist tag changes inside the database", err}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if payload.UserAccessPolicies != nil && !reflect.DeepEqual(payload.UserAccessPolicies, endpointGroup.UserAccessPolicies) {
|
|
endpointGroup.UserAccessPolicies = payload.UserAccessPolicies
|
|
}
|
|
|
|
if payload.TeamAccessPolicies != nil && !reflect.DeepEqual(payload.TeamAccessPolicies, endpointGroup.TeamAccessPolicies) {
|
|
endpointGroup.TeamAccessPolicies = payload.TeamAccessPolicies
|
|
}
|
|
|
|
err = handler.DataStore.EndpointGroup().UpdateEndpointGroup(endpointGroup.ID, endpointGroup)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist endpoint group changes inside the database", err}
|
|
}
|
|
|
|
if tagsChanged {
|
|
endpoints, err := handler.DataStore.Endpoint().Endpoints()
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve endpoints from the database", err}
|
|
|
|
}
|
|
|
|
for _, endpoint := range endpoints {
|
|
if endpoint.GroupID == endpointGroup.ID {
|
|
err = handler.updateEndpointRelations(&endpoint, endpointGroup)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist endpoint relations changes inside the database", err}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return response.JSON(w, endpointGroup)
|
|
}
|