Skip to content

Commit 06d32e8

Browse files
committed
chore: testing child node description and docs link
1 parent 727420b commit 06d32e8

3 files changed

Lines changed: 25 additions & 5 deletions

File tree

packages/core/src/types/arazzo.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,11 @@ const Info: NodeType = {
3838
properties: {
3939
title: { type: 'string' },
4040
description: { type: 'string' },
41-
summary: { type: 'string' },
41+
summary: {
42+
type: 'string',
43+
description: `The object provides metadata about API workflows defined in this Arazzo document. The metadata MAY be used by the clients if needed.`,
44+
documentationLink: `https://spec.openapis.org/arazzo/latest.html#info-object`,
45+
},
4246
version: { type: 'string' },
4347
},
4448
required: ['title', 'version'],

packages/core/src/types/oas3.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,16 @@ const Operation: NodeType = {
179179
type: 'array',
180180
items: { type: 'string' },
181181
},
182-
summary: { type: 'string' },
183-
description: { type: 'string' },
182+
summary: {
183+
type: 'string',
184+
description: `Optional short summary of what the operation does.`,
185+
documentationLink: `https://spec.openapis.org/oas/v3.1.0#operation-object`,
186+
},
187+
description: {
188+
type: 'string',
189+
description: `Optional description of the operation and its behavior. Supports Markdown formatting. Redocly tools support using $ref in this field to reuse or include content from other sources.`,
190+
documentationLink: `https://spec.openapis.org/oas/v3.1.0#operation-object`,
191+
},
184192
externalDocs: 'ExternalDocs',
185193
operationId: { type: 'string' },
186194
parameters: 'ParameterList',

packages/core/src/types/oas3_1.ts

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,16 @@ const Operation: NodeType = {
6666
type: 'array',
6767
items: { type: 'string' },
6868
},
69-
summary: { type: 'string' },
70-
description: { type: 'string' },
69+
summary: {
70+
type: 'string',
71+
description: `Optional short summary of what the operation does.`,
72+
documentationLink: `https://spec.openapis.org/oas/v3.1.0#operation-object`,
73+
},
74+
description: {
75+
type: 'string',
76+
description: `Optional description of the operation and its behavior. Supports Markdown formatting. Redocly tools support using $ref in this field to reuse or include content from other sources.`,
77+
documentationLink: `https://spec.openapis.org/oas/v3.1.0#operation-object`,
78+
},
7179
externalDocs: 'ExternalDocs',
7280
operationId: { type: 'string' },
7381
parameters: 'ParameterList',

0 commit comments

Comments
 (0)