feat(route-helper): Add 'documented' flag for hiding params

[STRML]

Description

Adds a documented parameter to 'accepts' - good for deprecating old parameters. parameterDeprecated is a thing in OpenAPI 3.0 (https://github.com/OAI/OpenAPI-Specification/pull/637/files) but not in 2.0, so this works well in the meantime and may have other uses even when we get to 3.0.

Example

{
  accepts: [
    {arg: 'id', type: 'string'},
    {arg: 'undocumented', type: 'string', documented: false},
  ],
}

Related issues

None

Checklist

• New tests added or existing tests modified to cover all changes
• Code conforms with the style
  guide

[zbarbuto]

Very good Idea. Would also love to see the same for endpoints as well as arguments but obviously that can be a separate PR.

[STRML]

It already is:

loopback-swagger/lib/specgen/swagger-spec-generator.js

Line 82 in db25c46

if (!route.documented) return;

[zbarbuto]

Ah, right you are... not sure why I thought it didn't exist - must have been thinking of something else

https://github.com/strongloop/strong-remoting/blob/master/lib/rest-adapter.js#L570

[bajtos]

👏

This is great, thank you for the contribution!

[bajtos]

@slnode ok to test

[bajtos]

@STRML could you please update our documentation to mention this new flag too? Here is the page to update: _includes/content/rm-options.md and here are the instructions for contributing to our docs: http://loopback.io/doc/en/contrib/doc-contrib.html

[STRML]

loopbackio/loopback.io#500

[bajtos]

Awesome, thank you for the doc contribution too!

I have landed the patch and released it in [email protected].

Enjoy 😄