Created by: 4brunu
Currently the there is a lot of information in the header api and model files.
That info includes for example spec version.
The problem with that, is that each time the backend publishes a new version, that happens very frequently, all the api and model files change which makes it very difficult go through the new changes introduced in the openapi spec file, since all the files changed with the new spec version.
This doesn't happen with the Swift client for example, because those kinds of info are not in each api and model files, but instead, it's on the readme, which makes sense, and fixes this issue.
With this PR those kinds of information, are moved from the header of api and model files, to the readme, this means that when an api or model file, has changes, they are actually real changes, and not just reflecting the new spec version.
PR checklist
-
Read the contribution guidelines. -
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. -
Run the following to build the project and update samples: Commit all changed files. This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master. These must match the expectations made by your contribution. You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example./mvnw clean package ./bin/generate-samples.sh ./bin/utils/export_docs_generators.sh./bin/generate-samples.sh bin/configs/java*. For Windows users, please run the script in Git BASH. -
File the PR against the correct branch: master(6.1.0) (minor release - breaking changes with fallbacks),7.0.x(breaking changes without fallbacks) -
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@jimschubert (2017/09)