Forum Discussion

adriaanbastien's avatar
adriaanbastien
Regular Visitor
5 months ago
Solved

resloved yaml is having 3 dashes "---" as first line, is removing all comments + adding linebreaks

Hello community.

 

Some question.

Is this normal behavior?

whenever we download the resolved yaml i notice big differences with resolved / unresolved.

what is the reason behind?

 

unresolved yaml is containing the comments as normal.

the resolved yaml is containing

- 3 dashes as the first line

- removes all the comments

- adds linebreaks to all the text \n \n###

---
openapi: 3.0.0
info:
title: Some API
description: "Some description with line breaks;\n- This is a point\n- another one;n- and so on\n\n#### "

Is this an option that we can activate / de-activate

thanks for the input.

  • Hello adriaanbastien 

    I am not sure about the reasons behind the modification of your file when resolving the specification.
    Resolved file is intended to be injected to any "Programmatic" system and it obviously requires to flatten the file before.
    So it may depend on your "resolving" engine"

    When using SwaggerHub resolve option, I got such kind of result:
    on the left, the resolved file.

     

     Like you see I am using MD language for return characters:


    let us know




1 Reply

  • chichepo's avatar
    chichepo
    Champion Level 3

    Hello adriaanbastien 

    I am not sure about the reasons behind the modification of your file when resolving the specification.
    Resolved file is intended to be injected to any "Programmatic" system and it obviously requires to flatten the file before.
    So it may depend on your "resolving" engine"

    When using SwaggerHub resolve option, I got such kind of result:
    on the left, the resolved file.

     

     Like you see I am using MD language for return characters:


    let us know