Skip to content

Commit 36716d2

Browse files
lisajianyuchenshi
authored andcommitted
Add instructions for running gen-auth-api-spec.ts to Auth Emulator README (firebase#3637)
Co-authored-by: Yuchen Shi <yuchenshi@google.com>
1 parent 37eb749 commit 36716d2

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/emulator/auth/README.md

+12
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,18 @@ large, feel free to review script changes only but with extra attention.
110110
rely on IDE / language helpers for autocompletion / peeking definition if you
111111
want to know more about the typing of request / response bodies.
112112

113+
To run `scripts/gen-auth-api-spec.ts` to re-generate `apiSpec.js` and
114+
`schema.ts` perform the following command from the root directory of
115+
`firebase-tools`:
116+
117+
```
118+
npm run generate:auth-api
119+
```
120+
121+
For more on what this command does and other useful commands, please refer to
122+
[`package.json`](https://github.com/firebase/firebase-tools/blob/master/package.json)
123+
and [`CONTRIBUTING.md`](https://github.com/firebase/firebase-tools/blob/master/CONTRIBUTING.md).
124+
113125
### Working with OpenAPI documents
114126

115127
It may be desirable to see the OpenAPI 3.0 document used in the Auth Emulator

0 commit comments

Comments
 (0)