Skip to content

Docs: Add "/v1" where missing so endpoint docs are consistent #25798

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 3 commits into
base: main
Choose a base branch
from

Conversation

aimeeu
Copy link
Contributor

@aimeeu aimeeu commented May 1, 2025

Description

This issue was raised for the ACL endpoints and fixed by an end user in #25356. This PR addresses the remaining API pages.

Links

Jira: CE-831

Contributor Checklist

  • Changelog Entry If this PR changes user-facing behavior, please generate and add a
    changelog entry using the make cl command.
  • Testing Please add tests to cover any new functionality or to demonstrate bug fixes and
    ensure regressions will be caught.
  • Documentation If the change impacts user-facing functionality such as the CLI, API, UI,
    and job configuration, please update the Nomad website documentation to reflect this. Refer to
    the website README for docs guidelines. Please also consider whether the
    change requires notes within the upgrade guide.

Reviewer Checklist

  • Backport Labels Please add the correct backport labels as described by the internal
    backporting document.
  • Commit Type Ensure the correct merge method is selected which should be "squash and merge"
    in the majority of situations. The main exceptions are long-lived feature branches or merges where
    history should be preserved.
  • Enterprise PRs If this is an enterprise only PR, please add any required changelog entry
    within the public repository.

@aimeeu aimeeu added theme/docs Documentation issues and enhancements backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/ent/1.8.x+ent Changes are backported to 1.8.x+ent backport/1.8.x backport to 1.8.x release line backport/ent/1.9.x+ent Changes are backported to 1.9.x+ent backport/1.9.x backport to 1.9.x release line backport/1.10.x backport to 1.10.x release line labels May 1, 2025
@aimeeu aimeeu requested review from a team as code owners May 1, 2025 15:57
@@ -14,7 +14,7 @@ This page lists all known jobs in a paginated, searchable, and sortable table.

| Path | Produces |
| ---------- | ----------- |
| `/ui/jobs` | `text/html` |
| `/v1/ui/jobs` | `text/html` |
Copy link
Member

Choose a reason for hiding this comment

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

We shouldn't have the /v1 prefix on any of the paths on this particular page because the web UI doesn't have that. Ex. http://localhost:4646/ui/jobs is the URL that brings you to the jobs page.

(That page then hits the API with the /v1 prefix shown on all the other pages in this api-docs section.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/ent/1.8.x+ent Changes are backported to 1.8.x+ent backport/ent/1.9.x+ent Changes are backported to 1.9.x+ent backport/website This will backport PR changes to `stable-website` && the latest release-branch backport/1.8.x backport to 1.8.x release line backport/1.9.x backport to 1.9.x release line backport/1.10.x backport to 1.10.x release line theme/docs Documentation issues and enhancements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants