From e6c0ebfb57e64a1489f40bbf6c033fc47bcedfc9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=81=B5=E3=81=81?= Date: Fri, 21 Apr 2023 22:13:58 +0900 Subject: [PATCH] update README MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: ふぁ --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 4dc9013..060f2af 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,17 @@ Note that the license also inherits to the output. - `src` *.yaml files should be written according to the [v3.0/schema.json](https://raw.githubusercontent.com/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json) - `dist` Do not rewrite this file as it is an automatically generated OpenAPI file. +### About build + +- `src/openapi/**/*.yaml#/paths/*/get/parameters` will be overwritten by `src/config/parameters.yaml#/paths/~1parameters/get/parameters` +- `src/openapi/**/*.yaml#/paths/*/get/responses/200/headers` will be overwritten by `src/config/headers.yaml#/components/headers` + +```shell +python -V # Python 3.10.8 +pip install -r requirements.txt +python tools/build.py +``` + ## License [agpl-3.0](./LICENSE.txt)