Skip to content
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

Is it possible that the plugin can handle $ref with external files? #48

Closed
hartmanjan1970 opened this issue Feb 21, 2024 · 13 comments · Fixed by #104
Closed

Is it possible that the plugin can handle $ref with external files? #48

hartmanjan1970 opened this issue Feb 21, 2024 · 13 comments · Fixed by #104
Assignees
Labels
enhancement New feature or request

Comments

@hartmanjan1970
Copy link

The plugin is not able to handle $ref with an external file.
if i have the following include file MyPayloadThing.yml

      payload:
         $ref: "./schema/MyPayloadThing.yml"

The preview can not render the file, while the content is correct refering to the included file.

Is this a feature that could be added, would be very nice.
Thanks

@hartmanjan1970 hartmanjan1970 added the enhancement New feature or request label Feb 21, 2024
Copy link

Welcome to AsyncAPI. Thanks a lot for reporting your first issue. Please check out our contributors guide and the instructions about a basic recommended setup 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.

@Pakisan
Copy link
Member

Pakisan commented Feb 21, 2024

@hartmanjan1970 Hi!

Can you show me your preview? I think that you are viewing your specification trough buggy IDEA preview, instead of my plugin

https://youtrack.jetbrains.com/issue/IDEA-331646/AsyncAPI-Preview-panel-cant-render-references-outside-given-specification

@theschles
Copy link
Member

@hartmanjan1970 Hi!

Can you show me your preview? I think that you are viewing your specification trough buggy IDEA preview, instead of my plugin

https://youtrack.jetbrains.com/issue/IDEA-331646/AsyncAPI-Preview-panel-cant-render-references-outside-given-specification

Hi @hartmanjan1970 I'm a maintainer and the same thing happened to me when IntelliJ added a built-in preview O_o

You have to make sure you're using the plugin's preview feature...not IntelliJ's built-in preview feature.

@hartmanjan1970
Copy link
Author

hartmanjan1970 commented Feb 21, 2024

I have no other preview than in the following screenshot (here is the include commented out)
Screenshot from 2024-02-21 19-16-03

Here screenshot with the include in intellij:
Screenshot from 2024-02-21 19-17-00

In intellij i don't have any preview settings i can set for AsyncApi for as far i can find.
AsyncApi version: 2.4.0+jre17
IntelliJ IDEA 2023.3.3 (Ultimate Edition) Build #IU-233.14015.106, built on January 25, 2024

@Pakisan
Copy link
Member

Pakisan commented Feb 21, 2024

I have no other preview than in the following screenshot (here is the include commented out) Screenshot from 2024-02-21 19-16-03

Here screenshot with the include in intellij: Screenshot from 2024-02-21 19-17-00

In intellij i don't have any preview settings i can set for AsyncApi for as far i can find.

Yep, left one is preview introduced in 2023.2* and it's buggy

On a right top corner must be panel with preview inside idea, you must click it and receive same page, but with white theme

@Pakisan
Copy link
Member

Pakisan commented Feb 21, 2024

image image

@hartmanjan1970
Copy link
Author

hartmanjan1970 commented Feb 21, 2024

If i take a simple example i get a preview, but it goes to white when i add some stuff. And the build-in preview gives up before the editor preview gives up.
But apparently it is in my asyncapi definition file.

mmm will check my asyncapi file.
Thanks

@Pakisan
Copy link
Member

Pakisan commented Feb 21, 2024

If i take a simple example i get a preview, but it goes to white when i add some stuff. And the build-in preview gives up before the editor preview gives up.

But apparently it is in my asyncapi definition file.

mmm will check my asyncapi file.

Thanks

Will check it out. It may be bug in react component, which renders specification in preview

You can check for errors in our studio

@Pakisan Pakisan self-assigned this Feb 21, 2024
@theschles
Copy link
Member

@hartmanjan1970 out of curiosity, did the above discussion help you? Would it be ok if we close this issue?

@hartmanjan1970
Copy link
Author

Yes, the discussion helped me with my definition of the AsyncApi contracts.
thanks for the input gents

Now up to our next problem that is generation of Java code from the contract....
this is not yet successfull

@theschles
Copy link
Member

Good luck to you with ironing out the Java code generation! Closing this issue as there doesn't appear to be an issue with the plugin's code.

@Pakisan
Copy link
Member

Pakisan commented Aug 28, 2024

@hartmanjan1970

fyi: #101

@Pakisan
Copy link
Member

Pakisan commented Sep 3, 2024

@hartmanjan1970 hi! New version is available

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants