Application custom config #71
Merged
Conversation
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
jworkmanjc
commented
Mar 20, 2024
| @@ -611,7 +617,7 @@ Function Update-SwaggerObject { | |||
| } Else { | |||
| $excludePath = ($InputObjectName -replace '.paths.', '') -replace "\.\w+", '' | |||
| # Write-Warning "[status] New SDK Endpoint Found: `nOperationId: $($ThisObject.operationId) `nPath: $excludePath" | |||
| Write-Error ("In '$($CurrentSDKName)' unknown operationId '$($ThisObject.operationId) - $($InputObjectName)'.") | |||
| Write-Warning ("In '$($CurrentSDKName)' unknown operationId '$($ThisObject.operationId) - $($InputObjectName)'.") | |||
There was a problem hiding this comment.
This really didn't need to throw an error/ switched to write-warning
jworkmanjc
commented
Mar 20, 2024
| @@ -69,6 +69,9 @@ $TransformConfig = [Ordered]@{ | |||
| '\[,' = '['; | |||
| ',]' = ']'; | |||
| }; | |||
| OverrideDefinitions = @( | |||
There was a problem hiding this comment.
the idea here is that if you want to replace an entire section of the Swagger spec you could do that by specifying the path of item you wish to replace and adding a corresponding json file in /CustomDefinitions/ directory
gweinjc
previously approved these changes
Mar 21, 2024
kmaranionjc
previously approved these changes
Mar 26, 2024
gweinjc
previously approved these changes
Mar 27, 2024
gweinjc
approved these changes
Mar 28, 2024
kmaranionjc
approved these changes
Mar 28, 2024
jworkmanjc
temporarily deployed
to
PublishToPSGallery
GitHub Actions
Inactive
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.
Issues
What does this solve?
The default models defined in our API specification are missing several properties in the Application model, This release manually re-defines the
configmodel for the Application model.Is there anything particularly tricky?
I've added a new "find and replace" type of way to redefine the generated code. Instead of using regex, to find and replace many things, you just need to replace sections of the API model. Within the
apiTransform.ps1file I've added aOverrideDefinitionslist. Within that list, one can denote a part of the SDK swagger spec to replace entirely. All you would need to do that would be to define a.jsonfile with the same name in the/Customdirectory.How should this be tested?
Using the current version of the V2 SDK (0.0.43) running the command:
remove-JCSystemGroupMember -SystemID 62ace7fbac30e538a6ba0ec8 -Groupid 604938c5232e1179d1e7bbdbshould return multiple status messagesUsing this version of the V2 SDK (0.0.44) running the command:
remove-JCSystemGroupMember -SystemID 62ace7fbac30e538a6ba0ec8 -Groupid 604938c5232e1179d1e7bbdbshould return the single status message as expected503 error should still catch and recover 😎
Screenshots