crowdin app methods

Description

List the application's API methods, or describe one

Synopsis

crowdin app methods <identifier> [path] [OPTIONS]

Arguments

<identifier>
Application identifier, as printed by 'crowdin app list'

[path]
API method path to describe

Options

-X, --method=…
Pick one of several HTTP methods declared for the same path

-h, --help
Display help message and exit

Config Options

-T, --token=…
Personal access token required for authentication

--base-url=…
Base URL of Crowdin server for API requests execution

--base-path=…
Path to your project directory on a local machine

Global Options

-v, --verbose
Provide more information about the command execution

-c, --config=…
Specify a path to the configuration file

--identity=…
Specify a path to user-specific credentials

--no-colors
Disable colors and styles

--no-progress
Disable progress on executed command

-o, --output=…
Change output format (choices: "json", "toon", "plain")

Examples

List the API methods an installed application declares:

crowdin app methods zendesk-guide

Describe one method, with its parameters and request body when the application publishes an OpenAPI document:

crowdin app methods zendesk-guide crowdin-update --output json

Pick one verb when a path is declared for several:

crowdin app methods zendesk-guide jobs --method DELETE

Notes

The method list comes from the application's manifest. Parameters and the request body are read from the application's OpenAPI document when one is available, and are left out otherwise.