-
-
Notifications
You must be signed in to change notification settings - Fork 9
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
refactor: update API according to latest changes #54
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This solves a lot of my doubts about the server object ❤️
Thanks! 🎉 I decided to move into this task because of that reason in particular. Anyway, this API can contain errors so we should be able to detect them as soon as possible, that's why we are prioritizing implementation time over design time. |
@magicmatatjahu @jonaslagoni anything you see potentially wrong? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Think there are some leftovers 🙂 Might be intentional 🤔?
- servers() : `Server[]` | ||
- summary() : `string` | `undefined` | ||
- tags() : `Tag[]` | ||
- tags() : `Tags` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure you are consistent either use a wrapper object or a simple array, don't use both IMO. I.e. we use channel[]
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed. Good catch.
docs/v1.md
Outdated
## Message | ||
- binding(bindingProtocol) : `any` | `undefined` | ||
- bindingProtocol : `enum{'amqp', 'amqps', 'http', 'https', 'jms', 'kafka', 'kafka-secure', 'mqtt', 'secure-mqtt', 'stomp', 'stomps', 'ws', 'wss'}` | ||
- bindings() : `Bindings` | ||
- channels() : `Channel[]` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this left over?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed. Good catch.
docs/v1.md
Outdated
- hasTitle() : `boolean` | ||
- headers() : `Schema` | `undefined` | ||
- id() : `string` | ||
- name() : `string` | `undefined` | ||
- operations() : `Operation[]` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same here? 🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed. Good catch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
Should I.e. What do you think @magicmatatjahu @jonaslagoni @Souvikns ? |
I would not focus on creating the intents for JSON Schema, and keep it |
We can always change it before releasing the final API anyway so 👍 for it |
/rtm |
I see I didn't comment in time 😄 But I agree with Jonas, Schema Object should work in a recursive way. |
🎉 This PR is included in version 1.0.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Description
Part of #53
This PR updates the current API with the latest changes applied in https://github.com/asyncapi/parser-js/tree/next-major and in asyncapi/parser-js#496.
I hope did not miss any other change 😅 .
cc @magicmatatjahu @Souvikns
Related issue(s)
#53