---
title: "Data types"
description: "Data types exported by @typespec/openapi"
llmstxt: true
---

## TypeSpec.OpenAPI

### `AdditionalInfo` {#TypeSpec.OpenAPI.AdditionalInfo}

Additional information for the OpenAPI document.

```typespec
model TypeSpec.OpenAPI.AdditionalInfo
```

#### Properties

| Name            | Type                                                  | Description                                                                                                                       |
| --------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| title?          | `string`                                              | The title of the API. Overrides the `@service` title.                                                                             |
| summary?        | `string`                                              | A short summary of the API. Overrides the `@summary` provided on the service namespace.                                           |
| version?        | `string`                                              | The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version). |
| termsOfService? | `url`                                                 | A URL to the Terms of Service for the API. MUST be in the format of a URL.                                                        |
| contact?        | [`Contact`](./data-types.md#TypeSpec.OpenAPI.Contact) | The contact information for the exposed API.                                                                                      |
| license?        | [`License`](./data-types.md#TypeSpec.OpenAPI.License) | The license information for the exposed API.                                                                                      |
|                 | `unknown`                                             | Additional properties                                                                                                             |

### `Contact` {#TypeSpec.OpenAPI.Contact}

Contact information for the exposed API.

```typespec
model TypeSpec.OpenAPI.Contact
```

#### Properties

| Name   | Type      | Description                                                                                      |
| ------ | --------- | ------------------------------------------------------------------------------------------------ |
| name?  | `string`  | The identifying name of the contact person/organization.                                         |
| url?   | `url`     | The URL pointing to the contact information. MUST be in the format of a URL.                     |
| email? | `string`  | The email address of the contact person/organization. MUST be in the format of an email address. |
|        | `unknown` | Additional properties                                                                            |

### `ExternalDocs` {#TypeSpec.OpenAPI.ExternalDocs}

External Docs information.

```typespec
model TypeSpec.OpenAPI.ExternalDocs
```

#### Properties

| Name         | Type      | Description           |
| ------------ | --------- | --------------------- |
| url          | `string`  | Documentation url     |
| description? | `string`  | Optional description  |
|              | `unknown` | Additional properties |

### `License` {#TypeSpec.OpenAPI.License}

License information for the exposed API.

```typespec
model TypeSpec.OpenAPI.License
```

#### Properties

| Name | Type      | Description                                                            |
| ---- | --------- | ---------------------------------------------------------------------- |
| name | `string`  | The license name used for the API.                                     |
| url? | `url`     | A URL to the license used for the API. MUST be in the format of a URL. |
|      | `unknown` | Additional properties                                                  |

### `TagMetadata` {#TypeSpec.OpenAPI.TagMetadata}

Metadata to a single tag that is used by operations.

```typespec
model TypeSpec.OpenAPI.TagMetadata
```

#### Properties

| Name          | Type                                                            | Description                                                                                                                            |
| ------------- | --------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| description?  | `string`                                                        | A description of the API.                                                                                                              |
| externalDocs? | [`ExternalDocs`](./data-types.md#TypeSpec.OpenAPI.ExternalDocs) | An external Docs information of the API.                                                                                               |
| parent?       | `string`                                                        | The name of a tag that this tag is nested under. Only supported in OpenAPI 3.2. For 3.0 and 3.1, this will be converted to `x-parent`. |
|               | `unknown`                                                       | Additional properties                                                                                                                  |
