docs: added glossary for style guide #769
Conversation
CynthiaPeter
requested review from
fmvilas,
quetzalliwrites,
derberg and
asyncapi-bot-eve
as code owners
![github-actions[bot]](https://github.com/avatars/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
There was a problem hiding this comment.
- I've done some reviews from my side.
- Requesting feedback from your side on this. @alequetzalli @CynthiaPeter @thulieblack
| Description: This glossary defines general terms and terms specific to AsyncAPI style guide, products, and documentation. | ||
| --- | ||
|
|
||
| This Glossary serves as a central location for terms that appears in the AsyncAPI documentation. If you find a term that you wish was defined here, please post an [issue requesting it](https://github.com/asyncapi/website/issues). |
There was a problem hiding this comment.
| This Glossary serves as a central location for terms that appears in the AsyncAPI documentation. If you find a term that you wish was defined here, please post an [issue requesting it](https://github.com/asyncapi/website/issues). | |
| This Glossary serves as a central location for terms that appear in the AsyncAPI documentation. If you find a term that you wish was defined here, please post an [issue requesting it](https://github.com/asyncapi/website/issues). |
|
|
||
|
|
||
| ## API | ||
| The general definition of "Application Program Interface" can refer to different things for different people. However, in this case, APIs refer to different kinds of APIs, including HTTP-based, Async, and Event-driven Architecture. |
There was a problem hiding this comment.
"Application Program Interface" or "Application Programming Interface" ?
| </Remember> | ||
|
|
||
| ## AsyncAPI document | ||
| An AsyncPI document is a file that defines and annotates the different components of a specific Event-Driven API. |
There was a problem hiding this comment.
| An AsyncPI document is a file that defines and annotates the different components of a specific Event-Driven API. | |
| An AsyncAPI document is a file that defines and annotates the different components of a specific Event-Driven API. |
| ## AsyncAPI document | ||
| An AsyncPI document is a file that defines and annotates the different components of a specific Event-Driven API. | ||
|
|
||
| ## AsyncAPI specification |
There was a problem hiding this comment.
| ## AsyncAPI specification | |
| ## AsyncAPI Specification |
- It should be capitalized as it has been done in the following description of it.
| A "binding" (or "protocol binding") is a mechanism to define protocol-specific information. Therefore, a protocol binding MUST define protocol-specific information only. | ||
|
|
||
| ## CLI | ||
| The AsyncAPI CLI is a tool you can use to work with your AsyncAPI documents. You can use the CLI to create, develop, validate, maintain, and maintain your AsyncAPI documents, use the Generator tool, and even create new AsyncAPI documents. |
There was a problem hiding this comment.
| The AsyncAPI CLI is a tool you can use to work with your AsyncAPI documents. You can use the CLI to create, develop, validate, maintain, and maintain your AsyncAPI documents, use the Generator tool, and even create new AsyncAPI documents. | |
| The AsyncAPI CLI is a tool you can use to work with your AsyncAPI documents. You can use the CLI to create, develop, validate, and maintain your AsyncAPI documents, use the Generator tool, and even create new AsyncAPI documents. |
- Why is there two occurence of
maintainin this line? Or am I missing something? @CynthiaPeter
| The AsyncAPI CLI is a tool you can use to work with your AsyncAPI documents. You can use the CLI to create, develop, validate, maintain, and maintain your AsyncAPI documents, use the Generator tool, and even create new AsyncAPI documents. | ||
|
|
||
| ## Consumer | ||
| In an Event Driven Architecture (EDA), a consumer is an application that listens for a particular event from a broker and reacts to it. |
There was a problem hiding this comment.
| In an Event Driven Architecture (EDA), a consumer is an application that listens for a particular event from a broker and reacts to it. | |
| In an Event-Driven Architecture (EDA), a consumer is an application that listens for a particular event from a broker and reacts to it. |
| You can use the generator to generate anything you want, provided that it can be defined in a template, such as code, diagrams, markdown files, microservices, and applications. | ||
|
|
||
| ## Github Actions | ||
| The Github Actions tool seamlessly integrates and generates docs and code for your GitHub Actions pipeline. |
There was a problem hiding this comment.
| The Github Actions tool seamlessly integrates and generates docs and code for your GitHub Actions pipeline. | |
| The GitHub Actions tool seamlessly integrates and generates docs and code for your GitHub Actions pipeline. |
- Let's stay consistent for the upper-cases and lower-cases.
|
|
||
|
|
||
| ## Message-driven APIs | ||
| Message-driven APIs, also known as Messaging APIs, facilitate communication between different components or services by exchanging messages. Instead of traditional request-response patterns in synchronous APIs, message-driven APIs rely on asynchronous messaging to enable decoupled and loosely coupled communication. |
There was a problem hiding this comment.
| Message-driven APIs, also known as Messaging APIs, facilitate communication between different components or services by exchanging messages. Instead of traditional request-response patterns in synchronous APIs, message-driven APIs rely on asynchronous messaging to enable decoupled and loosely coupled communication. | |
| Message-driven APIs, also known as Messaging APIs, facilitate communication between different components or services by exchanging messages. Instead of traditional request-response patterns in synchronous APIs, message-driven APIs rely on asynchronous messaging to enable de-coupled and loosely-coupled communication. |
- Is it better this way?
| Modelina is a library for generating data models based on inputs such as AsyncAPI, OpenAPI, or JSON Schema documents. | ||
|
|
||
| ## Parsers | ||
| Parser is a package used to validate and parse AsyncAPI documents —YAML or JSON— in your Node.js or browser application. |
There was a problem hiding this comment.
| Parser is a package used to validate and parse AsyncAPI documents —YAML or JSON— in your Node.js or browser application. | |
| Parser is a package used to validate and parse AsyncAPI documents — YAML or JSON — in your Node.js or browser application. |
|
This pull request has been automatically marked as stale because it has not had recent activity 😴 It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation. There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model. Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here. Thank you for your patience ❤️ |
|
Hi @CynthiaPeter I hope youre doing great, Are you still working on this and if you're can you please try to update the changes suggested or If you need any help can you post that. Thank You :) |
Hello @octonawish-akcodes, |
|
closing because Cynthia requested @octonawish-akcodes to take over this task via #974 |
Description
Notes
This list will be updated as we find new words or phrases.
Related issue(s)
Reference to asyncapi/website#1294