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

chore(cli): on the CLI help show the API endpoint of resources #2860

Merged
merged 1 commit into from
May 17, 2024

Conversation

JohnVillalovos
Copy link
Member

@JohnVillalovos JohnVillalovos commented May 10, 2024

This makes it easier for people to map CLI command names to the API.

Looks like this:

    $ gitlab --help
    <snip>
                            The GitLab resource to manipulate.
        application         API endpoint: /applications
        application-appearance
                            API endpoint: /application/appearance
        application-settings
                            API endpoint: /application/settings
        application-statistics
                            API endpoint: /application/statistics
    <snip>

@JohnVillalovos
Copy link
Member Author

JohnVillalovos commented May 15, 2024

@nejch If you have some time to review, it would be appreciated. Nothing too complicated, mostly just a quality of life improvement for the users (and me) 😊

This makes it easier for people to map CLI command names to the API.

Looks like this:
    $ gitlab --help
    <snip>
                            The GitLab resource to manipulate.
        application         API endpoint: /applications
        application-appearance
                            API endpoint: /application/appearance
        application-settings
                            API endpoint: /application/settings
        application-statistics
                            API endpoint: /application/statistics
    <snip>
Copy link
Member

@nejch nejch left a comment

Choose a reason for hiding this comment

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

Thanks @JohnVillalovos, that's a really cool idea! Just one quick question about the deleted test.

tests/functional/cli/test_cli.py Show resolved Hide resolved
@nejch nejch merged commit f1ef565 into main May 17, 2024
16 checks passed
@nejch nejch deleted the jlvillal/more_help branch May 17, 2024 14:27
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.

None yet

3 participants