Customization of blueprint routes on model does not work

[OscarMeier]

I'm not able to customize the blueprint route documentation: Neither by adding swagger JSDoc nor by adding the swagger object to the model (api/models/Foo.js):

/**
 *  @swagger
 *
 * /find:
 *    summary: Foo
 *    description: Bar
 */

swagger: {
    actions: {
      find: {
        summary: 'Foo',
        description: 'Bar',
      },
    },
  },

I dug into your code and found the referenced line. It's the line, where the paths get generated. The merged models contain the correct documentation (summary: 'Foo', description: 'Bar') but the models are not used in the generatePaths() function to override the blueprint templates. Did I overlook something or is this feature not implemented yet?

sails-hook-swagger-generator/lib/swagger-doc.ts

Line 95 in eafbed4

defaults(specifications.paths, generatePaths(routes, blueprintActionTemplates, theDefaults, specifications, models));

[danielsharvey]

Found it - the model per-blueprint-action overrides where not being merged correctly. Bugfix shortly.

[theoomoregbee]

🎉 This issue has been resolved in version 3.2.1 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[danielsharvey]

@OscarMeier Let us know how you get on. Thanks for finding this.

[OscarMeier]

@danielsharvey Thank you for the quick fix! The custom blueprint route documentation works as expected for the description and the summary. But I didn't figure out how to exclude an action. I tried to use the exclude option:

 * /add:
 *    exclude: true
 *
 * /populate:
 *    exclude: true
 */

I checked your code and found out that you just omit the exclude property:

sails-hook-swagger-generator/lib/generators.ts

Line 418 in c407361

}, 'exclude')),

But the blueprint action documentation does not get removed, right?

I would propose to keep the exclude property in the clone and to add a condition below:

if (pathEntry.exclude) {
  return;
}

[danielsharvey]

@OscarMeier Let me look! It looks like I did not check the test data closely enough! (several changes had large effects and I must not have checked the test fixture closely enough).

[danielsharvey]

Found and fixed. Merging now.

Note that the exclude property is excluded as it is included within the swagger content but not valid OpenAPI and so excluded from the generated output.

[theoomoregbee]

🎉 This issue has been resolved in version 3.2.2 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[danielsharvey]

@OscarMeier Let us know how you get on.

[OscarMeier]

@danielsharvey Thank you for resolving this issue! Everything works as expected.