Skip to content

configuration definitions descriptiontitle

Robert Massaioli edited this page Sep 7, 2021 · 5 revisions

DescriptionTitle Schema

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*

title Type

object (DescriptionTitle)

title Examples

{
  "value": "Title 1"
}
{
  "headingLevel": 2,
  "value": "Title Level 2"
}
{
  "headingLevel": 6,
  "value": "Inperceptible title"
}

title Properties

Property Type Required Nullable Defined by
headingLevel number Optional cannot be null Configuration
value string Required cannot be null Configuration

headingLevel

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

headingLevel Type

number (headingLevel)

headingLevel Constraints

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

headingLevel Default Value

The default value is:

1

value

The value of the included title.

value

value Type

string (value)

value Constraints

minimum length: the minimum number of characters for this string is: 1

Clone this wiki locally