diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 18d7393545..2f3e83b54d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,10 +1,14 @@ ## Requirements -Make sure you have following tools installed [golang](https://golang.org/), [dep](https://github.com/golang/dep), [protobuf](https://developers.google.com/protocol-buffers/), +Make sure you have following tools installed [docker](https://docs.docker.com/install/#supported-platforms), [golang](https://golang.org/), [dep](https://github.com/golang/dep), [protobuf](https://developers.google.com/protocol-buffers/), [ksonnet](https://github.com/ksonnet/ksonnet#install), [go-swagger](https://github.com/go-swagger/go-swagger/blob/master/docs/install.md), and [jq](https://stedolan.github.io/jq/) [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/). ``` -$ brew install go dep protobuf kubectl +$ brew tap go-swagger/go-swagger +$ brew install go dep protobuf kubectl ksonnet/tap/ks jq go-swagger $ go get -u github.com/golang/protobuf/protoc-gen-go +$ go get -u github.com/go-swagger/go-swagger/cmd/swagger +$ go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway +$ go get -u github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger ``` Nice to have [gometalinter](https://github.com/alecthomas/gometalinter) and [goreman](https://github.com/mattn/goreman): @@ -20,6 +24,11 @@ $ go get -u github.com/argoproj/argo-cd $ dep ensure $ make ``` +NOTE: The make command can take a while, and we recommend building the specific component you are working on +* `make cli` - Make the argocd CLI tool +* `make server` - Make the API/repo/controller server +* `make codegen` - Builds protobuf and swagger files +* `make argocd-util` - Make the administrator's utility, used for certain tasks such as import/export ## Running locally @@ -38,3 +47,10 @@ $ kubectl create -f install/manifests/01_application-crd.yaml ``` $ goreman start ``` + +## Troubleshooting +* Ensure argocd is installed: ./dist/argocd install +* Ensure you're logged in: ./dist/argocd login --username admin --password localhost:8080 +* Ensure that roles are configured: kubectl create -f install/manifests/02c_argocd-rbac-cm.yaml +* Ensure minikube is running: minikube stop && minikube start +* Ensure Argo CD is aware of minikube: ./dist/argocd cluster add minikube diff --git a/Gopkg.lock b/Gopkg.lock index 5628bfb853..3148051ffc 100644 --- a/Gopkg.lock +++ b/Gopkg.lock @@ -32,6 +32,12 @@ packages = ["."] revision = "de5bf2ad457846296e2031421a34e2568e304e35" +[[projects]] + name = "github.com/asaskevich/govalidator" + packages = ["."] + revision = "ccb8e960c48f04d6935e72476ae4a51028f9e22f" + version = "v9" + [[projects]] name = "github.com/blang/semver" packages = ["."] @@ -89,6 +95,18 @@ packages = ["."] revision = "0ca9ea5df5451ffdf184b4428c902747c2c11cd7" +[[projects]] + branch = "master" + name = "github.com/go-openapi/analysis" + packages = ["."] + revision = "5957818e100395077187fb7ef3b8a28227af06c6" + +[[projects]] + branch = "master" + name = "github.com/go-openapi/errors" + packages = ["."] + revision = "b2b2befaf267d082d779bcef52d682a47c779517" + [[projects]] branch = "master" name = "github.com/go-openapi/jsonpointer" @@ -101,18 +119,50 @@ packages = ["."] revision = "36d33bfe519efae5632669801b180bf1a245da3b" +[[projects]] + branch = "master" + name = "github.com/go-openapi/loads" + packages = ["."] + revision = "2a2b323bab96e6b1fdee110e57d959322446e9c9" + +[[projects]] + branch = "master" + name = "github.com/go-openapi/runtime" + packages = [ + ".", + "logger", + "middleware", + "middleware/denco", + "middleware/header", + "middleware/untyped", + "security" + ] + revision = "cd9d8ed52e4b4665463cbc655500e4faa09c3c16" + [[projects]] branch = "master" name = "github.com/go-openapi/spec" packages = ["."] revision = "1de3e0542de65ad8d75452a595886fdd0befb363" +[[projects]] + branch = "master" + name = "github.com/go-openapi/strfmt" + packages = ["."] + revision = "481808443b00a14745fada967cb5eeff0f9b1df2" + [[projects]] branch = "master" name = "github.com/go-openapi/swag" packages = ["."] revision = "84f4bee7c0a6db40e3166044c7983c1c32125429" +[[projects]] + branch = "master" + name = "github.com/go-openapi/validate" + packages = ["."] + revision = "b0a3ed684d0fdd3e1eda00433382188ce8aa7169" + [[projects]] name = "github.com/go-redis/cache" packages = [ @@ -190,7 +240,11 @@ packages = [ "jsonpb", "proto", + "protoc-gen-go", "protoc-gen-go/descriptor", + "protoc-gen-go/generator", + "protoc-gen-go/grpc", + "protoc-gen-go/plugin", "ptypes", "ptypes/any", "ptypes/duration", @@ -243,6 +297,14 @@ [[projects]] name = "github.com/grpc-ecosystem/grpc-gateway" packages = [ + "protoc-gen-grpc-gateway", + "protoc-gen-grpc-gateway/descriptor", + "protoc-gen-grpc-gateway/generator", + "protoc-gen-grpc-gateway/gengateway", + "protoc-gen-grpc-gateway/httprule", + "protoc-gen-swagger", + "protoc-gen-swagger/genswagger", + "protoc-gen-swagger/options", "runtime", "runtime/internal", "utilities" @@ -333,6 +395,12 @@ ] revision = "32fa128f234d041f196a9f3e0fea5ac9772c08e1" +[[projects]] + branch = "master" + name = "github.com/mitchellh/mapstructure" + packages = ["."] + revision = "bb74f1db0675b241733089d5a1faa5dd8b0ef57b" + [[projects]] name = "github.com/patrickmn/go-cache" packages = ["."] @@ -614,6 +682,15 @@ revision = "3887ee99ecf07df5b447e9b00d9c0b2adaa9f3e4" version = "v0.9.0" +[[projects]] + branch = "v2" + name = "gopkg.in/mgo.v2" + packages = [ + "bson", + "internal/json" + ] + revision = "3f83fa5005286a7fe593b055f0d7771a7dce4655" + [[projects]] name = "gopkg.in/square/go-jose.v2" packages = [ @@ -933,6 +1010,6 @@ [solve-meta] analyzer-name = "dep" analyzer-version = 1 - inputs-digest = "f2d179e0bbae6ede81f78cf6b0b16cb09fbeb5e97add78bdd97e3051238b86da" + inputs-digest = "38ccdbf0eaabe461fdf17a5d12463b3db0b61aab4daf9937f2e813d2ae2d2eb5" solver-name = "gps-cdcl" solver-version = 1 diff --git a/Gopkg.toml b/Gopkg.toml index 87d7423108..1735231087 100644 --- a/Gopkg.toml +++ b/Gopkg.toml @@ -3,6 +3,9 @@ required = [ "github.com/gogo/protobuf/protoc-gen-gogofast", "golang.org/x/sync/errgroup", "k8s.io/code-generator/cmd/go-to-protobuf", + "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway", + "github.com/grpc-ecosystem/grpc-gateway/protoc-gen-swagger", + "github.com/golang/protobuf/protoc-gen-go", ] [[constraint]] diff --git a/hack/generate-proto.sh b/hack/generate-proto.sh index 57293a7086..f6714c944d 100755 --- a/hack/generate-proto.sh +++ b/hack/generate-proto.sh @@ -1,4 +1,4 @@ -#!/bin/bash +#! /usr/bin/env bash # This script auto-generates protobuf related files. It is intended to be run manually when either # API types are added/modified, or server gRPC calls are added. The generated files should then @@ -77,5 +77,44 @@ for i in ${PROTO_FILES}; do -I${GOGO_PROTOBUF_PATH} \ --${GOPROTOBINARY}_out=plugins=grpc:$GOPATH/src \ --grpc-gateway_out=logtostderr=true:$GOPATH/src \ + --swagger_out=logtostderr=true:. \ $i done + +# collect_swagger gathers swagger files into a subdirectory +collect_swagger() { + SWAGGER_ROOT="$1" + EXPECTED_COLLISIONS="$2" + SWAGGER_OUT="${SWAGGER_ROOT}/swagger.json" + PRIMARY_SWAGGER=`mktemp` + COMBINED_SWAGGER=`mktemp` + + cat < "${PRIMARY_SWAGGER}" +{ + "swagger": "2.0", + "info": { + "title": "Consolidate Services", + "description": "Description of all APIs", + "version": "version not set" + }, + "paths": {} +} +EOF + + /bin/rm -f "${SWAGGER_OUT}" + + /usr/bin/find "${SWAGGER_ROOT}" -name '*.swagger.json' -exec /usr/local/bin/swagger mixin -c "${EXPECTED_COLLISIONS}" "${PRIMARY_SWAGGER}" '{}' \+ > "${COMBINED_SWAGGER}" + /usr/local/bin/jq -r 'del(.definitions[].properties[]? | select(."$ref"!=null and .description!=null).description) | del(.definitions[].properties[]? | select(."$ref"!=null and .title!=null).title)' "${COMBINED_SWAGGER}" > "${SWAGGER_OUT}" + + /bin/rm "${PRIMARY_SWAGGER}" "${COMBINED_SWAGGER}" +} + +# clean up generated swagger files (should come after collect_swagger) +clean_swagger() { + SWAGGER_ROOT="$1" + /usr/bin/find "${SWAGGER_ROOT}" -name '*.swagger.json' -delete +} + +collect_swagger server 15 +clean_swagger server +clean_swagger reposerver diff --git a/reposerver/swagger.json b/reposerver/swagger.json new file mode 100644 index 0000000000..a72e1f719e --- /dev/null +++ b/reposerver/swagger.json @@ -0,0 +1,136 @@ +{ + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "info": { + "description": "Description of all APIs", + "title": "Consolidate Services", + "version": "version not set" + }, + "paths": {}, + "definitions": { + "repositoryFileList": { + "type": "object", + "title": "FileList returns the contents of the repo of a ListDir request", + "properties": { + "items": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "repositoryGetFileResponse": { + "type": "object", + "title": "GetFileResponse returns the contents of the file of a GetFile request", + "properties": { + "data": { + "type": "string", + "format": "byte" + } + } + }, + "repositoryManifestResponse": { + "type": "object", + "properties": { + "manifests": { + "type": "array", + "items": { + "type": "string" + } + }, + "namespace": { + "type": "string" + }, + "params": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1ComponentParameter" + } + }, + "revision": { + "type": "string" + }, + "server": { + "type": "string" + } + } + }, + "v1Time": { + "description": "Time is a wrapper around time.Time which supports correct\nmarshaling to YAML and JSON. Wrappers are provided for many\nof the factory methods that the time package offers.\n\n+protobuf.options.marshal=false\n+protobuf.as=Timestamp\n+protobuf.options.(gogoproto.goproto_stringer)=false", + "type": "object", + "properties": { + "nanos": { + "description": "Non-negative fractions of a second at nanosecond resolution. Negative\nsecond values with fractions must still have non-negative nanos values\nthat count forward in time. Must be from 0 to 999,999,999\ninclusive. This field may be limited in precision depending on context.", + "type": "integer", + "format": "int32" + }, + "seconds": { + "description": "Represents seconds of UTC time since Unix epoch\n1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to\n9999-12-31T23:59:59Z inclusive.", + "type": "string", + "format": "int64" + } + } + }, + "v1alpha1ComponentParameter": { + "type": "object", + "title": "ComponentParameter contains information about component parameter value", + "properties": { + "component": { + "type": "string" + }, + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "v1alpha1ConnectionState": { + "type": "object", + "title": "ConnectionState contains information about remote resource connection state", + "properties": { + "attemptedAt": { + "$ref": "#/definitions/v1Time" + }, + "message": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "v1alpha1Repository": { + "type": "object", + "title": "Repository is a Git repository holding application configurations", + "properties": { + "connectionState": { + "$ref": "#/definitions/v1alpha1ConnectionState" + }, + "password": { + "type": "string" + }, + "repo": { + "type": "string" + }, + "sshPrivateKey": { + "type": "string" + }, + "username": { + "type": "string" + } + } + } + } +} diff --git a/server/application/application.pb.go b/server/application/application.pb.go index 614d7a4fd7..c32f271d40 100644 --- a/server/application/application.pb.go +++ b/server/application/application.pb.go @@ -509,15 +509,15 @@ type ApplicationServiceClient interface { GetManifests(ctx context.Context, in *ApplicationManifestQuery, opts ...grpc.CallOption) (*repository.ManifestResponse, error) // Update updates an application Update(ctx context.Context, in *ApplicationUpdateRequest, opts ...grpc.CallOption) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.Application, error) - // Update updates an application spec + // UpdateSpec updates an application spec UpdateSpec(ctx context.Context, in *ApplicationUpdateSpecRequest, opts ...grpc.CallOption) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.ApplicationSpec, error) // Delete deletes an application Delete(ctx context.Context, in *ApplicationDeleteRequest, opts ...grpc.CallOption) (*ApplicationResponse, error) // Sync syncs an application to its target state Sync(ctx context.Context, in *ApplicationSyncRequest, opts ...grpc.CallOption) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.Application, error) - // Sync syncs an application to its target state + // Rollback syncs an application to its target state Rollback(ctx context.Context, in *ApplicationRollbackRequest, opts ...grpc.CallOption) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.Application, error) - // PodLogs returns stream of log entries for the specified pod. Pod + // DeletePod returns stream of log entries for the specified pod. Pod DeletePod(ctx context.Context, in *ApplicationDeletePodRequest, opts ...grpc.CallOption) (*ApplicationResponse, error) // PodLogs returns stream of log entries for the specified pod. Pod PodLogs(ctx context.Context, in *ApplicationPodLogsQuery, opts ...grpc.CallOption) (ApplicationService_PodLogsClient, error) @@ -711,15 +711,15 @@ type ApplicationServiceServer interface { GetManifests(context.Context, *ApplicationManifestQuery) (*repository.ManifestResponse, error) // Update updates an application Update(context.Context, *ApplicationUpdateRequest) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.Application, error) - // Update updates an application spec + // UpdateSpec updates an application spec UpdateSpec(context.Context, *ApplicationUpdateSpecRequest) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.ApplicationSpec, error) // Delete deletes an application Delete(context.Context, *ApplicationDeleteRequest) (*ApplicationResponse, error) // Sync syncs an application to its target state Sync(context.Context, *ApplicationSyncRequest) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.Application, error) - // Sync syncs an application to its target state + // Rollback syncs an application to its target state Rollback(context.Context, *ApplicationRollbackRequest) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.Application, error) - // PodLogs returns stream of log entries for the specified pod. Pod + // DeletePod returns stream of log entries for the specified pod. Pod DeletePod(context.Context, *ApplicationDeletePodRequest) (*ApplicationResponse, error) // PodLogs returns stream of log entries for the specified pod. Pod PodLogs(*ApplicationPodLogsQuery, ApplicationService_PodLogsServer) error diff --git a/server/application/application.proto b/server/application/application.proto index c1787a23c9..3289c593a4 100644 --- a/server/application/application.proto +++ b/server/application/application.proto @@ -135,7 +135,7 @@ service ApplicationService { }; } - // Update updates an application spec + // UpdateSpec updates an application spec rpc UpdateSpec(ApplicationUpdateSpecRequest) returns (github.com.argoproj.argo_cd.pkg.apis.application.v1alpha1.ApplicationSpec) { option (google.api.http) = { put: "/api/v1/applications/{name}/spec" @@ -156,7 +156,7 @@ service ApplicationService { }; } - // Sync syncs an application to its target state + // Rollback syncs an application to its target state rpc Rollback(ApplicationRollbackRequest) returns (github.com.argoproj.argo_cd.pkg.apis.application.v1alpha1.Application) { option (google.api.http) = { post: "/api/v1/applications/{name}/rollback" @@ -164,7 +164,7 @@ service ApplicationService { }; } - // PodLogs returns stream of log entries for the specified pod. Pod + // DeletePod returns stream of log entries for the specified pod. Pod rpc DeletePod(ApplicationDeletePodRequest) returns (ApplicationResponse) { option (google.api.http).delete = "/api/v1/applications/{name}/pods/{podName}"; } diff --git a/server/cluster/cluster.pb.go b/server/cluster/cluster.pb.go index 2082f69f27..996ffa0a9a 100644 --- a/server/cluster/cluster.pb.go +++ b/server/cluster/cluster.pb.go @@ -126,7 +126,7 @@ type ClusterServiceClient interface { Get(ctx context.Context, in *ClusterQuery, opts ...grpc.CallOption) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.Cluster, error) // Update updates a cluster Update(ctx context.Context, in *ClusterUpdateRequest, opts ...grpc.CallOption) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.Cluster, error) - // Delete updates a cluster + // Delete deletes a cluster Delete(ctx context.Context, in *ClusterQuery, opts ...grpc.CallOption) (*ClusterResponse, error) } @@ -194,7 +194,7 @@ type ClusterServiceServer interface { Get(context.Context, *ClusterQuery) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.Cluster, error) // Update updates a cluster Update(context.Context, *ClusterUpdateRequest) (*github_com_argoproj_argo_cd_pkg_apis_application_v1alpha1.Cluster, error) - // Delete updates a cluster + // Delete deletes a cluster Delete(context.Context, *ClusterQuery) (*ClusterResponse, error) } diff --git a/server/cluster/cluster.proto b/server/cluster/cluster.proto index 1228dec897..b758a282d1 100644 --- a/server/cluster/cluster.proto +++ b/server/cluster/cluster.proto @@ -56,7 +56,7 @@ service ClusterService { }; } - // Delete updates a cluster + // Delete deletes a cluster rpc Delete(ClusterQuery) returns (ClusterResponse) { option (google.api.http).delete = "/api/v1/clusters/{server}"; } diff --git a/server/project/project.go b/server/project/project.go index 56985cc9c1..4f819435ec 100644 --- a/server/project/project.go +++ b/server/project/project.go @@ -37,7 +37,7 @@ func (s *Server) Create(ctx context.Context, q *ProjectCreateRequest) (*v1alpha1 return nil, grpc.ErrPermissionDenied } if q.Project.Name == common.DefaultAppProjectName { - return nil, status.Errorf(codes.InvalidArgument, "name '%s' is reserved and cannot be used as a project name") + return nil, status.Errorf(codes.InvalidArgument, "name '%s' is reserved and cannot be used as a project name", q.Project.Name) } return s.appclientset.ArgoprojV1alpha1().AppProjects(s.ns).Create(q.Project) } diff --git a/server/server.go b/server/server.go index 8566bb2570..259088bd6a 100644 --- a/server/server.go +++ b/server/server.go @@ -50,6 +50,7 @@ import ( "github.com/argoproj/argo-cd/util/rbac" util_session "github.com/argoproj/argo-cd/util/session" settings_util "github.com/argoproj/argo-cd/util/settings" + "github.com/argoproj/argo-cd/util/swagger" tlsutil "github.com/argoproj/argo-cd/util/tls" "github.com/argoproj/argo-cd/util/webhook" ) @@ -377,6 +378,8 @@ func (a *ArgoCDServer) newHTTPServer(ctx context.Context, port int) *http.Server mustRegisterGWHandler(settings.RegisterSettingsServiceHandlerFromEndpoint, ctx, gwmux, endpoint, dOpts) mustRegisterGWHandler(project.RegisterProjectServiceHandlerFromEndpoint, ctx, gwmux, endpoint, dOpts) + swagger.ServeSwaggerUI(mux, "server", "/swagger-ui") + // Dex reverse proxy and client app and OAuth2 login/callback a.registerDexHandlers(mux) diff --git a/server/session/session.pb.go b/server/session/session.pb.go index 35f343e658..7d5145f81d 100644 --- a/server/session/session.pb.go +++ b/server/session/session.pb.go @@ -118,9 +118,9 @@ const _ = grpc.SupportPackageIsVersion4 // Client API for SessionService service type SessionServiceClient interface { - // Create a new JWT for authentication. + // Create a new JWT for authentication and set a cookie if using HTTP. Create(ctx context.Context, in *SessionCreateRequest, opts ...grpc.CallOption) (*SessionResponse, error) - // Create a new JWT for authentication. + // Delete an existing JWT cookie if using HTTP. Delete(ctx context.Context, in *SessionDeleteRequest, opts ...grpc.CallOption) (*SessionResponse, error) } @@ -153,9 +153,9 @@ func (c *sessionServiceClient) Delete(ctx context.Context, in *SessionDeleteRequ // Server API for SessionService service type SessionServiceServer interface { - // Create a new JWT for authentication. + // Create a new JWT for authentication and set a cookie if using HTTP. Create(context.Context, *SessionCreateRequest) (*SessionResponse, error) - // Create a new JWT for authentication. + // Delete an existing JWT cookie if using HTTP. Delete(context.Context, *SessionDeleteRequest) (*SessionResponse, error) } diff --git a/server/session/session.proto b/server/session/session.proto index a9eb7172c6..339cbd2c65 100644 --- a/server/session/session.proto +++ b/server/session/session.proto @@ -30,7 +30,7 @@ message SessionResponse { // SessionService service SessionService { - // Create a new JWT for authentication. + // Create a new JWT for authentication and set a cookie if using HTTP. rpc Create(SessionCreateRequest) returns (SessionResponse) { option (google.api.http) = { post: "/api/v1/session" @@ -38,7 +38,7 @@ service SessionService { }; } - // Create a new JWT for authentication. + // Delete an existing JWT cookie if using HTTP. rpc Delete(SessionDeleteRequest) returns (SessionResponse) { option (google.api.http) = { delete: "/api/v1/session" diff --git a/server/swagger.json b/server/swagger.json new file mode 100644 index 0000000000..ece3ab92a9 --- /dev/null +++ b/server/swagger.json @@ -0,0 +1,2207 @@ +{ + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "schemes": [ + "http", + "https" + ], + "swagger": "2.0", + "info": { + "description": "Description of all APIs", + "title": "Consolidate Services", + "version": "version not set" + }, + "paths": { + "/api/v1/applications": { + "get": { + "tags": [ + "ApplicationService" + ], + "summary": "List returns list of applications", + "operationId": "ListMixin5", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "query" + }, + { + "type": "boolean", + "format": "boolean", + "name": "refresh", + "in": "query" + }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "project", + "in": "query" + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1ApplicationList" + } + } + } + }, + "post": { + "tags": [ + "ApplicationService" + ], + "summary": "Create creates an application", + "operationId": "CreateMixin5", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v1alpha1Application" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1Application" + } + } + } + } + }, + "/api/v1/applications/{application.metadata.name}": { + "put": { + "tags": [ + "ApplicationService" + ], + "summary": "Update updates an application", + "operationId": "UpdateMixin5", + "parameters": [ + { + "type": "string", + "name": "application.metadata.name", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v1alpha1Application" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1Application" + } + } + } + } + }, + "/api/v1/applications/{name}": { + "get": { + "tags": [ + "ApplicationService" + ], + "summary": "Get returns an application by name", + "operationId": "GetMixin5", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "path", + "required": true + }, + { + "type": "boolean", + "format": "boolean", + "name": "refresh", + "in": "query" + }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "project", + "in": "query" + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1Application" + } + } + } + }, + "delete": { + "tags": [ + "ApplicationService" + ], + "summary": "Delete deletes an application", + "operationId": "DeleteMixin5", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "path", + "required": true + }, + { + "type": "boolean", + "format": "boolean", + "name": "cascade", + "in": "query" + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/applicationApplicationResponse" + } + } + } + } + }, + "/api/v1/applications/{name}/events": { + "get": { + "tags": [ + "ApplicationService" + ], + "summary": "ListResourceEvents returns a list of event resources", + "operationId": "ListResourceEvents", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "path", + "required": true + }, + { + "type": "string", + "name": "resourceName", + "in": "query" + }, + { + "type": "string", + "name": "resourceUID", + "in": "query" + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1EventList" + } + } + } + } + }, + "/api/v1/applications/{name}/manifests": { + "get": { + "tags": [ + "ApplicationService" + ], + "summary": "GetManifests returns application manifests", + "operationId": "GetManifests", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "path", + "required": true + }, + { + "type": "string", + "name": "revision", + "in": "query" + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/repositoryManifestResponse" + } + } + } + } + }, + "/api/v1/applications/{name}/pods/{podName}": { + "delete": { + "tags": [ + "ApplicationService" + ], + "summary": "DeletePod returns stream of log entries for the specified pod. Pod", + "operationId": "DeletePod", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "path", + "required": true + }, + { + "type": "string", + "name": "podName", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/applicationApplicationResponse" + } + } + } + } + }, + "/api/v1/applications/{name}/pods/{podName}/logs": { + "get": { + "tags": [ + "ApplicationService" + ], + "summary": "PodLogs returns stream of log entries for the specified pod. Pod", + "operationId": "PodLogs", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "path", + "required": true + }, + { + "type": "string", + "name": "podName", + "in": "path", + "required": true + }, + { + "type": "string", + "name": "container", + "in": "query" + }, + { + "type": "string", + "format": "int64", + "name": "sinceSeconds", + "in": "query" + }, + { + "type": "string", + "format": "int64", + "description": "Represents seconds of UTC time since Unix epoch\n1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to\n9999-12-31T23:59:59Z inclusive.", + "name": "sinceTime.seconds", + "in": "query" + }, + { + "type": "integer", + "format": "int32", + "description": "Non-negative fractions of a second at nanosecond resolution. Negative\nsecond values with fractions must still have non-negative nanos values\nthat count forward in time. Must be from 0 to 999,999,999\ninclusive. This field may be limited in precision depending on context.", + "name": "sinceTime.nanos", + "in": "query" + }, + { + "type": "string", + "format": "int64", + "name": "tailLines", + "in": "query" + }, + { + "type": "boolean", + "format": "boolean", + "name": "follow", + "in": "query" + } + ], + "responses": { + "200": { + "description": "(streaming responses)", + "schema": { + "$ref": "#/definitions/applicationLogEntry" + } + } + } + } + }, + "/api/v1/applications/{name}/rollback": { + "post": { + "tags": [ + "ApplicationService" + ], + "summary": "Rollback syncs an application to its target state", + "operationId": "Rollback", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/applicationApplicationRollbackRequest" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1Application" + } + } + } + } + }, + "/api/v1/applications/{name}/spec": { + "put": { + "tags": [ + "ApplicationService" + ], + "summary": "UpdateSpec updates an application spec", + "operationId": "UpdateSpec", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v1alpha1ApplicationSpec" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1ApplicationSpec" + } + } + } + } + }, + "/api/v1/applications/{name}/sync": { + "post": { + "tags": [ + "ApplicationService" + ], + "summary": "Sync syncs an application to its target state", + "operationId": "Sync", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/applicationApplicationSyncRequest" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1Application" + } + } + } + } + }, + "/api/v1/clusters": { + "get": { + "tags": [ + "ClusterService" + ], + "summary": "List returns list of clusters", + "operationId": "List", + "parameters": [ + { + "type": "string", + "name": "server", + "in": "query" + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1ClusterList" + } + } + } + }, + "post": { + "tags": [ + "ClusterService" + ], + "summary": "Create creates a cluster", + "operationId": "Create", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v1alpha1Cluster" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1Cluster" + } + } + } + } + }, + "/api/v1/clusters/{cluster.server}": { + "put": { + "tags": [ + "ClusterService" + ], + "summary": "Update updates a cluster", + "operationId": "Update", + "parameters": [ + { + "type": "string", + "name": "cluster.server", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v1alpha1Cluster" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1Cluster" + } + } + } + } + }, + "/api/v1/clusters/{server}": { + "get": { + "tags": [ + "ClusterService" + ], + "summary": "Get returns a cluster by server address", + "operationId": "GetMixin1", + "parameters": [ + { + "type": "string", + "name": "server", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1Cluster" + } + } + } + }, + "delete": { + "tags": [ + "ClusterService" + ], + "summary": "Delete deletes a cluster", + "operationId": "Delete", + "parameters": [ + { + "type": "string", + "name": "server", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/clusterClusterResponse" + } + } + } + } + }, + "/api/v1/projects": { + "get": { + "tags": [ + "ProjectService" + ], + "summary": "List returns list of projects", + "operationId": "ListMixin3", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "query" + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1AppProjectList" + } + } + } + }, + "post": { + "tags": [ + "ProjectService" + ], + "summary": "Create a new project.", + "operationId": "CreateMixin3", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/projectProjectCreateRequest" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1AppProject" + } + } + } + } + }, + "/api/v1/projects/{name}": { + "get": { + "tags": [ + "ProjectService" + ], + "summary": "Get returns a project by name", + "operationId": "GetMixin3", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1AppProject" + } + } + } + } + }, + "/api/v1/repositories": { + "get": { + "tags": [ + "RepositoryService" + ], + "summary": "List returns list of repos", + "operationId": "ListMixin2", + "parameters": [ + { + "type": "string", + "name": "repo", + "in": "query" + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1RepositoryList" + } + } + } + }, + "post": { + "tags": [ + "RepositoryService" + ], + "summary": "Create creates a repo", + "operationId": "CreateMixin2", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v1alpha1Repository" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1Repository" + } + } + } + } + }, + "/api/v1/repositories/{name}": { + "delete": { + "tags": [ + "ProjectService" + ], + "summary": "Delete deletes a project", + "operationId": "DeleteMixin3", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/projectEmptyResponse" + } + } + } + } + }, + "/api/v1/repositories/{project.metadata.name}": { + "put": { + "tags": [ + "ProjectService" + ], + "summary": "Update updates a project", + "operationId": "UpdateMixin3", + "parameters": [ + { + "type": "string", + "name": "project.metadata.name", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/projectProjectUpdateRequest" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1AppProject" + } + } + } + } + }, + "/api/v1/repositories/{repo.repo}": { + "put": { + "tags": [ + "RepositoryService" + ], + "summary": "Update updates a repo", + "operationId": "UpdateMixin2", + "parameters": [ + { + "type": "string", + "name": "repo.repo", + "in": "path", + "required": true + }, + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/v1alpha1Repository" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1Repository" + } + } + } + } + }, + "/api/v1/repositories/{repo}": { + "get": { + "tags": [ + "RepositoryService" + ], + "summary": "Get returns a repo by name", + "operationId": "GetMixin2", + "parameters": [ + { + "type": "string", + "name": "repo", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/v1alpha1Repository" + } + } + } + }, + "delete": { + "tags": [ + "RepositoryService" + ], + "summary": "Delete deletes a repo", + "operationId": "DeleteMixin2", + "parameters": [ + { + "type": "string", + "name": "repo", + "in": "path", + "required": true + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/repositoryRepoResponse" + } + } + } + } + }, + "/api/v1/repositories/{repo}/ksonnet": { + "get": { + "tags": [ + "RepositoryService" + ], + "summary": "ListKsonnetApps returns list of Ksonnet apps in the repo", + "operationId": "ListKsonnetApps", + "parameters": [ + { + "type": "string", + "name": "repo", + "in": "path", + "required": true + }, + { + "type": "string", + "name": "revision", + "in": "query" + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/repositoryRepoKsonnetResponse" + } + } + } + } + }, + "/api/v1/session": { + "post": { + "tags": [ + "SessionService" + ], + "summary": "Create a new JWT for authentication and set a cookie if using HTTP.", + "operationId": "CreateMixin6", + "parameters": [ + { + "name": "body", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/sessionSessionCreateRequest" + } + } + ], + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/sessionSessionResponse" + } + } + } + }, + "delete": { + "tags": [ + "SessionService" + ], + "summary": "Delete an existing JWT cookie if using HTTP.", + "operationId": "DeleteMixin6", + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/sessionSessionResponse" + } + } + } + } + }, + "/api/v1/settings": { + "get": { + "tags": [ + "SettingsService" + ], + "summary": "Get returns ArgoCD settings", + "operationId": "Get", + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/clusterSettings" + } + } + } + } + }, + "/api/v1/stream/applications": { + "get": { + "tags": [ + "ApplicationService" + ], + "summary": "Watch returns stream of application change events.", + "operationId": "Watch", + "parameters": [ + { + "type": "string", + "name": "name", + "in": "query" + }, + { + "type": "boolean", + "format": "boolean", + "name": "refresh", + "in": "query" + }, + { + "type": "array", + "items": { + "type": "string" + }, + "name": "project", + "in": "query" + } + ], + "responses": { + "200": { + "description": "(streaming responses)", + "schema": { + "$ref": "#/definitions/v1alpha1ApplicationWatchEvent" + } + } + } + } + }, + "/api/version": { + "get": { + "tags": [ + "VersionService" + ], + "summary": "Version returns version information of the API server", + "operationId": "Version", + "responses": { + "200": { + "description": "(empty)", + "schema": { + "$ref": "#/definitions/versionVersionMessage" + } + } + } + } + } + }, + "definitions": { + "apismetav1ObjectMeta": { + "description": "ObjectMeta is metadata that all persisted resources must have, which includes all objects\nusers must create.", + "type": "object", + "properties": { + "annotations": { + "type": "object", + "title": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: http://kubernetes.io/docs/user-guide/annotations\n+optional", + "additionalProperties": { + "type": "string" + } + }, + "clusterName": { + "type": "string", + "title": "The name of the cluster which the object belongs to.\nThis is used to distinguish resources with same name and namespace in different clusters.\nThis field is not set anywhere right now and apiserver is going to ignore it if set in create or update request.\n+optional" + }, + "creationTimestamp": { + "$ref": "#/definitions/v1Time" + }, + "deletionGracePeriodSeconds": { + "type": "string", + "format": "int64", + "title": "Number of seconds allowed for this object to gracefully terminate before\nit will be removed from the system. Only set when deletionTimestamp is also set.\nMay only be shortened.\nRead-only.\n+optional" + }, + "deletionTimestamp": { + "$ref": "#/definitions/v1Time" + }, + "finalizers": { + "type": "array", + "title": "Must be empty before the object is deleted from the registry. Each entry\nis an identifier for the responsible component that will remove the entry\nfrom the list. If the deletionTimestamp of the object is non-nil, entries\nin this list can only be removed.\n+optional\n+patchStrategy=merge", + "items": { + "type": "string" + } + }, + "generateName": { + "description": "GenerateName is an optional prefix, used by the server, to generate a unique\nname ONLY IF the Name field has not been provided.\nIf this field is used, the name returned to the client will be different\nthan the name passed. This value will also be combined with a unique suffix.\nThe provided value has the same validation rules as the Name field,\nand may be truncated by the length of the suffix required to make the value\nunique on the server.\n\nIf this field is specified and the generated name exists, the server will\nNOT return a 409 - instead, it will either return 201 Created or 500 with Reason\nServerTimeout indicating a unique name could not be found in the time allotted, and the client\nshould retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified.\nMore info: https://git.k8s.io/community/contributors/devel/api-conventions.md#idempotency\n+optional", + "type": "string" + }, + "generation": { + "type": "string", + "format": "int64", + "title": "A sequence number representing a specific generation of the desired state.\nPopulated by the system. Read-only.\n+optional" + }, + "initializers": { + "$ref": "#/definitions/v1Initializers" + }, + "labels": { + "type": "object", + "title": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: http://kubernetes.io/docs/user-guide/labels\n+optional", + "additionalProperties": { + "type": "string" + } + }, + "name": { + "type": "string", + "title": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names\n+optional" + }, + "namespace": { + "description": "Namespace defines the space within each name must be unique. An empty namespace is\nequivalent to the \"default\" namespace, but \"default\" is the canonical representation.\nNot all objects are required to be scoped to a namespace - the value of this field for\nthose objects will be empty.\n\nMust be a DNS_LABEL.\nCannot be updated.\nMore info: http://kubernetes.io/docs/user-guide/namespaces\n+optional", + "type": "string" + }, + "ownerReferences": { + "type": "array", + "title": "List of objects depended by this object. If ALL objects in the list have\nbeen deleted, this object will be garbage collected. If this object is managed by a controller,\nthen an entry in this list will point to this controller, with the controller field set to true.\nThere cannot be more than one managing controller.\n+optional\n+patchMergeKey=uid\n+patchStrategy=merge", + "items": { + "$ref": "#/definitions/v1OwnerReference" + } + }, + "resourceVersion": { + "description": "An opaque value that represents the internal version of this object that can\nbe used by clients to determine when objects have changed. May be used for optimistic\nconcurrency, change detection, and the watch operation on a resource or set of resources.\nClients must treat these values as opaque and passed unmodified back to the server.\nThey may only be valid for a particular resource or set of resources.\n\nPopulated by the system.\nRead-only.\nValue must be treated as opaque by clients and .\nMore info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency\n+optional", + "type": "string" + }, + "selfLink": { + "type": "string", + "title": "SelfLink is a URL representing this object.\nPopulated by the system.\nRead-only.\n+optional" + }, + "uid": { + "description": "UID is the unique in time and space value for this object. It is typically generated by\nthe server on successful creation of a resource and is not allowed to change on PUT\noperations.\n\nPopulated by the system.\nRead-only.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#uids\n+optional", + "type": "string" + } + } + }, + "applicationApplicationResponse": { + "type": "object" + }, + "applicationApplicationRollbackRequest": { + "type": "object", + "properties": { + "dryRun": { + "type": "boolean", + "format": "boolean" + }, + "id": { + "type": "string", + "format": "int64" + }, + "name": { + "type": "string" + }, + "prune": { + "type": "boolean", + "format": "boolean" + } + } + }, + "applicationApplicationSyncRequest": { + "type": "object", + "title": "ApplicationSyncRequest is a request to apply the config state to live state", + "properties": { + "dryRun": { + "type": "boolean", + "format": "boolean" + }, + "name": { + "type": "string" + }, + "prune": { + "type": "boolean", + "format": "boolean" + }, + "revision": { + "type": "string" + } + } + }, + "applicationLogEntry": { + "type": "object", + "properties": { + "content": { + "type": "string" + }, + "timeStamp": { + "$ref": "#/definitions/v1Time" + } + } + }, + "clusterClusterResponse": { + "type": "object" + }, + "clusterConnector": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "clusterDexConfig": { + "type": "object", + "properties": { + "connectors": { + "type": "array", + "items": { + "$ref": "#/definitions/clusterConnector" + } + } + } + }, + "clusterSettings": { + "type": "object", + "properties": { + "dexConfig": { + "$ref": "#/definitions/clusterDexConfig" + }, + "url": { + "type": "string" + } + } + }, + "projectEmptyResponse": { + "type": "object" + }, + "projectProjectCreateRequest": { + "description": "ProjectCreateRequest defines project creation parameters.", + "type": "object", + "properties": { + "project": { + "$ref": "#/definitions/v1alpha1AppProject" + } + } + }, + "projectProjectUpdateRequest": { + "type": "object", + "properties": { + "project": { + "$ref": "#/definitions/v1alpha1AppProject" + } + } + }, + "repositoryKsonnetAppSpec": { + "type": "object", + "title": "KsonnetAppSpec contains Ksonnet app response\nThis roughly reflects: ksonnet/ksonnet/metadata/app/schema.go", + "properties": { + "environments": { + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/repositoryKsonnetEnvironment" + } + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + } + } + }, + "repositoryKsonnetEnvironment": { + "type": "object", + "properties": { + "destination": { + "$ref": "#/definitions/repositoryKsonnetEnvironmentDestination" + }, + "k8sVersion": { + "description": "KubernetesVersion is the kubernetes version the targetted cluster is running on.", + "type": "string" + }, + "name": { + "type": "string", + "title": "Name is the user defined name of an environment" + }, + "path": { + "description": "Path is the relative project path containing metadata for this environment.", + "type": "string" + } + } + }, + "repositoryKsonnetEnvironmentDestination": { + "type": "object", + "properties": { + "namespace": { + "type": "string", + "title": "Namespace is the namespace of the Kubernetes server that targets should be deployed to" + }, + "server": { + "description": "Server is the Kubernetes server that the cluster is running on.", + "type": "string" + } + } + }, + "repositoryManifestResponse": { + "type": "object", + "properties": { + "manifests": { + "type": "array", + "items": { + "type": "string" + } + }, + "namespace": { + "type": "string" + }, + "params": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1ComponentParameter" + } + }, + "revision": { + "type": "string" + }, + "server": { + "type": "string" + } + } + }, + "repositoryRepoKsonnetResponse": { + "type": "object", + "title": "RepoKsonnetResponse is a response for Repository contents matching a particular path", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/repositoryKsonnetAppSpec" + } + } + } + }, + "repositoryRepoResponse": { + "type": "object" + }, + "sessionSessionCreateRequest": { + "description": "SessionCreateRequest is for logging in.", + "type": "object", + "properties": { + "password": { + "type": "string" + }, + "token": { + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "sessionSessionResponse": { + "description": "SessionResponse wraps the created token or returns an empty string if deleted.", + "type": "object", + "properties": { + "token": { + "type": "string" + } + } + }, + "v1Event": { + "description": "Event is a report of an event somewhere in the cluster.", + "type": "object", + "properties": { + "action": { + "type": "string", + "title": "What action was taken/failed regarding to the Regarding object.\n+optional" + }, + "count": { + "type": "integer", + "format": "int32", + "title": "The number of times this event has occurred.\n+optional" + }, + "eventTime": { + "$ref": "#/definitions/v1MicroTime" + }, + "firstTimestamp": { + "$ref": "#/definitions/v1Time" + }, + "involvedObject": { + "$ref": "#/definitions/v1ObjectReference" + }, + "lastTimestamp": { + "$ref": "#/definitions/v1Time" + }, + "message": { + "type": "string", + "title": "A human-readable description of the status of this operation.\nTODO: decide on maximum length.\n+optional" + }, + "metadata": { + "$ref": "#/definitions/apismetav1ObjectMeta" + }, + "reason": { + "type": "string", + "title": "This should be a short, machine understandable string that gives the reason\nfor the transition into the object's current status.\nTODO: provide exact specification for format.\n+optional" + }, + "related": { + "$ref": "#/definitions/v1ObjectReference" + }, + "reportingComponent": { + "type": "string", + "title": "Name of the controller that emitted this Event, e.g. `kubernetes.io/kubelet`.\n+optional" + }, + "reportingInstance": { + "type": "string", + "title": "ID of the controller instance, e.g. `kubelet-xyzf`.\n+optional" + }, + "series": { + "$ref": "#/definitions/v1EventSeries" + }, + "source": { + "$ref": "#/definitions/v1EventSource" + }, + "type": { + "type": "string", + "title": "Type of this event (Normal, Warning), new types could be added in the future\n+optional" + } + } + }, + "v1EventList": { + "description": "EventList is a list of events.", + "type": "object", + "properties": { + "items": { + "type": "array", + "title": "List of events", + "items": { + "$ref": "#/definitions/v1Event" + } + }, + "metadata": { + "$ref": "#/definitions/v1ListMeta" + } + } + }, + "v1EventSeries": { + "description": "EventSeries contain information on series of events, i.e. thing that was/is happening\ncontinuously for some time.", + "type": "object", + "properties": { + "count": { + "type": "integer", + "format": "int32", + "title": "Number of occurrences in this series up to the last heartbeat time" + }, + "lastObservedTime": { + "$ref": "#/definitions/v1MicroTime" + }, + "state": { + "type": "string", + "title": "State of this Series: Ongoing or Finished" + } + } + }, + "v1EventSource": { + "description": "EventSource contains information for an event.", + "type": "object", + "properties": { + "component": { + "type": "string", + "title": "Component from which the event is generated.\n+optional" + }, + "host": { + "type": "string", + "title": "Node name on which the event is generated.\n+optional" + } + } + }, + "v1Initializer": { + "description": "Initializer is information about an initializer that has not yet completed.", + "type": "object", + "properties": { + "name": { + "description": "name of the process that is responsible for initializing this object.", + "type": "string" + } + } + }, + "v1Initializers": { + "description": "Initializers tracks the progress of initialization.", + "type": "object", + "properties": { + "pending": { + "type": "array", + "title": "Pending is a list of initializers that must execute in order before this object is visible.\nWhen the last pending initializer is removed, and no failing result is set, the initializers\nstruct will be set to nil and the object is considered as initialized and visible to all\nclients.\n+patchMergeKey=name\n+patchStrategy=merge", + "items": { + "$ref": "#/definitions/v1Initializer" + } + }, + "result": { + "$ref": "#/definitions/v1Status" + } + } + }, + "v1ListMeta": { + "description": "ListMeta describes metadata that synthetic resources must have, including lists and\nvarious status objects. A resource may have only one of {ObjectMeta, ListMeta}.", + "type": "object", + "properties": { + "continue": { + "description": "continue may be set if the user set a limit on the number of items returned, and indicates that\nthe server has more data available. The value is opaque and may be used to issue another request\nto the endpoint that served this list to retrieve the next set of available objects. Continuing a\nlist may not be possible if the server configuration has changed or more than a few minutes have\npassed. The resourceVersion field returned when using this continue value will be identical to\nthe value in the first response.", + "type": "string" + }, + "resourceVersion": { + "type": "string", + "title": "String that identifies the server's internal version of this object that\ncan be used by clients to determine when objects have changed.\nValue must be treated as opaque by clients and passed unmodified back to the server.\nPopulated by the system.\nRead-only.\nMore info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency\n+optional" + }, + "selfLink": { + "type": "string", + "title": "selfLink is a URL representing this object.\nPopulated by the system.\nRead-only.\n+optional" + } + } + }, + "v1MicroTime": { + "description": "MicroTime is version of Time with microsecond level precision.\n\n+protobuf.options.marshal=false\n+protobuf.as=Timestamp\n+protobuf.options.(gogoproto.goproto_stringer)=false", + "type": "object", + "properties": { + "nanos": { + "description": "Non-negative fractions of a second at nanosecond resolution. Negative\nsecond values with fractions must still have non-negative nanos values\nthat count forward in time. Must be from 0 to 999,999,999\ninclusive. This field may be limited in precision depending on context.", + "type": "integer", + "format": "int32" + }, + "seconds": { + "description": "Represents seconds of UTC time since Unix epoch\n1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to\n9999-12-31T23:59:59Z inclusive.", + "type": "string", + "format": "int64" + } + } + }, + "v1ObjectReference": { + "type": "object", + "title": "ObjectReference contains enough information to let you inspect or modify the referred object.\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object", + "properties": { + "apiVersion": { + "type": "string", + "title": "API version of the referent.\n+optional" + }, + "fieldPath": { + "type": "string", + "title": "If referring to a piece of an object instead of an entire object, this string\nshould contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].\nFor example, if the object reference is to a container within a pod, this would take on a value like:\n\"spec.containers{name}\" (where \"name\" refers to the name of the container that triggered\nthe event) or if no container name is specified \"spec.containers[2]\" (container with\nindex 2 in this pod). This syntax is chosen only to have some well-defined way of\nreferencing a part of an object.\nTODO: this design is not final and this field is subject to change in the future.\n+optional" + }, + "kind": { + "type": "string", + "title": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds\n+optional" + }, + "name": { + "type": "string", + "title": "Name of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names\n+optional" + }, + "namespace": { + "type": "string", + "title": "Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/\n+optional" + }, + "resourceVersion": { + "type": "string", + "title": "Specific resourceVersion to which this reference is made, if any.\nMore info: https://git.k8s.io/community/contributors/devel/api-conventions.md#concurrency-control-and-consistency\n+optional" + }, + "uid": { + "type": "string", + "title": "UID of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids\n+optional" + } + } + }, + "v1OwnerReference": { + "description": "OwnerReference contains enough information to let you identify an owning\nobject. Currently, an owning object must be in the same namespace, so there\nis no namespace field.", + "type": "object", + "properties": { + "apiVersion": { + "description": "API version of the referent.", + "type": "string" + }, + "blockOwnerDeletion": { + "type": "boolean", + "format": "boolean", + "title": "If true, AND if the owner has the \"foregroundDeletion\" finalizer, then\nthe owner cannot be deleted from the key-value store until this\nreference is removed.\nDefaults to false.\nTo set this field, a user needs \"delete\" permission of the owner,\notherwise 422 (Unprocessable Entity) will be returned.\n+optional" + }, + "controller": { + "type": "boolean", + "format": "boolean", + "title": "If true, this reference points to the managing controller.\n+optional" + }, + "kind": { + "type": "string", + "title": "Kind of the referent.\nMore info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds" + }, + "name": { + "type": "string", + "title": "Name of the referent.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#names" + }, + "uid": { + "type": "string", + "title": "UID of the referent.\nMore info: http://kubernetes.io/docs/user-guide/identifiers#uids" + } + } + }, + "v1Status": { + "description": "Status is a return value for calls that don't return other objects.", + "type": "object", + "properties": { + "code": { + "type": "integer", + "format": "int32", + "title": "Suggested HTTP return code for this status, 0 if not set.\n+optional" + }, + "details": { + "$ref": "#/definitions/v1StatusDetails" + }, + "message": { + "type": "string", + "title": "A human-readable description of the status of this operation.\n+optional" + }, + "metadata": { + "$ref": "#/definitions/v1ListMeta" + }, + "reason": { + "type": "string", + "title": "A machine-readable description of why this operation is in the\n\"Failure\" status. If this value is empty there\nis no information available. A Reason clarifies an HTTP status\ncode but does not override it.\n+optional" + }, + "status": { + "type": "string", + "title": "Status of the operation.\nOne of: \"Success\" or \"Failure\".\nMore info: https://git.k8s.io/community/contributors/devel/api-conventions.md#spec-and-status\n+optional" + } + } + }, + "v1StatusCause": { + "description": "StatusCause provides more information about an api.Status failure, including\ncases when multiple errors are encountered.", + "type": "object", + "properties": { + "field": { + "description": "The field of the resource that has caused this error, as named by its JSON\nserialization. May include dot and postfix notation for nested attributes.\nArrays are zero-indexed. Fields may appear more than once in an array of\ncauses due to fields having multiple errors.\nOptional.\n\nExamples:\n \"name\" - the field \"name\" on the current resource\n \"items[0].name\" - the field \"name\" on the first array entry in \"items\"\n+optional", + "type": "string" + }, + "message": { + "type": "string", + "title": "A human-readable description of the cause of the error. This field may be\npresented as-is to a reader.\n+optional" + }, + "reason": { + "type": "string", + "title": "A machine-readable description of the cause of the error. If this value is\nempty there is no information available.\n+optional" + } + } + }, + "v1StatusDetails": { + "description": "StatusDetails is a set of additional properties that MAY be set by the\nserver to provide additional information about a response. The Reason\nfield of a Status object defines what attributes will be set. Clients\nmust ignore fields that do not match the defined type of each attribute,\nand should assume that any attribute may be empty, invalid, or under\ndefined.", + "type": "object", + "properties": { + "causes": { + "type": "array", + "title": "The Causes array includes more details associated with the StatusReason\nfailure. Not all StatusReasons may provide detailed causes.\n+optional", + "items": { + "$ref": "#/definitions/v1StatusCause" + } + }, + "group": { + "type": "string", + "title": "The group attribute of the resource associated with the status StatusReason.\n+optional" + }, + "kind": { + "type": "string", + "title": "The kind attribute of the resource associated with the status StatusReason.\nOn some operations may differ from the requested resource Kind.\nMore info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds\n+optional" + }, + "name": { + "type": "string", + "title": "The name attribute of the resource associated with the status StatusReason\n(when there is a single name which can be described).\n+optional" + }, + "retryAfterSeconds": { + "type": "integer", + "format": "int32", + "title": "If specified, the time in seconds before the operation should be retried. Some errors may indicate\nthe client must take an alternate action - for those errors this field may indicate how long to wait\nbefore taking the alternate action.\n+optional" + }, + "uid": { + "type": "string", + "title": "UID of the resource.\n(when there is a single resource which can be described).\nMore info: http://kubernetes.io/docs/user-guide/identifiers#uids\n+optional" + } + } + }, + "v1Time": { + "description": "Time is a wrapper around time.Time which supports correct\nmarshaling to YAML and JSON. Wrappers are provided for many\nof the factory methods that the time package offers.\n\n+protobuf.options.marshal=false\n+protobuf.as=Timestamp\n+protobuf.options.(gogoproto.goproto_stringer)=false", + "type": "object", + "properties": { + "nanos": { + "description": "Non-negative fractions of a second at nanosecond resolution. Negative\nsecond values with fractions must still have non-negative nanos values\nthat count forward in time. Must be from 0 to 999,999,999\ninclusive. This field may be limited in precision depending on context.", + "type": "integer", + "format": "int32" + }, + "seconds": { + "description": "Represents seconds of UTC time since Unix epoch\n1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to\n9999-12-31T23:59:59Z inclusive.", + "type": "string", + "format": "int64" + } + } + }, + "v1alpha1AppProject": { + "type": "object", + "title": "AppProject is a definition of AppProject resource.\n+genclient\n+genclient:noStatus\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object", + "properties": { + "metadata": { + "$ref": "#/definitions/apismetav1ObjectMeta" + }, + "spec": { + "$ref": "#/definitions/v1alpha1AppProjectSpec" + } + } + }, + "v1alpha1AppProjectList": { + "type": "object", + "title": "AppProjectList is list of AppProject resources\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1AppProject" + } + }, + "metadata": { + "$ref": "#/definitions/v1ListMeta" + } + } + }, + "v1alpha1AppProjectSpec": { + "type": "object", + "title": "AppProjectSpec represents", + "properties": { + "description": { + "type": "string", + "title": "Description contains optional project description" + }, + "destinations": { + "type": "array", + "title": "Destinations contains list of destinations available for deployment", + "items": { + "$ref": "#/definitions/v1alpha1ApplicationDestination" + } + } + } + }, + "v1alpha1Application": { + "type": "object", + "title": "Application is a definition of Application resource.\n+genclient\n+genclient:noStatus\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object", + "properties": { + "metadata": { + "$ref": "#/definitions/apismetav1ObjectMeta" + }, + "operation": { + "$ref": "#/definitions/v1alpha1Operation" + }, + "spec": { + "$ref": "#/definitions/v1alpha1ApplicationSpec" + }, + "status": { + "$ref": "#/definitions/v1alpha1ApplicationStatus" + } + } + }, + "v1alpha1ApplicationCondition": { + "type": "object", + "title": "ApplicationCondition contains details about current application condition", + "properties": { + "message": { + "type": "string", + "title": "Message contains human-readable message indicating details about condition" + }, + "type": { + "type": "string", + "title": "Type is an application condition type" + } + } + }, + "v1alpha1ApplicationDestination": { + "type": "object", + "title": "ApplicationDestination contains deployment destination information", + "properties": { + "namespace": { + "type": "string", + "title": "Namespace overrides the environment namespace value in the ksonnet app.yaml" + }, + "server": { + "type": "string", + "title": "Server overrides the environment server value in the ksonnet app.yaml" + } + } + }, + "v1alpha1ApplicationList": { + "type": "object", + "title": "ApplicationList is list of Application resources\n+k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1Application" + } + }, + "metadata": { + "$ref": "#/definitions/v1ListMeta" + } + } + }, + "v1alpha1ApplicationSource": { + "description": "ApplicationSource contains information about github repository, path within repository and target application environment.", + "type": "object", + "properties": { + "componentParameterOverrides": { + "type": "array", + "title": "Environment parameter override values", + "items": { + "$ref": "#/definitions/v1alpha1ComponentParameter" + } + }, + "environment": { + "description": "Environment is a ksonnet application environment name.", + "type": "string" + }, + "path": { + "description": "Path is a directory path within repository which contains ksonnet application.", + "type": "string" + }, + "repoURL": { + "description": "RepoURL is the repository URL containing the ksonnet application.", + "type": "string" + }, + "targetRevision": { + "type": "string", + "title": "TargetRevision defines the commit, tag, or branch in which to sync the application to.\nIf omitted, will sync to HEAD" + } + } + }, + "v1alpha1ApplicationSpec": { + "description": "ApplicationSpec represents desired application state. Contains link to repository with application definition and additional parameters link definition revision.", + "type": "object", + "properties": { + "destination": { + "$ref": "#/definitions/v1alpha1ApplicationDestination" + }, + "project": { + "description": "Project is a application project name. Empty name means that application belongs to 'default' project.", + "type": "string" + }, + "source": { + "$ref": "#/definitions/v1alpha1ApplicationSource" + } + } + }, + "v1alpha1ApplicationStatus": { + "description": "ApplicationStatus contains information about application status in target environment.", + "type": "object", + "properties": { + "comparisonResult": { + "$ref": "#/definitions/v1alpha1ComparisonResult" + }, + "conditions": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1ApplicationCondition" + } + }, + "health": { + "$ref": "#/definitions/v1alpha1HealthStatus" + }, + "history": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1DeploymentInfo" + } + }, + "operationState": { + "$ref": "#/definitions/v1alpha1OperationState" + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1ComponentParameter" + } + } + } + }, + "v1alpha1ApplicationWatchEvent": { + "description": "ApplicationWatchEvent contains information about application change.", + "type": "object", + "properties": { + "application": { + "$ref": "#/definitions/v1alpha1Application" + }, + "type": { + "type": "string" + } + } + }, + "v1alpha1Cluster": { + "type": "object", + "title": "Cluster is the definition of a cluster resource", + "properties": { + "config": { + "$ref": "#/definitions/v1alpha1ClusterConfig" + }, + "connectionState": { + "$ref": "#/definitions/v1alpha1ConnectionState" + }, + "name": { + "type": "string", + "title": "Name of the cluster. If omitted, will use the server address" + }, + "server": { + "type": "string", + "title": "Server is the API server URL of the Kubernetes cluster" + } + } + }, + "v1alpha1ClusterConfig": { + "description": "ClusterConfig is the configuration attributes. This structure is subset of the go-client\nrest.Config with annotations added for marshalling.", + "type": "object", + "properties": { + "bearerToken": { + "description": "Server requires Bearer authentication. This client will not attempt to use\nrefresh tokens for an OAuth2 flow.\nTODO: demonstrate an OAuth2 compatible client.", + "type": "string" + }, + "password": { + "type": "string" + }, + "tlsClientConfig": { + "$ref": "#/definitions/v1alpha1TLSClientConfig" + }, + "username": { + "type": "string", + "title": "Server requires Basic authentication" + } + } + }, + "v1alpha1ClusterList": { + "description": "ClusterList is a collection of Clusters.", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1Cluster" + } + }, + "metadata": { + "$ref": "#/definitions/v1ListMeta" + } + } + }, + "v1alpha1ComparisonResult": { + "description": "ComparisonResult is a comparison result of application spec and deployed application.", + "type": "object", + "properties": { + "comparedAt": { + "$ref": "#/definitions/v1Time" + }, + "comparedTo": { + "$ref": "#/definitions/v1alpha1ApplicationSource" + }, + "error": { + "type": "string" + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1ResourceState" + } + }, + "status": { + "type": "string" + } + } + }, + "v1alpha1ComponentParameter": { + "type": "object", + "title": "ComponentParameter contains information about component parameter value", + "properties": { + "component": { + "type": "string" + }, + "name": { + "type": "string" + }, + "value": { + "type": "string" + } + } + }, + "v1alpha1ConnectionState": { + "type": "object", + "title": "ConnectionState contains information about remote resource connection state", + "properties": { + "attemptedAt": { + "$ref": "#/definitions/v1Time" + }, + "message": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "v1alpha1DeploymentInfo": { + "type": "object", + "title": "DeploymentInfo contains information relevant to an application deployment", + "properties": { + "componentParameterOverrides": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1ComponentParameter" + } + }, + "deployedAt": { + "$ref": "#/definitions/v1Time" + }, + "id": { + "type": "string", + "format": "int64" + }, + "params": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1ComponentParameter" + } + }, + "revision": { + "type": "string" + } + } + }, + "v1alpha1HealthStatus": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "statusDetails": { + "type": "string" + } + } + }, + "v1alpha1Operation": { + "description": "Operation contains requested operation parameters.", + "type": "object", + "properties": { + "rollback": { + "$ref": "#/definitions/v1alpha1RollbackOperation" + }, + "sync": { + "$ref": "#/definitions/v1alpha1SyncOperation" + } + } + }, + "v1alpha1OperationState": { + "description": "OperationState contains information about state of currently performing operation on application.", + "type": "object", + "properties": { + "finishedAt": { + "$ref": "#/definitions/v1Time" + }, + "message": { + "description": "Message hold any pertinent messages when attempting to perform operation (typically errors).", + "type": "string" + }, + "operation": { + "$ref": "#/definitions/v1alpha1Operation" + }, + "phase": { + "type": "string", + "title": "Phase is the current phase of the operation" + }, + "rollbackResult": { + "$ref": "#/definitions/v1alpha1SyncOperationResult" + }, + "startedAt": { + "$ref": "#/definitions/v1Time" + }, + "syncResult": { + "$ref": "#/definitions/v1alpha1SyncOperationResult" + } + } + }, + "v1alpha1Repository": { + "type": "object", + "title": "Repository is a Git repository holding application configurations", + "properties": { + "connectionState": { + "$ref": "#/definitions/v1alpha1ConnectionState" + }, + "password": { + "type": "string" + }, + "repo": { + "type": "string" + }, + "sshPrivateKey": { + "type": "string" + }, + "username": { + "type": "string" + } + } + }, + "v1alpha1RepositoryList": { + "description": "RepositoryList is a collection of Repositories.", + "type": "object", + "properties": { + "items": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1Repository" + } + }, + "metadata": { + "$ref": "#/definitions/v1ListMeta" + } + } + }, + "v1alpha1ResourceDetails": { + "type": "object", + "properties": { + "kind": { + "type": "string" + }, + "message": { + "type": "string" + }, + "name": { + "type": "string" + }, + "namespace": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "v1alpha1ResourceNode": { + "type": "object", + "title": "ResourceNode contains information about live resource and its children", + "properties": { + "children": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1ResourceNode" + } + }, + "state": { + "type": "string" + } + } + }, + "v1alpha1ResourceState": { + "type": "object", + "title": "ResourceState holds the target state of a resource and live state of a resource", + "properties": { + "childLiveResources": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1ResourceNode" + } + }, + "health": { + "$ref": "#/definitions/v1alpha1HealthStatus" + }, + "liveState": { + "type": "string" + }, + "status": { + "type": "string" + }, + "targetState": { + "type": "string" + } + } + }, + "v1alpha1RollbackOperation": { + "type": "object", + "properties": { + "dryRun": { + "type": "boolean", + "format": "boolean" + }, + "id": { + "type": "string", + "format": "int64" + }, + "prune": { + "type": "boolean", + "format": "boolean" + } + } + }, + "v1alpha1SyncOperation": { + "description": "SyncOperation contains sync operation details.", + "type": "object", + "properties": { + "dryRun": { + "type": "boolean", + "format": "boolean" + }, + "prune": { + "type": "boolean", + "format": "boolean" + }, + "revision": { + "type": "string" + } + } + }, + "v1alpha1SyncOperationResult": { + "type": "object", + "title": "SyncOperationResult represent result of sync operation", + "properties": { + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/v1alpha1ResourceDetails" + } + } + } + }, + "v1alpha1TLSClientConfig": { + "type": "object", + "title": "TLSClientConfig contains settings to enable transport layer security", + "properties": { + "caData": { + "type": "string", + "format": "byte", + "title": "CAData holds PEM-encoded bytes (typically read from a root certificates bundle).\nCAData takes precedence over CAFile" + }, + "certData": { + "type": "string", + "format": "byte", + "title": "CertData holds PEM-encoded bytes (typically read from a client certificate file).\nCertData takes precedence over CertFile" + }, + "insecure": { + "description": "Server should be accessed without verifying the TLS certificate. For testing only.", + "type": "boolean", + "format": "boolean" + }, + "keyData": { + "type": "string", + "format": "byte", + "title": "KeyData holds PEM-encoded bytes (typically read from a client certificate key file).\nKeyData takes precedence over KeyFile" + }, + "serverName": { + "description": "ServerName is passed to the server for SNI and is used in the client to check server\nceritificates against. If ServerName is empty, the hostname used to contact the\nserver is used.", + "type": "string" + } + } + }, + "versionVersionMessage": { + "type": "object", + "title": "VersionMessage represents version of the ArgoCD API server", + "properties": { + "BuildDate": { + "type": "string" + }, + "Compiler": { + "type": "string" + }, + "GitCommit": { + "type": "string" + }, + "GitTag": { + "type": "string" + }, + "GitTreeState": { + "type": "string" + }, + "GoVersion": { + "type": "string" + }, + "Platform": { + "type": "string" + }, + "Version": { + "type": "string" + } + } + } + } +} diff --git a/util/swagger/swagger.go b/util/swagger/swagger.go new file mode 100644 index 0000000000..bf4d846e15 --- /dev/null +++ b/util/swagger/swagger.go @@ -0,0 +1,25 @@ +package swagger + +import ( + "net/http" + "path" + "path/filepath" + + "github.com/go-openapi/runtime/middleware" +) + +// ServeSwaggerUI serves the Swagger UI and JSON spec. +func ServeSwaggerUI(mux *http.ServeMux, component, uiPath string) { + prefix := path.Dir(uiPath) + specURL := path.Join(prefix, "swagger.json") + + mux.HandleFunc(specURL, func(w http.ResponseWriter, r *http.Request) { + http.ServeFile(w, r, filepath.Join(component, "swagger.json")) + }) + + mux.Handle(uiPath, middleware.Redoc(middleware.RedocOpts{ + BasePath: prefix, + SpecURL: specURL, + Path: path.Base(uiPath), + }, http.NotFoundHandler())) +} diff --git a/util/swagger/swagger_test.go b/util/swagger/swagger_test.go new file mode 100644 index 0000000000..9e41a65edb --- /dev/null +++ b/util/swagger/swagger_test.go @@ -0,0 +1,66 @@ +package swagger + +import ( + "encoding/json" + "net" + "net/http" + "testing" + + "github.com/go-openapi/loads" +) + +func TestSwaggerUI(t *testing.T) { + const sentinel = `{ + "swagger": "2.0", + "info": { + "title": "Consolidate Services", + "description": "Description of all APIs", + "version": "version not set" + }, + "paths": {} +}` + + serve := func(c chan<- string) { + // listen on first available dynamic (unprivileged) port + listener, err := net.Listen("tcp", ":0") + if err != nil { + panic(err) + } + + // send back the address so that it can be used + c <- listener.Addr().String() + + mux := http.NewServeMux() + ServeSwaggerUI(mux, "../../server", "/swagger-ui") + panic(http.Serve(listener, mux)) + } + + c := make(chan string, 1) + + // run a local webserver to test data retrieval + go serve(c) + + address := <-c + t.Logf("Listening at address: %s", address) + + server := "http://" + address + + specDoc, err := loads.Spec(server + "/swagger.json") + if err != nil { + t.Fatal(err) + } + + _, err = json.MarshalIndent(specDoc.Spec(), "", " ") + if err != nil { + t.Fatal(err) + } + + resp, err := http.Get(server + "/swagger-ui") + if err != nil { + t.Fatal(err) + } + + if resp.StatusCode != 200 { + t.Fatalf("Was expecting status code 200 from swagger-ui, but got %d instead", resp.StatusCode) + } +}