Skip to content

Commit 81435ae

Browse files
authored
Remove guidance on length restrictions for summary
Per TDC discussion on PR OAI#1009, this removes the SHOULD keep length under 120 guidance from v2
1 parent 43ca992 commit 81435ae

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

versions/3.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -763,7 +763,7 @@ Describes a single API operation on a path.
763763
Field Name | Type | Description
764764
---|:---:|---
765765
<a name="operationTags"></a>tags | [`string`] | A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
766-
<a name="operationSummary"></a>summary | `string` | A short summary of what the operation does. For maximum readability in editing or documentation generation tools, this field SHOULD be less than 120 characters.
766+
<a name="operationSummary"></a>summary | `string` | A short summary of what the operation does.
767767
<a name="operationDescription"></a>description | `string` | A verbose explanation of the operation behavior. [CommonMark syntax](http://spec.commonmark.org/) can be used for rich text representation.
768768
<a name="operationExternalDocs"></a>externalDocs | [External Documentation Object](#externalDocumentationObject) | Additional external documentation for this operation.
769769
<a name="operationId"></a>operationId | `string` | Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.

0 commit comments

Comments
 (0)