Enum ApiCommand 

pub enum ApiCommand {
    Rest {
        endpoint: String,
        method: String,
        fields: Vec<String>,
        raw_fields: Vec<String>,
        headers: Vec<String>,
        input: Option<String>,
        paginate: bool,
        hostname: Option<String>,
        jq: Option<String>,
        template: Option<String>,
        silent: bool,
        include: bool,
    },
    Graphql {
        query: Option<String>,
        fields: Vec<String>,
        hostname: Option<String>,
        jq: Option<String>,
        template: Option<String>,
    },
}

Arguments for gor api.

Variants

Rest

Make a REST API request to a GitHub endpoint.

Fields

endpoint: String

The API endpoint path (e.g. /repos/owner/repo).

method: String

HTTP method (default: GET).

fields: Vec<String>

Add a typed field parameter (key=value) for the request body.

raw_fields: Vec<String>

Add a raw field parameter (key=value) for the request body.

headers: Vec<String>

Add a custom HTTP header (key: value).

input: Option<String>

Read the request body from a file (use @- for stdin).

paginate: bool

Follow Link headers to fetch all pages.

hostname: Option<String>

GitHub hostname for GitHub Enterprise Server (default: github.com).

jq: Option<String>

Filter JSON output with a jq expression.

template: Option<String>

Format output via a Go/Handlebars template.

silent: bool

Suppress status output.

include: bool

Include response headers in the output.

Graphql

Make a GraphQL API request.

Fields

query: Option<String>

The GraphQL query string. Reads from stdin if omitted.

fields: Vec<String>

GraphQL variables as key=value pairs (repeatable).

hostname: Option<String>

GitHub hostname for GitHub Enterprise Server (default: github.com).

jq: Option<String>

Filter JSON output with a jq expression.

template: Option<String>

Format output via a Go/Handlebars template.

Trait Implementations

impl Debug for ApiCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl FromArgMatches for ApiCommand

fn from_arg_matches(__clap_arg_matches: &ArgMatches) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn from_arg_matches_mut( __clap_arg_matches: &mut ArgMatches, ) -> Result<Self, Error>

Instantiate Self from ArgMatches, parsing the arguments as needed.

fn update_from_arg_matches( &mut self, __clap_arg_matches: &ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

fn update_from_arg_matches_mut<'b>( &mut self, __clap_arg_matches: &mut ArgMatches, ) -> Result<(), Error>

Assign values from ArgMatches to self.

impl Subcommand for ApiCommand

fn augment_subcommands<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate Self via FromArgMatches::from_arg_matches_mut

fn augment_subcommands_for_update<'b>(__clap_app: Command) -> Command

Append to Command so it can instantiate self via FromArgMatches::update_from_arg_matches_mut

fn has_subcommand(__clap_name: &str) -> bool

Test whether Self can parse a specific subcommand