feat: migrate HTTP API docs from openvox_8x to openvox-server_8x (#250)#254
Merged
Merged
Conversation
1c3ed94 to
2050da4
Compare
Resolves phase 1-4 of issue OpenVoxProject#250: - Move 9 Puppet v3 API pages from docs/_openvox_8x/http_api/ into docs/_openvox-server_8x/, updating front matter and schema links - Remove 3 deleted-endpoint pages (resource_type, environment, status) and delete the entire docs/_openvox_8x/http_api/ directory - Write 3 new CA v1 endpoint pages from scratch (expirations, renewal, sign), verified against OpenVox Server source and a live Vagrant env - Restructure openvox-server_8x nav into a single "HTTP API" parent with Puppet v3, Puppet v4, and CA v1 sub-groups - Replace openvox_8x HTTP API nav with a cross-link to openvox-server Closes OpenVoxProject#250 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
2050da4 to
807acdc
Compare
Nav links starting with '/' are already absolute site paths. The old code unconditionally prepended nav_base (also starting with '/'), producing a double-prefix like /openvox/latest//openvox-server/latest/... and causing a 404. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
tuxmea
reviewed
May 28, 2026
| * `pluginfacts` --- a highly magical mount point which merges the `facts.d` directory of every module together. Used for syncing external facts; not intended for general consumption. Per-module sub-paths can not be specified. | ||
| * `tasks/<MODULE>` --- a semi-magical mount point which allows access to files in the `tasks` subdirectory of `<MODULE>` --- see the [the docs on file serving](https://puppet.com/docs/puppet/latest/file_serving.html). | ||
| - Custom file serving mounts as specified in `fileserver.conf` — see the Puppet docs on | ||
| [configuring mount points](https://puppet.com/docs/puppet/latest/file_serving.html). |
| - Custom file serving mounts as specified in `fileserver.conf` — see the Puppet docs on | ||
| [configuring mount points](https://puppet.com/docs/puppet/latest/file_serving.html). | ||
| - `modules/<MODULE>` — allows access to the `files` subdirectory of `<MODULE>` — see the Puppet docs on | ||
| [file serving](https://puppet.com/docs/puppet/latest/file_serving.html). |
| - `pluginfacts` — merges the `facts.d` directory of every module together. Used for syncing external facts; not | ||
| intended for general consumption. Per-module sub-paths cannot be specified. | ||
| - `tasks/<MODULE>` — allows access to files in the `tasks` subdirectory of `<MODULE>` — see the Puppet docs on | ||
| [file serving](https://puppet.com/docs/puppet/latest/file_serving.html). |
In http_file_metadata.md and http_file_content.md, replace three puppet.com links in the mount point lists with internal openvox-docs pages: config_file_fileserver.html for mount point configuration and file_serving.html for file serving docs. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
tuxmea
approved these changes
May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/_openvox_8x/http_api/intodocs/_openvox-server_8x/, updating front matter, schema links, and heading style to match the collection conventionsdocs/_openvox_8x/http_api/directory_includes/nav-item.htmlto not prepend the collection base URL to nav links that are already absolute paths (starts with/) — this PR introduced the first cross-collection nav link, which exposed the bugCA endpoint verification (live Vagrant)
All three new CA v1 pages were verified against a running OpenVox Server in Vagrant (
puppet.example.com).Certificate Expirations (
GET /puppet-ca/v1/expirations):Two entries per key because the Vagrant environment uses an intermediate CA. CA cert expiry reflects the 15-year default from
puppetserver ca setup; CRL next-update reflects the 5-yearca_ttlrotation cycle.Certificate Renewal (
POST /puppet-ca/v1/certificate_renewal):With
allow-auto-renewal: false(default):Confirmed: endpoint returns 404 when auto-renewal is disabled, as documented.
Bulk Certificate Sign (
POST /puppet-ca/v1/sign):Schema violation (non-string certname value) returns:
Test plan
npx markdownlint-cli2passes with 0 errors on all 13 changed filescertificate_authority_core.clj)bundle exec jekyll serve— "HTTP API" parent expands with Puppet v3, Puppet v4, and CA v1 sub-groups, all links activehttp_api_index.markdownresolve to existing pages/openvox-server/latest/http_api_index.html) renders without double-slash and resolves correctlyCloses #250