docs

package
v0.0.0-...-06831c0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 18, 2024 License: Apache-2.0 Imports: 2 Imported by: 0

README

# 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.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetFS

func GetFS() http.FileSystem

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL