Skip to content

chore(cli): rename "object" to "GitLab resource" #2055

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 1 commit into from
Jun 5, 2022
Merged

chore(cli): rename "object" to "GitLab resource" #2055

merged 1 commit into from
Jun 5, 2022

Conversation

JohnVillalovos
Copy link
Member

Make the parser name more user friendly by renaming from generic
"object" to "GitLab resource"

@JohnVillalovos
Copy link
Member Author

With this change the CLI now looks like this:

$ gitlab --help
usage: gitlab [-h] [--version] [-v] [-d] [-c CONFIG_FILE] [-g GITLAB] [-o {json,legacy,yaml}] [-f FIELDS] [--server-url SERVER_URL] [--ssl-verify SSL_VERIFY] [--timeout TIMEOUT] [--api-version API_VERSION] [--per-page PER_PAGE] [--pagination PAGINATION] [--order-by ORDER_BY]
              [--user-agent USER_AGENT] [--private-token PRIVATE_TOKEN | --oauth-token OAUTH_TOKEN | --job-token JOB_TOKEN]
              {application,application-appearance,application-settings,audit-event,broadcast-message,current-user,current-user-email,current-user-gpg-key,current-user-key,current-user-status,deploy-key,deploy-token,dockerfile,event,feature,generic-package,geo-node,gitignore,gitlabciyml,group,group-access-request,group-access-token,group-audit-event,group-badge,group-billable-member,group-billable-member-membership,group-board,group-board-list,group-cluster,group-custom-attribute,group-deploy-token,group-descendant-group,group-epic,group-epic-award-emoji,group-epic-discussion-note,group-epic-issue,group-epic-note,group-epic-note-award-emoji,group-epic-resource-label-event,group-export,group-hook,group-import,group-issue,group-issues-statistics,group-label,group-member,group-member-all,group-merge-request,group-milestone,group-notification-settings,group-package,group-project,group-runner,group-subgroup,group-variable,group-wiki,hook,issue,issues-statistics,key,ldap-group,license,merge-request,namespace,notification-settings,pages-domain,personal-access-token,project,project-access-request,project-access-token,project-additional-statistics,project-approval,project-approval-rule,project-artifact,project-audit-event,project-badge,project-board,project-board-list,project-branch,project-cluster,project-commit,project-commit-comment,project-commit-discussion,project-commit-discussion-note,project-commit-status,project-custom-attribute,project-deploy-token,project-deployment,project-deployment-merge-request,project-environment,project-event,project-export,project-file,project-fork,project-hook,project-import,project-issue,project-issue-award-emoji,project-issue-discussion,project-issue-discussion-note,project-issue-link,project-issue-note,project-issue-note-award-emoji,project-issue-resource-label-event,project-issue-resource-milestone-event,project-issue-resource-state-event,project-issues-statistics,project-job,project-key,project-label,project-member,project-member-all,project-merge-request,project-merge-request-approval,project-merge-request-approval-rule,project-merge-request-approval-state,project-merge-request-award-emoji,project-merge-request-diff,project-merge-request-discussion,project-merge-request-discussion-note,project-merge-request-note,project-merge-request-note-award-emoji,project-merge-request-pipeline,project-merge-request-resource-label-event,project-merge-request-resource-milestone-event,project-merge-request-resource-state-event,project-merge-train,project-milestone,project-note,project-notification-settings,project-package,project-package-file,project-pages-domain,project-pipeline,project-pipeline-bridge,project-pipeline-job,project-pipeline-schedule,project-pipeline-schedule-variable,project-pipeline-test-report,project-pipeline-test-report-summary,project-pipeline-variable,project-protected-branch,project-protected-tag,project-push-rules,project-registry-repository,project-registry-tag,project-release,project-release-link,project-remote-mirror,project-runner,project-service,project-snippet,project-snippet-award-emoji,project-snippet-discussion,project-snippet-discussion-note,project-snippet-note,project-snippet-note-award-emoji,project-storage,project-tag,project-trigger,project-user,project-variable,project-wiki,runner,runner-job,snippet,starred-project,todo,topic,user,user-activities,user-custom-attribute,user-email,user-event,user-gpg-key,user-impersonation-token,user-key,user-membership,user-personal-access-token,user-project,user-status,variable}
              ...

GitLab API Command Line Interface

options:
  -h, --help            show this help message and exit
  --version             Display the version.
  -v, --verbose, --fancy
                        Verbose mode (legacy format only) [env var: GITLAB_VERBOSE]
  -d, --debug           Debug mode (display HTTP requests) [env var: GITLAB_DEBUG]
  -c CONFIG_FILE, --config-file CONFIG_FILE
                        Configuration file to use. Can be used multiple times. [env var: PYTHON_GITLAB_CFG]
  -g GITLAB, --gitlab GITLAB
                        Which configuration section should be used. If not defined, the default selection will be used.
  -o {json,legacy,yaml}, --output {json,legacy,yaml}
                        Output format (v4 only): json|legacy|yaml
  -f FIELDS, --fields FIELDS
                        Fields to display in the output (comma separated). Not used with legacy output
  --server-url SERVER_URL
                        GitLab server URL [env var: GITLAB_URL]
  --ssl-verify SSL_VERIFY
                        Whether SSL certificates should be validated. [env var: GITLAB_SSL_VERIFY]
  --timeout TIMEOUT     Timeout to use for requests to the GitLab server. [env var: GITLAB_TIMEOUT]
  --api-version API_VERSION
                        GitLab API version [env var: GITLAB_API_VERSION]
  --per-page PER_PAGE   Number of entries to return per page in the response. [env var: GITLAB_PER_PAGE]
  --pagination PAGINATION
                        Whether to use keyset or offset pagination [env var: GITLAB_PAGINATION]
  --order-by ORDER_BY   Set order_by globally [env var: GITLAB_ORDER_BY]
  --user-agent USER_AGENT
                        The user agent to send to GitLab with the HTTP request. [env var: GITLAB_USER_AGENT]
  --private-token PRIVATE_TOKEN
                        GitLab private access token [env var: GITLAB_PRIVATE_TOKEN]
  --oauth-token OAUTH_TOKEN
                        GitLab OAuth token [env var: GITLAB_OAUTH_TOKEN]
  --job-token JOB_TOKEN
                        GitLab CI job token [env var: CI_JOB_TOKEN]

GitLab resource:
  {application,application-appearance,application-settings,audit-event,broadcast-message,current-user,current-user-email,current-user-gpg-key,current-user-key,current-user-status,deploy-key,deploy-token,dockerfile,event,feature,generic-package,geo-node,gitignore,gitlabciyml,group,group-access-request,group-access-token,group-audit-event,group-badge,group-billable-member,group-billable-member-membership,group-board,group-board-list,group-cluster,group-custom-attribute,group-deploy-token,group-descendant-group,group-epic,group-epic-award-emoji,group-epic-discussion-note,group-epic-issue,group-epic-note,group-epic-note-award-emoji,group-epic-resource-label-event,group-export,group-hook,group-import,group-issue,group-issues-statistics,group-label,group-member,group-member-all,group-merge-request,group-milestone,group-notification-settings,group-package,group-project,group-runner,group-subgroup,group-variable,group-wiki,hook,issue,issues-statistics,key,ldap-group,license,merge-request,namespace,notification-settings,pages-domain,personal-access-token,project,project-access-request,project-access-token,project-additional-statistics,project-approval,project-approval-rule,project-artifact,project-audit-event,project-badge,project-board,project-board-list,project-branch,project-cluster,project-commit,project-commit-comment,project-commit-discussion,project-commit-discussion-note,project-commit-status,project-custom-attribute,project-deploy-token,project-deployment,project-deployment-merge-request,project-environment,project-event,project-export,project-file,project-fork,project-hook,project-import,project-issue,project-issue-award-emoji,project-issue-discussion,project-issue-discussion-note,project-issue-link,project-issue-note,project-issue-note-award-emoji,project-issue-resource-label-event,project-issue-resource-milestone-event,project-issue-resource-state-event,project-issues-statistics,project-job,project-key,project-label,project-member,project-member-all,project-merge-request,project-merge-request-approval,project-merge-request-approval-rule,project-merge-request-approval-state,project-merge-request-award-emoji,project-merge-request-diff,project-merge-request-discussion,project-merge-request-discussion-note,project-merge-request-note,project-merge-request-note-award-emoji,project-merge-request-pipeline,project-merge-request-resource-label-event,project-merge-request-resource-milestone-event,project-merge-request-resource-state-event,project-merge-train,project-milestone,project-note,project-notification-settings,project-package,project-package-file,project-pages-domain,project-pipeline,project-pipeline-bridge,project-pipeline-job,project-pipeline-schedule,project-pipeline-schedule-variable,project-pipeline-test-report,project-pipeline-test-report-summary,project-pipeline-variable,project-protected-branch,project-protected-tag,project-push-rules,project-registry-repository,project-registry-tag,project-release,project-release-link,project-remote-mirror,project-runner,project-service,project-snippet,project-snippet-award-emoji,project-snippet-discussion,project-snippet-discussion-note,project-snippet-note,project-snippet-note-award-emoji,project-storage,project-tag,project-trigger,project-user,project-variable,project-wiki,runner,runner-job,snippet,starred-project,todo,topic,user,user-activities,user-custom-attribute,user-email,user-event,user-gpg-key,user-impersonation-token,user-key,user-membership,user-personal-access-token,user-project,user-status,variable}
                        The GitLab resource to manipulate.

@JohnVillalovos JohnVillalovos requested a review from nejch June 5, 2022 16:28
nejch
nejch reviewed Jun 5, 2022
View reviewed changes
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.

Nice @JohnVillalovos was also thinking about it after the action one, kind of forgot that one from the previous review. Just a small note :)

@JohnVillalovos
chore(cli): rename "object" to "GitLab resource"
62e64a6 
Make the parser name more user friendly by renaming from generic
"object" to "GitLab resource"
@nejch nejch enabled auto-merge June 5, 2022 21:29
@nejch nejch merged commit 0e3c461 into main Jun 5, 2022
@nejch nejch deleted the jlvillal/resource branch June 5, 2022 21:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nejch nejch nejch approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@JohnVillalovos @nejch