Skip to content
This repository has been archived by the owner on Mar 29, 2024. It is now read-only.

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tiero committed Dec 6, 2023
1 parent 4a112ec commit 3427b85
Showing 1 changed file with 1 addition and 11 deletions.
12 changes: 1 addition & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,4 @@ Requires [yarn](https://yarnpkg.com/getting-started/install).
```sh
yarn install # install the necessary dependencies
yarn start # run the webserver
```

### Generate OpenAPI Documentation

The [docusaurus-openapi-docs](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs) plugin is used to include the `services` OpenAPI documentation. Run this before `yarn start`:

```sh
yarn docusaurus gen-api-docs all
```

[New specifications can be added](https://github.com/PaloAltoNetworks/docusaurus-openapi-docs#configuring-docusaurusconfigjs-plugin-and-theme-usage) and the docs regenerated using `yarn docusaurus gen-api-docs <id>`.
```

0 comments on commit 3427b85

Please sign in to comment.