7e385fc126
Some checks failed
SonarQube / SonarQube (push) Failing after 5m28s
E2e test on main branch push / server and client test (map[name:admin port:8080]) (push) Failing after 3m33s
Server and lib tests / Library test (js) (push) Failing after 1m36s
Server and lib tests / Library test (vue) (push) Successful in 2m24s
Server and lib tests / Web client test (admin) (push) Successful in 2m52s
Server and lib tests / Web client test (compose) (push) Successful in 3m23s
Server and lib tests / Web client test (discovery) (push) Successful in 2m49s
Server and lib tests / Web client test (one) (push) Successful in 2m52s
Server and lib tests / Web client test (privacy) (push) Successful in 2m44s
Server and lib tests / Web client test (reporter) (push) Successful in 2m56s
Server and lib tests / Web client test (workflow) (push) Successful in 3m0s
Server and lib tests / Server tests (push) Failing after 4m55s
E2e test on main branch push / notify-failure (push) Failing after 9s
Server and lib tests / Send matrix testing notification (push) Successful in 2s
Mark stale issues and pull requests / stale (push) Successful in 40s
18 lines
839 B
Plaintext
18 lines
839 B
Plaintext
# Corteza API documentation
|
|
|
|
WARNING: Work in progress
|
|
|
|
This is the first step in migration towards full OpenAPI standards support.
|
|
|
|
## Current state (`2021.3.x` and later)
|
|
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: 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.
|