configuration definitions descriptionmergebehaviour

DescriptionMergeBehaviour Schema

https://github.com/robertmassaioli/openapi-merge/blob/main/packages/openapi-merge-cli/src/data.ts#/properties/inputs/items/anyOf/3/properties/description

This configuration setting lets you configure how the info.description from this OpenAPI file will be merged into the final resulting OpenAPI file

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*

description Type

object (DescriptionMergeBehaviour)

description Examples

{
  "append": true
}

{
  "append": true,
  "title": {
    "value": "Title 1"
  }
}

{
  "append": true,
  "title": {
    "headingLevel": 2,
    "value": "Title Level 2"
  }
}

{
  "append": true,
  "title": {
    "headingLevel": 6,
    "value": "Inperceptible title"
  }
}

description Properties

Property	Type	Required	Nullable	Defined by
append	boolean	Required	cannot be null	Configuration
title	object	Optional	cannot be null	Configuration

append

Wether or not the description for this OpenAPI file will be merged into the description of the final file.

append

• is required

• Type: boolean (append)

• cannot be null

• defined in: Configuration

append Type

boolean (append)

title

You may optionally include a Markdown Title to demarcate this particular section of the merged description files.

title

• is optional

• Type: object (DescriptionTitle)

• cannot be null

• defined in: Configuration

title Type

object (DescriptionTitle)

title Examples

{
  "value": "Title 1"
}

{
  "headingLevel": 2,
  "value": "Title Level 2"
}

{
  "headingLevel": 6,
  "value": "Inperceptible title"
}