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

Backport of DOCS: CE-556 Add partition parameter to API endpoint docs into release/1.19.x #21551

Merged

Conversation

hc-github-team-consul-core
Copy link
Contributor

Backport

This PR is auto-generated from #21374 to be assessed for backporting due to the inclusion of the label backport/1.19.

🚨

Warning automatic cherry-pick of commits failed. If the first commit failed,
you will see a blank no-op commit below. If at least one commit succeeded, you
will see the cherry-picked commits up to, not including, the commit where
the merge conflict occurred.

The person who merged in the original PR is:
@aimeeu
This person should manually cherry-pick the original PR into a new backport PR,
and close this one when the manual backport PR is merged in.

merge conflict error: unable to process merge commit: "26c22247cf34ef9a66941f194bc6ba8df69d4482", automatic backport requires rebase workflow

The below text is copied from the body of the original PR.


Description

Many API docs are missing the partition parameter when compared to the corresponding CLI command.

  • Rename existing partition partial to make it clear that it is used in the CLI content.
  • Create new partials for use in the API content.
  • Update API content. I searched the CLI content for files that contained the partition partial and then updated the corresponding API content.

I tested several of the API calls to make sure partition worked as a query parameter or a body key as appropriate.

Deploy preview

Testing & Reproduction steps

None

Links

CD-556

PR Checklist

  • updated test coverage
  • external facing docs updated
  • appropriate backport labels added
  • not a security concern

Overview of commits

Copy link

Choose a reason for hiding this comment

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

Auto approved Consul Bot automated PR

@github-actions github-actions bot added the type/docs Documentation needs to be created/updated/clarified label Jul 18, 2024
@jmurret jmurret marked this pull request as ready for review August 19, 2024 20:28
@jmurret jmurret requested a review from a team as a code owner August 19, 2024 20:28
@jmurret jmurret merged commit abefc02 into release/1.19.x Aug 19, 2024
71 checks passed
@jmurret jmurret deleted the backport/docs-CE556/hopefully-flowing-sturgeon branch August 19, 2024 20:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type/docs Documentation needs to be created/updated/clarified
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants