Skip to content

Commit b883271

Browse files
committed
Update OPTIONS.md to include external: false options
1 parent 717dbb0 commit b883271

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

OPTIONS.md

+5
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,11 @@ collapseFolders|boolean|-|true|Importing will collapse all folders that have onl
66
optimizeConversion|boolean|-|true|Optimizes conversion for large specification, disabling this option might affect the performance of conversion.|CONVERSION|v1
77
requestParametersResolution|enum|Example, Schema|Schema|Select whether to generate the request parameters based on the [schema](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) or the [example](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject) in the schema.|CONVERSION|v1
88
exampleParametersResolution|enum|Example, Schema|Example|Select whether to generate the response parameters based on the [schema](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) or the [example](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject) in the schema.|CONVERSION|v1
9+
disabledParametersValidation|boolean|-|true|Whether disabled parameters of collection should be validated|VALIDATION|v2, v1
910
parametersResolution|enum|Example, Schema|Schema|Select whether to generate the request and response parameters based on the [schema](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject) or the [example](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject) in the schema.|CONVERSION|v2, v1
1011
folderStrategy|enum|Paths, Tags|Paths|Select whether to create folders according to the spec’s paths or tags.|CONVERSION|v2, v1
12+
schemaFaker|boolean|-|true|Whether or not schemas should be faked.|CONVERSION|v2, v1
13+
stackLimit|integer|-|10|Number of nesting limit till which schema resolution will happen. Increasing this limit may result in more time to convert collection depending on complexity of specification. (To make sure this option works correctly "optimizeConversion" option needs to be disabled)|CONVERSION|v2, v1
1114
includeAuthInfoInExample|boolean|-|true|Select whether to include authentication parameters in the example request.|CONVERSION|v2, v1
1215
shortValidationErrors|boolean|-|false|Whether detailed error messages are required for request <> schema validation operations.|VALIDATION|v2, v1
1316
validationPropertiesToIgnore|array|-|[]|Specific properties (parts of a request/response pair) to ignore during validation. Must be sent as an array of strings. Valid inputs in the array: PATHVARIABLE, QUERYPARAM, HEADER, BODY, RESPONSE_HEADER, RESPONSE_BODY|VALIDATION|v2, v1
@@ -20,6 +23,8 @@ strictRequestMatching|boolean|-|false|Whether requests should be strictly matche
2023
allowUrlPathVarMatching|boolean|-|false|Whether to allow matching path variables that are available as part of URL itself in the collection request|VALIDATION|v2, v1
2124
enableOptionalParameters|boolean|-|true|Optional parameters aren't selected in the collection. Once enabled they will be selected in the collection and request as well.|CONVERSION|v2, v1
2225
keepImplicitHeaders|boolean|-|false|Whether to keep implicit headers from the OpenAPI specification, which are removed by default.|CONVERSION|v2, v1
26+
includeWebhooks|boolean|-|false|Select whether to include Webhooks in the generated collection|CONVERSION|v2, v1
27+
includeReferenceMap|boolean|-|false|Whether or not to include reference map or not as part of output|BUNDLE|v2, v1
2328
includeDeprecated|boolean|-|true|Select whether to include deprecated operations, parameters, and properties in generated collection or not|CONVERSION, VALIDATION|v2, v1
2429
alwaysInheritAuthentication|boolean|-|false|Whether authentication details should be included on every request, or always inherited from the collection.|CONVERSION|v2, v1
2530
preferredRequestBodyType|enum|x-www-form-urlencoded, form-data, raw, first-listed|first-listed|When there are multiple content-types defined in the request body of OpenAPI, the conversion selects the preferred option content-type as request body.If "first-listed" is set, the first content-type defined in the OpenAPI spec will be selected.|CONVERSION|v2

lib/options.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ module.exports = {
396396
description: 'When there are multiple content-types defined in the request body of OpenAPI, the conversion ' +
397397
'selects the preferred option content-type as request body.If "first-listed" is set, the first ' +
398398
'content-type defined in the OpenAPI spec will be selected.',
399-
external: true,
399+
external: false,
400400
usage: ['CONVERSION'],
401401
supportedIn: [VERSION20, VERSION30, VERSION31],
402402
supportedModuleVersion: [MODULE_VERSION.V2]

test/system/structure.test.js

+2-2
Original file line numberDiff line numberDiff line change
@@ -323,8 +323,8 @@ describe('getOptions', function() {
323323
describe('OPTIONS.md', function() {
324324
it('must contain all details of options', function () {
325325
const optionsDoc = fs.readFileSync('OPTIONS.md', 'utf-8'),
326-
v1Options = getOptions(undefined, { external: true, moduleVersion: 'v1' }),
327-
v2Options = getOptions(undefined, { external: true, moduleVersion: 'v2' }),
326+
v1Options = getOptions(undefined, { moduleVersion: 'v1' }),
327+
v2Options = getOptions(undefined, { moduleVersion: 'v2' }),
328328
allOptions = _.uniqBy(_.concat(v1Options, v2Options), 'id');
329329

330330
expect(optionsDoc).to.eql(generateOptionsDoc(allOptions));

0 commit comments

Comments
 (0)