openstack/codegenerator
Code Issues Proposed changes
Generate OpenAPI of API bindings for OpenStack services
30 Commits 1 Branch 0 Tags 1.8 MiB
Python 87.5%
Jinja 11.3%
Shell 1.2%
24de073958
Go to file
Artem Goncharov 24de073958 Convert docstrings to md 
python docstrings are assumed to be RST, while for OpenAPI we need MD.
Convert controller description from rst->html->md using docutils.

Change-Id: I04acab45f5cf9d05b5d7158e484a14c4343bdb24
2024-04-22 18:44:27 +02:00
codegenerator Convert docstrings to md 2024-04-22 18:44:27 +02:00
doc Initial import 2024-03-06 10:07:54 +00:00
playbooks/openapi Add jobs to generate Nova OpenAPI spec 2024-03-23 15:06:07 +00:00
releasenotes Initial import 2024-03-06 10:07:54 +00:00
tools Integrate octavia 2024-04-11 11:17:13 +02:00
zuul.d Integrate octavia 2024-04-11 11:17:13 +02:00
.gitignore Initial import 2024-03-06 10:07:54 +00:00
.gitreview Added .gitreview 2024-03-01 14:43:11 +00:00
.pre-commit-config.yaml Convert docstrings to md 2024-04-22 18:44:27 +02:00
.stestr.conf Initial import 2024-03-06 10:07:54 +00:00
bindep.txt Initial import 2024-03-06 10:07:54 +00:00
README.rst Initial import 2024-03-06 10:07:54 +00:00
requirements.txt Convert docstrings to md 2024-04-22 18:44:27 +02:00
setup.cfg Initial import 2024-03-06 10:07:54 +00:00
setup.py Initial import 2024-03-06 10:07:54 +00:00
test-requirements.txt Initial import 2024-03-06 10:07:54 +00:00
tox.ini Initial import 2024-03-06 10:07:54 +00:00

README.rst

OpenStack CodeGenerator

Primary goal of the project is to simplify maintainers life by generating complete or at least parts of the code.

OpenApi Schema

CodeGenerator is able to generate OpenAPI specs for certain services by inspecting their code. This requires service package being installed in the environment where the generator is running. It then tries to initialize service application and for supported runtimes scans for the exposed operations. At the moment following services are covered:

  • Nova
  • Neutron
  • Cinder
  • Glance
  • Keystone
  • Octavia