package oas
Type Members
- class AddItemsToArrayType extends TransformationStep
- class CleanIdenticalExamples extends TransformationStep
- class CleanNullSecurity extends TransformationStep
- class CleanParameterExamples extends TransformationStep
- class CleanRepeatedOperationIds extends TransformationStep
- class DeclareUndeclaredSecuritySchemes extends TransformationStep
-
case class
FixConsumesAndProduces() extends TransformationStep with Product with Serializable
Contrary to OAS, In RAML, mediaTypes defined in requests/responses bodies are not added to the field accepts/contentType of the model.
Contrary to OAS, In RAML, mediaTypes defined in requests/responses bodies are not added to the field accepts/contentType of the model. So, in the MediaTypeResolutionStage, when converting from RAML to OAS 2.0, the accepts and contentType only include the global mediaType (if defined). This led to some inconsistent transformations when mediaTypes were defined in bodies as accepts/contentType did not correlate to the payload's mediaTypes. The purpose of this step is to address this issue. To do this, mediaTypes are collected from payloads and accepts and contentType fields are set with that values. This way payload's mediaTypes and modified fields will correlate, solving the inconsistency. The only particular case is when a file parameter is defined inside the request body. The accepts field is filled with the 2 possible mediaTypes according to the spec.
-
case class
FixFilePayloads() extends TransformationStep with Product with Serializable
To represent a method with file upload:
To represent a method with file upload:
in RAML: \- You define a body with multipart/form-data and a property of type: file \- You can specify acceptable file types directly with fileTypes: ['application/xml']
In OAS 2.0 you need a parameter of type: file and in: formData with a consumes: - multipart/form-data, to correctly emit this the FormBodyParameter annotation is needed
- class LowercaseSchemes extends TransformationStep
- class MandatoryDocumentationUrl extends TransformationStep
- class MandatoryPathParameters extends TransformationStep
- class MandatoryResponses extends TransformationStep
- class Oas20SecuritySettingsMapper extends SecuritySettingsMapper