{ "schemes": [ "http", "https" ], "swagger": "2.0", "info": { "description": "This is the API specification of the Epinio API", "title": "Epinio API", "version": "1.0.0" }, "basePath": "/api/v1", "paths": { "/appcharts": { "get": { "tags": [ "appcharts" ], "summary": "Return list of app charts.", "operationId": "AllCharts", "responses": { "200": { "$ref": "#/responses/AppChartsResponse" } } } }, "/appcharts/{Chart}": { "get": { "tags": [ "appcharts" ], "summary": "Return details of the named `Chart`.", "operationId": "ChartShow", "parameters": [ { "type": "string", "name": "Chart", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ChartShowResponse" } } } }, "/appchartsmatch": { "get": { "description": "Return the chart names. (No prefix == Empty prefix == All match)", "tags": [ "appcharts" ], "operationId": "ChartMatch0", "responses": { "200": { "$ref": "#/responses/ChartMatchResponse" } } } }, "/appchartsmatch/{Pattern}": { "get": { "tags": [ "appcharts" ], "summary": "Return the chart names with prefix `Pattern`.", "operationId": "ChartMatch", "parameters": [ { "type": "string", "name": "Pattern", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ChartMatchResponse" } } } }, "/applications": { "get": { "tags": [ "application" ], "summary": "Return list of applications in all namespaces.", "operationId": "AllApps", "responses": { "200": { "$ref": "#/responses/AppsResponse" } } } }, "/catalogservices": { "get": { "tags": [ "service" ], "summary": "Return all available Epinio Catalog services.", "operationId": "ServiceCatalog", "responses": { "200": { "$ref": "#/responses/ServiceCatalogResponse" } } } }, "/catalogservices/{CatalogService}": { "get": { "tags": [ "service" ], "summary": "Return details of the named Epinio `CatalogService`.", "operationId": "ServiceCatalogShow", "parameters": [ { "type": "string", "name": "CatalogService", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ServiceCatalogShowResponse" } } } }, "/catalogservicesmatches/{Pattern}": { "get": { "tags": [ "catalogservice" ], "summary": "Return list of names for all catalog entries whose name matches the prefix `Pattern`.", "operationId": "CatalogServiceMatch", "parameters": [ { "type": "string", "name": "Pattern", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/CatalogMatchResponse" } } } }, "/configurations": { "get": { "tags": [ "configuration" ], "summary": "Return list of configurations in all namespaces.", "operationId": "AllConfigurations", "responses": { "200": { "$ref": "#/responses/ConfigurationsResponse" } } } }, "/info": { "get": { "description": "Return server system information", "tags": [ "info" ], "operationId": "Info", "responses": { "200": { "$ref": "#/responses/InfoResponse" } } } }, "/namespace/{Namespace}/appsmatches/{Pattern}": { "get": { "tags": [ "application" ], "summary": "Return list of names for all applications whose name matches the prefix `Pattern`.", "operationId": "AppMatch", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "Pattern", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/AppMatchResponse" } } } }, "/namespace/{Namespace}/configurationsmatches/{Pattern}": { "get": { "tags": [ "configuration" ], "summary": "Return list of names for all configurations whose name matches the prefix `Pattern`.", "operationId": "ConfigurationMatch", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "Pattern", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ConfigurationMatchResponse" } } } }, "/namespace/{Namespace}/servicesmatches/{Pattern}": { "get": { "tags": [ "service" ], "summary": "Return list of names for all services whose name matches the prefix `Pattern`.", "operationId": "ServiceMatch", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "Pattern", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ServiceMatchResponse" } } } }, "/namespacematches": { "get": { "description": "Return list of names for all controlled namespaces (No prefix = empty prefix = match everything)", "tags": [ "namespace" ], "operationId": "NamespaceMatch0", "responses": { "200": { "$ref": "#/responses/NamespaceMatchResponse" } } } }, "/namespacematches/{Pattern}": { "get": { "tags": [ "namespace" ], "summary": "Return list of names for all controlled namespaces whose name matches the prefix `Pattern`.", "operationId": "NamespaceMatch", "parameters": [ { "type": "string", "name": "Pattern", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/NamespaceMatchResponse" } } } }, "/namespaces": { "get": { "tags": [ "namespace" ], "summary": "Return list of all controlled namespaces.", "operationId": "Namespaces", "responses": { "200": { "$ref": "#/responses/NamespacesResponse" } } }, "post": { "tags": [ "namespace" ], "summary": "Create the posted new namespace.", "operationId": "NamespaceCreate", "parameters": [ { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/NamespaceCreateRequest" } } ], "responses": { "200": { "$ref": "#/responses/NamespaceCreateResponse" } } }, "delete": { "summary": "Delete the named namespaces.", "operationId": "NamespaceBatchDelete", "parameters": [ { "type": "array", "items": { "type": "string" }, "description": "in: url", "name": "Namespaces", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/NamespaceDeleteResponse" } } } }, "/namespaces/{Namespace}": { "get": { "tags": [ "namespace" ], "summary": "Return details of the named `Namespace`.", "operationId": "NamespaceShow", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/NamespaceShowResponse" } } }, "delete": { "tags": [ "namespace" ], "summary": "Delete the named `Namespace`.", "operationId": "NamespaceDelete", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/NamespaceDeleteResponse" } } } }, "/namespaces/{Namespace}/applications": { "get": { "tags": [ "application" ], "summary": "Return list of applications in the `Namespace`.", "operationId": "Apps", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/AppsResponse" } } }, "post": { "tags": [ "application" ], "summary": "Create the posted new application in the `Namespace`.", "operationId": "AppCreate", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "name": "Configuration", "in": "body", "schema": { "$ref": "#/definitions/ApplicationCreateRequest" } } ], "responses": { "200": { "$ref": "#/responses/AppCreateResponse" } } }, "delete": { "summary": "Delete the named `Applications` in the `Namespace`.", "operationId": "AppBatchDelete", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "description": "in: url", "name": "Applications", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/AppDeleteResponse" } } } }, "/namespaces/{Namespace}/applications/{App}": { "get": { "tags": [ "application" ], "summary": "Return details of the named `App` in the `Namespace`.", "operationId": "AppShow", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/AppShowResponse" } } }, "delete": { "tags": [ "application" ], "summary": "Delete the named `App` in the `Namespace`.", "operationId": "AppDelete", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/AppDeleteResponse" } } }, "patch": { "tags": [ "application" ], "summary": "Patch the named `App` in the `Namespace`.", "operationId": "AppUpdate", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/ApplicationUpdateRequest" } } ], "responses": { "200": { "$ref": "#/responses/AppUpdateResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/configurationbindings": { "post": { "tags": [ "svc-binding" ], "summary": "Create configuration binding between `App` in `Namespace`, and the posted configurations, also in `Namespace`.", "operationId": "ConfigurationBindingCreate", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/BindRequest" } } ], "responses": { "200": { "$ref": "#/responses/ConfigurationBindResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/configurationbindings/{Configuration}": { "delete": { "tags": [ "svc-binding" ], "summary": "Remove configuration binding between `App` and `Configuration` in `Namespace`.", "operationId": "ConfigurationBindingDelete", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "type": "string", "name": "Configuration", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ConfigurationUnbindReponse" } } } }, "/namespaces/{Namespace}/applications/{App}/deploy": { "post": { "tags": [ "application" ], "summary": "Create the deployment, configuration and ingress resources for the named `App` in the `Namespace`.", "operationId": "AppDeploy", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/DeployRequest" } } ], "responses": { "200": { "$ref": "#/responses/AppDeployResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/environment": { "get": { "tags": [ "app-env" ], "summary": "Return the environment variable assignments for the `App` in the namespace`.", "operationId": "EnvList", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/EnvListResponse" } } }, "post": { "tags": [ "app-env" ], "summary": "Create/modify the posted environment variable assignments for the `App` in the `Namespace`.", "operationId": "EnvSet", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/EnvVariableMap" } } ], "responses": { "200": { "$ref": "#/responses/EnvSetResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/environment/{Env}": { "get": { "tags": [ "app-env" ], "summary": "Return the named `Env` variable assignment for the `App` in the `Namespace`.", "operationId": "EnvShow", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "type": "string", "name": "Env", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/EnvShowResponse" } } }, "delete": { "tags": [ "app-env" ], "summary": "Remove the named `Env` variable from the `App` in the `Namespace`.", "operationId": "EnvUnset", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "type": "string", "name": "Env", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/EnvUnsetResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/environmentmatch": { "get": { "description": "Return the environment variable names of the `App` in the `Namespace`. (No prefix == Empty prefix == All match)", "tags": [ "app-env" ], "operationId": "EnvMatch0", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/EnvMatchResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/environmentmatch/{Pattern}": { "get": { "tags": [ "app-env" ], "summary": "Return the environment variable names of the `App` in the `Namespace` with prefix `Pattern`.", "operationId": "EnvMatch", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "type": "string", "name": "Pattern", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/EnvMatchResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/exec": { "get": { "tags": [ "application" ], "summary": "Get a shell to the `App` in the `Namespace`.", "operationId": "AppExec", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "type": "string", "name": "Instance", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/AppExecResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/import-git": { "post": { "tags": [ "application" ], "summary": "Store the named `App` from a Git repo in the `Namespace`.", "operationId": "AppImportGit", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "type": "string", "name": "GitUrl", "in": "query" }, { "type": "string", "name": "GitRev", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/AppImportGitResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/logs": { "get": { "tags": [ "application" ], "summary": "Return logs of the named `App` in the `Namespace` streamed over a websocket.", "operationId": "AppLogs", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/AppLogsResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/part/{Part}": { "get": { "tags": [ "application" ], "summary": "Return parts of the named `App` in the `Namespace`.", "operationId": "AppPart", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "type": "string", "name": "Part", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/AppPartResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/portforward": { "get": { "tags": [ "application" ], "summary": "Get a shell to the `App` in the `Namespace`.", "operationId": "AppPortForward", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "type": "string", "name": "Instance", "in": "query" } ], "responses": { "200": { "$ref": "#/responses/AppPortForwardResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/restart": { "post": { "tags": [ "application" ], "summary": "Restart the named `App` in the `Namespace`.", "operationId": "AppRestart", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/AppRestartResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/running": { "get": { "tags": [ "application" ], "summary": "Wait for the named `App` in the `Namespace` to be running.", "operationId": "AppRunning", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/AppRunningResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/stage": { "post": { "tags": [ "application" ], "summary": "Create the resources needed to stage the named `App` in the `Namespace`.", "operationId": "AppStage", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true }, { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/StageRequest" } } ], "responses": { "200": { "$ref": "#/responses/AppStageResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/store": { "post": { "tags": [ "application" ], "summary": "Store the named `App` in the `Namespace`.", "operationId": "AppUpload", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/AppUploadResponse" } } } }, "/namespaces/{Namespace}/applications/{App}/validate-cv": { "post": { "description": "Validate the chart values configured for the named `App` in the given `Namespace` against the\nconfigured app chart.", "tags": [ "application" ], "operationId": "AppValidateCV", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "App", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/AppValidateCVResponse" } } } }, "/namespaces/{Namespace}/configurationapps": { "get": { "tags": [ "configuration" ], "summary": "Return map from configurations in the `Namespace`, to the apps in the same.", "operationId": "ConfigurationApps", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ConfigurationAppsResponse" } } } }, "/namespaces/{Namespace}/configurations": { "get": { "tags": [ "configuration" ], "summary": "Return list of configurations in the `Namespace`.", "operationId": "Configurations", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ConfigurationsResponse" } } }, "post": { "tags": [ "configuration" ], "summary": "Create the posted new configuration in the `Namespace`.", "operationId": "ConfigurationCreate", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "name": "Configuration", "in": "body", "schema": { "$ref": "#/definitions/ConfigurationCreateRequest" } } ], "responses": { "200": { "$ref": "#/responses/ConfigurationCreateResponse" } } }, "delete": { "summary": "Delete the named `Configurations` in the `Namespace`.", "operationId": "ConfigurationBatchDelete", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "description": "in: url", "name": "Configurations", "in": "query" }, { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/ConfigurationDeleteRequest" } } ], "responses": { "200": { "$ref": "#/responses/ConfigurationDeleteResponse" } } } }, "/namespaces/{Namespace}/configurations/{Configuration}": { "get": { "tags": [ "configuration" ], "summary": "Return details of the named `Configuration` in the `Namespace`.", "operationId": "ConfigurationShow", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "Configuration", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ConfigurationShowResponse" } } }, "put": { "description": "Replace the named `Configuration` in the `Namespace` as per the instructions in the body", "tags": [ "configuration" ], "operationId": "ConfigurationReplace", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "Configuration", "in": "path", "required": true }, { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/ConfigurationReplaceRequest" } } ], "responses": { "200": { "$ref": "#/responses/ConfigurationReplaceResponse" } } }, "delete": { "tags": [ "configuration" ], "summary": "Delete the named `Configuration` in the `Namespace`.", "operationId": "ConfigurationDelete", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "Configuration", "in": "path", "required": true }, { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/ConfigurationDeleteRequest" } } ], "responses": { "200": { "$ref": "#/responses/ConfigurationDeleteResponse" } } }, "patch": { "description": "Update the named `Configuration` in the `Namespace` as per the instructions in the body", "tags": [ "configuration" ], "operationId": "ConfigurationUpdate", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "Configuration", "in": "path", "required": true }, { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/ConfigurationUpdateRequest" } } ], "responses": { "200": { "$ref": "#/responses/ConfigurationUpdateResponse" } } } }, "/namespaces/{Namespace}/serviceapps": { "get": { "tags": [ "service" ], "summary": "Return map from services in the `Namespace`, to the apps in the same.", "operationId": "ServiceApps", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ServiceAppsResponse" } } } }, "/namespaces/{Namespace}/services": { "get": { "tags": [ "service" ], "summary": "Return list of services in the `Namespace`.", "operationId": "ServiceList", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ServiceListResponse" } } }, "post": { "tags": [ "service" ], "summary": "Create a named service of an Epinio catalog service in the `Namespace`.", "operationId": "ServiceCreate", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "name": "Configuration", "in": "body", "schema": { "$ref": "#/definitions/ServiceCreateRequest" } } ], "responses": { "200": { "$ref": "#/responses/ServiceCreateResponse" } } }, "delete": { "summary": "Delete the named `Services` in the `Namespace`.", "operationId": "ServiceBatchDelete", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "array", "items": { "type": "string" }, "description": "in: url", "name": "Services", "in": "query" }, { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/ServiceDeleteRequest" } } ], "responses": { "200": { "$ref": "#/responses/ServiceDeleteResponse" } } } }, "/namespaces/{Namespace}/services/{Service}": { "get": { "tags": [ "service" ], "summary": "Return details of the named `Service` in the `Namespace`.", "operationId": "ServiceShow", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "Service", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/ServiceShowResponse" } } }, "delete": { "tags": [ "service" ], "summary": "Delete the named `Service` in the `Namespace`.", "operationId": "ServiceDelete", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "Service", "in": "path", "required": true }, { "name": "Body", "in": "body", "schema": { "$ref": "#/definitions/ServiceDeleteRequest" } } ], "responses": { "200": { "$ref": "#/responses/ServiceDeleteResponse" } } } }, "/namespaces/{Namespace}/services/{Service}/bind": { "post": { "tags": [ "service" ], "summary": "Bind the named `Service` in the `Namespace` to an App.", "operationId": "ServiceBind", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "Service", "in": "path", "required": true }, { "name": "Configuration", "in": "body", "schema": { "$ref": "#/definitions/ServiceBindRequest" } } ], "responses": { "200": { "$ref": "#/responses/ServiceBindResponse" } } } }, "/namespaces/{Namespace}/services/{Service}/unbind": { "post": { "tags": [ "service" ], "summary": "Unbind the named `Service` in the `Namespace` from an App.", "operationId": "ServiceUnbind", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "Service", "in": "path", "required": true }, { "name": "Configuration", "in": "body", "schema": { "$ref": "#/definitions/ServiceUnbindRequest" } } ], "responses": { "200": { "$ref": "#/responses/ServiceUnbindResponse" } } } }, "/namespaces/{Namespace}/staging/{StageID}/complete": { "get": { "tags": [ "application" ], "summary": "Waits for the completion of the staging process identified by `StageID` in the `Namespace`.", "operationId": "StagingComplete", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "StageID", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/StagingCompleteResponse" } } } }, "/namespaces/{Namespace}/staging/{StageID}/logs": { "get": { "tags": [ "application" ], "summary": "Return logs of the named `StageID` in the `Namespace` streamed over a websocket.", "operationId": "StagingLogs", "parameters": [ { "type": "string", "name": "Namespace", "in": "path", "required": true }, { "type": "string", "name": "StageID", "in": "path", "required": true } ], "responses": { "200": { "$ref": "#/responses/StagingLogsResponse" } } } }, "/services": { "get": { "tags": [ "service" ], "summary": "Return all the `Services` where the User has authorization.", "operationId": "AllServices", "responses": { "200": { "$ref": "#/responses/ServiceListResponse" } } } } }, "definitions": { "App": { "description": "The main structure has identifying information.\nIt is used in the CLI and API responses.", "type": "object", "title": "App has all the application's properties, for at rest (Configuration), and active (Workload).", "properties": { "configuration": { "$ref": "#/definitions/ApplicationConfiguration" }, "deployment": { "$ref": "#/definitions/AppDeployment" }, "image_url": { "type": "string", "x-go-name": "ImageURL" }, "meta": { "$ref": "#/definitions/AppRef" }, "origin": { "$ref": "#/definitions/ApplicationOrigin" }, "stage_id": { "type": "string", "x-go-name": "StageID" }, "staging": { "$ref": "#/definitions/ApplicationStage" }, "stagingstatus": { "$ref": "#/definitions/ApplicationStagingStatus" }, "status": { "$ref": "#/definitions/ApplicationStatus" }, "statusmessage": { "type": "string", "x-go-name": "StatusMessage" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "AppChart": { "description": "Differences:\nField `Values` is not made public here. It contains server-internal information the\nuser has no need for.", "type": "object", "title": "AppChart nearly matches github.com/epinio/application/api/v1 AppChartSpec\nReason for existence: Do not expose the internal CRD struct in the API.", "properties": { "description": { "type": "string", "x-go-name": "Description" }, "helm_chart": { "type": "string", "x-go-name": "HelmChart" }, "helm_repo": { "type": "string", "x-go-name": "HelmRepo" }, "meta": { "$ref": "#/definitions/MetaLite" }, "settings": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChartSetting" }, "x-go-name": "Settings" }, "short_description": { "type": "string", "x-go-name": "ShortDescription" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "AppChartList": { "description": "AppChartList is a collection of app charts", "type": "array", "items": { "$ref": "#/definitions/AppChart" }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "AppDeployment": { "description": "AppDeployment contains all the information specific to an active\napplication, i.e. one with a deployment in the cluster.", "type": "object", "properties": { "active": { "type": "boolean", "x-go-name": "Active" }, "createdAt": { "type": "string", "x-go-name": "CreatedAt" }, "desiredreplicas": { "type": "integer", "format": "int32", "x-go-name": "DesiredReplicas" }, "name": { "description": "TODO: Readiness and Liveness fields?", "type": "string", "x-go-name": "Name" }, "readyreplicas": { "type": "integer", "format": "int32", "x-go-name": "ReadyReplicas" }, "replicas": { "type": "object", "additionalProperties": { "$ref": "#/definitions/PodInfo" }, "x-go-name": "Replicas" }, "routes": { "type": "array", "items": { "type": "string" }, "x-go-name": "Routes" }, "stage_id": { "type": "string", "x-go-name": "StageID" }, "status": { "type": "string", "x-go-name": "Status" }, "username": { "type": "string", "x-go-name": "Username" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "AppList": { "description": "AppList is a collection of app references", "type": "array", "items": { "$ref": "#/definitions/App" }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "AppMatchResponse": { "description": "AppMatchResponse contains the list of names for matching apps", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "x-go-name": "Names" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "AppRef": { "description": "AppRef references an App by name and namespace", "type": "object", "properties": { "createdAt": { "$ref": "#/definitions/Time" }, "name": { "type": "string", "x-go-name": "Name" }, "namespace": { "type": "string", "x-go-name": "Namespace" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ApplicationConfiguration": { "description": "ApplicationConfiguration is the part of the manifest describing the configuration of the application", "type": "object", "properties": { "appchart": { "type": "string", "x-go-name": "AppChart" }, "configurations": { "type": "array", "items": { "type": "string" }, "x-go-name": "Configurations" }, "environment": { "$ref": "#/definitions/EnvVariableMap" }, "instances": { "type": "integer", "format": "int32", "x-go-name": "Instances" }, "routes": { "type": "array", "items": { "type": "string" }, "x-go-name": "Routes" }, "settings": { "$ref": "#/definitions/ChartValueSettings" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ApplicationCreateRequest": { "description": "ApplicationCreateRequest represents and contains the data needed to\ncreate an application (at rest), possibly with presets (configurations)", "type": "object", "properties": { "configuration": { "$ref": "#/definitions/ApplicationUpdateRequest" }, "name": { "type": "string", "x-go-name": "Name" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ApplicationDeleteResponse": { "description": "ApplicationDeleteResponse represents the server's response to a successful app deletion", "type": "object", "properties": { "unboundconfigurations": { "type": "array", "items": { "type": "string" }, "x-go-name": "UnboundConfigurations" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ApplicationOrigin": { "description": "ApplicationOrigin is the part of the manifest describing the origin of the application\n(sources). At most one of the fields may be specified / not empty.", "type": "object", "properties": { "Kind": { "description": "Hidden from yaml. Type tag to simplify struct usage.\nNote: we cannot hide this property from the JSON since it's used to unmarshal correctly the result of the Apps endpoint\n@see failling test here: https://github.com/epinio/epinio/runs/4935898437?check_suite_focus=true\nWe should probably expose a more meaningful value instead of this \"Kind\" int", "type": "integer", "format": "int64" }, "archive": { "type": "boolean", "x-go-name": "Archive" }, "container": { "type": "string", "x-go-name": "Container" }, "git": { "$ref": "#/definitions/GitRef" }, "path": { "type": "string", "x-go-name": "Path" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ApplicationStage": { "description": "ApplicationStage is the part of the manifest holding information\nrelevant to staging the application's sources. This is, currently,\nonly the reference to the Paketo builder image to use.", "type": "object", "properties": { "builder": { "type": "string", "x-go-name": "Builder" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ApplicationStagingStatus": { "type": "string", "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ApplicationStatus": { "type": "string", "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ApplicationUpdateRequest": { "description": "ApplicationUpdateRequest represents and contains the data needed to update\nan application. Specifically to modify the number of replicas to\nrun, and the configurations bound to it.\nNote: Instances is a pointer to give us a nil value separate from\nactual integers, as means of communicating `default`/`no change`.", "type": "object", "properties": { "appchart": { "type": "string", "x-go-name": "AppChart" }, "configurations": { "type": "array", "items": { "type": "string" }, "x-go-name": "Configurations" }, "environment": { "$ref": "#/definitions/EnvVariableMap" }, "instances": { "type": "integer", "format": "int32", "x-go-name": "Instances" }, "restart": { "type": "boolean", "x-go-name": "Restart" }, "routes": { "type": "array", "items": { "type": "string" }, "x-go-name": "Routes" }, "settings": { "$ref": "#/definitions/ChartValueSettings" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "BindRequest": { "type": "object", "title": "BindRequest represents and contains the data needed to bind configurations to an application.", "properties": { "names": { "type": "array", "items": { "type": "string" }, "x-go-name": "Names" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "BindResponse": { "description": "BindResponse represents the server's response to the successful binding of configurations to\nan application.", "type": "object", "properties": { "wasbound": { "type": "array", "items": { "type": "string" }, "x-go-name": "WasBound" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "CatalogMatchResponse": { "description": "CatalogMatchResponse contains the list of names for matching catalog entries", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "x-go-name": "Names" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "CatalogService": { "description": "CatalogService mostly matches github.com/epinio/application/api/v1 ServiceSpec\nReason for existence: Do not expose the internal CRD struct in the API.", "type": "object", "properties": { "appVersion": { "type": "string", "x-go-name": "AppVersion" }, "chart": { "type": "string", "x-go-name": "HelmChart" }, "chartVersion": { "type": "string", "x-go-name": "ChartVersion" }, "description": { "type": "string", "x-go-name": "Description" }, "helm_repo": { "$ref": "#/definitions/HelmRepo" }, "meta": { "$ref": "#/definitions/MetaLite" }, "secretTypes": { "type": "array", "items": { "type": "string" }, "x-go-name": "SecretTypes" }, "serviceIcon": { "type": "string", "x-go-name": "ServiceIcon" }, "settings": { "type": "object", "additionalProperties": { "$ref": "#/definitions/ChartSetting" }, "x-go-name": "Settings" }, "short_description": { "type": "string", "x-go-name": "ShortDescription" }, "values": { "type": "string", "x-go-name": "Values" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "CatalogServices": { "description": "CatalogServices is a list of catalog service elements", "type": "array", "items": { "$ref": "#/definitions/CatalogService" }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ChartMatchResponse": { "description": "ChartMatchResponse contains the list of names for matching application charts", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "x-go-name": "Names" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ChartSetting": { "description": "ChartSetting matches github.com/epinio/application/api/v1 ChartSetting\nReason for existence: Do not expose the internal CRD struct in the API.", "type": "object", "properties": { "enum": { "description": "Enumeration of allowed values, for types string, number, integer", "type": "array", "items": { "type": "string" }, "x-go-name": "Enum" }, "maximum": { "description": "Maximal allowed value, for number, integer", "type": "string", "x-go-name": "Maximum" }, "minimum": { "description": "Minimal allowed value, for number, integer", "type": "string", "x-go-name": "Minimum" }, "type": { "description": "Type of the setting (string, bool, number, or integer)", "type": "string", "x-go-name": "Type" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ChartValueSettings": { "description": "ChartValueSettings is a collection of key/value pairs describing the user's chosen settings with which\nto configure the helm chart referenced by the application's appchart.", "type": "object", "additionalProperties": { "type": "string" }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ConfigurationCreateRequest": { "description": "ConfigurationCreateRequest represents and contains the data needed to\ncreate a configuration instance", "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "string" }, "x-go-name": "Data" }, "name": { "type": "string", "x-go-name": "Name" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ConfigurationDeleteRequest": { "description": "ConfigurationDeleteRequest represents and contains the data needed to delete a configuration", "type": "object", "properties": { "unbind": { "type": "boolean", "x-go-name": "Unbind" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ConfigurationDeleteResponse": { "description": "ConfigurationDeleteResponse represents the server's response to a successful configuration deletion", "type": "object", "properties": { "boundapps": { "type": "array", "items": { "type": "string" }, "x-go-name": "BoundApps" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ConfigurationMatchResponse": { "description": "ConfigurationMatchResponse contains the list of names for matching configurations", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "x-go-name": "Names" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ConfigurationRef": { "description": "ConfigurationRef references a Configuration by name and namespace", "type": "object", "properties": { "createdAt": { "$ref": "#/definitions/Time" }, "name": { "type": "string", "x-go-name": "Name" }, "namespace": { "type": "string", "x-go-name": "Namespace" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ConfigurationReplaceRequest": { "description": "ConfigurationReplaceRequest represents and contains the data needed to\nreplace a configuration instance", "type": "object", "additionalProperties": { "type": "string" }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ConfigurationResponse": { "description": "ConfigurationResponse represents the data of a single configuration instance", "type": "object", "properties": { "configuration": { "$ref": "#/definitions/ConfigurationShowResponse" }, "meta": { "$ref": "#/definitions/ConfigurationRef" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ConfigurationResponseList": { "description": "ConfigurationResponseList represents a collection of configuration instance", "type": "array", "items": { "$ref": "#/definitions/ConfigurationResponse" }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ConfigurationShowResponse": { "description": "ConfigurationShowResponse contains details about a configuration", "type": "object", "properties": { "boundapps": { "type": "array", "items": { "type": "string" }, "x-go-name": "BoundApps" }, "details": { "type": "object", "additionalProperties": { "type": "string" }, "x-go-name": "Details" }, "origin": { "type": "string", "x-go-name": "Origin" }, "siblings": { "type": "array", "items": { "type": "string" }, "x-go-name": "Siblings" }, "type": { "type": "string", "x-go-name": "Type" }, "user": { "type": "string", "x-go-name": "Username" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ConfigurationUpdateRequest": { "description": "ConfigurationUpdateRequest represents and contains the data needed to\nupdate a configuration instance (add/change, and remove keys)", "type": "object", "properties": { "edit": { "type": "object", "additionalProperties": { "type": "string" }, "x-go-name": "Set" }, "remove": { "type": "array", "items": { "type": "string" }, "x-go-name": "Remove" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "DeployRequest": { "description": "DeployRequest represents and contains the data needed to deploy an application\nNote that the overall application configuration (instances, configurations, EVs) is\nalready known server side, through AppCreate/AppUpdate requests.\nThis request not only comes with the image to deploy, but also the\ninformation where the sources of that image came from.", "type": "object", "properties": { "app": { "$ref": "#/definitions/AppRef" }, "image": { "type": "string", "x-go-name": "ImageURL" }, "origin": { "$ref": "#/definitions/ApplicationOrigin" }, "stage": { "$ref": "#/definitions/StageRef" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "DeployResponse": { "description": "DeployResponse represents the server's response to a successful app deployment", "type": "object", "properties": { "routes": { "type": "array", "items": { "type": "string" }, "x-go-name": "Routes" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "EnvMatchResponse": { "description": "EnvMatchResponse contains the list of names for matching env variables", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "x-go-name": "Names" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "EnvVariable": { "description": "EnvVariable represents the Show Response for a single environment variable", "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name" }, "value": { "type": "string", "x-go-name": "Value" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "EnvVariableMap": { "description": "EnvVariableMap is a collection of EVs as a map. It is used for Set Requests, and as\nList Responses", "type": "object", "additionalProperties": { "type": "string" }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "GitProvider": { "type": "string", "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "GitRef": { "type": "object", "properties": { "branch": { "type": "string", "x-go-name": "Branch" }, "provider": { "$ref": "#/definitions/GitProvider" }, "repository": { "type": "string", "x-go-name": "URL" }, "revision": { "type": "string", "x-go-name": "Revision" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "HelmRepo": { "description": "HelmRepo matches github.com/epinio/application/api/v1 HelmRepo\nReason for existence: Do not expose the internal CRD struct in the API.", "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name" }, "url": { "type": "string", "x-go-name": "URL" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ImportGitResponse": { "type": "object", "properties": { "blobuid": { "type": "string", "x-go-name": "BlobUID" }, "branch": { "type": "string", "x-go-name": "Branch" }, "revision": { "type": "string", "x-go-name": "Revision" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "InfoResponse": { "description": "InfoResponse contains information about Epinio and its components", "type": "object", "properties": { "default_builder_image": { "type": "string", "x-go-name": "DefaultBuilderImage" }, "kube_version": { "type": "string", "x-go-name": "KubeVersion" }, "platform": { "type": "string", "x-go-name": "Platform" }, "version": { "type": "string", "x-go-name": "Version" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "Meta": { "description": "Meta holds the information needed to reference a resource (name and namespace), plus\ngeneral descriptive things (creation timestamp).", "type": "object", "properties": { "createdAt": { "$ref": "#/definitions/Time" }, "name": { "type": "string", "x-go-name": "Name" }, "namespace": { "type": "string", "x-go-name": "Namespace" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "MetaLite": { "description": "plus general descriptive things (creation timestamp).", "type": "object", "title": "MetaLite holds the information needed to reference a non-namespaced resource (name),", "properties": { "createdAt": { "$ref": "#/definitions/Time" }, "name": { "type": "string", "x-go-name": "Name" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "Namespace": { "description": "Namespace has all the namespace properties, i.e. name, app names, and configuration names\nIt is used in the CLI and API responses.", "type": "object", "properties": { "apps": { "type": "array", "items": { "type": "string" }, "x-go-name": "Apps" }, "configurations": { "type": "array", "items": { "type": "string" }, "x-go-name": "Configurations" }, "meta": { "$ref": "#/definitions/MetaLite" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "NamespaceCreateRequest": { "description": "NamespaceCreateRequest contains the name of the namespace that should be created", "type": "object", "properties": { "name": { "type": "string", "x-go-name": "Name" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "NamespaceList": { "description": "NamespaceList is a collection of namespaces", "type": "array", "items": { "$ref": "#/definitions/Namespace" }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "NamespacesMatchResponse": { "description": "NamespacesMatchResponse contains the list of names for matching namespaces", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "x-go-name": "Names" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "PodInfo": { "type": "object", "properties": { "createdAt": { "type": "string", "x-go-name": "CreatedAt" }, "memoryBytes": { "type": "integer", "format": "int64", "x-go-name": "MemoryBytes" }, "metricsOk": { "type": "boolean", "x-go-name": "MetricsOk" }, "millicpus": { "type": "integer", "format": "int64", "x-go-name": "MilliCPUs" }, "name": { "type": "string", "x-go-name": "Name" }, "ready": { "type": "boolean", "x-go-name": "Ready" }, "restarts": { "type": "integer", "format": "int32", "x-go-name": "Restarts" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "Response": { "type": "object", "properties": { "status": { "type": "string", "x-go-name": "Status" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "Service": { "type": "object", "properties": { "boundapps": { "type": "array", "items": { "type": "string" }, "x-go-name": "BoundApps" }, "catalog_service": { "type": "string", "x-go-name": "CatalogService" }, "catalog_service_version": { "type": "string", "x-go-name": "CatalogServiceVersion" }, "internal_routes": { "type": "array", "items": { "type": "string" }, "x-go-name": "InternalRoutes" }, "meta": { "$ref": "#/definitions/Meta" }, "secretTypes": { "type": "array", "items": { "type": "string" }, "x-go-name": "SecretTypes" }, "settings": { "$ref": "#/definitions/ChartValueSettings" }, "status": { "$ref": "#/definitions/ServiceStatus" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ServiceBindRequest": { "type": "object", "properties": { "app_name": { "type": "string", "x-go-name": "AppName" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ServiceCreateRequest": { "type": "object", "properties": { "catalog_service": { "type": "string", "x-go-name": "CatalogService" }, "name": { "type": "string", "x-go-name": "Name" }, "settings": { "$ref": "#/definitions/ChartValueSettings" }, "wait": { "type": "boolean", "x-go-name": "Wait" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ServiceDeleteRequest": { "description": "ServiceDeleteRequest represents and contains the data needed to delete a service", "type": "object", "properties": { "unbind": { "type": "boolean", "x-go-name": "Unbind" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ServiceDeleteResponse": { "description": "ServiceDeleteResponse represents the server's response to a successful service deletion", "type": "object", "properties": { "boundapps": { "type": "array", "items": { "type": "string" }, "x-go-name": "BoundApps" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ServiceList": { "description": "ServiceList represents a collection of service instances", "type": "array", "items": { "$ref": "#/definitions/Service" }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ServiceMatchResponse": { "description": "ServiceMatchResponse contains the list of names for matching services", "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "x-go-name": "Names" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ServiceStatus": { "type": "string", "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "ServiceUnbindRequest": { "type": "object", "properties": { "app_name": { "type": "string", "x-go-name": "AppName" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "StageRef": { "description": "StageRef references a staging run by ID, currently randomly generated\nfor each POST to the staging endpoint", "type": "object", "properties": { "id": { "type": "string", "x-go-name": "ID" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "StageRequest": { "description": "StageRequest represents and contains the data needed to stage an application", "type": "object", "properties": { "app": { "$ref": "#/definitions/AppRef" }, "blobuid": { "type": "string", "x-go-name": "BlobUID" }, "builderimage": { "type": "string", "x-go-name": "BuilderImage" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "StageResponse": { "description": "StageResponse represents the server's response to a successful app staging", "type": "object", "properties": { "image": { "type": "string", "x-go-name": "ImageURL" }, "stage": { "$ref": "#/definitions/StageRef" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" }, "Time": { "description": "+protobuf.options.marshal=false\n+protobuf.as=Timestamp\n+protobuf.options.(gogoproto.goproto_stringer)=false", "type": "object", "title": "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.", "x-go-package": "k8s.io/apimachinery/pkg/apis/meta/v1" }, "UploadResponse": { "description": "UploadResponse represents the server's response to a successful app sources upload", "type": "object", "properties": { "blobuid": { "type": "string", "x-go-name": "BlobUID" } }, "x-go-package": "github.com/epinio/epinio/pkg/api/core/v1/models" } }, "responses": { "AppChartsResponse": { "description": "", "schema": { "$ref": "#/definitions/AppChartList" } }, "AppCreateResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "AppDeleteResponse": { "description": "", "schema": { "$ref": "#/definitions/ApplicationDeleteResponse" } }, "AppDeployResponse": { "description": "", "schema": { "$ref": "#/definitions/DeployResponse" } }, "AppExecResponse": { "description": "" }, "AppImportGitResponse": { "description": "", "schema": { "$ref": "#/definitions/ImportGitResponse" } }, "AppLogsResponse": { "description": "" }, "AppMatchResponse": { "description": "", "schema": { "$ref": "#/definitions/AppMatchResponse" } }, "AppPartResponse": { "description": "", "schema": { "type": "array", "items": { "type": "integer", "format": "uint8" } } }, "AppPortForwardResponse": { "description": "" }, "AppRestartResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "AppRunningResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "AppShowResponse": { "description": "", "schema": { "$ref": "#/definitions/App" } }, "AppStageResponse": { "description": "", "schema": { "$ref": "#/definitions/StageResponse" } }, "AppUpdateResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "AppUploadResponse": { "description": "", "schema": { "$ref": "#/definitions/UploadResponse" } }, "AppValidateCVResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "AppsResponse": { "description": "", "schema": { "$ref": "#/definitions/AppList" } }, "CatalogMatchResponse": { "description": "", "schema": { "$ref": "#/definitions/CatalogMatchResponse" } }, "ChartMatchResponse": { "description": "", "schema": { "$ref": "#/definitions/ChartMatchResponse" } }, "ChartShowResponse": { "description": "", "schema": { "$ref": "#/definitions/AppChart" } }, "ConfigurationAppsResponse": { "description": "", "schema": { "type": "object", "additionalProperties": { "$ref": "#/definitions/AppList" } } }, "ConfigurationBindResponse": { "description": "", "schema": { "$ref": "#/definitions/BindResponse" } }, "ConfigurationCreateResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "ConfigurationDeleteResponse": { "description": "", "schema": { "$ref": "#/definitions/ConfigurationDeleteResponse" } }, "ConfigurationMatchResponse": { "description": "", "schema": { "$ref": "#/definitions/ConfigurationMatchResponse" } }, "ConfigurationReplaceResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "ConfigurationShowResponse": { "description": "", "schema": { "$ref": "#/definitions/ConfigurationResponse" } }, "ConfigurationUnbindReponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "ConfigurationUpdateResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "ConfigurationsResponse": { "description": "", "schema": { "$ref": "#/definitions/ConfigurationResponseList" } }, "EnvListResponse": { "description": "", "schema": { "$ref": "#/definitions/EnvVariableMap" } }, "EnvMatchResponse": { "description": "", "schema": { "$ref": "#/definitions/EnvMatchResponse" } }, "EnvSetResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "EnvShowResponse": { "description": "", "schema": { "$ref": "#/definitions/EnvVariable" } }, "EnvUnsetResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "InfoResponse": { "description": "", "schema": { "$ref": "#/definitions/InfoResponse" } }, "NamespaceCreateResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "NamespaceDeleteResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "NamespaceMatchResponse": { "description": "", "schema": { "$ref": "#/definitions/NamespacesMatchResponse" } }, "NamespaceShowResponse": { "description": "", "schema": { "$ref": "#/definitions/Namespace" } }, "NamespacesResponse": { "description": "", "schema": { "$ref": "#/definitions/NamespaceList" } }, "ServiceAppsResponse": { "description": "", "schema": { "type": "object", "additionalProperties": { "$ref": "#/definitions/AppList" } } }, "ServiceBindResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "ServiceCatalogResponse": { "description": "", "schema": { "$ref": "#/definitions/CatalogServices" } }, "ServiceCatalogShowResponse": { "description": "", "schema": { "$ref": "#/definitions/CatalogService" } }, "ServiceCreateResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "ServiceDeleteResponse": { "description": "", "schema": { "$ref": "#/definitions/ServiceDeleteResponse" } }, "ServiceListResponse": { "description": "", "schema": { "$ref": "#/definitions/ServiceList" } }, "ServiceMatchResponse": { "description": "", "schema": { "$ref": "#/definitions/ServiceMatchResponse" } }, "ServicePortForwardResponse": { "description": "" }, "ServiceShowResponse": { "description": "", "schema": { "$ref": "#/definitions/Service" } }, "ServiceUnbindResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "StagingCompleteResponse": { "description": "", "schema": { "$ref": "#/definitions/Response" } }, "StagingLogsResponse": { "description": "" } }, "securityDefinitions": { "basicAuth": { "type": "basic" } }, "security": [ { "basicAuth": [ "[]" ] } ] }