{// Union fielddocumentationcan be only one of the following:"oasDocumentation":{object (OASDocumentation)},"graphqlDocumentation":{object (GraphqlDocumentation)}// End of list of possible types for union fielddocumentation.}
Fields
Union fielddocumentation. The API reference documentation for this catalog item, if any.documentationcan be only one of the following:
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThis documentation covers API catalog items, focusing on their representation and specification in JSON format, which can use different documentation types.\u003c/p\u003e\n"],["\u003cp\u003eCatalog items can have API reference documentation specified as either OpenAPI Specification (OAS) documentation or GraphQL documentation, selectable through a union field.\u003c/p\u003e\n"],["\u003cp\u003eOAS documentation requires a \u003ccode\u003espec\u003c/code\u003e field that references the \u003ccode\u003eDocumentationFile\u003c/code\u003e for the file's content, along with a \u003ccode\u003eformat\u003c/code\u003e field to specify whether the spec is in JSON or YAML format.\u003c/p\u003e\n"],["\u003cp\u003eGraphQL documentation requires a \u003ccode\u003eschema\u003c/code\u003e field, which also references \u003ccode\u003eDocumentationFile\u003c/code\u003e, and an \u003ccode\u003eendpointUri\u003c/code\u003e string detailing the GraphQL API's endpoint.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eDocumentationFile\u003c/code\u003e for either OAS or GraphQL requires both a \u003ccode\u003edisplayName\u003c/code\u003e and \u003ccode\u003econtents\u003c/code\u003e field, where \u003ccode\u003econtents\u003c/code\u003e is the base64-encoded documentation file, with a maximum size limit of 4 MB.\u003c/p\u003e\n"]]],[],null,["# ApiDocDocumentation\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [OASDocumentation](#OASDocumentation)\n - [JSON representation](#OASDocumentation.SCHEMA_REPRESENTATION)\n- [DocumentationFile](#DocumentationFile)\n - [JSON representation](#DocumentationFile.SCHEMA_REPRESENTATION)\n- [Format](#Format)\n- [GraphqlDocumentation](#GraphqlDocumentation)\n - [JSON representation](#GraphqlDocumentation.SCHEMA_REPRESENTATION)\n\nThe documentation for a catalog item.\n\nOASDocumentation\n----------------\n\nOpenAPI Specification documentation for a catalog item.\n\nDocumentationFile\n-----------------\n\nDocumentation file contents for a catalog item.\n\nFormat\n------\n\nA format specification for documentation file contents.\n\nGraphqlDocumentation\n--------------------\n\nGraphQL documentation for a catalog item."]]
