Add allowedValues support for API parameter discovery#13543
Open
dheeraj12347 wants to merge 2 commits into
Open
Add allowedValues support for API parameter discovery#13543dheeraj12347 wants to merge 2 commits into
dheeraj12347 wants to merge 2 commits into
Conversation
Contributor
|
@blueorangutan package |
|
@DaanHoogland a [SL] Jenkins job has been kicked to build packages. It will be bundled with no SystemVM templates. I'll keep you posted as I make progress. |
|
Packaging result [SF]: ✖️ el8 ✖️ el9 ✖️ debian ✖️ suse15. SL-JID 18464 |
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #13543 +/- ##
============================================
+ Coverage 18.08% 20.40% +2.31%
- Complexity 16721 18786 +2065
============================================
Files 6037 5757 -280
Lines 542580 520931 -21649
Branches 66428 60824 -5604
============================================
+ Hits 98149 106293 +8144
+ Misses 433409 403057 -30352
- Partials 11022 11581 +559
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or 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
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.
Summary
This PR adds support for exposing allowed parameter values through the API Discovery framework.
Framework changes
allowedValuesattribute to the@ParameterannotationApiParameterResponseto expose allowed valuesApiDiscoveryServiceImplto populateallowedValuesAPI annotations
Add
allowedValuesannotations to representative API parameters with fixed documented values.The annotations cover:
Testing
Successfully built using:
I also investigated runtime verification using the simulator. The simulator Docker image runs from an embedded source tree, so local source changes require rebuilding the simulator image before they are reflected in
listApis.