mirror of
https://github.com/portainer/portainer.git
synced 2025-07-22 14:59:41 +02:00
50b57614cf
* 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
68 lines
2.2 KiB
Go
68 lines
2.2 KiB
Go
package dockerhub
|
|
|
|
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 dockerhubUpdatePayload struct {
|
|
// Enable authentication against DockerHub
|
|
Authentication bool `validate:"required" example:"false"`
|
|
// Username used to authenticate against the DockerHub
|
|
Username string `validate:"required" example:"hub_user"`
|
|
// Password used to authenticate against the DockerHub
|
|
Password string `validate:"required" example:"hub_password"`
|
|
}
|
|
|
|
func (payload *dockerhubUpdatePayload) Validate(r *http.Request) error {
|
|
if payload.Authentication && (govalidator.IsNull(payload.Username) || govalidator.IsNull(payload.Password)) {
|
|
return errors.New("Invalid credentials. Username and password must be specified when authentication is enabled")
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// @id DockerHubUpdate
|
|
// @summary Update DockerHub information
|
|
// @description Use this endpoint to update the information used to connect to the DockerHub
|
|
// @description **Access policy**: administrator
|
|
// @tags dockerhub
|
|
// @security jwt
|
|
// @accept json
|
|
// @produce json
|
|
// @param body body dockerhubUpdatePayload true "DockerHub information"
|
|
// @success 204 "Success"
|
|
// @failure 400 "Invalid request"
|
|
// @failure 500 "Server error"
|
|
// @router /dockerhub [put]
|
|
func (handler *Handler) dockerhubUpdate(w http.ResponseWriter, r *http.Request) *httperror.HandlerError {
|
|
var payload dockerhubUpdatePayload
|
|
err := request.DecodeAndValidateJSONPayload(r, &payload)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusBadRequest, "Invalid request payload", err}
|
|
}
|
|
|
|
dockerhub := &portainer.DockerHub{
|
|
Authentication: false,
|
|
Username: "",
|
|
Password: "",
|
|
}
|
|
|
|
if payload.Authentication {
|
|
dockerhub.Authentication = true
|
|
dockerhub.Username = payload.Username
|
|
dockerhub.Password = payload.Password
|
|
}
|
|
|
|
err = handler.DataStore.DockerHub().UpdateDockerHub(dockerhub)
|
|
if err != nil {
|
|
return &httperror.HandlerError{http.StatusInternalServerError, "Unable to persist the Dockerhub changes inside the database", err}
|
|
}
|
|
|
|
return response.Empty(w)
|
|
}
|