Skip to content

Commit

Permalink
docs: update config docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ugrc-release-bot[bot] authored and stdavis committed Jul 5, 2024
1 parent dfc7e1f commit 434569f
Show file tree
Hide file tree
Showing 34 changed files with 482 additions and 482 deletions.
32 changes: 16 additions & 16 deletions docs/config-definitions-limitcontrol.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@

`field`

* is required
* is required

* Type: `string` ([Field](config-definitions-limitcontrol-properties-field.md))
* Type: `string` ([Field](config-definitions-limitcontrol-properties-field.md))

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-definitions-limitcontrol-properties-field.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/limitControl/properties/field")
* defined in: [WFRC RTP Projects Application Configuration](config-definitions-limitcontrol-properties-field.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/limitControl/properties/field")

### field Type

Expand All @@ -35,13 +35,13 @@

`labels`

* is required
* is required

* Type: `string[]`
* Type: `string[]`

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-definitions-limitcontrol-properties-label.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/limitControl/properties/labels")
* defined in: [WFRC RTP Projects Application Configuration](config-definitions-limitcontrol-properties-label.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/limitControl/properties/labels")

### labels Type

Expand All @@ -53,13 +53,13 @@

`values`

* is required
* is required

* Type: `string[]`
* Type: `string[]`

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-definitions-limitcontrol-properties-values.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/limitControl/properties/values")
* defined in: [WFRC RTP Projects Application Configuration](config-definitions-limitcontrol-properties-values.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/limitControl/properties/values")

### values Type

Expand All @@ -71,13 +71,13 @@ The modes that this control should be enabled for

`modes`

* is required
* is required

* Type: `string[]`
* Type: `string[]`

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-definitions-limitcontrol-properties-modes.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/limitControl/properties/modes")
* defined in: [WFRC RTP Projects Application Configuration](config-definitions-limitcontrol-properties-modes.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/limitControl/properties/modes")

### modes Type

Expand Down
24 changes: 12 additions & 12 deletions docs/config-definitions-project-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ The query that will be applied to the line layers

`lines`

* is required
* is required

* Type: `string` ([Lines Query](config-definitions-project-type-properties-lines-query.md))
* Type: `string` ([Lines Query](config-definitions-project-type-properties-lines-query.md))

* can be null
* can be null

* defined in: [WFRC RTP Projects Application Configuration](config-definitions-project-type-properties-lines-query.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/projectType/properties/lines")
* defined in: [WFRC RTP Projects Application Configuration](config-definitions-project-type-properties-lines-query.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/projectType/properties/lines")

### lines Type

Expand All @@ -34,13 +34,13 @@ The query that will be applied to the point layers

`points`

* is required
* is required

* Type: `string` ([Points Query](config-definitions-project-type-properties-points-query.md))
* Type: `string` ([Points Query](config-definitions-project-type-properties-points-query.md))

* can be null
* can be null

* defined in: [WFRC RTP Projects Application Configuration](config-definitions-project-type-properties-points-query.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/projectType/properties/points")
* defined in: [WFRC RTP Projects Application Configuration](config-definitions-project-type-properties-points-query.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/projectType/properties/points")

### points Type

Expand All @@ -52,13 +52,13 @@ Optionally show a '?' popup with help text

`helpTxt`

* is optional
* is optional

* Type: `string` ([Help Text](config-definitions-project-type-properties-help-text.md))
* Type: `string` ([Help Text](config-definitions-project-type-properties-help-text.md))

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-definitions-project-type-properties-help-text.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/projectType/properties/helpTxt")
* defined in: [WFRC RTP Projects Application Configuration](config-definitions-project-type-properties-help-text.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/projectType/properties/helpTxt")

### helpTxt Type

Expand Down
4 changes: 2 additions & 2 deletions docs/config-definitions-translation-additionalproperties.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ merged type ([Details](config-definitions-translation-additionalproperties.md))

one (and only one) of

* [Untitled string in WFRC RTP Projects Application Configuration](config-definitions-translation-additionalproperties-oneof-0.md "check type definition")
* [Untitled string in WFRC RTP Projects Application Configuration](config-definitions-translation-additionalproperties-oneof-0.md "check type definition")

* [Untitled object in WFRC RTP Projects Application Configuration](config-definitions-translation-additionalproperties-oneof-1.md "check type definition")
* [Untitled object in WFRC RTP Projects Application Configuration](config-definitions-translation-additionalproperties-oneof-1.md "check type definition")
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ Additional properties are allowed, as long as they follow this schema:



* is optional
* is optional

* Type: `string`
* Type: `string`

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-definitions-translation-properties-maptabsdialog-additionalproperties.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/translation/properties/mapTabsDialog/additionalProperties")
* defined in: [WFRC RTP Projects Application Configuration](config-definitions-translation-properties-maptabsdialog-additionalproperties.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/translation/properties/mapTabsDialog/additionalProperties")

### additionalProperties Type

Expand Down
20 changes: 10 additions & 10 deletions docs/config-definitions-translation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@

`mapTabsDialog`

* is optional
* is optional

* Type: `object` ([Details](config-definitions-translation-properties-maptabsdialog.md))
* Type: `object` ([Details](config-definitions-translation-properties-maptabsdialog.md))

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-definitions-translation-properties-maptabsdialog.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/translation/properties/mapTabsDialog")
* defined in: [WFRC RTP Projects Application Configuration](config-definitions-translation-properties-maptabsdialog.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/translation/properties/mapTabsDialog")

### mapTabsDialog Type

Expand All @@ -33,20 +33,20 @@ Additional properties are allowed, as long as they follow this schema:



* is optional
* is optional

* Type: merged type ([Details](config-definitions-translation-additionalproperties.md))
* Type: merged type ([Details](config-definitions-translation-additionalproperties.md))

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-definitions-translation-additionalproperties.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/translation/additionalProperties")
* defined in: [WFRC RTP Projects Application Configuration](config-definitions-translation-additionalproperties.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/definitions/translation/additionalProperties")

### additionalProperties Type

merged type ([Details](config-definitions-translation-additionalproperties.md))

one (and only one) of

* [Untitled string in WFRC RTP Projects Application Configuration](config-definitions-translation-additionalproperties-oneof-0.md "check type definition")
* [Untitled string in WFRC RTP Projects Application Configuration](config-definitions-translation-additionalproperties-oneof-0.md "check type definition")

* [Untitled object in WFRC RTP Projects Application Configuration](config-definitions-translation-additionalproperties-oneof-1.md "check type definition")
* [Untitled object in WFRC RTP Projects Application Configuration](config-definitions-translation-additionalproperties-oneof-1.md "check type definition")
24 changes: 12 additions & 12 deletions docs/config-properties-default-map-extent.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@

`x`

* is required
* is required

* Type: `number`
* Type: `number`

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-properties-default-map-extent-properties-x.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/defaultExtent/properties/x")
* defined in: [WFRC RTP Projects Application Configuration](config-properties-default-map-extent-properties-x.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/defaultExtent/properties/x")

### x Type

Expand All @@ -34,13 +34,13 @@

`y`

* is required
* is required

* Type: `number`
* Type: `number`

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-properties-default-map-extent-properties-y.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/defaultExtent/properties/y")
* defined in: [WFRC RTP Projects Application Configuration](config-properties-default-map-extent-properties-y.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/defaultExtent/properties/y")

### y Type

Expand All @@ -52,13 +52,13 @@

`scale`

* is required
* is required

* Type: `number`
* Type: `number`

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-properties-default-map-extent-properties-scale.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/defaultExtent/properties/scale")
* defined in: [WFRC RTP Projects Application Configuration](config-properties-default-map-extent-properties-scale.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/defaultExtent/properties/scale")

### scale Type

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@

`cost`

* is required
* is required

* Type: `string` ([Cost](config-properties-filter-widget-configuration-properties-field-names-properties-cost.md))
* Type: `string` ([Cost](config-properties-filter-widget-configuration-properties-field-names-properties-cost.md))

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-properties-filter-widget-configuration-properties-field-names-properties-cost.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/filter/properties/fieldNames/properties/cost")
* defined in: [WFRC RTP Projects Application Configuration](config-properties-filter-widget-configuration-properties-field-names-properties-cost.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/filter/properties/fieldNames/properties/cost")

### cost Type

Expand All @@ -35,13 +35,13 @@

`mode`

* is required
* is required

* Type: `string` ([Mode](config-properties-filter-widget-configuration-properties-field-names-properties-mode.md))
* Type: `string` ([Mode](config-properties-filter-widget-configuration-properties-field-names-properties-mode.md))

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-properties-filter-widget-configuration-properties-field-names-properties-mode.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/filter/properties/fieldNames/properties/mode")
* defined in: [WFRC RTP Projects Application Configuration](config-properties-filter-widget-configuration-properties-field-names-properties-mode.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/filter/properties/fieldNames/properties/mode")

### mode Type

Expand All @@ -53,13 +53,13 @@

`phase`

* is required
* is required

* Type: `string` ([Phase](config-properties-filter-widget-configuration-properties-field-names-properties-phase.md))
* Type: `string` ([Phase](config-properties-filter-widget-configuration-properties-field-names-properties-phase.md))

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-properties-filter-widget-configuration-properties-field-names-properties-phase.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/filter/properties/fieldNames/properties/phase")
* defined in: [WFRC RTP Projects Application Configuration](config-properties-filter-widget-configuration-properties-field-names-properties-phase.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/filter/properties/fieldNames/properties/phase")

### phase Type

Expand All @@ -71,13 +71,13 @@

`phaseNeeded`

* is required
* is required

* Type: `string` ([Phase Needed](config-properties-filter-widget-configuration-properties-field-names-properties-phase-needed.md))
* Type: `string` ([Phase Needed](config-properties-filter-widget-configuration-properties-field-names-properties-phase-needed.md))

* cannot be null
* cannot be null

* defined in: [WFRC RTP Projects Application Configuration](config-properties-filter-widget-configuration-properties-field-names-properties-phase-needed.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/filter/properties/fieldNames/properties/phaseNeeded")
* defined in: [WFRC RTP Projects Application Configuration](config-properties-filter-widget-configuration-properties-field-names-properties-phase-needed.md "https://wfrc.org/rtp-2023-adopted-map/config.schema.json#/properties/filter/properties/fieldNames/properties/phaseNeeded")

### phaseNeeded Type

Expand Down
Loading

0 comments on commit 434569f

Please sign in to comment.