Skip to content
This repository has been archived by the owner on Nov 16, 2023. It is now read-only.

Add optic api documentation #336

Open
wants to merge 287 commits into
base: master
Choose a base branch
from

Conversation

ukmadlz
Copy link

@ukmadlz ukmadlz commented Jul 20, 2021

This boilerplate starter for a TS based Express app is fantastic, I really like how it lays out the OAuth flow as well as all the basic user endpoints to extend off.

I thought it'd be great to add something to assist with documenting APIs build off it. I've added Optic as a way to automate the collection of API endpoint documentation, I've gone ahead and added the middleware and the pointers in the README. I've set it to only run in non-production setups with minimal hassle and to not get in the way of the users flow if they don't want to use the CLI.

ThanhTDT and others added 30 commits July 27, 2017 21:09
- Attach debug configuration
- Scripts: debug, serve-debug, watch-debug
- Readme
add attach debug configuration
fix: fix lint warnings for test files
this seems a bit crude but allows running the tests and having them take
care of setting up the port to use
Added missing "node_modules/*" path mapping to README.
Removed extra "s" in sourceMap compilerOptions
Added missing "node_modules/*" path mapping to README.
this seems a bit crude but allows running the tests and having them take
care of setting up the port to use
change tests to not always pass
The ts-node allows to execute build scripts written in TypeScript
so the entire project could be written in TypeScript.
This commit introduces support for ts-node, updates packages
and migrate copy routine to TypeScript

Thanks!
The VSCode CosmosDB supports locally installed MongoDB servers
(and lot of other things and features).
It seems reasonable to offer that extension to project users.

Thanks!
sana-ajani and others added 28 commits June 17, 2020 12:15
Co-authored-by: Shane Lanan <tbd@tbd.com>
Co-authored-by: Shane Lanan <tbd@tbd.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [handlebars](https://github.com/wycats/handlebars.js) from 4.3.4 to 4.7.6.
- [Release notes](https://github.com/wycats/handlebars.js/releases)
- [Changelog](https://github.com/handlebars-lang/handlebars.js/blob/master/release-notes.md)
- [Commits](handlebars-lang/handlebars.js@v4.3.4...v4.7.6)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Bumps [tree-kill](https://github.com/pkrumins/node-tree-kill) from 1.2.1 to 1.2.2.
- [Release notes](https://github.com/pkrumins/node-tree-kill/releases)
- [Commits](pkrumins/node-tree-kill@v1.2.1...v1.2.2)

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This version bump should fix issue with `node-sass` installation on some
systems.
Tested on Win 10.

Thanks!

Closes microsoft#165
Bumps [ini](https://github.com/isaacs/ini) from 1.3.5 to 1.3.7.
- [Release notes](https://github.com/isaacs/ini/releases)
- [Commits](npm/ini@v1.3.5...v1.3.7)

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
)

This removes warnings about deprecated configuration option:

```text
tsConfig` is depecrated and will be removed in ts-jest 27
```

kulshekhar/ts-jest@8fec681

Thanks!
Should fix issues with failing CI checks on updated packages.

/cc @samal-rasmussen
…#326)

- Replaced section about mLab with MongoDB Atlas
thx to @klemensz!
This fixes issue with failing pages

/cc @klemensz

Fixes microsoft#323
This updates some deps to remove high security warnings from NPM audits.

Thanks!
@ghost
Copy link

ghost commented Jul 20, 2021

CLA assistant check
All CLA requirements met.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet