# `info`

**REQUIRED**

Type: object (map)

| Field name | Type | Description |
| --- | --- | --- |
| title | string | **REQUIRED.** The title of the API. |
| version | string | **REQUIRED.** The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). |
| description | string | **RECOMMENDED.** A description of the API (Markdown may be used). |
| summary | string | A short summary of the API. |
| termsOfService | string | A URL to the Terms of Service for the API. |
| contact | [Contact object](/learn/openapi/openapi-visual-reference/contact) | The contact information for the exposed API. |
| license | [License object](/learn/openapi/openapi-visual-reference/license) | The license information for the exposed API. |
| x-logo | [Logo object](https://redoc.ly/docs-legacy/api-reference-docs/specification-extensions/x-logo/) | A commonly used specification extension containing the information about the API logo. |

## Visuals

The following is an example of a minimally recommended OpenAPI `info` object:

```yaml
info:
  title: Example
  version: '1.0'
  description: |
    # My API description in Markdown

    This is a sample of an info description.
```

See how it renders in Redocly OpenAPI documentation.

![info-render](/content-assets/info-1-46dbc8d447813898.png)

### `version` Examples

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.

```yaml
info:
  title: Example
  version: ''
  description: |
    # My API description in Markdown

    This is a sample of an info description.
```

![info without version](/content-assets/info-2-b79aed5af02e31b8.png)

### `description` Examples

The H1 and H2 tags from the `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.

```yaml
info:
  title: Example
  version: ''
  description: |
    # My API description in Markdown

    This is a sample of an info description.

    # Another H1

    This is body paragraph text.

    ## H2 level heading
```

![headings in info description](/content-assets/info-3-812e7cef459138b1.png)

The following image shows the expansion of the group.

![headings in info description with group expansion](/content-assets/info-4-d65650b95a6e2dcb.png)

### `summary` Examples

The following example contains a summary.

```yaml
info:
  title: Example
  version: ''
  description: |
    # My API description in Markdown

    This is a sample of an info description.
  summary: This is a sample summary
```

The `summary` renders before the `description`.

![info summary](/content-assets/info-5-88b8fa1f40af268a.png)

### `termsOfService` example

The following example defines a `termsOfService` URL.

```yaml
info:
  title: Example
  version: ''
  description: |
    # My API description in Markdown

    This is a sample of an info description.
  termsOfService: https://redoc.ly/subscription-agreement/
```

![info termsOfService](/content-assets/info-6-79a8bf1356b72c6c.png)

### Example with everything

```yaml
info:
  title: Example
  version: ''
  description: |
    # My API description in Markdown

    This is a sample of an info description.
  summary: This is a summary
  termsOfService: https://redoc.ly/subscription-agreement/
  contact:
    name: API team
    email: team@redocly.com
    url: https://redocly.com/contact-us/
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
```

![info everything](/content-assets/info-9-b30022b1026385c2.png)

## Types

- `Info`

```js
const Info: NodeType = {
  properties: {
    title: { type: 'string' },
    version: { type: 'string' },
    description: { type: 'string' },
    termsOfService: { type: 'string' },
    contact: 'Contact',
    license: 'License',
  },
  required: ['title', 'version'],
};
```
