DeforaNetworks/corteza
DeforaNetworks/corteza
3
0
Fork 0
Code

Refresh docs/REAME.adoc

Browse Source
This commit is contained in:
Denis Arh 2021-02-10 15:54:24 +01:00
parent a36bb95b0b
commit eae857809e
1 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/README.adoc
View File

@ -4,16 +4,17 @@ WARNING: Work in progress
WARNING: Any changes to these files here require `make docs`
This is the first step in migration towards full OpenAPI standards support.`
This is the first step in migration towards full OpenAPI standards support.
## Original/starting state (pre `2020.9`; deprecated):
Home-brew API definition format in JSON, still available under `api/*/spec.json`.
This is still needed for controller/request/handler codegens. Documentation generators are disabled.
## Current state (`2020.9`)
## Current state (`2021.3.x` and later)
In branch `2020.12.x` we're experimenting with first step toward conversion to OpenAPI 3.0 YAML files for API
definition. There is a converter available in https://github.com/cortezaproject/openapi3-converter[cortezaproject/openapi3-converter]
that takes those custom YAML files and converts them to OpenAPI format.
## Goal (target `2020.12`)
## Goal (target: end of 2021)
Generate HTTP handlers and all auxiliary code and documentation from YAML files in OpenAPI 3.0 format
## Original/starting state (pre `2020.9`; deprecated):
Home-brew API definition format in JSON, still available under `api/*/spec.json`.
This is still needed for controller/request/handler codegens. Documentation generators are disabled.