Skip to content

configuration definitions configurationinputfromurl

Robert Massaioli edited this page Sep 6, 2021 · 4 revisions

ConfigurationInputFromUrl Schema

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

A 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*

1 Type

object (ConfigurationInputFromUrl)

1 Properties

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

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

description Type

object (DescriptionMergeBehaviour)

disputePrefix

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

disputePrefix

disputePrefix Type

string (disputePrefix)

disputePrefix Constraints

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

inputURL

The input url that we should load our configuration file from.

inputURL

inputURL Type

string (inputURL)

inputURL Constraints

pattern: the string must match the following regular expression:

^https?://

try pattern

URI: the string must be a URI, according to RFC 3986

operationSelection

Choose which OpenAPI Operations should be included from this input.

operationSelection

operationSelection Type

object (OperationSelection)

pathModification

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

pathModification

pathModification Type

object (PathModification)

Clone this wiki locally