https://github.com/santjosie/spac3
work with descriptions, titles, summary and examples in OpenAPI specs
https://github.com/santjosie/spac3
excel openapi openapi-specification
Last synced: about 2 months ago
JSON representation
work with descriptions, titles, summary and examples in OpenAPI specs
- Host: GitHub
- URL: https://github.com/santjosie/spac3
- Owner: santjosie
- Created: 2024-09-14T03:40:46.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-31T01:12:51.000Z (over 1 year ago)
- Last Synced: 2025-01-31T01:24:54.675Z (over 1 year ago)
- Topics: excel, openapi, openapi-specification
- Language: Python
- Homepage:
- Size: 224 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# spac3
Use spac3 to manage descriptions of attributes in an OpenAPI document. space3 reads an OpenAPI spec and extracts all the descriptions into an MS Excel file. Your product management and technical writing teams can then work on adding descriptions to the attributes in MS Excel. Once the descriptions are added, they can merge the MS Excel file with the original OpenAPI spec document so that the descriptions in the OpenAPI document are updated with the descriptions from the Excel file.
Works with OpenAPI documents in both yaml and json formats.
## See it in action
A hosted version is available at [spac3s.streamlit.app](https://spac3s.streamlit.app).
To run it locally
1. install pre-reqs - python
2. clone the repository
3. install dependancies `pip install requirements.txt -r` from project root
4. run `streamlit run Home.py`
## OpenAPI specifications currently supported
3.1
## Contributing
the usual. iykyk.
## Bonus
additional highly opinionated Overlay processor for modifying OpenAPI docs using an Overlay specification file.