Skip to content

Commit

Permalink
Merge branch 'master' into docs-q4-report
Browse files Browse the repository at this point in the history
  • Loading branch information
@quetzalliwrites
quetzalliwrites authored Jan 23, 2024
2 parents 636d796 + 83c1916 commit 619b59b
Show file tree
Hide file tree
Showing 4 changed files with 98 additions and 69 deletions.
7 changes: 7 additions & 0 deletions config/meetings.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,12 @@
"url": "https://github.com/asyncapi/community/issues/1016",
"banner": "https://user-images.githubusercontent.com/40604284/297103292-e05b8e50-1203-4452-8b2d-0983a48a7925.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MDU0MTkwMzksIm5iZiI6MTcwNTQxODczOSwicGF0aCI6Ii80MDYwNDI4NC8yOTcxMDMyOTItZTA1YjhlNTAtMTIwMy00NDUyLThiMmQtMDk4M2E0OGE3OTI1LnBuZz9YLUFtei1BbGdvcml0aG09QVdTNC1ITUFDLVNIQTI1NiZYLUFtei1DcmVkZW50aWFsPUFLSUFWQ09EWUxTQTUzUFFLNFpBJTJGMjAyNDAxMTYlMkZ1cy1lYXN0LTElMkZzMyUyRmF3czRfcmVxdWVzdCZYLUFtei1EYXRlPTIwMjQwMTE2VDE1MjUzOVomWC1BbXotRXhwaXJlcz0zMDAmWC1BbXotU2lnbmF0dXJlPWFjY2EzYzg2NjNmNTQxOWQxODUxYWMxODlhZWVjNzkwYWRlOWQ5ODkxOTQ4NDhkYWFjNjZjOGU1YTcwMzhhMDYmWC1BbXotU2lnbmVkSGVhZGVycz1ob3N0JmFjdG9yX2lkPTAma2V5X2lkPTAmcmVwb19pZD0wIn0.hs63wNh2t8iH1xayTqIFvprHHa2Z--RfIA9k3q2lD4Y",
"date": "2024-01-23T16:00:00.000Z"
},
{
"title": "AsyncAPI v3 retrospective",
"calLink": "https://www.google.com/calendar/event?eid=ZnNjNTllMW9ydGIwOHEzZTYxY3NncHRyZzQgY19xOXRzZWlnbG9tZHNqNm5qdWh2YnB0czExY0Bn",
"url": "https://github.com/asyncapi/community/issues/1019",
"banner": "",
"date": "2024-02-08T15:00:00.000Z"
}
]
22 changes: 11 additions & 11 deletions config/tools-automated.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -635,15 +635,15 @@
"description": "The following is a list of templates compatible with AsyncAPI Generator. You can use them to generate apps, clients or documentation from your AsyncAPI documents.",
"toolsList": [
{
"title": "HTML Template",
"description": "HTML template for AsyncAPI Generator. Use it to generate a static docs. It is using AsyncAPI React component under the hood.",
"title": "Node.js Multiprotocol Template",
"description": "This template generates a server using your AsyncAPI document. It supports multiple different protocols, like Kafka or MQTT. It is designed in the way that generated code is a library and with it's API you can start the server, send messages or register a middleware for listening incoming messages. Runtime message validation included.",
"links": {
"repoUrl": "https://github.com/asyncapi/html-template"
"repoUrl": "https://github.com/asyncapi/nodejs-template"
},
"filters": {
"language": "javascript",
"technology": [
"HTML"
"Node.js"
],
"categories": [
"generator-template"
Expand All @@ -653,10 +653,10 @@
}
},
{
"title": "Node.js Multiprotocol Template",
"description": "This template generates a server using your AsyncAPI document. It supports multiple different protocols, like Kafka or MQTT. It is designed in the way that generated code is a library and with it's API you can start the server, send messages or register a middleware for listening incoming messages. Runtime message validation included.",
"title": "Node.js Websockets Template",
"description": "Node.js WebSockets template for the AsyncAPI Generator. It showcases how from a single AsyncAPI document you can generate a server and a client at the same time.",
"links": {
"repoUrl": "https://github.com/asyncapi/nodejs-template"
"repoUrl": "https://github.com/asyncapi/nodejs-ws-template"
},
"filters": {
"language": "javascript",
Expand All @@ -671,15 +671,15 @@
}
},
{
"title": "Node.js Websockets Template",
"description": "Node.js WebSockets template for the AsyncAPI Generator. It showcases how from a single AsyncAPI document you can generate a server and a client at the same time.",
"title": "HTML Template",
"description": "HTML template for AsyncAPI Generator. Use it to generate a static docs. It is using AsyncAPI React component under the hood.",
"links": {
"repoUrl": "https://github.com/asyncapi/nodejs-ws-template"
"repoUrl": "https://github.com/asyncapi/html-template"
},
"filters": {
"language": "javascript",
"technology": [
"Node.js"
"HTML"
],
"categories": [
"generator-template"
Expand Down
132 changes: 77 additions & 55 deletions dashboard.json
View file
Original file line number Diff line number Diff line change
@@ -1,35 +1,24 @@
{
"hotDiscussions": [
{
"id": "PR_kwDOCHlHJM5ezPwM",
"isPR": true,
"isAssigned": false,
"title": "feat: allow generator to pull from private npm repo",
"author": "AayushSaini101",
"resourcePath": "/asyncapi/generator/pull/1061",
"repo": "asyncapi/generator",
"labels": [],
"score": 29.578982641173653
},
{
"id": "I_kwDOBW5R_c5J6qNe",
"id": "I_kwDODou01c5AqLB8",
"isPR": false,
"isAssigned": false,
"title": "Measuring AsyncAPI spec adoption",
"author": "derberg",
"resourcePath": "/asyncapi/website/issues/780",
"repo": "asyncapi/website",
"title": "\"Open with Studio\" button for Markdown files.",
"author": "smoya",
"resourcePath": "/asyncapi/studio/issues/218",
"repo": "asyncapi/studio",
"labels": [
{
"name": "enhancement",
"color": "84b6eb"
"color": "a2eeef"
},
{
"name": "stale",
"color": "ededed"
"name": "keep-open",
"color": "f9dd4b"
}
],
"score": 19.815046623698855
"score": 19.527872034949596
},
{
"id": "PR_kwDOFLhIt85bqKL8",
Expand Down Expand Up @@ -62,13 +51,9 @@
{
"name": "level/medium",
"color": "0e8a16"
},
{
"name": "bounty/2023-Q4",
"color": "0e8a16"
}
],
"score": 17.230475324955524
"score": 17.804824502454043
},
{
"id": "PR_kwDOFDnrNc5f0Nm0",
Expand All @@ -79,7 +64,34 @@
"resourcePath": "/asyncapi/cli/pull/890",
"repo": "asyncapi/cli",
"labels": [],
"score": 15.794602381209232
"score": 16.943300736206268
},
{
"id": "I_kwDODou01c5E_LV0",
"isPR": false,
"isAssigned": false,
"title": "Create onboarding for features of Studio",
"author": "mcturco",
"resourcePath": "/asyncapi/studio/issues/284",
"repo": "asyncapi/studio",
"labels": [
{
"name": "enhancement",
"color": "a2eeef"
}
],
"score": 16.08177696995849
},
{
"id": "PR_kwDOBW5R_c5fTNfJ",
"isPR": true,
"isAssigned": false,
"title": "feat: add Mailchimp integration using netlify function",
"author": "akshatnema",
"resourcePath": "/asyncapi/website/pull/2315",
"repo": "asyncapi/website",
"labels": [],
"score": 15.220253203710714
},
{
"id": "I_kwDOFDnrNc5rjrK-",
Expand Down Expand Up @@ -120,17 +132,6 @@
"labels": [],
"score": 14.933078614961456
},
{
"id": "PR_kwDOBW5R_c5fTNfJ",
"isPR": true,
"isAssigned": false,
"title": "feat: add Mailchimp integration using netlify function",
"author": "akshatnema",
"resourcePath": "/asyncapi/website/pull/2315",
"repo": "asyncapi/website",
"labels": [],
"score": 14.645904026212197
},
{
"id": "PR_kwDOBW5R_c5fbyLb",
"isPR": true,
Expand All @@ -153,6 +154,17 @@
"labels": [],
"score": 14.07155484871368
},
{
"id": "PR_kwDOBW5R_c5jw3SL",
"isPR": true,
"isAssigned": true,
"title": "chore(blog): annual review",
"author": "thulieblack",
"resourcePath": "/asyncapi/website/pull/2549",
"repo": "asyncapi/website",
"labels": [],
"score": 13.78438025996442
},
{
"id": "PR_kwDOBW5R_c5dT1NT",
"isPR": true,
Expand All @@ -163,33 +175,43 @@
"repo": "asyncapi/website",
"labels": [],
"score": 13.78438025996442
},
}
],
"goodFirstIssues": [
{
"id": "I_kwDOFi_gUM5hpuWl",
"isPR": false,
"isAssigned": true,
"title": "Improve kafka adapter",
"author": "KhudaDad414",
"resourcePath": "/asyncapi/glee/issues/411",
"repo": "asyncapi/glee",
"id": "I_kwDOE8Qh3858hQCM",
"title": "Add OpenAPI 3.1 support",
"isAssigned": false,
"resourcePath": "/asyncapi/modelina/issues/1749",
"repo": "asyncapi/modelina",
"author": "jonaslagoni",
"area": "typescript",
"labels": [
{
"name": "enhancement",
"color": "a2eeef"
},
{
"name": "good first issue",
"color": "7057ff"
},
"name": "openapi",
"color": "960C58"
}
]
},
{
"id": "I_kwDOCVQpZM58chHc",
"title": "Workflows failing because of some leftovers scripts",
"isAssigned": false,
"resourcePath": "/asyncapi/asyncapi-react/issues/888",
"repo": "asyncapi/asyncapi-react",
"author": "derberg",
"area": "Unknown",
"labels": [
{
"name": "area/typescript",
"color": "007acc"
"name": "bug",
"color": "d73a4a"
}
],
"score": 13.210031082465903
}
],
"goodFirstIssues": [
]
},
{
"id": "I_kwDOE8Qh38572qE9",
"title": "Add runtime tests for Python",
Expand Down
6 changes: 3 additions & 3 deletions pages/docs/tutorials/getting-started/coming-from-openapi.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ title: "Coming from OpenAPI"
weight: 20
---

If you're coming from OpenAPI, you must know that AsyncAPI [started as an adaptation of the OpenAPI specification](https://medium.com/asyncapi/whats-new-on-asyncapi-lots-2d9019a1869d). AsyncAPI wanted to be as compatible as possible with OpenAPI so that users could reuse parts in both.
If you're coming from OpenAPI, you must know that AsyncAPI [started as an adaptation of the OpenAPI specification](https://medium.com/asyncapi/whats-new-on-asyncapi-lots-2d9019a1869d). AsyncAPI wanted to be as compatible as possible with OpenAPI so that the users could reuse parts in both.

Before AsyncAPI `3.0.0`, you could find many similarities between OpenAPI and AsyncAPI. Remember that in the world of event-driven architectures, you have more than one protocol; therefore, some things are different. Check out the following comparison chart, inspired by [Darrel Miller's blog post](https://www.openapis.org/news/blogs/2016/10/tdc-structural-improvements-explaining-30-spec-part-2):
Before AsyncAPI `3.0.0`, you could find many similarities between OpenAPI and AsyncAPI. Remember that in the world of Event-Driven Architectures, you have more than one protocol; therefore, some things are different. Check out the following comparison chart, inspired by [Darrel Miller's blog post](https://www.openapis.org/news/blogs/2016/10/tdc-structural-improvements-explaining-30-spec-part-2):

import OpenAPIComparison from '../../../../components/OpenAPIComparison'

Expand All @@ -20,7 +20,7 @@ import OpenAPIComparisonV3 from '../../../../components/OpenAPIComparisonV3'
Aside from structural differences, you should know:

1. AsyncAPI is compatible with OpenAPI schemas.
1. The message payload in AsyncAPI can be any value, not just an AsyncAPI/OpenAPI schema. For instance, it could be an Avro schema.
1. The message payload in AsyncAPI can be any value, not just an AsyncAPI/OpenAPI schema. For instance, it could be an [Avro](https://avro.apache.org/) schema.
1. The [AsyncAPI server object](/docs/specifications/2.2.0/#serverObject) is almost identical to its OpenAPI counterpart, with the exception that `scheme` has been renamed to `protocol` and AsyncAPI introduces a new property called `protocolVersion`. AsyncAPI supports multiple protocols, not only HTTP, like in the case of OpenAPI.
1. OpenAPI path parameters and [AsyncAPI channel parameters](/docs/specifications/2.2.0/#parameterObject) are a bit different since AsyncAPI doesn't have the notion of "query" and "cookie", and header parameters can be defined in the [message object](/docs/specifications/2.2.0/#messageObject). Therefore, AsyncAPI channel parameters are the equivalent of OpenAPI path parameters.

Expand Down

0 comments on commit 619b59b

Please sign in to comment.