mirror of
https://github.com/portainer/portainer.git
synced 2025-07-23 07:19:41 +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
127 lines
4.3 KiB
Go
127 lines
4.3 KiB
Go
package registries
|
|
|
|
import (
|
|
"errors"
|
|
"net/http"
|
|
|
|
httperror "github.com/portainer/libhttp/error"
|
|
"github.com/portainer/libhttp/request"
|
|
"github.com/portainer/libhttp/response"
|
|
portainer "github.com/portainer/portainer/api"
|
|
bolterrors "github.com/portainer/portainer/api/bolt/errors"
|
|
)
|
|
|
|
type registryUpdatePayload struct {
|
|
// Name that will be used to identify this registry
|
|
Name *string `validate:"required" example:"my-registry"`
|
|
// URL or IP address of the Docker registry
|
|
URL *string `validate:"required" example:"registry.mydomain.tld:2375"`
|
|
// Is authentication against this registry enabled
|
|
Authentication *bool `example:"false" validate:"required"`
|
|
// Username used to authenticate against this registry. Required when Authentication is true
|
|
Username *string `example:"registry_user"`
|
|
// Password used to authenticate against this registry. required when Authentication is true
|
|
Password *string `example:"registry_password"`
|
|
UserAccessPolicies portainer.UserAccessPolicies
|
|
TeamAccessPolicies portainer.TeamAccessPolicies
|
|
}
|
|
|
|
func (payload *registryUpdatePayload) Validate(r *http.Request) error {
|
|
return nil
|
|
}
|
|
|
|
// @id RegistryUpdate
|
|
// @summary Update a registry
|
|
// @description Update a registry
|
|
// @description **Access policy**: administrator
|
|
// @tags registries
|
|
// @security jwt
|
|
// @accept json
|
|
// @produce json
|
|
// @param id path int true "Registry identifier"
|
|
// @param body body registryUpdatePayload true "Registry details"
|
|
// @success 200 {object} portainer.Registry "Success"
|
|
// @failure 400 "Invalid request"
|
|
// @failure 404 "Registry not found"
|
|
// @failure 409 "Another registry with the same URL already exists"
|
|
// @failure 500 "Server error"
|
|
// @router /registries/{id} [put]
|
|
func (handler *Handler) registryUpdate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
|
registryID, err := request.RetrieveNumericRouteVariableValue(r, "id")
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid registry identifier route variable", err}
|
|
}
|
|
|
|
var payload registryUpdatePayload
|
|
err = request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid request payload", err}
|
|
}
|
|
|
|
registry, err := handler.DataStore.Registry().Registry(portainer.RegistryID(registryID))
|
|
if err == bolterrors.ErrObjectNotFound {
|
|
return &httperror.HandlerError{http.StatusNotFound, "Unable to find a registry with the specified identifier inside the database", err}
|
|
} else if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to find a registry with the specified identifier inside the database", err}
|
|
}
|
|
|
|
if payload.Name != nil {
|
|
registry.Name = *payload.Name
|
|
}
|
|
|
|
if payload.URL != nil {
|
|
registries, err := handler.DataStore.Registry().Registries()
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to retrieve registries from the database", err}
|
|
}
|
|
for _, r := range registries {
|
|
if r.ID != registry.ID && hasSameURL(&r, registry) {
|
|
return &httperror.HandlerError{http.StatusConflict, "Another registry with the same URL already exists", errors.New("A registry is already defined for this URL")}
|
|
}
|
|
}
|
|
|
|
registry.URL = *payload.URL
|
|
}
|
|
|
|
if payload.Authentication != nil {
|
|
if *payload.Authentication {
|
|
registry.Authentication = true
|
|
|
|
if payload.Username != nil {
|
|
registry.Username = *payload.Username
|
|
}
|
|
|
|
if payload.Password != nil && *payload.Password != "" {
|
|
registry.Password = *payload.Password
|
|
}
|
|
|
|
} else {
|
|
registry.Authentication = false
|
|
registry.Username = ""
|
|
registry.Password = ""
|
|
}
|
|
}
|
|
|
|
if payload.UserAccessPolicies != nil {
|
|
registry.UserAccessPolicies = payload.UserAccessPolicies
|
|
}
|
|
|
|
if payload.TeamAccessPolicies != nil {
|
|
registry.TeamAccessPolicies = payload.TeamAccessPolicies
|
|
}
|
|
|
|
err = handler.DataStore.Registry().UpdateRegistry(registry.ID, registry)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist registry changes inside the database", err}
|
|
}
|
|
|
|
return response.JSON(w, registry)
|
|
}
|
|
|
|
func hasSameURL(r1, r2 *portainer.Registry) bool {
|
|
if r1.Type != portainer.GitlabRegistry || r2.Type != portainer.GitlabRegistry {
|
|
return r1.URL == r2.URL
|
|
}
|
|
|
|
return r1.URL == r2.URL && r1.Gitlab.ProjectPath == r2.Gitlab.ProjectPath
|
|
}
|