diff --git a/_data/toc.yaml b/_data/toc.yaml index e0a52a1efc..31ad3b8836 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -3228,6 +3228,8 @@ manuals: title: Working with Docker Template - path: /app-template/cli-reference/ title: CLI reference + - path: /app-template/api-reference/ + title: API reference - sectiontitle: Docker Compose section: - path: /compose/overview/ diff --git a/app-template/api-reference.md b/app-template/api-reference.md index 469648c2a8..f0a5064917 100644 --- a/app-template/api-reference.md +++ b/app-template/api-reference.md @@ -77,7 +77,7 @@ The parameters section allows to specify the input parameters that are going to | :----------------------|:----------------------|:----------------------------------------| |name |yes| The identifier for this parameter. Must be unique within the service parameters. | |description| no|A short description of the parameter. Will be used as label in the Application Designer| -|type| yes|The type of the parameter. Possible options are:| +|type| yes|The type of the parameter. Possible options are: `string` - The default type, with no validation or specific features. `enum` - Allow the user to choose a value included in a specific list of options. Must specify the values parameter. `hostPort` - Specify that this parameter is a port that is going to be exposed. Use port format regexp validation, and avoid duplicate ports within an application.| |defaultValue| yes|The default value for this parameter. For enum type, must be a valid value from the values list.| |values| no|For enum type, specify a list of value with a value/description tuple.| diff --git a/app-template/working-with-template.md b/app-template/working-with-template.md index 39cb2a79e8..62d7dd7669 100644 --- a/app-template/working-with-template.md +++ b/app-template/working-with-template.md @@ -14,7 +14,7 @@ A _service template_ is a container image that generates code and contains the m - The metadata file that describes the service template is called the service definition. It contains the name of the service, description, and available parameters such as ports, volumes, etc. For a complete list of parameters that are allowed, see [Docker Template API reference](/ee/app-template/api-reference). -An _application template_ is a collection of one or more service templates. +An _application template_ is a collection of one or more service templates. An application template generates a Dockerfile per service and only one Compose file for the entire application, aggregating all services. ## Create a custom service template