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

Siblings of $ref are ignored #904

Open
rijenkii opened this issue Feb 3, 2024 · 4 comments
Open

Siblings of $ref are ignored #904

rijenkii opened this issue Feb 3, 2024 · 4 comments

Comments

@rijenkii
Copy link

rijenkii commented Feb 3, 2024

Description

In JSON Schema draft 2019-09 $refs are allowed to have siblings: https://json-schema.org/draft/2019-09/release-notes#keyword-changes.
asyncapi-react does not seem to support this, and does not use any properties defined alongside $ref.

Steps to reproduce

Paste the following schema into the playground:

Reproduction
{
  "asyncapi": "3.0.0",
  "info": {
    "title": "Reproduction",
    "version": "1.0.0"
  },
  "components": {
    "schemas": {
      "test": {
        "type": "string",
        "pattern": "^(?:helloworld)+$"
      },
    },
    "messages": {
      "test": {
        "payload": {
          "type": "object",
          "properties": {
            "test": {
              "description": "test",
              "$ref": "#/components/schemas/test"
            },
          },
          "required": ["test"]
        },
      },
    },
  }
}

Expected result

Property test of message test to have a description "test".

Actual result

Property test of message test does not have any description.

Troubleshooting

N/A

Copy link

github-actions bot commented Feb 3, 2024

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.

@jonaslagoni
Copy link
Sponsor Member

Definitely a problem yea, problem is we have no better referencing tool right now we can use, and the short coming of the current one is not being context dependent in its behavior i.e. switch behaviour for newer JSON Schema versions...

So yea, right now this is not something that can be fixed right away 🤔

Copy link

github-actions bot commented Jun 3, 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 3, 2024
@rijenkii
Copy link
Author

rijenkii commented Jun 3, 2024

Still an issue.

@github-actions github-actions bot removed the stale label Jun 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants