ApiSpecInfo

ApiSpecInfo
ApiSpecInfo
JSON Example
{
    "component_schema_count": 0,
    "description": "string",
    "inline_schema_count": 0,
    "oas_version": "string",
    "path_count": 0,
    "servers": [
        {
            "description": "string",
            "url": "string"
        }
    ],
    "title": "string",
    "version": "string"
}
integer As uint32 As uint32
component_schema_count
Read-Only  

Number of schemas defined in the components/schemas section of the OpenAPI document. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
description
Read-Only  

Description of the OpenAPI document from the info object. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
inline_schema_count
Read-Only  

Number of complex inline schemas promoted to top-level ApiSchema objects during import. Schemas are promoted when they contain object properties, array constraints, or composite types (oneOf/anyOf/allOf). Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
oas_version
Read-Only  

OpenAPI Specification version. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32
path_count
Read-Only  

Number of paths in the OpenAPI document. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

servers
Read-Only  

List of server URLs extracted from the OpenAPI document's servers section. Field introduced in 32.1.4. Maximum of 100 items allowed. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
title
Read-Only  

Title of the OpenAPI document. Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string
version
Read-Only  

Version of the OpenAPI document, which is distinct from the OpenAPI Specification version (oas_version). Field introduced in 32.1.4. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.