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

fix(documentation): update descriptionText metadata field for invalid media type openAPI query #7361

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

fix(documentation): update descriptionText metadata field for invalid media type openAPI query #7361

wants to merge 4 commits into from

Conversation

ArturRibeiro-CX
Copy link
Contributor

@ArturRibeiro-CX ArturRibeiro-CX commented Mar 1, 2025 •
edited
Loading

Reason for Proposed Changes

  • The correct media type format should be <type>/<subtype>[+suffix][;parameters], but the single quotes (') were missing.
  • This caused the displayed information to be inaccurate.
  • See the issue in the attached screenshot.
image

Proposed Changes

  • Update the query documentation to correctly display the media type value pattern, ensuring it reflects the intended use case (v2 and v3).
image

I submit this contribution under the Apache-2.0 license.

@ArturRibeiro-CX ArturRibeiro-CX self-assigned this Mar 1, 2025
@github-actions github-actions bot added the query New query feature label Mar 1, 2025
@github-actions github-actions bot added the openapi OpenAPI query label Mar 1, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 1, 2025

kics-logo

KICS version: v2.1.4

Category Results
CRITICAL CRITICAL 0
HIGH HIGH 0
MEDIUM MEDIUM 0
LOW LOW 0
INFO INFO 0
TRACE TRACE 0
TOTAL TOTAL 0
Metric Values
Files scanned placeholder 1
Files parsed placeholder 1
Files failed to scan placeholder 0
Total executed queries placeholder 47
Queries failed to execute placeholder 0
Execution time placeholder 0

@ArturRibeiro-CX ArturRibeiro-CX marked this pull request as ready for review March 1, 2025 15:45
@ArturRibeiro-CX ArturRibeiro-CX requested a review from a team as a code owner March 1, 2025 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@ArturRibeiro-CX ArturRibeiro-CX

Labels
openapi OpenAPI query query New query feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@ArturRibeiro-CX