ApiDocDocumentation

JSON representation
OASDocumentation
- JSON representation
DocumentationFile
- JSON representation
Format
GraphqlDocumentation
- JSON representation

The documentation for a catalog item.

JSON representation

JSON representation
{ // Union field `documentation` can be only one of the following: "oasDocumentation" : { object ( `OASDocumentation` ) } , "graphqlDocumentation" : { object ( `GraphqlDocumentation` ) } // End of list of possible types for union field `documentation` . }

 { 
 // Union field documentation 
can be only one of the following: 
 "oasDocumentation" 
 : 
 { 
 object (  OASDocumentation 
 
) 
 } 
 , 
 "graphqlDocumentation" 
 : 
 { 
 object (  GraphqlDocumentation 
 
) 
 } 
 // End of list of possible types for union field documentation 
. 
 }

Fields

Union field documentation . The API reference documentation for this catalog item, if any. documentation can be only one of the following:

oasDocumentation

object ( OASDocumentation )

Optional. OpenAPI Specification documentation.

graphqlDocumentation

object ( GraphqlDocumentation )

Optional. GraphQL documentation.

OASDocumentation

OpenAPI Specification documentation for a catalog item.

JSON representation
{ "spec" : { object ( `DocumentationFile` ) } , "format" : enum ( `Format` ) }

Fields

Fields
`spec`	`object ( DocumentationFile )` Required. The documentation file contents for the OpenAPI Specification. JSON and YAML file formats are supported.
`format`	`enum ( Format )` Output only. The format of the input specification file contents.

spec

object ( DocumentationFile )

Required. The documentation file contents for the OpenAPI Specification. JSON and YAML file formats are supported.

format

enum ( Format )

Output only. The format of the input specification file contents.

DocumentationFile

Documentation file contents for a catalog item.

JSON representation
{ "displayName" : string , "contents" : string }

Fields

Fields
`displayName`	`string` Required. A display name for the file, shown in the management UI. Max length is 255 characters.
`contents`	`string ( bytes format)` Required. The file contents. The max size is 4 MB. A base64-encoded string.

displayName

string

Required. A display name for the file, shown in the management UI. Max length is 255 characters.

contents

string ( bytes format)

Required. The file contents. The max size is 4 MB.

A base64-encoded string.

Format

A format specification for documentation file contents.

Enums
`FORMAT_UNSPECIFIED`	The format is not available.
`YAML`	YAML format.
`JSON`	JSON format.

GraphqlDocumentation

GraphQL documentation for a catalog item.

JSON representation
{ "schema" : { object ( `DocumentationFile` ) } , "endpointUri" : string }

Fields

Fields
`schema`	`object ( DocumentationFile )` Required. The documentation file contents for the GraphQL schema.
`endpointUri`	`string` Required. The GraphQL endpoint URI to be queried by API consumers. Max length is 2,083 characters.

schema

object ( DocumentationFile )

Required. The documentation file contents for the GraphQL schema.

endpointUri

string

Required. The GraphQL endpoint URI to be queried by API consumers. Max length is 2,083 characters.