Skip to content

Commit 2c1cdd3

Browse files
docs: tighten ATTRIBUTES heading and intro
- Heading was 12 words ("Adding custom attributes to changelog entries basing on OpenAPI extension tags") and used "tags", which is a different OpenAPI concept. Shortened to "Add OpenAPI Extensions to the Changelog" — matches the README link text. - Intro said "Some people annotate their endpoints with OpenAPI Extension tags" — vague subject and wrong terminology. Replaced with a definition-first sentence that describes what the x-* fields are. - Tightened the trailing prose ("Oasdiff can add these attributes ... as follows" → "Use the --attributes flag to include these values in JSON or YAML changelog entries"). Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent e06876d commit 2c1cdd3

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

docs/ATTRIBUTES.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
# Adding custom attributes to changelog entries basing on OpenAPI extension tags
2-
Some people annotate their endpoints with OpenAPI Extension tags, for example:
1+
# Add OpenAPI Extensions to the Changelog
2+
OpenAPI specs can carry custom `x-*` extension fields that attach metadata to operations. For example:
33
```
44
/restapi/oauth/token:
55
post:
@@ -12,7 +12,7 @@ Some people annotate their endpoints with OpenAPI Extension tags, for example:
1212
...
1313
```
1414

15-
Oasdiff can add these attributes to the changelog in JSON or YAML formats as follows:
15+
Use the `--attributes` flag to include these values in JSON or YAML changelog entries:
1616

1717
```
1818
❯ oasdiff changelog base.yaml revision.yaml -f yaml --attributes x-audience

0 commit comments

Comments
 (0)