-
Notifications
You must be signed in to change notification settings - Fork 28
configuration definitions descriptiontitle
Robert Massaioli edited this page Sep 7, 2021
·
5 revisions
https://github.com/robertmassaioli/openapi-merge/blob/main/packages/openapi-merge-cli/src/data.ts#/definitions/DescriptionMergeBehaviour/properties/title
You may optionally include a Markdown Title to demarcate this particular section of the merged description files.
Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
---|---|---|---|---|---|---|---|
Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | configuration.schema.json* |
object
(DescriptionTitle)
{
"value": "Title 1"
}
{
"headingLevel": 2,
"value": "Title Level 2"
}
{
"headingLevel": 6,
"value": "Inperceptible title"
}
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
headingLevel | number |
Optional | cannot be null | Configuration |
value | string |
Required | cannot be null | Configuration |
What heading level this heading will be at: from h1 through to h6. The default value is 1 and will create h1 elements in Markdown format.
headingLevel
-
is optional
-
Type:
number
(headingLevel) -
cannot be null
-
defined in: Configuration
number
(headingLevel)
maximum: the value of this number must smaller than or equal to: 6
minimum: the value of this number must greater than or equal to: 1
The default value is:
1
The value of the included title.
value
-
is required
-
Type:
string
(value) -
cannot be null
-
defined in: Configuration
string
(value)
minimum length: the minimum number of characters for this string is: 1