allow using operation id as header id

[ashercoren]

Useful for single page with sidebar

Description

When using the OASpec component to render all operations in a single page layout, and also using useSidebar to automatically generate sidebar items, the sidebar links are not aligned with the OASpec headers. This PR adds a prop to OASpec to support using the operation id as the header id

Types of changes

• New feature (non-breaking change which adds functionality)

[vercel[bot]]

Someone is attempting to deploy a commit to the Enzo Notario's projects Team on Vercel.

A member of the Team first needs to authorize it.

[coderabbitai[bot]]

Walkthrough

The changes in this pull request introduce new properties to the OAHeading, OAOperation, and OASpec components. Specifically, headerId is added to OAHeading, while operationIdAsHeaderId is introduced in both OAOperation and OASpec. These properties modify how IDs are computed and passed between components, allowing for more dynamic header management. The overall structure and functionality of the components remain intact, with enhancements made to accommodate the new properties.

Changes

File Path	Change Summary
src/components/Common/OAHeading.vue	Added headerId property of type String with a default value of null. Modified computed id to utilize headerId.
src/components/Common/OAOperation.vue	Added operationIdAsHeaderId property of type Boolean with a default value of false. Updated computed headerId to conditionally return operationId. Updated OAHeading binding to use the new headerId.
src/components/Common/OASpec.vue	Added operationIdAsHeaderId property of type Boolean with a default value of false. Modified rendering logic to pass this prop to OAOperation.

Sequence Diagram(s)

sequenceDiagram
    participant OASpec
    participant OAOperation
    participant OAHeading

    OASpec->>OAOperation: Pass operationIdAsHeaderId
    OAOperation->>OAHeading: Set headerId based on operationIdAsHeaderId
    OAHeading->>OAHeading: Compute id using headerId or fallback

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

[enzonotario]

Hi @ashercoren , why did you closed this? I'd be happy to support this if needed.

I just don't understand if you refer to the Left Sidebar, or Right Sidebar (for example in https://vitepress-openapi.vercel.app/example/one-page.html#getalldata-get-all-planets).

If you refer to Right Sidebar, I think it's working fine (as shown in the example).

[enzonotario]

Hi @ashercoren , I think you were trying to fix #76 ? I experimented this issue while working with internal URLs. It was calculating the wrong id. Now it should works fine. In a future, we can even support multiple "id calculations" (operationId,tag/path`, etc).