Skip to main content

OpenAPIWebdaDefinition

@webda/core

Interface: OpenAPIWebdaDefinition

Defined in: packages/core/src/rest/irest.ts:11

Define overridable OpenAPI description

Extends​

  • DeepPartial<OpenAPIV3.PathItemObject>

Properties​

$ref?​

optional $ref?: string

Defined in: node_modules/.pnpm/openapi-types@12.1.3/node_modules/openapi-types/dist/index.d.ts:208

Inherited from​

DeepPartial.$ref

delete?​

optional delete?: DeepPartial<{ callbacks?: {[callback: string]: ReferenceObject | CallbackObject; }; deprecated?: boolean; description?: string; externalDocs?: ExternalDocumentationObject; operationId?: string; parameters?: (ReferenceObject | ParameterObject)[]; requestBody?: ReferenceObject | RequestBodyObject; responses: ResponsesObject; security?: SecurityRequirementObject[]; servers?: ServerObject[]; summary?: string; tags?: string[]; }>

Inherited from​

DeepPartial.delete

description?​

optional description?: string

Defined in: node_modules/.pnpm/openapi-types@12.1.3/node_modules/openapi-types/dist/index.d.ts:210

Inherited from​

DeepPartial.description

get?​

optional get?: OpenApiWebdaOperation

Defined in: packages/core/src/rest/irest.ts:30

Overrides​

DeepPartial.get

optional head?: DeepPartial<{ callbacks?: {[callback: string]: ReferenceObject | CallbackObject; }; deprecated?: boolean; description?: string; externalDocs?: ExternalDocumentationObject; operationId?: string; parameters?: (ReferenceObject | ParameterObject)[]; requestBody?: ReferenceObject | RequestBodyObject; responses: ResponsesObject; security?: SecurityRequirementObject[]; servers?: ServerObject[]; summary?: string; tags?: string[]; }>

Inherited from​

OpenAPIWebdaDefinition.head

hidden?​

optional hidden?: boolean

Defined in: packages/core/src/rest/irest.ts:18

Do not output for this specific Route

It can still be output with --include-hidden, as it is needed to declare the route in API Gateway or any other internal documentation

model?​

optional model?: string

Defined in: packages/core/src/rest/irest.ts:22

If defined will link to the model schema instead of a generic Object

options?​

optional options?: DeepPartial<{ callbacks?: {[callback: string]: ReferenceObject | CallbackObject; }; deprecated?: boolean; description?: string; externalDocs?: ExternalDocumentationObject; operationId?: string; parameters?: (ReferenceObject | ParameterObject)[]; requestBody?: ReferenceObject | RequestBodyObject; responses: ResponsesObject; security?: SecurityRequirementObject[]; servers?: ServerObject[]; summary?: string; tags?: string[]; }>

Inherited from​

OpenAPIWebdaDefinition.options

parameters?​

optional parameters?: DeepPartial<ReferenceObject | ParameterObject>[]

Defined in: node_modules/.pnpm/openapi-types@12.1.3/node_modules/openapi-types/dist/index.d.ts:212

Inherited from​

DeepPartial.parameters

patch?​

optional patch?: OpenApiWebdaOperation

Defined in: packages/core/src/rest/irest.ts:29

Overrides​

DeepPartial.patch

post?​

optional post?: OpenApiWebdaOperation

Defined in: packages/core/src/rest/irest.ts:27

Overrides​

DeepPartial.post

put?​

optional put?: OpenApiWebdaOperation

Defined in: packages/core/src/rest/irest.ts:28

Overrides​

DeepPartial.put

servers?​

optional servers?: DeepPartial<ServerObject>[]

Defined in: node_modules/.pnpm/openapi-types@12.1.3/node_modules/openapi-types/dist/index.d.ts:211

Inherited from​

DeepPartial.servers

summary?​

optional summary?: string

Defined in: node_modules/.pnpm/openapi-types@12.1.3/node_modules/openapi-types/dist/index.d.ts:209

Inherited from​

DeepPartial.summary

tags?​

optional tags?: string[]

Defined in: packages/core/src/rest/irest.ts:26

Tags defined for all methods

trace?​

optional trace?: DeepPartial<{ callbacks?: {[callback: string]: ReferenceObject | CallbackObject; }; deprecated?: boolean; description?: string; externalDocs?: ExternalDocumentationObject; operationId?: string; parameters?: (ReferenceObject | ParameterObject)[]; requestBody?: ReferenceObject | RequestBodyObject; responses: ResponsesObject; security?: SecurityRequirementObject[]; servers?: ServerObject[]; summary?: string; tags?: string[]; }>

Inherited from​

OpenAPIWebdaDefinition.trace