-
Notifications
You must be signed in to change notification settings - Fork 30
configuration definitions configurationinputfromurl
https://github.com/robertmassaioli/openapi-merge/blob/main/packages/openapi-merge-cli/src/data.ts#/properties/inputs/items/anyOf/1A single Configuration input from a URL
| 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 (ConfigurationInputFromUrl)
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| description | object |
Optional | cannot be null | Configuration |
| disputePrefix | string |
Optional | cannot be null | Configuration |
| inputURL | string |
Required | cannot be null | Configuration |
| operationSelection | object |
Optional | cannot be null | Configuration |
| pathModification | object |
Optional | cannot be null | Configuration |
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
object (DescriptionMergeBehaviour)
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
string (disputePrefix)
minimum length: the minimum number of characters for this string is: 1
The input url that we should load our configuration file from.
inputURL
-
is required
-
Type:
string(inputURL) -
cannot be null
-
defined in: Configuration
string (inputURL)
pattern: the string must match the following regular expression:
^https?://URI: the string must be a URI, according to RFC 3986
Choose which OpenAPI Operations should be included from this input.
operationSelection
-
is optional
-
Type:
object(OperationSelection) -
cannot be null
-
defined in: Configuration
object (OperationSelection)
For this input, you can perform these modifications to its paths elements.
pathModification
-
is optional
-
Type:
object(PathModification) -
cannot be null
-
defined in: Configuration
object (PathModification)