From eae857809e891d24b5f2c4ea9b174bc380d3847e Mon Sep 17 00:00:00 2001 From: Denis Arh Date: Wed, 10 Feb 2021 15:54:24 +0100 Subject: [PATCH] Refresh docs/REAME.adoc --- docs/README.adoc | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/README.adoc b/docs/README.adoc index 729fd326c..1761583c0 100644 --- a/docs/README.adoc +++ b/docs/README.adoc @@ -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.