End User Documentation#17
Merged
Merged
Conversation
Co-authored-by: Copilot <copilot@github.com>
There was a problem hiding this comment.
Pull request overview
This PR adds an end-user documentation set under docs/ and updates several client resources/specs/RBS to align with current Puppet Enterprise / Puppet Core API endpoint shapes (HTTP method/path, required params, and response types).
Changes:
- Added a structured
docs/documentation set and linked it from the rootREADME.md. - Updated multiple resources/specs to match current API endpoints (RBAC v1 SAML/LDAP/groups, Node Classifier rules/import-hierarchy/environments, Orchestrator plan events + scheduled job updates).
- Tightened/updated several RBS signatures to reflect the updated public APIs (notably Puppet v3 file/static file content and Orchestrator scheduled jobs).
Reviewed changes
Copilot reviewed 50 out of 50 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| spec/pe_client/resources/rbac_v1/saml_spec.rb | Updates SAML configure endpoint expectation to PUT /rbac-api/v1/saml. |
| spec/pe_client/resources/rbac_v1/ldap_spec.rb | Updates LDAP update method expectation and adds coverage for deprecated ds/ds_test. |
| spec/pe_client/resources/rbac_v1/groups_spec.rb | Updates groups create/deprecated-create endpoint expectations. |
| spec/pe_client/resources/puppet_v3_spec.rb | Updates static/file content specs to include environment/code_id params and octet-stream headers. |
| spec/pe_client/resources/orchestrator_v1/scheduled_jobs_spec.rb | Adds spec coverage for editing/disabling scheduled environment jobs. |
| spec/pe_client/resources/orchestrator_v1/plan_jobs_spec.rb | Updates plan job event details endpoint path (/event/<id>). |
| spec/pe_client/resources/node_classifier_v1/rules_spec.rb | Updates rules translate to POST + plaintext response expectations. |
| spec/pe_client/resources/node_classifier_v1/import_hierarchy_spec.rb | Updates import-hierarchy replace to accept an array payload. |
| spec/pe_client/resources/node_classifier_v1/environments_spec.rb | Updates environment creation to PUT /environments/<name> with no body expectation. |
| sig/pe_client/resource/puppet.v3.rbs | Updates Puppet v3 file_content/static_file_content signatures to require env/code_id. |
| sig/pe_client/resource/orchestrator.v1/ScheduledJobs.rbs | Adds update signature and adjusts create userdata typing. |
| sig/pe_client/resource/node_classifier.v1/rules.rbs | Updates translate signature to accept rule: and changes return type. |
| sig/pe_client/resource/node_classifier.v1/import_hierarchy.rbs | Updates replace signature to take an array payload. |
| README.md | Links to docs and updates certificate-auth SSL example. |
| lib/pe_client/resources/rbac.v2/users.rb | Updates RBAC v2 users YARD @see link. |
| lib/pe_client/resources/rbac.v1/saml.rb | Updates SAML configure to PUT /saml (no /configure). |
| lib/pe_client/resources/rbac.v1/ldap.rb | Updates LDAP update HTTP method and deprecated DS paths. |
| lib/pe_client/resources/rbac.v1/groups.rb | Updates groups create endpoint and deprecated create to use POST /groups. |
| lib/pe_client/resources/puppet.v3.rb | Requires env/code_id params for content endpoints; adds octet-stream headers. |
| lib/pe_client/resources/puppet_db/query.v4/nodes.rb | Doc comment formatting adjustments. |
| lib/pe_client/resources/puppet_db/query.v4/catalogs.rb | Doc comment formatting adjustments. |
| lib/pe_client/resources/puppet_ca.v1/certificate_status.rb | Updates @see link and shortens doc comment. |
| lib/pe_client/resources/orchestrator.v1/scopes.rb | Minor doc grammar fix. |
| lib/pe_client/resources/orchestrator.v1/scheduled_jobs.rb | Adds update method for scheduled environment jobs. |
| lib/pe_client/resources/orchestrator.v1/plan_jobs.rb | Updates event detail endpoint path (/event/<id>). |
| lib/pe_client/resources/node_classifier.v1/rules.rb | Changes translate to POST with rule body + format param. |
| lib/pe_client/resources/node_classifier.v1/import_hierarchy.rb | Changes replace to accept array payload. |
| lib/pe_client/resources/node_classifier.v1/groups.rb | Doc wording fixes. |
| lib/pe_client/resources/node_classifier.v1/group_children.rb | Doc punctuation fix. |
| lib/pe_client/resources/node_classifier.v1/environments.rb | Changes create to PUT /environments/<name>. |
| lib/pe_client/resources/node_classifier.v1.rb | Fixes module-level @see link to node classifier docs. |
| docs/status.md | New end-user doc for Status API. |
| docs/README.md | New docs index / TOC. |
| docs/rbac_service_v2.md | New end-user doc for RBAC v2 API. |
| docs/rbac_service_v1.md | New end-user doc for RBAC v1 API. |
| docs/puppetdb/metadata_v1.md | New end-user doc for PuppetDB metadata API. |
| docs/puppetdb/admin_v1.md | New end-user doc for PuppetDB admin API. |
| docs/puppetdb.md | New end-user doc hub for PuppetDB APIs. |
| docs/puppet_server.md | New end-user doc for Puppet Server APIs used by the gem. |
| docs/puppet_admin.md | New end-user doc for Puppet Admin API. |
| docs/orchestrator.md | New end-user doc for Orchestrator API. |
| docs/node_inventory.md | New end-user doc for Node Inventory API. |
| docs/node_classifier_service.md | New end-user doc for Node Classifier API. |
| docs/metrics.md | New end-user doc for Metrics API. |
| docs/getting_started.md | New getting-started guide (token + cert auth). |
| docs/code_manager.md | New end-user doc for Code Manager API. |
| docs/ca.md | New end-user doc for Certificate Authority API. |
| docs/activity_service.md | New end-user doc for Activity Service API. |
| .ruby-version | Updates developer Ruby version pin. |
docs: Update example client certificate authentication to use generic PKey docs: clarify NodeClassifierV1::Rules#translate documentation docs: OrchestratorV1::ScheduledJobs#create shouldn't accept nil for userdata
docs: don't use @option with an Array
docs: clarify CHANGELOG breaking changes
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.
Add additional documentation for reference with end users
Breaking Changes
PuppetV3#file_contentnow requires anenvironmentparameter.PuppetV3#static_file_contentnow requires thecode_idandenvironmentparameters.ImportHierarchy#replacenow accepts an Array of Hashes instead of a single Hash.