thegeneralist01/twitter-openapi
1
Fork 0
mirror of https://github.com/thegeneralist01/twitter-openapi synced 2026-01-11 15:40:26 +01:00
Code Issues Activity

update README

Browse source 
Signed-off-by: ふぁ <yuki@yuki0311.com>
This commit is contained in:
ふぁ 2023-04-21 22:13:58 +09:00
parent f45f2c4514
commit e6c0ebfb57
No known key found for this signature in database
GPG key ID: 83A8A5E74872A8AA
1 changed files with 11 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -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) - `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. - `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 ## License
[agpl-3.0](./LICENSE.txt) [agpl-3.0](./LICENSE.txt)