Skip to content

Engine api hands on exercise-anjali (AST-92867) #1112

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

Open
wants to merge 34 commits into
base: main
Choose a base branch
from

Conversation

cx-anjali-deore
Copy link
Contributor

@cx-anjali-deore cx-anjali-deore commented Apr 16, 2025

By submitting this pull request, you agree to the terms within the Checkmarx Code of Conduct. Please review the contributing guidelines for guidance on creating high-quality pull requests.

Description

Hands on Excercise for API list for CXOne engines (currently added for sast,dast and sca engines)

Type of Change

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

Related Issues

Link any related issues or tickets.

Checklist

  • I have performed a self-review of my code

  • I have added tests that prove my fix is effective or that my feature works

  • I have added necessary documentation (if appropriate)

  • All active GitHub checks for tests, formatting, and security are passing

  • The correct base branch is being used

    Functional requirements completed :

    1. To add support for command - engine , subcommand - list-api
    2. Flags-
      --engine-name (string, optional): Specifies the engine for which APIs are to be listed. If not provided, APIs for all
      engines will be listed.
      --output-format (string, optional): Defines the output format (table, json, or yaml). Default is table.Added support for
      available output format in plugin like json, pdf , table ,list

Scenarios:

  1. Command - engines list-api
    Output- List of all APIs and description in default table output format
    image

  2. Command - engines list-api --engine-name sast
    output - List of all SAST APIs and description in default table format
    image

  3. Command - engines list-api --engine-name sca
    output - List of all SCA APIs and description in default table format
    image

  4. Command - engines list-api --output-format json
    output - List of all APIs and description in format of Json
    image

  5. Command - engine list-api --engine-name sast --output-format indented-json
    image

Additional Notes

Add any other relevant information.

@cx-anjali-deore cx-anjali-deore changed the title Engine api hands on exercise-anjali Engine api hands on exercise-anjali (AST-92867) Apr 16, 2025
Copy link

github-actions bot commented Apr 16, 2025

Logo
Checkmarx One – Scan Summary & Details49ac3c0d-3da6-4d3c-8777-e9e8d21a49a9

Great job, no security vulnerabilities found in this Pull Request

@cx-anjali-deore cx-anjali-deore force-pushed the other/anjali/CLItask branch 2 times, most recently from f4219ba to 5f82307 Compare April 23, 2025 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants