forked from compose-spec/compose-spec
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update schema to make external.name as deprecated
Signed-off-by: Nicolas De Loof <[email protected]>
- Loading branch information
Showing
318 changed files
with
10,866 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| FROM node:12 as generator | ||
| RUN npm install -g @adobe/jsonschema2md | ||
| COPY schema /schema | ||
| RUN jsonschema2md -d /schema/config_schema_v3.9.json -v "04" -o /docs | ||
| RUN jsonschema2md -d /schema/ -e json | ||
|
|
||
| FROM scratch as docs | ||
| COPY --from=generator /docs / | ||
| COPY --from=generator /out / |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,77 @@ | ||
| # README | ||
|
|
||
| ## Top-level Schemas | ||
|
|
||
| - [Untitled object in undefined](./config_schema_v3.md "The Compose file is a YAML file defining a multi-containers based application") – `-` | ||
|
|
||
| ## Other Schemas | ||
|
|
||
| ### Objects | ||
|
|
||
| - [Untitled object in undefined](./config_schema_v3-properties-services.md "Service definition contains configuration that is applied to each container started for that service") – `undefined#/properties/services` | ||
| - [Untitled object in undefined](./config_schema_v3-properties-networks.md) – `undefined#/properties/networks` | ||
| - [Untitled object in undefined](./config_schema_v3-properties-volumes.md) – `undefined#/properties/volumes` | ||
| - [Untitled object in undefined](./config_schema_v3-properties-secrets.md) – `undefined#/properties/secrets` | ||
| - [Untitled object in undefined](./config_schema_v3-properties-configs.md) – `undefined#/properties/configs` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service.md) – `undefined#/definitions/service` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-build-oneof-1.md) – `undefined#/definitions/service/properties/build/oneOf/1` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-configs-items-oneof-1.md) – `undefined#/definitions/service/properties/configs/items/oneOf/1` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-credential_spec.md) – `undefined#/definitions/service/properties/credential_spec` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-logging.md) – `undefined#/definitions/service/properties/logging` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-logging-properties-options.md) – `undefined#/definitions/service/properties/logging/properties/options` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-networks-oneof-1.md) – `undefined#/definitions/service/properties/networks/oneOf/1` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-networks-oneof-1-patternproperties-a-za-z0-9_--oneof-0.md) – `undefined#/definitions/service/properties/networks/oneOf/1/patternProperties/^[a-zA-Z0-9._-]+$/oneOf/0` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-ports-items-oneof-2.md) – `undefined#/definitions/service/properties/ports/items/oneOf/2` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-secrets-items-oneof-1.md) – `undefined#/definitions/service/properties/secrets/items/oneOf/1` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-ulimits.md) – `undefined#/definitions/service/properties/ulimits` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-ulimits-patternproperties-a-z-oneof-1.md) – `undefined#/definitions/service/properties/ulimits/patternProperties/^[a-z]+$/oneOf/1` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-volumes-items-oneof-1.md) – `undefined#/definitions/service/properties/volumes/items/oneOf/1` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-volumes-items-oneof-1-properties-bind.md) – `undefined#/definitions/service/properties/volumes/items/oneOf/1/properties/bind` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-volumes-items-oneof-1-properties-volume.md) – `undefined#/definitions/service/properties/volumes/items/oneOf/1/properties/volume` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-service-properties-volumes-items-oneof-1-properties-tmpfs.md) – `undefined#/definitions/service/properties/volumes/items/oneOf/1/properties/tmpfs` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-healthcheck.md) – `undefined#/definitions/healthcheck` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-deployment-properties-rollback_config.md) – `undefined#/definitions/deployment/properties/rollback_config` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-deployment-properties-update_config.md) – `undefined#/definitions/deployment/properties/update_config` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-deployment-properties-resources.md) – `undefined#/definitions/deployment/properties/resources` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-deployment-properties-resources-properties-limits.md) – `undefined#/definitions/deployment/properties/resources/properties/limits` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-deployment-properties-resources-properties-reservations.md) – `undefined#/definitions/deployment/properties/resources/properties/reservations` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-deployment-properties-restart_policy.md) – `undefined#/definitions/deployment/properties/restart_policy` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-deployment-properties-placement.md) – `undefined#/definitions/deployment/properties/placement` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-deployment-properties-placement-properties-preferences-items.md) – `undefined#/definitions/deployment/properties/placement/properties/preferences/items` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-generic_resources-items.md) – `undefined#/definitions/generic_resources/items` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-generic_resources-items-properties-discrete_resource_spec.md) – `undefined#/definitions/generic_resources/items/properties/discrete_resource_spec` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-network-properties-driver_opts.md) – `undefined#/definitions/network/properties/driver_opts` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-network-properties-ipam.md) – `undefined#/definitions/network/properties/ipam` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-network-properties-ipam-properties-config-items.md) – `undefined#/definitions/network/properties/ipam/properties/config/items` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-volume-properties-driver_opts.md) – `undefined#/definitions/volume/properties/driver_opts` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-secret.md) – `undefined#/definitions/secret` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-secret-properties-driver_opts.md) – `undefined#/definitions/secret/properties/driver_opts` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-config.md) – `undefined#/definitions/config` | ||
| - [Untitled object in undefined](./config_schema_v3-definitions-list_or_dict-oneof-0.md) – `undefined#/definitions/list_or_dict/oneOf/0` | ||
|
|
||
| ### Arrays | ||
|
|
||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-cap_add.md) – `undefined#/definitions/service/properties/cap_add` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-cap_drop.md) – `undefined#/definitions/service/properties/cap_drop` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-command-oneof-1.md) – `undefined#/definitions/service/properties/command/oneOf/1` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-configs.md) – `undefined#/definitions/service/properties/configs` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-devices.md) – `undefined#/definitions/service/properties/devices` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-entrypoint-oneof-1.md) – `undefined#/definitions/service/properties/entrypoint/oneOf/1` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-expose.md) – `undefined#/definitions/service/properties/expose` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-external_links.md) – `undefined#/definitions/service/properties/external_links` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-links.md) – `undefined#/definitions/service/properties/links` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-ports.md) – `undefined#/definitions/service/properties/ports` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-security_opt.md) – `undefined#/definitions/service/properties/security_opt` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-secrets.md) – `undefined#/definitions/service/properties/secrets` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-service-properties-volumes.md) – `undefined#/definitions/service/properties/volumes` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-healthcheck-properties-test-oneof-1.md) – `undefined#/definitions/healthcheck/properties/test/oneOf/1` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-deployment-properties-placement-properties-constraints.md) – `undefined#/definitions/deployment/properties/placement/properties/constraints` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-deployment-properties-placement-properties-preferences.md) – `undefined#/definitions/deployment/properties/placement/properties/preferences` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-generic_resources.md) – `undefined#/definitions/generic_resources` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-network-properties-ipam-properties-config.md) – `undefined#/definitions/network/properties/ipam/properties/config` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-list_of_strings.md) – `undefined#/definitions/list_of_strings` | ||
| - [Untitled array in undefined](./config_schema_v3-definitions-list_or_dict-oneof-1.md) – `undefined#/definitions/list_or_dict/oneOf/1` | ||
|
|
||
| ## Version Note | ||
|
|
||
| The schemas linked above follow the JSON Schema Spec version: `http://json-schema.org/draft/2019-09/schema` |
16 changes: 16 additions & 0 deletions
16
docs/config_schema_v3-definitions-config-patternproperties-x-.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Untitled Schema Schema | ||
|
|
||
| ```txt | ||
| undefined#/definitions/config/patternProperties/^x- | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [config_schema_v3.9.json\*](config_schema_v3.9.json "open original schema") | | ||
|
|
||
| ## ^x- Type | ||
|
|
||
| unknown |
16 changes: 16 additions & 0 deletions
16
docs/config_schema_v3-definitions-config-patternproperties.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Untitled Schema Schema | ||
|
|
||
| ```txt | ||
| undefined#/definitions/config/patternProperties | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [config_schema_v3.9.json\*](config_schema_v3.9.json "open original schema") | | ||
|
|
||
| ## patternProperties Type | ||
|
|
||
| unknown |
16 changes: 16 additions & 0 deletions
16
docs/config_schema_v3-definitions-config-properties-external-properties-name.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Untitled string in undefined Schema | ||
|
|
||
| ```txt | ||
| undefined#/definitions/config/properties/external/properties/name | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | ---------- | ---------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Deprecated | Unknown identifiability | Forbidden | Allowed | none | [config_schema_v3.9.json\*](config_schema_v3.9.json "open original schema") | | ||
|
|
||
| ## name Type | ||
|
|
||
| `string` |
16 changes: 16 additions & 0 deletions
16
docs/config_schema_v3-definitions-config-properties-external-properties.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Untitled Schema Schema | ||
|
|
||
| ```txt | ||
| undefined#/definitions/config/properties/external/properties | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [config_schema_v3.9.json\*](config_schema_v3.9.json "open original schema") | | ||
|
|
||
| ## properties Type | ||
|
|
||
| unknown |
38 changes: 38 additions & 0 deletions
38
docs/config_schema_v3-definitions-config-properties-external.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Untitled Schema Schema | ||
|
|
||
| ```txt | ||
| undefined#/definitions/config/properties/external | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | ---------- | -------------- | ------------ | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | [config_schema_v3.9.json\*](config_schema_v3.9.json "open original schema") | | ||
|
|
||
| ## external Type | ||
|
|
||
| any of the folllowing: `boolean` or `object` ([Details](config_schema_v3-definitions-config-properties-external.md)) | ||
|
|
||
| # undefined Properties | ||
|
|
||
| | Property | Type | Required | Nullable | Defined by | | ||
| | :------------ | -------- | -------- | -------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | [name](#name) | `string` | Optional | cannot be null | [Untitled schema](config_schema_v3-definitions-config-properties-external-properties-name.md "undefined#/definitions/config/properties/external/properties/name") | | ||
|
|
||
| ## name | ||
|
|
||
|
|
||
|
|
||
|
|
||
| `name` | ||
|
|
||
| - is optional | ||
| - Type: `string` | ||
| - cannot be null | ||
| - defined in: [Untitled schema](config_schema_v3-definitions-config-properties-external-properties-name.md "undefined#/definitions/config/properties/external/properties/name") | ||
|
|
||
| ### name Type | ||
|
|
||
| `string` |
16 changes: 16 additions & 0 deletions
16
docs/config_schema_v3-definitions-config-properties-file.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Untitled string in undefined Schema | ||
|
|
||
| ```txt | ||
| undefined#/definitions/config/properties/file | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [config_schema_v3.9.json\*](config_schema_v3.9.json "open original schema") | | ||
|
|
||
| ## file Type | ||
|
|
||
| `string` |
16 changes: 16 additions & 0 deletions
16
docs/config_schema_v3-definitions-config-properties-labels.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Untitled Schema Schema | ||
|
|
||
| ```txt | ||
| undefined#/definitions/config/properties/labels | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [config_schema_v3.9.json\*](config_schema_v3.9.json "open original schema") | | ||
|
|
||
| ## labels Type | ||
|
|
||
| unknown |
16 changes: 16 additions & 0 deletions
16
docs/config_schema_v3-definitions-config-properties-name.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Untitled string in undefined Schema | ||
|
|
||
| ```txt | ||
| undefined#/definitions/config/properties/name | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [config_schema_v3.9.json\*](config_schema_v3.9.json "open original schema") | | ||
|
|
||
| ## name Type | ||
|
|
||
| `string` |
16 changes: 16 additions & 0 deletions
16
docs/config_schema_v3-definitions-config-properties-template_driver.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Untitled string in undefined Schema | ||
|
|
||
| ```txt | ||
| undefined#/definitions/config/properties/template_driver | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [config_schema_v3.9.json\*](config_schema_v3.9.json "open original schema") | | ||
|
|
||
| ## template_driver Type | ||
|
|
||
| `string` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| # Untitled Schema Schema | ||
|
|
||
| ```txt | ||
| undefined#/definitions/config/properties | ||
| ``` | ||
|
|
||
|
|
||
|
|
||
|
|
||
| | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In | | ||
| | :------------------ | ---------- | -------------- | ----------------------- | :---------------- | --------------------- | ------------------- | --------------------------------------------------------------------------- | | ||
| | Can be instantiated | No | Unknown status | Unknown identifiability | Forbidden | Allowed | none | [config_schema_v3.9.json\*](config_schema_v3.9.json "open original schema") | | ||
|
|
||
| ## properties Type | ||
|
|
||
| unknown |
Oops, something went wrong.