---
title: Index
sidebar_position: 0
toc_min_heading_level: 2
toc_max_heading_level: 3
---

## Cadl.Http

### Decorators

- [`@statusCode`](./decorators.md#@Cadl.Http.statusCode)
- [`@body`](./decorators.md#@Cadl.Http.body)
- [`@header`](./decorators.md#@Cadl.Http.header)
- [`@query`](./decorators.md#@Cadl.Http.query)
- [`@path`](./decorators.md#@Cadl.Http.path)
- [`@get`](./decorators.md#@Cadl.Http.get)
- [`@put`](./decorators.md#@Cadl.Http.put)
- [`@post`](./decorators.md#@Cadl.Http.post)
- [`@patch`](./decorators.md#@Cadl.Http.patch)
- [`@delete`](./decorators.md#@Cadl.Http.delete)
- [`@head`](./decorators.md#@Cadl.Http.head)
- [`@server`](./decorators.md#@Cadl.Http.server)
- [`@useAuth`](./decorators.md#@Cadl.Http.useAuth)
- [`@includeInapplicableMetadataInPayload`](./decorators.md#@Cadl.Http.includeInapplicableMetadataInPayload)

### Models

- [`Response`](./data-types.md#Cadl.Http.Response)
- [`Body`](./data-types.md#Cadl.Http.Body)
- [`LocationHeader`](./data-types.md#Cadl.Http.LocationHeader)
- [`HeaderOptions`](./data-types.md#Cadl.Http.HeaderOptions)
- [`OkResponse`](./data-types.md#Cadl.Http.OkResponse)
- [`CreatedResponse`](./data-types.md#Cadl.Http.CreatedResponse)
- [`AcceptedResponse`](./data-types.md#Cadl.Http.AcceptedResponse)
- [`NoContentResponse`](./data-types.md#Cadl.Http.NoContentResponse)
- [`MovedResponse`](./data-types.md#Cadl.Http.MovedResponse)
- [`NotModifiedResponse`](./data-types.md#Cadl.Http.NotModifiedResponse)
- [`BadRequestResponse`](./data-types.md#Cadl.Http.BadRequestResponse)
- [`UnauthorizedResponse`](./data-types.md#Cadl.Http.UnauthorizedResponse)
- [`ForbiddenResponse`](./data-types.md#Cadl.Http.ForbiddenResponse)
- [`NotFoundResponse`](./data-types.md#Cadl.Http.NotFoundResponse)
- [`ConflictResponse`](./data-types.md#Cadl.Http.ConflictResponse)
- [`PlainData`](./data-types.md#Cadl.Http.PlainData)
- [`QueryOptions`](./data-types.md#Cadl.Http.QueryOptions)
- [`BasicAuth`](./data-types.md#Cadl.Http.BasicAuth)
- [`BearerAuth`](./data-types.md#Cadl.Http.BearerAuth)
- [`ApiKeyAuth`](./data-types.md#Cadl.Http.ApiKeyAuth)
- [`OAuth2Auth`](./data-types.md#Cadl.Http.OAuth2Auth)
- [`AuthorizationCodeFlow`](./data-types.md#Cadl.Http.AuthorizationCodeFlow)
- [`ImplicitFlow`](./data-types.md#Cadl.Http.ImplicitFlow)
- [`PasswordFlow`](./data-types.md#Cadl.Http.PasswordFlow)
- [`ClientCredentialsFlow`](./data-types.md#Cadl.Http.ClientCredentialsFlow)

## Cadl.Rest

### Decorators

- [`@autoRoute`](./decorators.md#@Cadl.Rest.autoRoute)
- [`@segment`](./decorators.md#@Cadl.Rest.segment)
- [`@segmentOf`](./decorators.md#@Cadl.Rest.segmentOf)
- [`@actionSeparator`](./decorators.md#@Cadl.Rest.actionSeparator)
- [`@resource`](./decorators.md#@Cadl.Rest.resource)
- [`@readsResource`](./decorators.md#@Cadl.Rest.readsResource)
- [`@createsResource`](./decorators.md#@Cadl.Rest.createsResource)
- [`@createsOrReplacesResource`](./decorators.md#@Cadl.Rest.createsOrReplacesResource)
- [`@createsOrUpdatesResource`](./decorators.md#@Cadl.Rest.createsOrUpdatesResource)
- [`@updatesResource`](./decorators.md#@Cadl.Rest.updatesResource)
- [`@deletesResource`](./decorators.md#@Cadl.Rest.deletesResource)
- [`@listsResource`](./decorators.md#@Cadl.Rest.listsResource)
- [`@action`](./decorators.md#@Cadl.Rest.action)
- [`@collectionAction`](./decorators.md#@Cadl.Rest.collectionAction)

## Cadl.Rest.Resource

### Interfaces

- [`ResourceRead`](./interfaces.md#Cadl.Rest.Resource.ResourceRead)
- [`ResourceCreateOrReplace`](./interfaces.md#Cadl.Rest.Resource.ResourceCreateOrReplace)
- [`ResourceCreateOrUpdate`](./interfaces.md#Cadl.Rest.Resource.ResourceCreateOrUpdate)
- [`ResourceCreate`](./interfaces.md#Cadl.Rest.Resource.ResourceCreate)
- [`ResourceUpdate`](./interfaces.md#Cadl.Rest.Resource.ResourceUpdate)
- [`ResourceDelete`](./interfaces.md#Cadl.Rest.Resource.ResourceDelete)
- [`ResourceList`](./interfaces.md#Cadl.Rest.Resource.ResourceList)
- [`ResourceInstanceOperations`](./interfaces.md#Cadl.Rest.Resource.ResourceInstanceOperations)
- [`ResourceCollectionOperations`](./interfaces.md#Cadl.Rest.Resource.ResourceCollectionOperations)
- [`ResourceOperations`](./interfaces.md#Cadl.Rest.Resource.ResourceOperations)
- [`SingletonResourceRead`](./interfaces.md#Cadl.Rest.Resource.SingletonResourceRead)
- [`SingletonResourceUpdate`](./interfaces.md#Cadl.Rest.Resource.SingletonResourceUpdate)
- [`SingletonResourceOperations`](./interfaces.md#Cadl.Rest.Resource.SingletonResourceOperations)
- [`ExtensionResourceRead`](./interfaces.md#Cadl.Rest.Resource.ExtensionResourceRead)
- [`ExtensionResourceCreateOrUpdate`](./interfaces.md#Cadl.Rest.Resource.ExtensionResourceCreateOrUpdate)
- [`ExtensionResourceCreate`](./interfaces.md#Cadl.Rest.Resource.ExtensionResourceCreate)
- [`ExtensionResourceUpdate`](./interfaces.md#Cadl.Rest.Resource.ExtensionResourceUpdate)
- [`ExtensionResourceDelete`](./interfaces.md#Cadl.Rest.Resource.ExtensionResourceDelete)
- [`ExtensionResourceList`](./interfaces.md#Cadl.Rest.Resource.ExtensionResourceList)
- [`ExtensionResourceInstanceOperations`](./interfaces.md#Cadl.Rest.Resource.ExtensionResourceInstanceOperations)
- [`ExtensionResourceCollectionOperations`](./interfaces.md#Cadl.Rest.Resource.ExtensionResourceCollectionOperations)
- [`ExtensionResourceOperations`](./interfaces.md#Cadl.Rest.Resource.ExtensionResourceOperations)

### Models

- [`ResourceError`](./data-types.md#Cadl.Rest.Resource.ResourceError)
- [`KeysOf`](./data-types.md#Cadl.Rest.Resource.KeysOf)
- [`ParentKeysOf`](./data-types.md#Cadl.Rest.Resource.ParentKeysOf)
- [`ResourceParameters`](./data-types.md#Cadl.Rest.Resource.ResourceParameters)
- [`ResourceCollectionParameters`](./data-types.md#Cadl.Rest.Resource.ResourceCollectionParameters)
- [`ResourceCreatedResponse`](./data-types.md#Cadl.Rest.Resource.ResourceCreatedResponse)
- [`ResourceCreateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateModel)
- [`ResourceCreateOrUpdateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateOrUpdateModel)
- [`ResourceDeletedResponse`](./data-types.md#Cadl.Rest.Resource.ResourceDeletedResponse)
- [`CollectionWithNextLink`](./data-types.md#Cadl.Rest.Resource.CollectionWithNextLink)
- [`ResourceCreateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateModel)
- [`ResourceCreatedResponse`](./data-types.md#Cadl.Rest.Resource.ResourceCreatedResponse)
- [`ResourceCreateOrUpdateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateOrUpdateModel)
- [`ResourceCreatedResponse`](./data-types.md#Cadl.Rest.Resource.ResourceCreatedResponse)
- [`ResourceCreateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateModel)
- [`ResourceCreatedResponse`](./data-types.md#Cadl.Rest.Resource.ResourceCreatedResponse)
- [`ResourceCreateOrUpdateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateOrUpdateModel)
- [`CollectionWithNextLink`](./data-types.md#Cadl.Rest.Resource.CollectionWithNextLink)
- [`ResourceCreateOrUpdateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateOrUpdateModel)
- [`ResourceCreateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateModel)
- [`ResourceCreatedResponse`](./data-types.md#Cadl.Rest.Resource.ResourceCreatedResponse)
- [`CollectionWithNextLink`](./data-types.md#Cadl.Rest.Resource.CollectionWithNextLink)
- [`ResourceCreateOrUpdateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateOrUpdateModel)
- [`ResourceCreateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateModel)
- [`ResourceCreatedResponse`](./data-types.md#Cadl.Rest.Resource.ResourceCreatedResponse)
- [`CollectionWithNextLink`](./data-types.md#Cadl.Rest.Resource.CollectionWithNextLink)
- [`ResourceCreateOrUpdateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateOrUpdateModel)
- [`ResourceCreateOrUpdateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateOrUpdateModel)
- [`ResourceCreateOrUpdateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateOrUpdateModel)
- [`ResourceCreatedResponse`](./data-types.md#Cadl.Rest.Resource.ResourceCreatedResponse)
- [`ResourceCreateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateModel)
- [`ResourceCreatedResponse`](./data-types.md#Cadl.Rest.Resource.ResourceCreatedResponse)
- [`ResourceCreateOrUpdateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateOrUpdateModel)
- [`CollectionWithNextLink`](./data-types.md#Cadl.Rest.Resource.CollectionWithNextLink)
- [`ResourceCreateOrUpdateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateOrUpdateModel)
- [`ResourceCreateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateModel)
- [`ResourceCreatedResponse`](./data-types.md#Cadl.Rest.Resource.ResourceCreatedResponse)
- [`CollectionWithNextLink`](./data-types.md#Cadl.Rest.Resource.CollectionWithNextLink)
- [`ResourceCreateOrUpdateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateOrUpdateModel)
- [`ResourceCreateModel`](./data-types.md#Cadl.Rest.Resource.ResourceCreateModel)
- [`ResourceCreatedResponse`](./data-types.md#Cadl.Rest.Resource.ResourceCreatedResponse)
- [`CollectionWithNextLink`](./data-types.md#Cadl.Rest.Resource.CollectionWithNextLink)
