File: README.md

package info (click to toggle)
ycmd 0%2B20201028%2Bgit1d415c5%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 4,836 kB
  • sloc: python: 39,750; cpp: 5,991; java: 275; sh: 255; cs: 194; javascript: 150; ansic: 82; makefile: 47; xml: 18; objc: 10
file content (9 lines) | stat: -rw-r--r-- 396 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
API documentation
=================

This directory contains the API docs which are generated from the `openapi.yaml`
file. This file follows [the OpenAPI v2 specification][openapi]. When ycmd's API
changes, edit that file and run the `update_api_docs.py` script in the ycmd
folder to update the documentation.

[openapi]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md