diff --git a/CODEOWNERS b/CODEOWNERS index 54e75c801bdf..d9db0f6d8e2b 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -14,5 +14,5 @@ pages/blog/*.md @thulieblack @alequetzalli pages/community/*.md @thulieblack @alequetzalli README.md @alequetzalli @derberg @akshatnema @magicmatatjahu @mayaleeeee @asyncapi-bot-eve -#docTriagers: TRohit20 octonawish-akcodes BhaswatiRoy VaishnaviNandakumar J0SAL +#docTriagers: TRohit20 BhaswatiRoy VaishnaviNandakumar J0SAL #codeTriagers: sambhavgupta0705 diff --git a/components/campaigns/AnnouncementBanner.tsx b/components/campaigns/AnnouncementBanner.tsx index dc595f415735..2f0da080d75b 100644 --- a/components/campaigns/AnnouncementBanner.tsx +++ b/components/campaigns/AnnouncementBanner.tsx @@ -48,7 +48,7 @@ export default function Banner({ }: BannerProps) { return (
)}
-
+
{banners.map( (banner, index) => banner.show && ( diff --git a/config/meetings.json b/config/meetings.json index 8636db46c06e..d17a57704fd9 100644 --- a/config/meetings.json +++ b/config/meetings.json @@ -213,5 +213,12 @@ "url": "https://github.com/asyncapi/community/issues/1212", "banner": "", "date": "2024-05-22T14:00:00.000Z" + }, + { + "title": "Developer Experience Working Group", + "calLink": "https://www.google.com/calendar/event?eid=ZWd1bWVrMjNrN3JoM3A3cXJndmZvNGFsdmsgY19xOXRzZWlnbG9tZHNqNm5qdWh2YnB0czExY0Bn", + "url": "https://github.com/asyncapi/community/issues/1220", + "banner": "", + "date": "2024-05-23T14:00:00.000Z" } ] \ No newline at end of file diff --git a/config/newsroom_videos.json b/config/newsroom_videos.json index ee79f1017941..52eefddc49ba 100644 --- a/config/newsroom_videos.json +++ b/config/newsroom_videos.json @@ -1,4 +1,16 @@ [ + { + "image_url": "https://i.ytimg.com/vi/K7fvKbOfqOg/hqdefault.jpg", + "title": "Developer Experience Working Group, 14:00 UTC Thursday May 23rd 2024", + "description": "Define our vision and plans https://github.com/asyncapi/community/issues/1220.", + "videoId": "K7fvKbOfqOg" + }, + { + "image_url": "https://i.ytimg.com/vi/94SSXX78VCU/hqdefault.jpg", + "title": "Essential Building Blocks Working Group, 18:00 UTC Tuesday May 14th 2024", + "description": "https://github.com/asyncapi/community/issues/1200.", + "videoId": "94SSXX78VCU" + }, { "image_url": "https://i.ytimg.com/vi/RijgS6y_JAo/hqdefault.jpg", "title": "Maintainers Growth Working Group, 14:00 UTC Wednesday May 8th 2024", @@ -16,17 +28,5 @@ "title": "Marketing - WG setup and hiring, 14:00 UTC Wednesday May 9th 2024", "description": "https://github.com/asyncapi/community/issues/1192.", "videoId": "eQed8AKDlsM" - }, - { - "image_url": "https://i.ytimg.com/vi/33uFRKeSSfM/hqdefault.jpg", - "title": "Community X Conference Meeting , Tuesday April 30th 2024", - "description": "https://github.com/asyncapi/community/issues/1184.", - "videoId": "33uFRKeSSfM" - }, - { - "image_url": "https://i.ytimg.com/vi/aJxXEF11r5s/hqdefault.jpg", - "title": "Marketing - Next steps, Thursday April 25th 2024", - "description": "https://github.com/asyncapi/community/issues/1175.", - "videoId": "aJxXEF11r5s" } ] \ No newline at end of file diff --git a/dashboard.json b/dashboard.json index be6636389902..dcfc4cd8c2f4 100644 --- a/dashboard.json +++ b/dashboard.json @@ -29,27 +29,7 @@ "resourcePath": "/asyncapi/community/pull/1013", "repo": "asyncapi/community", "labels": [], - "score": 23.26114168868996 - }, - { - "id": "I_kwDOBW5R_c5J6qNe", - "isPR": false, - "isAssigned": false, - "title": "Measuring AsyncAPI spec adoption", - "author": "derberg", - "resourcePath": "/asyncapi/website/issues/780", - "repo": "asyncapi/website", - "labels": [ - { - "name": "enhancement", - "color": "84b6eb" - }, - { - "name": "keep-open", - "color": "ffee84" - } - ], - "score": 22.112443333692923 + "score": 23.548316277439216 }, { "id": "PR_kwDOFLhIt85bqKL8", @@ -96,7 +76,18 @@ "color": "0e8a16" } ], - "score": 16.943300736206268 + "score": 17.517649913704783 + }, + { + "id": "I_kwDOCVQpZM5M_dcV", + "isPR": false, + "isAssigned": true, + "title": "DocsUI: Messages Object output", + "author": "mcturco", + "resourcePath": "/asyncapi/asyncapi-react/issues/618", + "repo": "asyncapi/asyncapi-react", + "labels": [], + "score": 17.230475324955524 }, { "id": "I_kwDOFLhIt84-OUI3", @@ -125,6 +116,17 @@ "labels": [], "score": 14.933078614961456 }, + { + "id": "PR_kwDOCoBobc5tRBZn", + "isPR": true, + "isAssigned": false, + "title": "chore: introduce the turborepo to the parser.js", + "author": "ayushnau", + "resourcePath": "/asyncapi/parser-js/pull/992", + "repo": "asyncapi/parser-js", + "labels": [], + "score": 14.358729437462937 + }, { "id": "I_kwDOFi_gUM5hpuWl", "isPR": false, @@ -149,17 +151,6 @@ ], "score": 13.78438025996442 }, - { - "id": "PR_kwDOCoBobc5tRBZn", - "isPR": true, - "isAssigned": false, - "title": "chore: introduce the turborepo to the parser.js", - "author": "ayushnau", - "resourcePath": "/asyncapi/parser-js/pull/992", - "repo": "asyncapi/parser-js", - "labels": [], - "score": 13.78438025996442 - }, { "id": "I_kwDODou01c5BZZv-", "isPR": false, @@ -226,7 +217,7 @@ { "id": "I_kwDOCxglSM6Bxg4I", "title": "Convert OpenAPI 3.0 to AsyncAPI 3.0", - "isAssigned": false, + "isAssigned": true, "resourcePath": "/asyncapi/converter-js/issues/233", "repo": "asyncapi/converter-js", "author": "jonaslagoni", @@ -465,6 +456,10 @@ { "name": "bug", "color": "d73a4a" + }, + { + "name": "keep-open", + "color": "fce14b" } ] }, diff --git a/markdown/docs/concepts/message.md b/markdown/docs/concepts/message.md index 12cdf528d1f3..e5e65e91fb0a 100644 --- a/markdown/docs/concepts/message.md +++ b/markdown/docs/concepts/message.md @@ -4,7 +4,7 @@ weight: 30 --- ## What is a message? -A `message` is a communication asset used to transmit or exchange information from a sender to the receiver through `channels`. A single `message` can be consumed by multiple independent receivers and can also be defined as an _event_ or _command_. The sender includes a payload of data that needs to be processed and serialized by the receiver into an appropriate format, e.g., JSON, XML, binary, etc. It may also include metadata, i.e., information that describes the message itself. This metadata is often known as _headers_ or _properties_. +A `message` is a communication asset used to transmit or exchange information from a sender to the receiver through `channels`. A single `message` can be consumed by multiple independent receivers and can also be defined as an _event_ or _command_. The sender includes a payload of data (that has been serialized into an appropriate format, e.g., JSON, XML, binary, etc.) that needs to be processed by the receiver. It may also include metadata; information that describes the message itself. This metadata is often known as _headers_ or _properties_. ``` mermaid diff --git a/markdown/docs/tools/cli/usage.md b/markdown/docs/tools/cli/usage.md index 6a2dd38e16e1..9f8800619e15 100644 --- a/markdown/docs/tools/cli/usage.md +++ b/markdown/docs/tools/cli/usage.md @@ -27,7 +27,7 @@ $ npm install -g @asyncapi/cli $ asyncapi COMMAND running command... $ asyncapi (--version) -@asyncapi/cli/1.14.2 linux-x64 node-v18.20.2 +@asyncapi/cli/1.15.2 linux-x64 node-v18.20.2 $ asyncapi --help [COMMAND] USAGE $ asyncapi COMMAND @@ -98,7 +98,7 @@ EXAMPLES $ asyncapi bundle ./asyncapi.yaml -o final-asyncapi.yaml --base ../public-api/main.yaml --baseDir ./social-media/comments-service ``` -_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/bundle.ts)_ +_See code: [src/commands/bundle.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/bundle.ts)_ ## `asyncapi config` @@ -112,7 +112,7 @@ DESCRIPTION CLI config settings ``` -_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/config/index.ts)_ +_See code: [src/commands/config/index.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/config/index.ts)_ ## `asyncapi config analytics` @@ -132,7 +132,7 @@ DESCRIPTION Enable or disable analytics for metrics collection ``` -_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/config/analytics.ts)_ +_See code: [src/commands/config/analytics.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/config/analytics.ts)_ ## `asyncapi config context` @@ -146,7 +146,7 @@ DESCRIPTION Manage short aliases for full paths to AsyncAPI documents ``` -_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/config/context/index.ts)_ +_See code: [src/commands/config/context/index.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/config/context/index.ts)_ ## `asyncapi config context add CONTEXT-NAME SPEC-FILE-PATH` @@ -168,7 +168,7 @@ DESCRIPTION Add a context to the store ``` -_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/config/context/add.ts)_ +_See code: [src/commands/config/context/add.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/config/context/add.ts)_ ## `asyncapi config context current` @@ -185,7 +185,7 @@ DESCRIPTION Shows the current context that is being used ``` -_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/config/context/current.ts)_ +_See code: [src/commands/config/context/current.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/config/context/current.ts)_ ## `asyncapi config context edit CONTEXT-NAME NEW-SPEC-FILE-PATH` @@ -206,7 +206,7 @@ DESCRIPTION Edit a context in the store ``` -_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/config/context/edit.ts)_ +_See code: [src/commands/config/context/edit.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/config/context/edit.ts)_ ## `asyncapi config context init [CONTEXT-FILE-PATH]` @@ -229,7 +229,7 @@ DESCRIPTION Initialize context ``` -_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/config/context/init.ts)_ +_See code: [src/commands/config/context/init.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/config/context/init.ts)_ ## `asyncapi config context list` @@ -246,7 +246,7 @@ DESCRIPTION List all the stored contexts in the store ``` -_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/config/context/list.ts)_ +_See code: [src/commands/config/context/list.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/config/context/list.ts)_ ## `asyncapi config context remove CONTEXT-NAME` @@ -266,7 +266,7 @@ DESCRIPTION Delete a context from the store ``` -_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/config/context/remove.ts)_ +_See code: [src/commands/config/context/remove.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/config/context/remove.ts)_ ## `asyncapi config context use CONTEXT-NAME` @@ -286,7 +286,7 @@ DESCRIPTION Set a context as current ``` -_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/config/context/use.ts)_ +_See code: [src/commands/config/context/use.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/config/context/use.ts)_ ## `asyncapi config versions` @@ -303,7 +303,7 @@ DESCRIPTION Show versions of AsyncAPI tools used ``` -_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/config/versions.ts)_ +_See code: [src/commands/config/versions.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/config/versions.ts)_ ## `asyncapi convert [SPEC-FILE]` @@ -325,7 +325,7 @@ DESCRIPTION Convert asyncapi documents older to newer versions ``` -_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/convert.ts)_ +_See code: [src/commands/convert.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/convert.ts)_ ## `asyncapi diff OLD NEW` @@ -365,7 +365,7 @@ DESCRIPTION Find diff between two asyncapi files ``` -_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/diff.ts)_ +_See code: [src/commands/diff.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/diff.ts)_ ## `asyncapi generate` @@ -379,7 +379,7 @@ DESCRIPTION Generate typed models or other things like clients, applications or docs using AsyncAPI Generator templates. ``` -_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/generate/index.ts)_ +_See code: [src/commands/generate/index.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/generate/index.ts)_ ## `asyncapi generate fromTemplate ASYNCAPI TEMPLATE` @@ -423,7 +423,7 @@ EXAMPLES $ asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template --param version=1.0.0 singleFile=true --output ./docs --force-write ``` -_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/generate/fromTemplate.ts)_ +_See code: [src/commands/generate/fromTemplate.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/generate/fromTemplate.ts)_ ## `asyncapi generate models LANGUAGE FILE` @@ -491,7 +491,7 @@ DESCRIPTION Generates typed models ``` -_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/generate/models.ts)_ +_See code: [src/commands/generate/models.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/generate/models.ts)_ ## `asyncapi new` @@ -548,7 +548,7 @@ EXAMPLES $ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode ``` -_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/new/index.ts)_ +_See code: [src/commands/new/index.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/new/index.ts)_ ## `asyncapi new file` @@ -605,7 +605,7 @@ EXAMPLES $ asyncapi new --file-name=my-asyncapi.yml --example=default-example.yml --no-tty - create a new file with a specific name, using one of the examples and without interactive mode ``` -_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/new/file.ts)_ +_See code: [src/commands/new/file.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/new/file.ts)_ ## `asyncapi new glee` @@ -627,7 +627,7 @@ DESCRIPTION Creates a new Glee project ``` -_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/new/glee.ts)_ +_See code: [src/commands/new/glee.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/new/glee.ts)_ ## `asyncapi optimize [SPEC-FILE]` @@ -665,7 +665,7 @@ EXAMPLES $ asyncapi optimize ./asyncapi.yaml --optimization=remove-components --output=terminal --no-tty ``` -_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/optimize.ts)_ +_See code: [src/commands/optimize.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/optimize.ts)_ ## `asyncapi start` @@ -679,7 +679,7 @@ DESCRIPTION Start asyncapi studio ``` -_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/start/index.ts)_ +_See code: [src/commands/start/index.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/start/index.ts)_ ## `asyncapi start studio` @@ -698,7 +698,7 @@ DESCRIPTION starts a new local instance of Studio ``` -_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/start/studio.ts)_ +_See code: [src/commands/start/studio.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/start/studio.ts)_ ## `asyncapi validate [SPEC-FILE]` @@ -726,5 +726,5 @@ DESCRIPTION validate asyncapi file ``` -_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v1.14.2/src/commands/validate.ts)_ +_See code: [src/commands/validate.ts](https://github.com/asyncapi/cli/blob/v1.15.2/src/commands/validate.ts)_ diff --git a/markdown/docs/tools/generator/index.md b/markdown/docs/tools/generator/index.md index 147e566b3189..a80e0253162c 100644 --- a/markdown/docs/tools/generator/index.md +++ b/markdown/docs/tools/generator/index.md @@ -24,7 +24,7 @@ The AsyncAPI generator is a tool that generates anything you want using the **[A 3. The **Parser** uses additional plugins such as the OpenAPI, RAML, or Avro schemas to validate custom schemas of message payloads defined in the **AsyncAPI Document**. 4. If the **Parser** determines that the original **AsyncAPI Document** is valid, it manipulates the document and returns a set of helper functions and properties and bundles them together into an **asyncapi** variable that is an instance of [**AsyncAPIDocument**](https://github.com/asyncapi/parser-api/blob/master/docs/api.md#asyncapidocument). The **asyncapi** helper functions make it easier to access the contents of the AsyncAPI Document. 5. At this point, the **Generator** passes the **[asyncapi](generator/asyncapi-document#method-2-asyncapi-and-template)**, the **[originalAsyncAPI](generator/asyncapi-document#method-1-originalasyncapi-and-template)**, and the **params** which collectively make up the **[Template Context](generator/template-context)** to the **Render Engine**. -6. AsyncAPI has two **Render Engines**([react](generator/react-render-engine) and [nunjucks](generator/nunjucks-render-engine). Depending on which one you've specified in your `package.json`, the **Generator** knows the right **Render Engine** to pass both the **Template Files** and the **Template Context**. +6. AsyncAPI has two **Render Engines**([react](generator/react-render-engine) and [nunjucks](generator/nunjucks-render-engine)). Depending on which one you've specified in your `package.json`, the **Generator** knows the right **Render Engine** to pass both the **Template Files** and the **Template Context**. 7. Once the **Render Engine** receives the **Template Files** and the **Template Context**, it injects all the dynamic values in your react or nunjucks based **Template Files** using the **Template Context**. As a result, the **Render Engine** generates **markdown**, **pdf**, **boilerplate code**, and **anything else** you specified to be generated as output. > You can generate anything you want using the generator as long as it can be defined in a **Template**. diff --git a/markdown/docs/tutorials/websocket/index.md b/markdown/docs/tutorials/websocket/index.md index ca3ac0363bc3..c508d329506e 100644 --- a/markdown/docs/tutorials/websocket/index.md +++ b/markdown/docs/tutorials/websocket/index.md @@ -264,31 +264,31 @@ components: summary: Action triggered when a successful WebSocket connection is established payload: $ref: '#/components/schemas/hello' -schemas: - hello: - type: object - properties: - type: - type: string - description: A hello string confirming WebSocket connection - connection_info: - type: object - properties: - app_id: - type: string - num_connections: - type: integer - debug_info: - type: object - properties: - host: - type: string - started: - type: string - build_number: - type: integer - approximate_connection_time: - type: integer + schemas: + hello: + type: object + properties: + type: + type: string + description: A hello string confirming WebSocket connection + connection_info: + type: object + properties: + app_id: + type: string + num_connections: + type: integer + debug_info: + type: object + properties: + host: + type: string + started: + type: string + build_number: + type: integer + approximate_connection_time: + type: integer reaction: type: object properties: