https://github.com/dunnl/nena-openapi-docs
HTML documentation for the OpenAPI specifications published by the National Emergency Number Association
https://github.com/dunnl/nena-openapi-docs
nena ng9-1-1 ng911 openapi
Last synced: 10 months ago
JSON representation
HTML documentation for the OpenAPI specifications published by the National Emergency Number Association
- Host: GitHub
- URL: https://github.com/dunnl/nena-openapi-docs
- Owner: dunnl
- Created: 2024-12-18T00:13:40.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-18T17:17:45.000Z (about 1 year ago)
- Last Synced: 2025-02-12T05:44:51.583Z (12 months ago)
- Topics: nena, ng9-1-1, ng911, openapi
- Language: Makefile
- Homepage: https://dunnl.github.io/NENA-OpenAPI-Docs/
- Size: 143 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NENA OpenAPI Documentation
This repo contains scripts to generate documentation for [OpenAPI](https://www.openapis.org/) specifications published by [NENA](https://nena.org) on their [Github page](https://github.com/NENA911). Documentation is generated using [Redocly](https://redocly.com).
## Dependencies
- Basic developer utilities (GNU `make`, `find`)
- `npm` (The Node.js package manager)
- `gh` (The Github CLI utility)
If you do not have these tools you will need to install them. A typical procedure to install `npm` on Ubuntu would look like the following. I recommend installing `nvm` first, like this:
```
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.1/install.sh | bash
```
(Make sure you trust the above script.) Then run
```
nvm install --lts
```
to install the latest Long Term Support version of Node.js
If you do not have `gh`, installation on Ubuntu would look like this:
```
apt update
apt install gh
```
## First time setup
The following only needs to be done **once**. First, login to Github with
```
gh auth login
```
Then initialize the worktree by running
```
make initialize
```
This will clone all of [NENA's Github repos](https://github.com/NENA911) to a directory named `NENA911`. Then, all files ending in `.yaml` will be dumped into a `yaml/` directory. Then you will need to install the remaining dependencies from `package.json`:
```
npm install
```
## Usage
Run `make` to generate documentation under `docs/`
Clean the worktree with `make clean`. This will delete the generated HTML documentation and other build artifacts.