Update docs with deails about --no-deprecated-operations #155
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces the DeprecatedEndpointTests.cs file which includes unit tests to verify if deprecated OpenAPI endpoints are handled correctly. The tests ensure that the generated code builds successfully, contains an "[System.Obsolete]" attribute and is not empty/null. This is crucial to maintain API stability and to avoid unintended use of deprecated endpoints.
A new test file, DeprecatedEndpointsSkippedTests.cs, has been added. These tests ensure that the refit code generation process correctly skips endpoints marked as deprecated in the OpenAPI specifications. This is to prevent usage of obsolete endpoints, improving the reliability and up-to-dateness of the codebase.
Added information about the `--no-deprecated-operations` option in the README files. This option enables users to choose not to generate deprecated operations. This update provides clearer guidance for users on how to work with deprecated operations when generating code from an OpenAPI specifications file.
A flag has been added to the Github Workflow configuration to ignore deprecated operations on the /pet/ endpoint. This change is done to ensure our workflow only considers up-to-date operations and avoids any issues that can arise from deprecated operations.
christianhelle
added
the
documentation
|
Kudos, SonarCloud Quality Gate passed!
|
Codecov Report
@@ Coverage Diff @@
## main #155 +/- ##
==========================================
+ Coverage 98.32% 98.40% +0.08%
==========================================
Files 37 39 +2
Lines 1195 1255 +60
==========================================
+ Hits 1175 1235 +60
Misses 6 6
Partials 14 14
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The changes here also add missing tests regarding handling deprecated operations and skipping code generation of deprecated operations