docs(api): document apis with swagger (#4678)

* 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

api/http/handler/handler.go

@@ -64,6 +64,77 @@ type Handler struct {
 	WebhookHandler         *webhooks.Handler
 }
 
+// @title PortainerCE API
+// @version 2.1.1
+// @description.markdown api-description.md
+// @termsOfService
+
+// @contact.email info@portainer.io
+
+// @license.name
+// @license.url
+
+// @host
+// @BasePath /api
+// @schemes http https
+
+// @securitydefinitions.apikey jwt
+// @in header
+// @name Authorization
+
+// @tag.name auth
+// @tag.description Authenticate against Portainer HTTP API
+// @tag.name custom_templates
+// @tag.description Manage Custom Templates
+// @tag.name dockerhub
+// @tag.description Manage how Portainer connects to the DockerHub
+// @tag.name edge_groups
+// @tag.description Manage Edge Groups
+// @tag.name edge_jobs
+// @tag.description Manage Edge Jobs
+// @tag.name edge_stacks
+// @tag.description Manage Edge Stacks
+// @tag.name edge_templates
+// @tag.description Manage Edge Templates
+// @tag.name edge
+// @tag.description Manage Edge related endpoint settings
+// @tag.name endpoints
+// @tag.description Manage Docker environments
+// @tag.name endpoint_groups
+// @tag.description Manage endpoint groups
+// @tag.name motd
+// @tag.description Fetch the message of the day
+// @tag.name registries
+// @tag.description Manage Docker registries
+// @tag.name resource_controls
+// @tag.description Manage access control on Docker resources
+// @tag.name roles
+// @tag.description Manage roles
+// @tag.name settings
+// @tag.description Manage Portainer settings
+// @tag.name status
+// @tag.description Information about the Portainer instance
+// @tag.name stacks
+// @tag.description Manage Docker stacks
+// @tag.name users
+// @tag.description Manage users
+// @tag.name tags
+// @tag.description Manage tags
+// @tag.name teams
+// @tag.description Manage teams
+// @tag.name team_memberships
+// @tag.description Manage team memberships
+// @tag.name templates
+// @tag.description Manage App Templates
+// @tag.name stacks
+// @tag.description Manage stacks
+// @tag.name upload
+// @tag.description Upload files
+// @tag.name webhooks
+// @tag.description Manage webhooks
+// @tag.name websocket
+// @tag.description Create exec sessions using websockets
+
 // ServeHTTP delegates a request to the appropriate subhandler.
 func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	switch {