open-api icon indicating copy to clipboard operation
open-api copied to clipboard

Deprecate method.apiDoc in favor of method.operationDoc

Open jsdevel opened this issue 6 years ago • 2 comments

jsdevel avatar Aug 11 '18 13:08 jsdevel

I only picked up express-openapi a few weeks ago. I'm interested in the motivation here. I wasn't aware of an operationDoc, since the documentation uses method.apiDoc throughout.

What are the benefits of method.operationDoc, and what would the behavior be for continued use of method.apiDoc? I ask because I'm wondering how stable my code will be for continued use of it, and when a change would be required.

maxwellb avatar Jan 07 '19 19:01 maxwellb

@maxwellb it'll definitely come with a major version bump, so i wouldn't worry too much about your code breaking. I'll likely add a warning though to provide some time for people the ability to update their projects.

jsdevel avatar Jan 07 '19 20:01 jsdevel