Class: OpenApiTransformerBase

openapi-transformer-base~OpenApiTransformerBase()

Base class for traversing or transforming OpenAPI 2.x or 3.x documents using a modified visitor design pattern to traverse object types within the OpenAPI document tree. This class uses the following conventions:
  • Objects passed as arguments are never modified by this class. Subclasses are encouraged to maintain this invariant by returning modified copies rather than modifying the argument objects.
  • JSON References, if present, are passed to the transform method for the type required by their position. (e.g. a schema $ref is passed to transformSchema).
  • Properties which are not defined in the OpenAPI specification are preserved in returned objects unchanged. (e.g. x- extension properties)
  • The order that properties are visited is not defined and may change in future versions.
  • The behavior of this class is not conditional on the declared OpenAPI version in the document. It will traverse properties which are present, regardless of whether they are specified in the declared version.
  • Callers may begin traversal at any point in the document (e.g. by calling transformSchema directly, instead of transitively through transformOpenApi).
  • No validation is performed on the OpenAPI document and every attempt is made to handle invalid values gracefully. Child classes should be prepared for arguments with any type or value if the document may not be valid.
  • Minimal effort is made to handle or preserve values which are not representable in JSON (e.g. Date, RegExp, non-Object.prototype, Symbol and non-enumerable properties, etc.), which are usually treated as generic objects.
  • One exception to the previous point: transform methods are not called on undefined values, which are treated like missing properties except that they are copied to the transformed object to preserve the object shape.
  • Returned values are added to the transformed object, regardless of value. Therefore, unless overridden, returned objects will have the same properties as the original object, some of which may be undefined.

Constructor

new OpenApiTransformerBase()

Source:

Methods

transformArray(arr, transform) → {!Array.<TransformedType>|*}

Transforms an Array[ValueType] using a given transform method.
Parameters:
Name Type Description
arr !Array.<ValueType> | * Array to transform.
transform function Method which transforms values in arr.
Source:
Returns:
If arr is an Array, the result of Array#map(transform). Otherwise, obj is returned unchanged.
Type
!Array.<TransformedType> | *

transformCallback(callbacknon-null) → (non-null) {object}

Transforms a Callback Object.
Parameters:
Name Type Description
callback object Callback Object.
Source:
Returns:
Transformed Callback Object.
Type
object

transformComponents(componentsnon-null) → (non-null) {object}

Transforms a Components Object.
Parameters:
Name Type Description
components object Components Object.
Source:
Returns:
Transformed Components Object.
Type
object

transformContact(contactnon-null) → (non-null) {object}

Transforms a Contact Object.
Parameters:
Name Type Description
contact object Contact Object.
Source:
Returns:
Transformed Contact Object.
Type
object

transformDiscriminator(discriminatornon-null) → (non-null) {object}

Transforms a Discriminator Object.
Parameters:
Name Type Description
discriminator object Discriminator Object.
Source:
Returns:
Transformed Discriminator Object.
Type
object

transformEncoding(encodingnon-null) → (non-null) {object}

Transforms a Encoding Object.
Parameters:
Name Type Description
encoding object Encoding Object.
Source:
Returns:
Transformed Encoding Object.
Type
object

transformExample(examplenon-null) → (non-null) {object}

Transforms an OpenAPI 2.0 Example Object.
Parameters:
Name Type Description
example object OpenAPI 2.0 Example Object.
Source:
Returns:
Transformed Example Object.
Type
object

transformExample3(examplenon-null) → (non-null) {object}

Transforms an OpenAPI 3.x Example Object.
Parameters:
Name Type Description
example object OpenAPI 3.x Example Object.
Source:
Returns:
Transformed Example Object.
Type
object

transformExternalDocs(externalDocsnon-null) → (non-null) {object}

Transforms an External Documentation Object.
Parameters:
Name Type Description
externalDocs object External Documentation Object.
Source:
Returns:
Transformed External Documentation Object.
Type
object

transformHeader(headernon-null) → (non-null) {object}

Transforms a Header Object.
Parameters:
Name Type Description
header object Header Object.
Source:
Returns:
Transformed Header Object.
Type
object

transformInfo(infonon-null) → (non-null) {object}

Transforms an Info Object.
Parameters:
Name Type Description
info object Info Object.
Source:
Returns:
Transformed Info Object.
Type
object

transformItems(itemsnon-null) → (non-null) {object}

Transforms an Items Object. Note: Items Object is a subset of Schema Object with the addition of collectionFormat.
Parameters:
Name Type Description
items object Items Object.
Source:
Returns:
Transformed Items Object.
Type
object

transformLicense(licensenon-null) → (non-null) {object}

Transforms a License Object.
Parameters:
Name Type Description
license object License Object.
Source:
Returns:
Transformed License Object.
Type
object
Transforms an Link Object.
Parameters:
Name Type Description
link object Link Object.
Source:
Returns:
Transformed Link Object.
Type
object

transformMap(obj, transform) → {!object.<string, TransformedType>|*}

Transforms a Map[string, ValueType] using a given transform method. Similar to modify-values and _.mapValues from lodash. Unlike the above:
  • If the first argument is not an object, it is returned unchanged.
  • If the first argument is an Array, it is returned unchanged.
  • If the first argument is a non-null object, the returned object will be a new object with prototype Object.prototype and properties matching the first argument with transformed values.
Parameters:
Name Type Description
obj !object.<string, ValueType> | * Map to transform.
transform function Method which transforms values in obj.
Source:
Returns:
If obj is a Map, a plain object with the same own enumerable string-keyed properties as obj with values returned by transform. Otherwise, obj is returned unchanged.
Type
!object.<string, TransformedType> | *

transformMediaType(mediaTypenon-null) → (non-null) {object}

Transforms a Media Type Object.
Parameters:
Name Type Description
mediaType object Media Type Object.
Source:
Returns:
Transformed Media Type Object.
Type
object

transformOAuthFlow(flownon-null) → (non-null) {object}

Transforms an OAuth Flow Object.
Parameters:
Name Type Description
flow object OAuth Flow Object.
Source:
Returns:
Transformed OAuth Flow Object.
Type
object

transformOAuthFlows(flowsnon-null) → (non-null) {object}

Transforms an OAuth Flows Object.
Parameters:
Name Type Description
flows object OAuth Flows Object.
Source:
Returns:
Transformed OAuth Flows Object.
Type
object

transformOpenApi(openApinon-null) → (non-null) {object}

Transforms an OpenAPI 3.0 Object or OpenAPI 2.0 (fka Swagger) Object.
Parameters:
Name Type Description
openApi object OpenAPI Object.
Source:
Returns:
Transformed OpenAPI Object.
Type
object

transformOperation(operationnon-null) → (non-null) {object}

Transforms a Operation Object.
Parameters:
Name Type Description
operation object Operation Object.
Source:
Returns:
Transformed Operation Object.
Type
object

transformParameter(parameternon-null) → (non-null) {object}

Transforms a Parameter Object. Note: In OpenAPI 2.0, Parameter Object shares many properties with Schema Object (when .in !== 'body').
Parameters:
Name Type Description
parameter object Parameter Object.
Source:
Returns:
Transformed Parameter Object.
Type
object

transformPathItem(pathItemnon-null) → (non-null) {object}

Transforms a Path Item Object.
Parameters:
Name Type Description
pathItem object Path Item Object.
Source:
Returns:
Transformed Path Item Object.
Type
object

transformPaths(pathsnon-null) → (non-null) {object}

Transforms a Paths Object. Note: Paths Object may be traversed from the x-ms-paths property in addition to the paths property of the OpenAPI Object.
Parameters:
Name Type Description
paths object Paths Object.
Source:
Returns:
Transformed Paths Object.
Type
object

transformRequestBody(requestBodynon-null) → (non-null) {object}

Transforms a Request Body Object.
Parameters:
Name Type Description
requestBody object Request Body Object.
Source:
Returns:
Transformed Request Body Object.
Type
object

transformResponse(responsenon-null) → (non-null) {object}

Transforms a Response Object.
Parameters:
Name Type Description
response object Response Object.
Source:
Returns:
Transformed Response Object.
Type
object

transformResponses(responsesnon-null) → (non-null) {object}

Transforms a Responses Object.
Parameters:
Name Type Description
responses object Responses Object.
Source:
Returns:
Transformed Response Object.
Type
object

transformSchema(schemanon-null) → (non-null) {object}

Transforms a Schema Object. Note: For OpenAPI 2.0 documents, consider overriding {@see transformParameter}, {@see transformItems}, and {@see transformHeader} to transform all schema-like objects.
Parameters:
Name Type Description
schema object Schema Object.
Source:
Returns:
Transformed Schema Object.
Type
object

transformSchemaProperties(propertiesnon-null) → (non-null) {object}

Transforms Schema Object properties.
Parameters:
Name Type Description
properties object Schema Object properties.
Source:
Returns:
Transformed Schema Object properties.
Type
object

transformSecurityRequirement(securityRequirementnon-null) → (non-null) {object}

Transforms a Security Requirement Object.
Parameters:
Name Type Description
securityRequirement object Security Requirement Object.
Source:
Returns:
Transformed Security Requirement Object.
Type
object

transformSecurityScheme(securitySchemenon-null) → (non-null) {object}

Transforms a Security Scheme Object.
Parameters:
Name Type Description
securityScheme object Security Scheme Object.
Source:
Returns:
Transformed Security Scheme Object.
Type
object

transformServer(servernon-null) → (non-null) {object}

Transforms a Server Object.
Parameters:
Name Type Description
server object Server Object.
Source:
Returns:
Transformed Server Object.
Type
object

transformServerVariable(serverVariablenon-null) → (non-null) {object}

Transforms a Server Variable Object.
Parameters:
Name Type Description
serverVariable object Server Variable Object.
Source:
Returns:
Transformed Server Variable Object.
Type
object

transformTag(tagnon-null) → (non-null) {object}

Transforms a Tag Object.
Parameters:
Name Type Description
tag object Tag Object.
Source:
Returns:
Transformed Tag Object.
Type
object

transformXml(xmlnon-null) → (non-null) {object}

Transforms an XML Object.
Parameters:
Name Type Description
xml object XML Object.
Source:
Returns:
Transformed XML Object.
Type
object

warn(message, …values)

Logs a warning about the transformation. Logs to util.debuglog('openapi-transformer-base') by default. Designed to be overridden and/or reassigned to log as appropriate for projects which use this class.
Parameters:
Name Type Attributes Description
message string | * Message with zero or more substitution strings, or first value to log.
values * <repeatable>
 Additional values to log. Applied to substitution string in message, if one matches, otherwise appended.
Source: