Skip to content

mw wiki rest describe

Releasev0.35.0 · cfeceb67

mw wiki rest describe [MODULE] [flags]

Read the cached REST module index or a module’s OpenAPI document

--format <string>
Format the specified output
-o, --output <string>
Output format (jq|json) Default: json.
--raw
Print response bytes unchanged
--anon
Use anonymous access instead of saved credentials
--help
Help for this command
--no-interaction
Do not ask any interactive questions
--password <string>
Wiki login password (or bot password)
--password-file <string>
Read the login password from a file
--profile <string>
Saved profile name or REALM/NAME
--realm <string>
Shared-login realm (wikimedia and wikibase-world are built in)
--username <string>
Wiki login username (use Name@bot for a bot password)
-v, --verbose <count>
Increase output verbosity. Example: --verbose=2 or -vv
--wiki <string>
Wiki URL or API endpoint
Terminal window
mw wiki rest describe wikibase/v1
Report an issue with this page

Report a documentation issue

The report includes this page’s link, section and documentation version.

Review and submit on Phabricator, or run the command using your saved CLI profile. The command asks before creating the task.