Ensure all {modelIdentity}/{action} actions are handled as 'model-related'
#82
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
Improve `SwaggerRouteInfo` interface to support above:
1. Add separate fields for action vs blueprint action.
2. Add separate flag for shortcut blueprint routes.
Big picture for PR: Ensure all `{modelIdentity}/{action}` actions
are handled as 'model-related':
1. All `{modelIdentity}/{action}` actions treated as related to the
model (including `/allActions`) and Swagger content integrated /
merged appropriately.
2. Actions2 actions recognised as model-related, and therefore
recognised as blueprint action overrides (where applicable)
3. Improve consistency of handling/merging of actions (and Swagger
documentation) relating to model controllers.
Refactor route parsing to rely predominantly on `{modelIdentity}/{action}`
to ensure all model-related actions (including overrides including
actions2) are captured. This is consistent with Sails
`parseBlueprintOptions()`.
Big picture for PR: Ensure all `{modelIdentity}/{action}` actions
are handled as 'model-related':
1. All `{modelIdentity}/{action}` actions treated as related to the
model (including `/allActions`) and Swagger content integrated /
merged appropriately.
2. Actions2 actions recognised as model-related, and therefore
recognised as blueprint action overrides (where applicable)
3. Improve consistency of handling/merging of actions (and Swagger
documentation) relating to model controllers.
Big picture for PR: Ensure all `{modelIdentity}/{action}` actions
are handled as 'model-related':
1. All `{modelIdentity}/{action}` actions treated as related to the
model (including `/allActions`) and Swagger content integrated /
merged appropriately.
2. Actions2 actions recognised as model-related, and therefore
recognised as blueprint action overrides (where applicable)
3. Improve consistency of handling/merging of actions (and Swagger
documentation) relating to model controllers.
Refactor generation to improve route/model/controller Swagger merge.
Refactor for `SwaggerRouteInfo` changes.
Big picture for PR: Ensure all `{modelIdentity}/{action}` actions
are handled as 'model-related':
1. All `{modelIdentity}/{action}` actions treated as related to the
model (including `/allActions`) and Swagger content integrated /
merged appropriately.
2. Actions2 actions recognised as model-related, and therefore
recognised as blueprint action overrides (where applicable)
3. Improve consistency of handling/merging of actions (and Swagger
documentation) relating to model controllers.
Includes full re-generation of parsed routes based on
`SwaggerRouteInfo` changes.
Minor adjustment to Sails AttributeDefinition as `type` optional.
Big picture for PR: Ensure all `{modelIdentity}/{action}` actions
are handled as 'model-related':
1. All `{modelIdentity}/{action}` actions treated as related to the
model (including `/allActions`) and Swagger content integrated /
merged appropriately.
2. Actions2 actions recognised as model-related, and therefore
recognised as blueprint action overrides (where applicable)
3. Improve consistency of handling/merging of actions (and Swagger
documentation) relating to model controllers.
Add new Actions2 action overriding blueprint action.
Adjust `UserController` to add new Swagger merge.
Big picture for PR: Ensure all `{modelIdentity}/{action}` actions
are handled as 'model-related':
1. All `{modelIdentity}/{action}` actions treated as related to the
model (including `/allActions`) and Swagger content integrated /
merged appropriately.
2. Actions2 actions recognised as model-related, and therefore
recognised as blueprint action overrides (where applicable)
3. Improve consistency of handling/merging of actions (and Swagger
documentation) relating to model controllers.
Swagger generation merge changes resulted in ordering changes in
generated output.
Big picture for PR: Ensure all `{modelIdentity}/{action}` actions
are handled as 'model-related':
1. All `{modelIdentity}/{action}` actions treated as related to the
model (including `/allActions`) and Swagger content integrated /
merged appropriately.
2. Actions2 actions recognised as model-related, and therefore
recognised as blueprint action overrides (where applicable)
3. Improve consistency of handling/merging of actions (and Swagger
documentation) relating to model controllers.
Swagger generation changes related to new test cases and model-related
merge changes (UserController now equivalent to User model).
Big picture for PR: Ensure all `{modelIdentity}/{action}` actions
are handled as 'model-related':
1. All `{modelIdentity}/{action}` actions treated as related to the
model (including `/allActions`) and Swagger content integrated /
merged appropriately.
2. Actions2 actions recognised as model-related, and therefore
recognised as blueprint action overrides (where applicable)
3. Improve consistency of handling/merging of actions (and Swagger
documentation) relating to model controllers.
Swagger generation changes related to new test cases and model-related
merge changes (UserController now equivalent to User model).
Big picture for PR: Ensure all `{modelIdentity}/{action}` actions
are handled as 'model-related':
1. All `{modelIdentity}/{action}` actions treated as related to the
model (including `/allActions`) and Swagger content integrated /
merged appropriately.
2. Actions2 actions recognised as model-related, and therefore
recognised as blueprint action overrides (where applicable)
3. Improve consistency of handling/merging of actions (and Swagger
documentation) relating to model controllers.
|
Closes #81. |
|
@theoomoregbee A review would be good for this change. The way |
|
cool! will give this a look before end of today. Thanks @danielsharvey |
…ee/sails-hook-swagger-generator into fix-custom-blueprint * 'fix-custom-blueprint' of https://github.com/theoomoregbee/sails-hook-swagger-generator: docs: remove expressjs license badge and added npm downloads badge
|
🎉 This PR is included in version 3.2.3 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Overview
Ensure all
{modelIdentity}/{action}actions are handled as 'model-related':{modelIdentity}/{action}actions treated as related to the model (including/allActions) and Swagger content integrated / merged appropriately.Details
refactor: Improve
SwaggerRouteInfointerfaceImprove
SwaggerRouteInfointerface to support above:refactor: Refactor route parsing using
{modelIdentity}/{action}Refactor route parsing to rely predominantly on
{modelIdentity}/{action}to ensure all model-related actions (including overrides including actions2) are captured. This is consistent with SailsparseBlueprintOptions().refactor: Refactor transformations phase for
SwaggerRouteInfochangesrefactor: Refactor Swagger generation for model-related changes
Refactor generation to improve route/model/controller Swagger merge.
Refactor for
SwaggerRouteInfochanges.test: Refactor tests for Swagger generation (model-related changes)
Swagger generation changes related to new test cases and model-related merge changes (UserController now equivalent to User model).
Swagger generation merge changes resulted in ordering changes in generated output.
Add new Actions2 action overriding blueprint action.
Adjust
UserControllerto add new Swagger merge.Includes full re-generation of parsed routes based on
SwaggerRouteInfochanges.Minor adjustment to Sails AttributeDefinition as
typeoptional.