---
jsApi: true
title: "[P] JS API"

---
## Enumerations

- [Visibility](enumerations/Visibility.md)

## Interfaces

- [AnyHttpAuthRef](interfaces/AnyHttpAuthRef.md)
- [ApiKeyAuth](interfaces/ApiKeyAuth.md)
- [Authentication](interfaces/Authentication.md)
- [AuthenticationOption](interfaces/AuthenticationOption.md)
- [AuthenticationOptionReference](interfaces/AuthenticationOptionReference.md)
- [AuthenticationReference](interfaces/AuthenticationReference.md)
- [AuthorizationCodeFlow](interfaces/AuthorizationCodeFlow.md)
- [BasicAuth](interfaces/BasicAuth.md)
- [BearerAuth](interfaces/BearerAuth.md)
- [ClientCredentialsFlow](interfaces/ClientCredentialsFlow.md)
- [HeaderFieldOptions](interfaces/HeaderFieldOptions.md)
- [HttpAuthBase](interfaces/HttpAuthBase.md)
- [HttpOperation](interfaces/HttpOperation.md)
- [HttpOperationBody](interfaces/HttpOperationBody.md)
- [HttpOperationParameters](interfaces/HttpOperationParameters.md)
- [HttpOperationRequestBody](interfaces/HttpOperationRequestBody.md)
- [HttpOperationResponse](interfaces/HttpOperationResponse.md)
- [HttpOperationResponseContent](interfaces/HttpOperationResponseContent.md)
- [HttpServer](interfaces/HttpServer.md)
- [HttpService](interfaces/HttpService.md)
- [HttpServiceAuthentication](interfaces/HttpServiceAuthentication.md)
- [HttpStatusCodeRange](interfaces/HttpStatusCodeRange.md)
- [ImplicitFlow](interfaces/ImplicitFlow.md)
- [MetadataInfo](interfaces/MetadataInfo.md)
- [MetadataInfoOptions](interfaces/MetadataInfoOptions.md)
- [NoAuth](interfaces/NoAuth.md)
- [NoHttpAuthRef](interfaces/NoHttpAuthRef.md)
- [OAuth2HttpAuthRef](interfaces/OAuth2HttpAuthRef.md)
- [OAuth2Scope](interfaces/OAuth2Scope.md)
- [Oauth2Auth](interfaces/Oauth2Auth.md)
- [OpenIDConnectAuth](interfaces/OpenIDConnectAuth.md)
- [OperationParameterOptions](interfaces/OperationParameterOptions.md)
- [PasswordFlow](interfaces/PasswordFlow.md)
- [PathParameterOptions](interfaces/PathParameterOptions.md)
- [QueryParameterOptions](interfaces/QueryParameterOptions.md)
- [RouteOptions](interfaces/RouteOptions.md)
- [RoutePath](interfaces/RoutePath.md)
- [RouteProducerResult](interfaces/RouteProducerResult.md)
- [RouteResolutionOptions](interfaces/RouteResolutionOptions.md)

## Type Aliases

- [HttpAuth](type-aliases/HttpAuth.md)
- [HttpAuthRef](type-aliases/HttpAuthRef.md)
- [HttpOperationParameter](type-aliases/HttpOperationParameter.md)
- [HttpStatusCodes](type-aliases/HttpStatusCodes.md)
- [HttpStatusCodesEntry](type-aliases/HttpStatusCodesEntry.md)
- [HttpVerb](type-aliases/HttpVerb.md)
- [OAuth2Flow](type-aliases/OAuth2Flow.md)
- [OAuth2FlowType](type-aliases/OAuth2FlowType.md)
- [OperationContainer](type-aliases/OperationContainer.md)
- [OperationDetails](type-aliases/OperationDetails.md)
- [OperationVerbSelector](type-aliases/OperationVerbSelector.md)
- [RouteProducer](type-aliases/RouteProducer.md)
- [ServiceAuthentication](type-aliases/ServiceAuthentication.md)
- [StatusCode](type-aliases/StatusCode.md)

## Variables

- [$lib](variables/$lib.md)
- [$linter](variables/$linter.md)
- [namespace](variables/namespace.md)

## Functions

- [$body](functions/$body.md)
- [$delete](functions/$delete.md)
- [$get](functions/$get.md)
- [$head](functions/$head.md)
- [$header](functions/$header.md)
- [$includeInapplicableMetadataInPayload](functions/$includeInapplicableMetadataInPayload.md)
- [$onValidate](functions/$onValidate.md)
- [$patch](functions/$patch.md)
- [$path](functions/$path.md)
- [$plainData](functions/$plainData.md)
- [$post](functions/$post.md)
- [$put](functions/$put.md)
- [$query](functions/$query.md)
- [$route](functions/$route.md)
- [$server](functions/$server.md)
- [$sharedRoute](functions/$sharedRoute.md)
- [$statusCode](functions/$statusCode.md)
- [$useAuth](functions/$useAuth.md)
- [DefaultRouteProducer](functions/DefaultRouteProducer.md)
- [createMetadataInfo](functions/createMetadataInfo.md)
- [gatherMetadata](functions/gatherMetadata.md)
- [getAllHttpServices](functions/getAllHttpServices.md)
- [getAllRoutes](functions/getAllRoutes.md)
- [getAuthentication](functions/getAuthentication.md)
- [getAuthenticationForOperation](functions/getAuthenticationForOperation.md)
- [getContentTypes](functions/getContentTypes.md)
- [getHeaderFieldName](functions/getHeaderFieldName.md)
- [getHeaderFieldOptions](functions/getHeaderFieldOptions.md)
- [getHttpOperation](functions/getHttpOperation.md)
- [getHttpService](functions/getHttpService.md)
- [getOperationParameters](functions/getOperationParameters.md)
- [getOperationVerb](functions/getOperationVerb.md)
- [getPathParamName](functions/getPathParamName.md)
- [getPathParamOptions](functions/getPathParamOptions.md)
- [getQueryParamName](functions/getQueryParamName.md)
- [getQueryParamOptions](functions/getQueryParamOptions.md)
- [getRequestVisibility](functions/getRequestVisibility.md)
- [getResponsesForOperation](functions/getResponsesForOperation.md)
- [getRouteOptionsForNamespace](functions/getRouteOptionsForNamespace.md)
- [getRoutePath](functions/getRoutePath.md)
- [getRouteProducer](functions/getRouteProducer.md)
- [getServers](functions/getServers.md)
- [getStatusCodeDescription](functions/getStatusCodeDescription.md)
- [getStatusCodes](functions/getStatusCodes.md)
- [getStatusCodesWithDiagnostics](functions/getStatusCodesWithDiagnostics.md)
- [getVisibilitySuffix](functions/getVisibilitySuffix.md)
- [includeInapplicableMetadataInPayload](functions/includeInapplicableMetadataInPayload.md)
- [includeInterfaceRoutesInNamespace](functions/includeInterfaceRoutesInNamespace.md)
- [isApplicableMetadata](functions/isApplicableMetadata.md)
- [isApplicableMetadataOrBody](functions/isApplicableMetadataOrBody.md)
- [isBody](functions/isBody.md)
- [isContentTypeHeader](functions/isContentTypeHeader.md)
- [isHeader](functions/isHeader.md)
- [isMetadata](functions/isMetadata.md)
- [isOverloadSameEndpoint](functions/isOverloadSameEndpoint.md)
- [isPathParam](functions/isPathParam.md)
- [isQueryParam](functions/isQueryParam.md)
- [isSharedRoute](functions/isSharedRoute.md)
- [isStatusCode](functions/isStatusCode.md)
- [isVisible](functions/isVisible.md)
- [listHttpOperationsIn](functions/listHttpOperationsIn.md)
- [reportIfNoRoutes](functions/reportIfNoRoutes.md)
- [resolveAuthentication](functions/resolveAuthentication.md)
- [resolvePathAndParameters](functions/resolvePathAndParameters.md)
- [resolveRequestVisibility](functions/resolveRequestVisibility.md)
- [setAuthentication](functions/setAuthentication.md)
- [setRoute](functions/setRoute.md)
- [setRouteOptionsForNamespace](functions/setRouteOptionsForNamespace.md)
- [setRouteProducer](functions/setRouteProducer.md)
- [setSharedRoute](functions/setSharedRoute.md)
- [setStatusCode](functions/setStatusCode.md)
- [validateRouteUnique](functions/validateRouteUnique.md)
