docs: update examples to be written by human not converter #977
Conversation
| @@ -148,7 +148,15 @@ components: | |||
| description: Stands for "Gravatar version" and is used for cache busting. | |||
| bindings: | |||
| http: | |||
| $ref: '#/components/messageBindings/streamingHeaders' | |||
| headers: | |||
There was a problem hiding this comment.
$ref no supported in http header
| @@ -159,10 +167,12 @@ components: | |||
| - "\r\n" | |||
| bindings: | |||
| http: | |||
| $ref: '#/components/messageBindings/streamingHeaders' | |||
There was a problem hiding this comment.
ref not supported in header + it must be a json schema
| @@ -28,15 +28,8 @@ operations: | |||
| - 'subscribe:auth_revocations' | |||
| bindings: | |||
| http: | |||
| type: request | |||
There was a problem hiding this comment.
not supported in operation anymore, same headers
| @@ -48,6 +41,10 @@ components: | |||
| X-SIGNATURE: | |||
| description: ECC message signature | |||
| type: string | |||
| Content-Type: | |||
There was a problem hiding this comment.
header can be normally a part of the message
| requestSum.message: | ||
| bindings: | ||
| amqp: | ||
| replyTo: |
There was a problem hiding this comment.
not supported by binding
| sum.message: | ||
| bindings: | ||
| amqp: | ||
| replyTo: |
There was a problem hiding this comment.
not supported by binding
| $ref: '#/components/messages/book' | ||
| description: >- | ||
| Every time a resource of type `http://schema.org/Book` is created or | ||
| modified, a JSON-LD representation of the new version of this resource | ||
| must be pushed in this Mercure topic. | ||
| parameters: | ||
| id: {} | ||
| id: |
There was a problem hiding this comment.
this one was converted correct, as type was integer and no more info, even description provided, so result is basically an empty id parameter. But yeah, for best practice better share that description is a minimum
|
Kudos, SonarCloud Quality Gate passed!
|
| commentId: {} | ||
| update/comment/likes: | ||
| commentId: | ||
| $ref: '../common/parameters.yaml#/commentId' |
There was a problem hiding this comment.
since it is no longer schema it is better to promote also a separate file per parameters
derberg
requested review from
fmvilas,
dalelane,
smoya,
char0n and
asyncapi-bot-eve
as code owners
|
/rtm |
asyncapi-bot
merged commit cc109fe
into
asyncapi:next-major-spec
|
🎉 This PR is included in version 3.0.0-next-major-spec.15 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
addresswould bring confusion and suggest bad practiceWhat I did not do
So social media example could be modified further imho. It was limited by v2 and could not show sharing of channels and operations. Now I think it should be refactored to do so too. Wdyt?