Skip to content

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

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
Merged
merged 4 commits into from
Mar 5, 2025
Merged

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

merged 4 commits into from
Mar 5, 2025

Conversation

cx-artur-ribeiro
Copy link
Contributor

@cx-artur-ribeiro cx-artur-ribeiro 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.

@cx-artur-ribeiro cx-artur-ribeiro 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

@cx-artur-ribeiro cx-artur-ribeiro marked this pull request as ready for review March 1, 2025 15:45
@cx-artur-ribeiro cx-artur-ribeiro requested a review from a team as a code owner March 1, 2025 15:45
cx-rui-araujo
cx-rui-araujo approved these changes Mar 5, 2025
View reviewed changes
Copy link
Contributor

@cx-rui-araujo cx-rui-araujo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@cx-artur-ribeiro cx-artur-ribeiro merged commit 45b27f5 into master Mar 5, 2025
36 checks passed
@cx-artur-ribeiro cx-artur-ribeiro deleted the AST-65365-fix-query-documentation branch March 5, 2025 10:08
JonasCordsen pushed a commit to JonasCordsen/kics that referenced this pull request Jun 11, 2025
@cx-artur-ribeiro
fix(documentation): update descriptionText metadata field for invalid…
0fc7df3 
… media type openAPI query (Checkmarx#7361)

* Update descriptionText metadata field to fix queries documentation instead of .md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cx-rui-araujo cx-rui-araujo cx-rui-araujo approved these changes

Assignees

@cx-artur-ribeiro cx-artur-ribeiro

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

Successfully merging this pull request may close these issues.
2 participants
@cx-artur-ribeiro @cx-rui-araujo