configuration properties inputs items anyof 0

Untitled object in Configuration Schema

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

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*

0 Type

object (Details)

0 Properties

Property	Type	Required	Nullable	Defined by
description	object	Optional	cannot be null	Configuration
disputePrefix	string	Optional	cannot be null	Configuration
inputFile	string	Required	cannot be null	Configuration
operationSelection	object	Optional	cannot be null	Configuration
pathModification	object	Optional	cannot be null	Configuration

description

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

description

• is optional

• Type: object (DescriptionMergeBehaviour)

• cannot be null

• defined in: Configuration

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"
  }
}

disputePrefix

The prefix that will be used in the event of a conflict of two definition names.

disputePrefix

• is optional

• Type: string (disputePrefix)

• cannot be null

• defined in: Configuration

disputePrefix Type

string (disputePrefix)

disputePrefix Constraints

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

inputFile

The path to the input OpenAPI Schema that will be merged.

inputFile

• is required

• Type: string (inputFile)

• cannot be null

• defined in: Configuration

inputFile Type

string (inputFile)

inputFile Constraints

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

operationSelection

Choose which OpenAPI Operations should be included from this input.

operationSelection

• is optional

• Type: object (OperationSelection)

• cannot be null

• defined in: Configuration

operationSelection Type

object (OperationSelection)

operationSelection Examples

{
  "includeTags": [
    "include-this-tag-only"
  ]
}

{
  "excludeTags": [
    "exclude-these-tags"
  ]
}

{
  "excludeTags": [
    "filter-out-with-this-tag"
  ],
  "includeTags": [
    "select-this-first"
  ]
}

pathModification

For this input, you can perform these modifications to its paths elements.

pathModification

• is optional

• Type: object (PathModification)

• cannot be null

• defined in: Configuration

pathModification Type

object (PathModification)

pathModification Examples

{
  "stripStart": "Model"
}

{
  "prepend": "Model"
}

{
  "prepend": "Object",
  "stripStart": "Jira"
}