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

Hidden section still appears in sidebar #905

Closed
rijenkii opened this issue Feb 3, 2024 · 8 comments · Fixed by #1038
Closed

Hidden section still appears in sidebar #905

rijenkii opened this issue Feb 3, 2024 · 8 comments · Fixed by #1038
Labels

Comments

@rijenkii
Copy link

rijenkii commented Feb 3, 2024

Description

When hiding a section in configuration, links to the section and its children remain in the sidebar.

Steps to reproduce

Paste the following into the playground:

Schema
{
  "asyncapi": "3.0.0",
  "info": {
    "title": "Reproduction",
    "version": "1.0.0"
  },
  "operations": {
    "test": {
      "action": "receive",
      "channel": { "$ref": "#/channels/test" }
    }
  },
  "channels": {
    "test": {
      "address": "/test",
      "messages": {
        "test": { "$ref": "#/components/messages/test" }
      }
    }
  },
  "components": {
    "messages": {
      "test": {
        "payload": {
          "type": "object",
          "properties": {
            "test": {
              "description": "test",
              "type": "string",
              "pattern": "^(?:helloworld)+$"
            }
          },
          "required": ["test"]
        }
      }
    }
  }
}
Configuration
{
  "show": {
    "sidebar": true,
    "info": true,
    "operations": true,
    "servers": true,
    "messages": false,
    "schemas": true,
    "errors": true
  },
  "expand":{
    "messageExamples": false
  },
  "sidebar": {
    "showServers": "byDefault",
    "showOperations": "byDefault"
  }
}

Expected result

Section "messages" to be removed from the page and from the sidebar.

Actual result

Section "messages" is removed from the page, but not from the sidebar.

Troubleshooting

N/A

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
@gcx-seb
Copy link

gcx-seb commented Aug 6, 2024

Ran into this today, too

@AceTheCreator
Copy link
Member

I'd look into this

@asyncapi-bot
Copy link
Contributor

🎉 This issue has been resolved in version 2.2.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@gcx-seb
Copy link

gcx-seb commented Aug 26, 2024

I see it's now working in the playground.

But on CLI I'm still running into this 🤔

$ asyncapi --version          
@asyncapi/cli/2.3.2 linux-x64 node-v20.17.0

$ asyncapi generate fromTemplate asyncapi.yaml \
        @asyncapi/html-template \
        --param \
        singleFile=true \
        config='{"show":{"messages":false},"expand":{"messageExamples":true},"sidebar":{"showOperations":"byOperationsTags"}}' \
        --output example

Any ideas?

Edit: ah, looks like html-template still needs an update

@rsulzenbacher
Copy link

Hi! Same issue here. In playground everything is looking good, but on CLI (generator) not.
Is there any solution? Or how can I regenerate/update html-template myself?

@gcx-seb
Copy link

gcx-seb commented Sep 10, 2024

Yeah I think the issue is that @asyncapi/html-template depends on an older version of @asyncapi/react-component (^1.2.13), see https://github.com/asyncapi/html-template/blob/v2.3.13/package.json#L43

Not sure if it would be easily possible to upgrade from major version 1 to 2 🤷

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

Successfully merging a pull request may close this issue.

5 participants