Skip to content

Commit 807acdc

Browse files
miharpclaude
andcommitted
feat: migrate HTTP API docs from openvox_8x to openvox-server_8x
Resolves phase 1-4 of issue #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 #250 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com> Signed-off-by: Michael Harp <mike@mikeharp.com>
1 parent 346be08 commit 807acdc

26 files changed

Lines changed: 980 additions & 2067 deletions

_data/nav/openvox-server_8x.yml

Lines changed: 91 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -66,64 +66,98 @@
6666
link: tuning_guide.html
6767
- text: Scaling OpenVox Server with compilers
6868
link: scaling_puppet_server.html
69-
- text: Administrative API endpoints
69+
- text: HTTP API
7070
items:
71-
- text: Environment cache
72-
link: admin-api/v1/environment-cache.html
73-
- text: JRuby pool
74-
link: admin-api/v1/jruby-pool.html
75-
- text: CA API endpoints
76-
items:
77-
- text: Certificate
78-
link: http_certificate.html
79-
- text: Certificate signing request
80-
link: http_certificate_request.html
81-
- text: Certificate status
82-
link: http_certificate_status.html
83-
- text: Certificate revocation list
84-
link: http_certificate_revocation_list.html
85-
- text: Server-specific Puppet API endpoints
86-
items:
87-
- text: Environment classes
88-
link: puppet-api/v3/environment_classes.html
89-
- text: Environment modules
90-
link: puppet-api/v3/environment_modules.html
91-
- text: Environment transports
92-
link: puppet-api/v3/environment_transports.html
93-
- text: Compile endpoint
94-
link: puppet-api/v3/compile.html
95-
- text: Static file content
96-
link: puppet-api/v3/static_file_content.html
97-
- text: File content
98-
link: puppet-api/v3/file_content.html
99-
- text: Tasks overview
100-
link: puppet-api/v3/tasks.html
101-
- text: Tasks details
102-
link: puppet-api/v3/task_detail.html
103-
- text: Plans overview
104-
link: puppet-api/v3/plans.html
105-
- text: Plans details
106-
link: puppet-api/v3/plan_detail.html
107-
- text: Catalog endpoint
108-
link: puppet-api/v4/catalog.html
109-
- text: Status API endpoints
110-
items:
111-
- text: Services endpoint
112-
link: status-api/v1/services.html
113-
- text: Simple endpoint
114-
link: status-api/v1/simple.html
115-
- text: Metrics
116-
items:
117-
- text: Monitoring OpenVox Server metrics
118-
link: puppet_server_metrics.html
119-
- text: HTTP client metrics
120-
link: http_client_metrics.html
121-
- text: Applying metrics to improve performance
122-
link: puppet_server_metrics_performance.html
123-
- text: v1 metrics API
124-
link: metrics-api/v1/metrics_api.html
125-
- text: v2 (Jolokia) metrics API
126-
link: metrics-api/v2/metrics_api.html
71+
- text: HTTP API overview
72+
link: http_api_index.html
73+
- text: PSON
74+
link: pson.html
75+
- text: Puppet v3 API
76+
items:
77+
- text: Catalog
78+
link: http_catalog.html
79+
- text: Node
80+
link: http_node.html
81+
- text: Facts
82+
link: http_facts.html
83+
- text: File bucket file
84+
link: http_file_bucket_file.html
85+
- text: File content
86+
link: http_file_content.html
87+
- text: File metadata
88+
link: http_file_metadata.html
89+
- text: Report
90+
link: http_report.html
91+
- text: Environments
92+
link: http_environments.html
93+
- text: Puppet v4 API
94+
items:
95+
- text: Catalog
96+
link: puppet-api/v4/catalog.html
97+
- text: CA v1 API
98+
items:
99+
- text: Certificate
100+
link: http_certificate.html
101+
- text: Certificate request
102+
link: http_certificate_request.html
103+
- text: Certificate status
104+
link: http_certificate_status.html
105+
- text: Certificate revocation list
106+
link: http_certificate_revocation_list.html
107+
- text: Certificate clean
108+
link: http_certificate_clean.html
109+
- text: Certificate expirations
110+
link: http_certificate_expirations.html
111+
- text: Certificate renewal
112+
link: http_certificate_renewal.html
113+
- text: Bulk certificate sign
114+
link: http_certificate_sign.html
115+
- text: Server-specific API
116+
items:
117+
- text: Environment classes
118+
link: puppet-api/v3/environment_classes.html
119+
- text: Environment modules
120+
link: puppet-api/v3/environment_modules.html
121+
- text: Environment transports
122+
link: puppet-api/v3/environment_transports.html
123+
- text: Compile endpoint
124+
link: puppet-api/v3/compile.html
125+
- text: Static file content
126+
link: puppet-api/v3/static_file_content.html
127+
- text: File content
128+
link: puppet-api/v3/file_content.html
129+
- text: Tasks overview
130+
link: puppet-api/v3/tasks.html
131+
- text: Tasks details
132+
link: puppet-api/v3/task_detail.html
133+
- text: Plans overview
134+
link: puppet-api/v3/plans.html
135+
- text: Plans details
136+
link: puppet-api/v3/plan_detail.html
137+
- text: Admin API
138+
items:
139+
- text: Environment cache
140+
link: admin-api/v1/environment-cache.html
141+
- text: JRuby pool
142+
link: admin-api/v1/jruby-pool.html
143+
- text: Status API
144+
items:
145+
- text: Services endpoint
146+
link: status-api/v1/services.html
147+
- text: Simple endpoint
148+
link: status-api/v1/simple.html
149+
- text: Metrics
150+
items:
151+
- text: Monitoring OpenVox Server metrics
152+
link: puppet_server_metrics.html
153+
- text: HTTP client metrics
154+
link: http_client_metrics.html
155+
- text: Applying metrics to improve performance
156+
link: puppet_server_metrics_performance.html
157+
- text: v1 metrics API
158+
link: metrics-api/v1/metrics_api.html
159+
- text: v2 (Jolokia) metrics API
160+
link: metrics-api/v2/metrics_api.html
127161
- text: Developer information
128162
items:
129163
- text: Developer debugging

_data/nav/openvox_8x.yml

Lines changed: 2 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -395,58 +395,8 @@
395395
link: "man/status.html"
396396
- text: HTTP API
397397
items:
398-
- text: Index
399-
link: "http_api/http_api_index.html"
400-
- text: PSON
401-
link: "http_api/pson.html"
402-
- text: Catalog
403-
link: "http_api/http_catalog.html"
404-
- text: Node
405-
link: "http_api/http_node.html"
406-
- text: File bucket file
407-
link: "http_api/http_file_bucket_file.html"
408-
- text: File content
409-
link: "http_api/http_file_content.html"
410-
- text: File metadata
411-
link: "http_api/http_file_metadata.html"
412-
- text: Report
413-
link: "http_api/http_report.html"
414-
- text: Environments
415-
link: "http_api/http_environments.html"
416-
- text: Resource type
417-
link: "http_api/http_resource_type.html"
418-
- text: Status
419-
link: "http_api/http_status.html"
420-
- text: Certificate
421-
link: "http_api/http_certificate.html"
422-
- text: Certificate signing requests
423-
link: "http_api/http_certificate_request.html"
424-
- text: Certificate status
425-
link: "http_api/http_certificate_status.html"
426-
- text: Certificate revocation list
427-
link: "http_api/http_certificate_revocation_list.html"
428-
- text: catalog.json
429-
link: "schemas/catalog.json"
430-
- text: environments.json
431-
link: "schemas/environments.json"
432-
- text: error.json
433-
link: "schemas/error.json"
434-
- text: facts.json
435-
link: "schemas/facts.json"
436-
- text: file_metadata.json
437-
link: "schemas/file_metadata.json"
438-
- text: host.json
439-
link: "schemas/host.json"
440-
- text: json-meta-schema.json
441-
link: "schemas/json-meta-schema.json"
442-
- text: node.json
443-
link: "schemas/node.json"
444-
- text: report.json
445-
link: "schemas/report.json"
446-
- text: resource_type.json
447-
link: "schemas/resource_type.json"
448-
- text: status.json
449-
link: "schemas/status.json"
398+
- text: OpenVox Server HTTP API
399+
link: "/openvox-server/latest/http_api_index.html"
450400
- text: SSL and certificates
451401
items:
452402
- text: Using an external CA

docs/_openvox-server_8x/http_api_index.markdown

Lines changed: 33 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ All configuration endpoints are prefixed with `/puppet`, while all CA endpoints
2525

2626
### Authorization
2727

28-
Authorization for `/puppet` and `/puppet-ca` endpoints is controlled with [OpenVox Server's `auth.conf` authorization system](./config_file_auth.html).
28+
Authorization for `/puppet` and `/puppet-ca` endpoints is controlled with [OpenVox Server's `auth.conf` authorization system](config_file_auth.html).
2929

3030
## OpenVox V3 HTTP API
3131

3232
The OpenVox agent application uses several network services to manage systems. These services are all grouped under the `/puppet` API.
33-
Other tools can access these services and use the OpenVox Servers's data for other purposes.
33+
Other tools can access these services and use the OpenVox Server's data for other purposes.
3434

3535
The V3 API contains endpoints of two types: those that are based on dispatching to OpenVox's internal "indirector" framework, and those that are not (namely the [environments endpoint](#environments-endpoint)).
3636

@@ -44,52 +44,47 @@ Using this API requires significant understanding of how OpenVox's internal serv
4444

4545
### Configuration management services
4646

47-
The OpenVox agent application directly uses these servcies to manage the configuration of a node.
47+
The OpenVox agent application directly uses these services to manage the configuration of a node.
4848

4949
These endpoints accept payload formats formatted as JSON by default (MIME type of `application/json`), except for `File Content` and `File Bucket File`, which always use `application/octet-stream`.
5050

5151
> **Note:** Legacy PSON (MIME type of `text/pson`) is still an available format, but should be used only as a fallback for binary content.
5252
53-
- [Facts](/openvox/latest/http_api/http_facts.html)
54-
- [Catalog](/openvox/latest/http_api/http_catalog.html)
55-
- [Node](/openvox/latest/http_api/http_node.html)
56-
- [File bucket file](/openvox/latest/http_api/http_file_bucket_file.html)
57-
- [File content](/openvox/latest/http_api/http_file_content.html)
58-
- [File metadata](/openvox/latest/http_api/http_file_metadata.html)
59-
- [Report](/openvox/latest/http_api/http_report.html)
53+
- [Facts](http_facts.html)
54+
- [Catalog](http_catalog.html)
55+
- [Node](http_node.html)
56+
- [File bucket file](http_file_bucket_file.html)
57+
- [File content](http_file_content.html)
58+
- [File metadata](http_file_metadata.html)
59+
- [Report](http_report.html)
6060

61-
### Informational services
62-
63-
These services are not directly used by OpenVox agent, but can be used by other tools.
64-
65-
- [Status](/openvox/latest/http_api/http_status.html)
66-
67-
> **Note:** The [OpenVox Server status API](#openvox-server-specific-endpoints) provides more detail and features.
61+
> **Note:** The [Puppet v4 catalog API](puppet-api/v4/catalog.html) is preferred for new integrations. It does
62+
> not require facts to be submitted as part of the catalog request.
6863
6964
### Environments endpoint
7065

71-
The `/puppet/v3/environments` endpoint uses a different format than the configuration management and informational services endpoints.
66+
The `/puppet/v3/environments` endpoint uses a different format than the configuration management endpoints.
7267

7368
The endpoint accepts only payloads formatted as JSON, and responds with JSON (MIME type of `application/json`).
7469

75-
- [Environments](/openvox/latest/http_api/http_environments.html)
70+
- [Environments](http_environments.html)
7671

7772
### OpenVox Server-specific endpoints
7873

7974
OpenVox Server adds several unique endpoints of its own. They include these additional `/puppet/v3/` endpoints:
8075

81-
- [Environment classes](./puppet-api/v3/environment_classes.html), at `/puppet/v3/environment_classes`
82-
- [Environment modules](./puppet-api/v3/environment_modules.html), at `/puppet/v3/environment_modules`
83-
- [Static file content](./puppet-api/v3/static_file_content.html), at `/puppet/v3/static_file_content`
76+
- [Environment classes](puppet-api/v3/environment_classes.html), at `/puppet/v3/environment_classes`
77+
- [Environment modules](puppet-api/v3/environment_modules.html), at `/puppet/v3/environment_modules`
78+
- [Static file content](puppet-api/v3/static_file_content.html), at `/puppet/v3/static_file_content`
8479

8580
It also includes these unique APIs, with endpoints containing other URL prefixes:
8681

87-
- [Status API](./status-api/v1/services.html), at `/status/v1/services`
88-
- [Metrics v1 (mbeans) API](./metrics-api/v1/metrics_api.html), at `/metrics/v1/mbeans`
89-
- [Metrics v2 (Jolokia) API](./metrics-api/v2/metrics_api.html), at `/metrics/v2/`
82+
- [Status API](status-api/v1/services.html), at `/status/v1/services`
83+
- [Metrics v1 (mbeans) API](metrics-api/v1/metrics_api.html), at `/metrics/v1/mbeans`
84+
- [Metrics v2 (Jolokia) API](metrics-api/v2/metrics_api.html), at `/metrics/v2/`
9085
- Admin API, at `/puppet-admin-api/v1/`:
91-
- [Environment cache](./admin-api/v1/environment-cache.html), at `/puppet-admin-api/v1/environment-cache`
92-
- [JRuby pool](./admin-api/v1/jruby-pool.html), at `/puppet-admin-api/v1/jruby-pool`
86+
- [Environment cache](admin-api/v1/environment-cache.html), at `/puppet-admin-api/v1/environment-cache`
87+
- [JRuby pool](admin-api/v1/jruby-pool.html), at `/puppet-admin-api/v1/jruby-pool`
9388

9489
### Error responses
9590

@@ -109,7 +104,7 @@ Except for HEAD requests, error responses contain a body of a uniform JSON objec
109104
- `message`: (`String`) A human-readable message explaining the error.
110105
- `issue_kind`: (`String`) A unique label to identify the error class.
111106

112-
OpenVOx provides a [JSON schema for error objects](/openvox/latest/schemas/error.json). Endpoints implemented by OpenVox Server have a different error schema:
107+
OpenVox provides a [JSON schema for error objects](/openvox/latest/schemas/error.json). Endpoints implemented by OpenVox Server have a different error schema:
113108

114109
```json
115110
{
@@ -136,18 +131,22 @@ The following documents specify what is available and how to interact with it.
136131

137132
### SSL certificate-related services
138133

139-
These endpoints accept only plain-text payload formats. Historically, OpenVox has used the MIME type `s` to mean `text/plain`. In now uses `text/plain`, but continues to accept `s` as an equivalent.
134+
These endpoints accept only plain-text payload formats. Historically, OpenVox has used the MIME type `s` to mean `text/plain`. It now uses `text/plain`, but continues to accept `s` as an equivalent.
140135

141-
- [Certificate](./http_certificate.html)
142-
- [Certificate Signing Requests](./http_certificate_request.html)
143-
- [Certificate Status](./http_certificate_status.html)
144-
- [Certificate Revocation List](./http_certificate_revocation_list.html)
136+
- [Certificate](http_certificate.html)
137+
- [Certificate Signing Requests](http_certificate_request.html)
138+
- [Certificate Status](http_certificate_status.html)
139+
- [Certificate Revocation List](http_certificate_revocation_list.html)
140+
- [Certificate Clean](http_certificate_clean.html)
141+
- [Certificate Expirations](http_certificate_expirations.html)
142+
- [Certificate Renewal](http_certificate_renewal.html)
143+
- [Bulk Certificate Sign](http_certificate_sign.html)
145144

146145
## Serialization formats
147146

148147
OpenVox sends messages using several serialization formats. Not all REST services support all of the formats.
149148

150149
- [JSON](https://tools.ietf.org/html/rfc7159)
151-
- [PSON](/openvox/latest/http_api/pson.html)
150+
- [PSON](pson.html) (deprecated — see the PSON page for details)
152151

153152
`YAML` was supported in earlier versions of OpenVox, but is no longer for security reasons.

0 commit comments

Comments
 (0)