Skip to content

Commit

Permalink
docs: misspelled AsyncAPI (#3181)
Browse files Browse the repository at this point in the history
  • Loading branch information
akkshitgupta authored Sep 10, 2024
1 parent 1b6c3e1 commit abd4ba0
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion markdown/docs/concepts/asyncapi-document/tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ weight: 63

A tag functions as a label or category for logically grouping related entities like channels or servers in an event-driven system. The `tag` object facilitates the organization of channels, operations, or other components, categorizing them based on functionality, purpose, or other relevant criteria.

In AyncAPI, the `tags` object is a list of individual `tag` objects. Each `tag` within this collection can be defined with a specific name, accompanied by an optional description that offers additional insight into the tag's intended purpose or usage.
In AsyncAPI, the `tags` object is a list of individual `tag` objects. Each `tag` within this collection can be defined with a specific name, accompanied by an optional description that offers additional insight into the tag's intended purpose or usage.

You can define `tags` in the [`components` object](/docs/reference/specification/latest#componentsObject) of an AsyncAPI document, which enables the reusability of the tags. If you include `tags` in the `components` object, they can be re-used by using [reference objects](/docs/reference/specification/latest#referenceObject).

Expand Down
2 changes: 1 addition & 1 deletion markdown/docs/tools/generator/asyncapi-document.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ graph LR
The AsyncAPI document's content is accessible to you while writing your template in two distinct ways:

- The `originalAsyncAPI`, which is a stringified version of the AsyncAPI document provided as input, without any modifications.
- The `asyncapi` (`AsyncAPIDocument`) which is an object with a set of helper functions, that comes as a result of the `Parser` manipulating the `originalAyncAPI` .The `asyncapi` functions make it easier to access the contents of AsyncAPI documents in your templates.
- The `asyncapi` (`AsyncAPIDocument`) which is an object with a set of helper functions, that comes as a result of the `Parser` manipulating the `originalAsyncAPI` .The `asyncapi` functions make it easier to access the contents of AsyncAPI documents in your templates.

In the following sections, you will learn how to use either the **originalAsyncAPI** or the **asyncapi** in your template.

Expand Down

0 comments on commit abd4ba0

Please sign in to comment.