Skip to content

Commit 9fc781a

Browse files
bagulm123bagulm123
committed
added devspace-schema.json and openapi.json files on root level. Fixed issue in pipelines, vars, commands to support multiple values
1 parent 9fdb853 commit 9fc781a

4 files changed

Lines changed: 576 additions & 2661 deletions

File tree

docs/schemas/config-openapi.json renamed to devspace-openapi.json

Lines changed: 32 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1944,7 +1944,7 @@
19441944
},
19451945
"alwaysResolve": {
19461946
"type": "boolean",
1947-
"description": "AlwaysResolve makes sure this variable will always be resolved and not only if it is used somewhere"
1947+
"description": "AlwaysResolve makes sure this variable will always be resolved and not only if it is used somewhere. Defaults to true."
19481948
},
19491949
"source": {
19501950
"type": "string",
@@ -2008,11 +2008,8 @@
20082008
"description": "Functions are POSIX functions that can be used within pipelines. Those functions can also be imported by\nimports."
20092009
},
20102010
"pipelines": {
2011-
"oneOf": [
2011+
"anyOf": [
20122012
{
2013-
"additionalProperties": {
2014-
"type": "string"
2015-
},
20162013
"type": "object"
20172014
},
20182015
{
@@ -2023,20 +2020,26 @@
20232020
"description": "Pipelines are the work blocks that DevSpace should execute when devspace dev, devspace build, devspace deploy or devspace purge\nis called. Pipelines are defined through a special POSIX script that allows you to use special commands\nsuch as create_deployments, start_dev, build_images etc. to signal DevSpace you want to execute\na specific functionality. The pipelines dev, build, deploy and purge are special and will override\nthe default functionality of the respective command if defined. All other pipelines can be either run\nvia the devspace run-pipeline command or used within another pipeline through run_pipelines."
20242021
},
20252022
"images": {
2026-
"patternProperties": {
2027-
".*": {
2028-
"$ref": "#/definitions/Config/$defs/Image"
2023+
"anyOf": [
2024+
{
2025+
"type": "object"
2026+
},
2027+
{
2028+
"type": "object"
20292029
}
2030-
},
2030+
],
20312031
"type": "object",
20322032
"description": "Images holds configuration of how DevSpace should build images. By default, DevSpace will build all defined images.\nIf you are using a custom pipeline, you can dynamically define which image is built at which time during the\nexecution."
20332033
},
20342034
"deployments": {
2035-
"patternProperties": {
2036-
".*": {
2037-
"$ref": "#/definitions/Config/$defs/DeploymentConfig"
2035+
"anyOf": [
2036+
{
2037+
"type": "object"
2038+
},
2039+
{
2040+
"type": "object"
20382041
}
2039-
},
2042+
],
20402043
"type": "object",
20412044
"description": "Deployments holds configuration of how DevSpace should deploy resources to Kubernetes. By default, DevSpace will deploy all defined deployments.\nIf you are using a custom pipeline, you can dynamically define which deployment is deployed at which time during the\nexecution."
20422045
},
@@ -2050,11 +2053,8 @@
20502053
"description": "Dev holds development configuration. Each dev configuration targets a single pod and enables certain dev services on that pod\nor even rewrites it if certain changes are requested, such as adding an environment variable or changing the entrypoint.\nDev allows you to:\n- sync local folders to the Kubernetes pod\n- port forward remote ports to your local computer\n- forward local ports into the Kubernetes pod\n- configure an ssh tunnel to the Kubernetes pod\n- proxy local commands to the container\n- restart the container on file changes"
20512054
},
20522055
"vars": {
2053-
"oneOf": [
2056+
"anyOf": [
20542057
{
2055-
"additionalProperties": {
2056-
"type": "string"
2057-
},
20582058
"type": "object"
20592059
},
20602060
{
@@ -2065,11 +2065,8 @@
20652065
"description": "Vars are config variables that can be used inside other config sections to replace certain values dynamically"
20662066
},
20672067
"commands": {
2068-
"oneOf": [
2068+
"anyOf": [
20692069
{
2070-
"additionalProperties": {
2071-
"type": "string"
2072-
},
20732070
"type": "object"
20742071
},
20752072
{
@@ -2080,20 +2077,26 @@
20802077
"description": "Commands are custom commands that can be executed via 'devspace run COMMAND'. These commands are run within a pseudo bash\nthat also allows executing special commands such as run_watch or is_equal."
20812078
},
20822079
"dependencies": {
2083-
"patternProperties": {
2084-
".*": {
2085-
"$ref": "#/definitions/Config/$defs/DependencyConfig"
2080+
"anyOf": [
2081+
{
2082+
"type": "object"
2083+
},
2084+
{
2085+
"type": "object"
20862086
}
2087-
},
2087+
],
20882088
"type": "object",
20892089
"description": "Dependencies are sub devspace projects that lie in a local folder or remote git repository that can be executed\nfrom within the pipeline. In contrast to imports, these projects pose as separate fully functional DevSpace projects\nthat typically lie including source code in a different folder and can be used to compose a full microservice\napplication that will be deployed by DevSpace. Each dependency name can only be used once and if you want to use\nthe same project multiple times, make sure to use a different name for each of those instances."
20902090
},
20912091
"pullSecrets": {
2092-
"patternProperties": {
2093-
".*": {
2094-
"$ref": "#/definitions/Config/$defs/PullSecretConfig"
2092+
"anyOf": [
2093+
{
2094+
"type": "object"
2095+
},
2096+
{
2097+
"type": "object"
20952098
}
2096-
},
2099+
],
20972100
"type": "object",
20982101
"description": "PullSecrets are image pull secrets that will be created by devspace in the target namespace\nduring devspace dev or devspace deploy. DevSpace will merge all defined pull secrets into a single\none or the one specified."
20992102
},

0 commit comments

Comments
 (0)