Skip to content

Commit 1f69961

Browse files
authored
Merge pull request #131 from secvisogram/use-global-openapi-generator-package
chore: use global openapi generator tool
2 parents f95bb03 + b12b091 commit 1f69961

File tree

4 files changed

+200
-1821
lines changed

4 files changed

+200
-1821
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# BSI Secvisogram CSAF Validator Service
22

33
<!-- TOC depthfrom:2 depthto:3 -->
4+
45
- [About the project](#about-the-project)
56
- [Getting started](#getting-started)
67
- [Documentation](#documentation)
@@ -10,11 +11,14 @@
1011
- [Prerequisites](#prerequisites)
1112
- [Installation](#installation)
1213
- [Run server](#run-server)
14+
- [Generate documentation](#generate-documentation)
15+
- [Create new version](#create-new-version)
1316
- [Testing](#testing)
1417
- [Docker](#docker)
1518
- [Persist with pm2](#persist-with-pm2)
1619
- [Contributing](#contributing)
1720
- [Dependencies](#dependencies)
21+
1822
<!-- /TOC -->
1923

2024
## About the project
@@ -104,6 +108,14 @@ openapi-generator-cli generate -i http://localhost:8082/docs/json -g asciidoc -o
104108

105109
[(back to top)](#bsi-secvisogram-csaf-validator-service)
106110

111+
### Create new version
112+
113+
Make sure, you have the package [@openapitools/openapi-generator-cli](https://www.npmjs.com/package/@openapitools/openapi-generator-cli) installed globally (using `npm i -g @openapitools/openapi-generator-cli`).
114+
115+
To create a new version use npm's [version](https://docs.npmjs.com/cli/v11/commands/npm-version) command and make sure that your server is not running (since this command will start it).
116+
117+
[(back to top)](#bsi-secvisogram-csaf-validator-service)
118+
107119
## Testing
108120

109121
Many tests are integration tests which need a running server. So make sure to start it before running the tests:

0 commit comments

Comments
 (0)