TrafficPermissions configuration reference
This sample page template shows how to format high structured reference information.
Configuration model
The following list outlines field hierarchy, language-specific data types, and requirements in this configuration entry. Click on a property name to view additional details, including default values.
elem_a
: data type | defaultelem_b
: data type | defaultspec
: data type | defaultelem_ba
: data type | defaultelem_baa
: data type | defaultelem_baaa
: data type | defaultelem_baab
: data type | defaultelem_baac
: data type | defaultelement_bab
: data type | default
Complete configuration
The complete configuration follows the configuration model. Use tabs for each markup language you expect pracitioners to use.
Specification
The specification block contains the details about each configuration. It is a flattened representation of the configuration model block that allows for extended descriptions, examples, and other information to help readers understand the behavior of the configurations.
Elem_a
Use this space to thoroughly, but succinctly, document the configuration item. This format is intended to allow you to create complete documentation, however, stay within the scope of the reference. If the description deviates from the reference material, create a new Concept topic or add the information to an existing Concept.
Values
- Default: default value or none
- This field is required.
- Data type: data type
Specify any additional information about the values that you can specify.
Elem_b
Add your description. You can include example configurations and describe any dependencies or cascading effects that the configuration may have.
Values
- Default: default value or none
- This field is required.
- Data type: data type
Specify any additional information about the values that you can specify.
Examples
If you have more than one example to show, create an Examples section (general block) and introduce the examples per the style guide.
Specific use case
Introduce examples clearly and help readers understand the connections
between the example snippet and the configuration element you are trying to
explain. Use phrases such as "In the following example, the elem
performs
some action on a service named service-name
".