{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"info","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["info"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Type: object (map)"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field name"},"children":["Field name"]},{"$$mdtype":"Tag","name":"th","attributes":{"align":"center","data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["title"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," The title of the API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["version"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["description"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["RECOMMENDED."]}," A description of the API (Markdown may be used)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["summary"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A short summary of the API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["termsOfService"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A URL to the Terms of Service for the API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["contact"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/learn/openapi/openapi-visual-reference/contact"},"children":["Contact object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The contact information for the exposed API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["license"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/learn/openapi/openapi-visual-reference/license"},"children":["License object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The license information for the exposed API."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["x-logo"]},{"$$mdtype":"Tag","name":"td","attributes":{"align":"center"},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"https://redoc.ly/docs-legacy/api-reference-docs/specification-extensions/x-logo/"},"children":["Logo object"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A commonly used specification extension containing the information about the API logo."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"visuals","__idx":1},"children":["Visuals"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following is an example of a minimally recommended OpenAPI ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["info"]}," object:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"info:\n  title: Example\n  version: '1.0'\n  description: |\n    # My API description in Markdown\n\n    This is a sample of an info description.\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["See how it renders in Redocly OpenAPI documentation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/info-1-46dbc8d447813898.png","alt":"info-render"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"version-examples","__idx":2},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["version"]}," Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The version is required."," ","But sometimes an API document doesn't have a sensible version."," ","To hide it from the documentation, change it to an empty string."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"info:\n  title: Example\n  version: ''\n  description: |\n    # My API description in Markdown\n\n    This is a sample of an info description.\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/info-2-b79aed5af02e31b8.png","alt":"info without version"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"description-examples","__idx":3},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}," Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The H1 and H2 tags from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]}," are pulled into the sidebar navigation."," ","When an H2 appears after an H1 tag, the preceding H1 tag turns into a group in the sidebar navigation."," ","The chevron indicates that a group can be expanded."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"info:\n  title: Example\n  version: ''\n  description: |\n    # My API description in Markdown\n\n    This is a sample of an info description.\n\n    # Another H1\n\n    This is body paragraph text.\n\n    ## H2 level heading\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/info-3-812e7cef459138b1.png","alt":"headings in info description"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following image shows the expansion of the group."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/info-4-d65650b95a6e2dcb.png","alt":"headings in info description with group expansion"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"summary-examples","__idx":4},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["summary"]}," Examples"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example contains a summary."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"info:\n  title: Example\n  version: ''\n  description: |\n    # My API description in Markdown\n\n    This is a sample of an info description.\n  summary: This is a sample summary\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["summary"]}," renders before the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["description"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/info-5-88b8fa1f40af268a.png","alt":"info summary"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"termsofservice-example","__idx":5},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["termsOfService"]}," example"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following example defines a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["termsOfService"]}," URL."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"info:\n  title: Example\n  version: ''\n  description: |\n    # My API description in Markdown\n\n    This is a sample of an info description.\n  termsOfService: https://redoc.ly/subscription-agreement/\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/info-6-79a8bf1356b72c6c.png","alt":"info termsOfService"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"example-with-everything","__idx":6},"children":["Example with everything"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","header":{"controls":{"copy":{}}},"source":"info:\n  title: Example\n  version: ''\n  description: |\n    # My API description in Markdown\n\n    This is a sample of an info description.\n  summary: This is a summary\n  termsOfService: https://redoc.ly/subscription-agreement/\n  contact:\n    name: API team\n    email: team@redocly.com\n    url: https://redocly.com/contact-us/\n  license:\n    name: MIT\n    url: https://opensource.org/licenses/MIT\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"Image","attributes":{"src":"/content-assets/info-9-b30022b1026385c2.png","alt":"info everything"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"types","__idx":7},"children":["Types"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Info"]}]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"js","header":{"controls":{"copy":{}}},"source":"const Info: NodeType = {\n  properties: {\n    title: { type: 'string' },\n    version: { type: 'string' },\n    description: { type: 'string' },\n    termsOfService: { type: 'string' },\n    contact: 'Contact',\n    license: 'License',\n  },\n  required: ['title', 'version'],\n};\n","lang":"js"},"children":[]}]},"frontmatter":{},"tagList":[],"title":"info","lastModified":"2025-05-28T16:01:32.000Z"}