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.

Sign up for GitHub

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

Jump to bottom

Errors will not be displayed with StandAlone component #794

Open
GreenRover opened this issue Oct 2, 2023 · 4 comments
Open

Errors will not be displayed with StandAlone component #794

GreenRover opened this issue Oct 2, 2023 · 4 comments
Labels
stale

Comments

@GreenRover
Copy link
Contributor

Description

When using the standalone component, schema errors will not be displayed

Expected result

Any kind of possibility to show a reason to the user why this schema could not be rendered.

Actual result

A white screen.

Steps to reproduce

Create a file: library/e2e/sites/standalone-with-invalid-schema.html
having content:

<html>
  <body>
    <div id="spec"></div>

    <script src="../../browser/standalone/index.js"></script>
    <link rel="stylesheet" href="../../styles/default.min.css" />

    <script>
      const schema = {
        "asyncapi": "2.6.0",
        "info": {
          "title": "runtime-v2-prod",
          "version": "1.3.3.7"
        },
        "defaultContentType": "application/json",
        "channels": {
          "tms/capacityplanner/trip/p/v2/paths/find/in": {
            "publish": {
              "message": {
                "$ref": "#/components/messages/TodoReplaceMeSometimePleaseMessage"
              }
            }
          },
          "tms/capacityplanner/trip/p/v2/paths/find/out/>": {
            "subscribe": {
              "message": {
                "$ref": "#/components/messages/TodoReplaceMeSometimePleaseMessage"
              }
            }
          }
        },
        "components": {
          "messages": {
            "TodoReplaceMeSometimePleaseMessage": {
              "description": "This is a place holder. Will be replaced with a real schema in the future.\n",
              "contentType": "application/json",
              "traits": [
                {
                  "$ref": "#/components/messageTraits/replyHeadersRemoteFixed"
                }
              ],
              "payload": {
                "$ref": "#/components/schemas/TodoReplaceMeSometimePleasePayload"
              }
            }
          },
          "messageTraits": {
            "replyHeadersRemoteFixed": {
              "headers": {
                "type": "object",
                "properties": {
                  "replyTo": {
                    "type": "string",
                    "description": "destination the ServiceDesc needs to be replied to"
                  }
                }
              }
            },
            "replyHeadersLocalOptional": {
              "headers": {
                "type": "object",
                "properties": {
                  "replyTo": {
                    "type": "string",
                    "description": "Add the replyTo header if you wand status reports to be sent back. You are advised to at least log those msgs."
                  }
                }
              }
            }
          },
          "schemas": {
            "TodoReplaceMeSometimePleasePayload": {
              "type": "object"
            }
          }
        }
      };
      const config = {
        show: {
          sidebar: true,
          errors: true,
        },
        parserOptions: {
          validateOptions: {
            allowedSeverity: {
              error: false,
              warning: true,
              info: true,
              hint: true,
            },
          },
        },
      };
      AsyncApiStandalone.render({ schema, config }, document.getElementById('spec'));
    </script>
  </body>
</html>

open it in browser and your will see a white page.
@github-actions
Copy link

github-actions bot commented Oct 2, 2023

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.

@github-actions GitHub Actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Jan 31, 2024
@GreenRover
Copy link
Contributor Author

bug still exists an needs to be fixed

@github-actions github-actions bot removed the stale label Feb 1, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Jun 1, 2024

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions bot added the stale label Jun 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
stale
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@GreenRover