ApiSpecGenerateParams

JSON Example

{
    "api_policy_ref": "string",
    "file_object_ref": "string",
    "format": "string",
    "name": "string"
}

string

api_policy_ref

Optional

API policy to generate api spec from. It is a reference to an object of type ApiPolicy. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

file_object_ref

Optional

File object to generate api spec from. It is a reference to an object of type FileObject. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

format

Optional

Constraints: default: API_SPEC_GENERATE_FORMAT_JSON

Output format json (default) or yaml. Enum options - API_SPEC_GENERATE_FORMAT_JSON, API_SPEC_GENERATE_FORMAT_YAML. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

name

Optional

Name for the spec generation object. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

Property Of

ApiSpecGenerate