express-oas-generator icon indicating copy to clipboard operation
express-oas-generator copied to clipboard

Published 20 hours ago • verified publisher icon mpashkovskiy

Roadmap 1.X + 2.X

Open maxiejbe opened this issue 4 years ago • 6 comments

Creating this issue as a roadmap (sorted by priority):

Still in 1.X:

  • [x] OpenApi3: PR #63
  • [x] Fix links to specification json: PR #68
  • [x] Warning for production env #64: PR #69
  • [x] Unhandled requests/responses: #50 + #55: PR https://github.com/mpashkovskiy/express-oas-generator/pull/73
  • [x] Preserve OpenApi spec file ` #52: PR https://github.com/mpashkovskiy/express-oas-generator/pull/86
  • [x] Ensure OpenApi spec file directory #51: PR #91
  • [ ] Remove unused tags #72
  • [ ] Smaller README.md, focused on "advanced" (unique) usage.
  • [ ] Nice refactor: Promises (remove all callbacks), async/await, args destructuring, linter (including examples + tests).

2.X major version:

  • [ ] Deprecating init #65

What do you think @kiprasmel @mpashkovskiy ?

maxiejbe avatar Aug 15 '20 14:08 maxiejbe

For 2.x, I'd love to have the examples adjusted to the advanced version aswell. Otherwise looking good!

kiprasmel avatar Aug 15 '20 15:08 kiprasmel

For 2.x, I'd love to have the examples adjusted to the advanced version aswell. Otherwise looking good!

Sure, will do! Examples + README.md included. Will also promisify everything for 2.x.

maxiejbe avatar Aug 15 '20 15:08 maxiejbe

looks good to me

mpashkovskiy avatar Aug 17 '20 06:08 mpashkovskiy

@mpashkovskiy @kiprasmel Guys, after covering minor #72 the priorities for me would be:

Improving readme

  • [ ] Removing basic usage
  • [ ] Document advanced usage properly (options object args table: https://docs.github.com/en/github/writing-on-github/organizing-information-with-tables with columns name, required, type, description, default value)
  • [ ] Removing or moving down internal library functionality explanations
  • [ ] @mpashkovskiy About npm readme, does it take the same README.md? Or we need to update it manually?

Refactor

  • [ ] Remove basic usage example
  • [ ] Updating tests with advanced usage.
  • [ ] Updating examples/with-jest with advanced usage
  • [ ] Promisify instead of callbacks (Suggest to do that by the way). Use async/await.
  • [ ] Include prettier

After all that, we can finally deprecate init and ship 2.x.

Let me know if you like the plan 😄

maxiejbe avatar May 16 '21 23:05 maxiejbe

@maxiejbe looks good to me! Let's remove the basic usage example right before we ship 2.x but not earlier to avoid confusion. :shipit:

kiprasmel avatar May 17 '21 07:05 kiprasmel

Looks like we need support of [email protected]

mpashkovskiy avatar Jul 13 '22 14:07 mpashkovskiy