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

add ignore to redocly #6863

Merged
merged 2 commits into from
Feb 5, 2025
Merged

Conversation

yurisasuke
Copy link
Member

@yurisasuke yurisasuke commented Feb 5, 2025

PR Type

configuration changes


Description

  • Added a new ignore rule to .redocly.lint-ignore.yaml.

  • Updated configuration to handle debug endpoint schema.


Changes walkthrough 📝

Relevant files
Configuration changes
.redocly.lint-ignore.yaml
Add ignore rule for debug endpoint schema                               

.redocly.lint-ignore.yaml

  • Added a new ignore rule for the debug endpoint schema.
  • Updated the configuration to include the path
    #/paths/~1tyk~1debug/post/requestBody/content/application~1json/schema.
  • +1/-0     

    Need help?
  • Type /help how to ... in the comments thread for any questions about PR-Agent usage.
  • Check out the documentation for more information.
  • @buger
    Copy link
    Member

    buger commented Feb 5, 2025

    A JIRA Issue ID is missing from your branch name, PR title and PR description! 🦄

    Your branch: fix-redocly-ignore

    Your PR title: add ignore to redocly

    Your PR description: null

    If this is your first time contributing to this repository - welcome!


    Please refer to jira-lint to get started.

    Without the JIRA Issue ID in your branch name you would lose out on automatic updates to JIRA via SCM; some GitHub status checks might fail.

    Valid sample branch names:

    ‣ feature/shiny-new-feature--mojo-10'
    ‣ 'chore/changelogUpdate_mojo-123'
    ‣ 'bugfix/fix-some-strange-bug_GAL-2345'

    @yurisasuke yurisasuke merged commit 277104b into TT-13890-request-debug-endpoint Feb 5, 2025
    1 check passed
    @yurisasuke yurisasuke deleted the fix-redocly-ignore branch February 5, 2025 11:48
    Copy link
    Contributor

    github-actions bot commented Feb 5, 2025

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Configuration Validation

    Ensure that the newly added ignore rule for the debug endpoint schema is valid and does not unintentionally exclude necessary validations.

    - '#/paths/~1tyk~1debug/post/requestBody/content/application~1json/schema'

    @buger
    Copy link
    Member

    buger commented Feb 5, 2025

    A JIRA Issue ID is missing from your branch name, PR title and PR description! 🦄

    Your branch: fix-redocly-ignore

    Your PR title: add ignore to redocly

    Your PR description: null

    If this is your first time contributing to this repository - welcome!


    Please refer to jira-lint to get started.

    Without the JIRA Issue ID in your branch name you would lose out on automatic updates to JIRA via SCM; some GitHub status checks might fail.

    Valid sample branch names:

    ‣ feature/shiny-new-feature--mojo-10'
    ‣ 'chore/changelogUpdate_mojo-123'
    ‣ 'bugfix/fix-some-strange-bug_GAL-2345'

    Copy link
    Contributor

    github-actions bot commented Feb 5, 2025

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Validate the newly added schema path

    Ensure that the newly added path
    #/paths/1tyk1debug/post/requestBody/content/application~1json/schema is valid and
    corresponds to an actual schema in the referenced OpenAPI specification to avoid
    potential misconfigurations or errors.

    .redocly.lint-ignore.yaml [19]

    +- '#/paths/~1tyk~1debug/post/requestBody/content/application~1json/schema'
     
    -
    Suggestion importance[1-10]: 7

    __

    Why: The suggestion to validate the newly added schema path is relevant and important to ensure that the configuration does not lead to misconfigurations or errors. However, it is not actionable as it only asks for verification without providing a specific improvement or fix, which slightly reduces its score.

    Medium

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

    Successfully merging this pull request may close these issues.

    2 participants