Skip to content

feat(cli): rename detail commands to describe#1029

Merged
Aaron ("AJ") Steers (aaronsteers) merged 1 commit into
devin/1775171846-airbyte-clifrom
devin/1779161532-cli-describe-commands
May 19, 2026
Merged

feat(cli): rename detail commands to describe#1029
Aaron ("AJ") Steers (aaronsteers) merged 1 commit into
devin/1775171846-airbyte-clifrom
devin/1779161532-cli-describe-commands

Conversation

@aaronsteers
Copy link
Copy Markdown
Member

This PR targets the following PR:


Summary

AJ approved replacing resource-detail get commands with describe for the PyAirbyte Cloud CLI where the command describes top-level primitives.

This PR:

  • Renames Cloud detail commands for workspaces, sources, destinations, connections, and jobs from get to describe.
  • Updates command docstrings so generated CLI docs use describe wording.
  • Adds docs-generator test coverage that asserts these Cloud resource groups expose describe and do not expose get.

This intentionally leaves deferred items untouched: universal --json, credential compatibility, output envelope/--fields, public/config API root naming, and the existing non-blocking connections sync default.

Review & Testing Checklist for Human

  • Confirm these are the intended top-level primitive detail commands to rename, and that no state/catalog/log-style property commands were changed.
  • Verify the generated Cloud CLI reference names now show describe for workspaces, sources, destinations, connections, and jobs.
  • Confirm deferred convention decisions remain out of scope for this PR.

Notes

Validated locally with:

  • uv run ruff check airbyte/cli/cloud tests/docs_tests/test_cli_docs.py
  • uv run ruff format --check airbyte/cli/cloud tests/docs_tests/test_cli_docs.py
  • uv run pytest tests/docs_tests/test_cli_docs.py -q

Devin session

Requested by: Aaron ("AJ") Steers (@aaronsteers)

@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Copy Markdown

👋 Greetings, Airbyte Team Member!

Here are some helpful tips and reminders for your convenience.

💡 Show Tips and Tricks

Testing This PyAirbyte Version

You can test this version of PyAirbyte using the following:

# Run PyAirbyte CLI from this branch:
uvx --from 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1779161532-cli-describe-commands' pyairbyte --help

# Install PyAirbyte from this branch for development:
pip install 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1779161532-cli-describe-commands'

PR Slash Commands

Airbyte Maintainers can execute the following slash commands on your PR:

  • /fix-pr - Fixes most formatting and linting issues
  • /uv-lock - Updates uv.lock file
  • /test-pr - Runs tests with the updated PyAirbyte
  • /prerelease - Builds and publishes a prerelease version to PyPI
📚 Show Repo Guidance

Helpful Resources

Community Support

Questions? Join the #pyairbyte channel in our Slack workspace.

📝 Edit this welcome message.

@aaronsteers Aaron ("AJ") Steers (aaronsteers) marked this pull request as ready for review May 19, 2026 03:36
@aaronsteers Aaron ("AJ") Steers (aaronsteers) merged commit a8236b5 into devin/1775171846-airbyte-cli May 19, 2026
11 of 19 checks passed
@aaronsteers Aaron ("AJ") Steers (aaronsteers) deleted the devin/1779161532-cli-describe-commands branch May 19, 2026 03:36
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no potential bugs to report.

View in Devin Review to see 1 additional finding.

Open in Devin Review

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.

1 participant