[][src]Module oac_parser::spec

Implementation of the OpenAutoComplete spec.

The root for a JSON file conforming to the spec is Document.

Structs

Argument

Specification of a positional argument. Examples: (docker pull) IMAGE, etc.

Cli

Description of the general properties of the program.

Command

Specification of a subcommand. Examples: (http) get, post, etc.

Components

Root for all reusable components for use across OAC document. These components are allowed to be referenced.

Document

OAC document is a JSON document described in RFC8259.

OpenAutoCompletion

Metadata about the spec used.

Option

Specification of an option - a boolean flag. Examples: --verbose, --dry-run, etc.

PatternCommon

Common fields shared by all pattern types.

Enums

Pattern

A Pattern is a "place" in the completion DAG where a component can appear.

Constants

VERSION

Version of the OAC spec this crate implements.