Adds invalid "includePath" properties into exported OpenAPI 3.0 types when modular RAML is used

[Windowsfreak]

When using !include statements for better RAML modularisation, e.g.

#main.raml

types:
  Response: !include types/myResponse.raml

#types/myResponse.raml

#%RAML 1.0 DataType
properties:
  // ...

Then the generated specification will contain an extra property includePath in the types that does not belong to OpenAPI 3.0 specification:

{ // ...
      "Response": {
        "includePath": "types/myResponse.raml", // ...
      }
}

[einarjohnson]

@Windowsfreak , did you ever figure a way around this?

[stn1slv]

@Windowsfreak , did you ever figure a way around this?

You can fix it in the following way as a workaround:

1. Convert to YAML

# Convert JSON to YAML:
yq -P -o yaml '.' /path/to/your/api-oas3.json > /path/to/your/api-oas3.yaml

2. Comment out includePath:

# Replace with your actual file path
sed '/includePath:/s/^/# /' /path/to/your/api-oas3.yaml > /path/to/your/api-oas3-final.yaml