Documentation

Unity Gaming Services CLI


GitHub Repository

Unity Gaming Services CLI


Get module spec

Get the OpenAPI specification for a Cloud Code module.
Read time 1 minuteLast updated 4 days ago

Get the OpenAPI specification for a Cloud Code module.

Command

Authentication Required:
Yes
ugs cloud-code modules get-spec <module-name> [options]

Arguments

<module-name>
Name of the target module

Options

Alias

Description

project-id-p, --project-idThe Unity cloud project ID.
environment-e, --environment-nameThe services environment name.
version--versionWhich version to describe:
latest
, or a version number. Defaults to live.
help-?, -h, --helpDisplay help and usage information.
quiet-q, --quietReduce logging to a minimum.
json-j, --jsonUse JSON as the output format.

Describing a specific version

Without
--version
, the live version's specification is returned. Supply a version number, as listed by
modules get --versions
, to describe an older version instead:
ugs cloud-code modules get-spec MyModule --version 1788856057800102
Supplying a version requires module versions to be enabled for the project.