I've found an unexpected behavior that the output was different even if the input files are identical and swagger-cli version is also the same. Is this behavior intentional?
--- out.10.0.3.yaml 2023-02-22 01:38:29.174884945 +0900
+++ out.10.1.0.yaml 2023-02-22 01:38:45.803131147 +0900
@@ -31,6 +31,7 @@
content:
application/json:
schema:
+ description: the order of this description directive changes between versions
type: object
required:
- test
@@ -38,4 +39,3 @@
test:
type: integer
example: 1
- description: the order of this description directive changes between versions
Expected behavior
The same output is generated if the input and swagger-cli version are identical.
Such situations can occur, for example, in the following cases: when a new member joins our team, and runs npm install -g @apidevtools/swagger-cli @4.0.4, this member's machine may have a different version of swagger-parser. If so, there will be differences in the files generated by the new member and the existing member even if the version of swagger-cli is fixed.
This feels counter-intuitive to me. Especially if we're committing the generated files to git, the differences in the output cause annoying diff.
notes
I'm not sure of the exact cause but this difference seems to come from this block of json-schema-ref-parser
The version of json-schema-ref-parser is fixed in this commit but I couldn't find out more details of this change
I've found an unexpected behavior that the output was different even if the input files are identical and swagger-cli version is also the same. Is this behavior intentional?
How to reproduce
@apidevtools/swagger-parser
is differExpected behavior
The same output is generated if the input and swagger-cli version are identical.
Such situations can occur, for example, in the following cases: when a new member joins our team, and runs
npm install -g @apidevtools/swagger-cli @4.0.4
, this member's machine may have a different version ofswagger-parser
. If so, there will be differences in the files generated by the new member and the existing member even if the version ofswagger-cli
is fixed.This feels counter-intuitive to me. Especially if we're committing the generated files to git, the differences in the output cause annoying diff.
notes