feat: initial job property validation docs by achrinza · Pull Request #915 · cloudfoundry/docs-bosh

achrinza · 2026-07-12T17:21:39Z

Document BOSH release job property validation

see: cloudfoundry/community#1049
see: cloudfoundry/bosh-cli#681
see: cloudfoundry/bosh#2602

coderabbitai · 2026-07-12T17:21:55Z

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

@coderabbitai resume to resume automatic reviews.
@coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

▶️ Resume reviews
🔍 Trigger review

Walkthrough

Updates job specification documentation with a YAML example title and a property validation section covering BOSH version requirements, bosh create-env behavior, per-job properties_schema.json files, JSON Schema examples, the custom certificate type, and validation-only schema scope.

Suggested reviewers: neddp

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: initial documentation for job property validation.
Description check	✅ Passed	The description matches the documentation-focused changes and references the related BOSH validation work.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

coderabbitai

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@content/jobs.md`:
- Around line 111-112: Insert a blank line between the `---` separator and the
`## Property validation` heading in the property-validation section, preserving
the heading and separator unchanged.
- Around line 132-139: Update the trusted_certificate property in
properties-schema.json to use the valid JSON Schema type "string" instead of
"certificate"; preserve any certificate-specific requirements through separate
validation or description metadata.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 4fbd9741-2a4a-4ea1-b892-432454065c91

📥 Commits

Reviewing files that changed from the base of the PR and between 31eab35 and 0feabf3.

📒 Files selected for processing (1)

content/jobs.md

achrinza · 2026-07-13T07:35:09Z

@coderabbitai review

coderabbitai · 2026-07-13T07:35:16Z

✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

aramprice

Looks good, thank you for the additions. I ran copilot, feel free to resolve any comments that aren't helpful.

Copilot

Pull request overview

Documents BOSH release job property validation by introducing a new “Property validation” section in the release jobs documentation, including version requirements and example JSON Schemas.

Changes:

Adds a dedicated “Property validation” section describing how job properties can be validated via JSON Schema.
Includes example schema files and a BOSH-specific JSON Schema certificate type extension.
Improves/clarifies existing wording around job spec property keys and validation.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

aramprice · 2026-07-16T14:47:02Z

@achrinza - could you rebase this, there appear to be conflicts. Thanks!

Document BOSH release job property validation see: cloudfoundry/community#1049 see: cloudfoundry/bosh-cli#681 see: cloudfoundry/bosh#2602 Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>

Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@content/jobs.md`:
- Around line 148-149: Update the BOSH custom certificate type description to
state that validation accepts values parseable by
OpenSSL::X509::Certificate.load, including PEM or DER encodings, rather than
requiring PEM-encoded X.509 v3 certificates. Explicitly document that an empty
string is accepted if this behavior is intentional.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 10940be6-3ada-401e-be03-26a33bd7e8f0

📥 Commits

Reviewing files that changed from the base of the PR and between 57ca4c9 and c1e9d04.

📒 Files selected for processing (1)

content/jobs.md

coderabbitai

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@content/jobs.md`:
- Around line 127-128: Update the wording in the deployment validation
description to refer to a “JSON Schema” rather than a “JSON Schema instance,”
while preserving the existing explanation of Director-enforced validation during
BOSH deployments.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

Push a commit to this branch (recommended)
Create a new PR with the fixes

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: cbd74844-55af-4ab7-a9eb-fd3086c7d1b5

📥 Commits

Reviewing files that changed from the base of the PR and between c1e9d04 and 3217984.

📒 Files selected for processing (1)

content/jobs.md

- Document restriction to Draft 2020-12 - Explain zero-string validity for `type: "certificate"` - Fix incorrect `JSON Schema instance` to `JSON Schema document` Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>

coderabbitai Bot requested changes Jul 12, 2026

View reviewed changes

Comment thread content/jobs.md

Comment thread content/jobs.md Outdated

cf-foundation-community-automation Bot added this to Foundational Infrastructure Working Group Jul 12, 2026

coderabbitai Bot previously approved these changes Jul 12, 2026

View reviewed changes

cf-foundation-community-automation Bot moved this to Inbox in Foundational Infrastructure Working Group Jul 12, 2026

github-project-automation Bot moved this from Inbox to Pending Merge | Prioritized in Foundational Infrastructure Working Group Jul 12, 2026

achrinza dismissed coderabbitai[bot]’s stale review via 1395c14 July 12, 2026 17:32

achrinza force-pushed the feat/property-validation branch 5 times, most recently from afcdff8 to cc69f46 Compare July 13, 2026 06:17

coderabbitai Bot previously approved these changes Jul 13, 2026

View reviewed changes

aramprice previously approved these changes Jul 13, 2026

View reviewed changes

aramprice requested a review from Copilot July 13, 2026 16:19

Copilot started reviewing on behalf of aramprice July 13, 2026 16:19 View session

Copilot AI reviewed Jul 13, 2026

View reviewed changes

Comment thread content/jobs.md Outdated

Comment thread content/jobs.md Outdated

Comment thread content/jobs.md Outdated

achrinza dismissed stale reviews from aramprice and coderabbitai[bot] via 57ca4c9 July 13, 2026 16:24

coderabbitai Bot previously approved these changes Jul 13, 2026

View reviewed changes

aramprice moved this from Pending Merge | Prioritized to Waiting for Changes | Open for Contribution in Foundational Infrastructure Working Group Jul 16, 2026

achrinza added 2 commits July 19, 2026 15:51

feat: initial job property validation docs

5fa7bda

Document BOSH release job property validation see: cloudfoundry/community#1049 see: cloudfoundry/bosh-cli#681 see: cloudfoundry/bosh#2602 Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>

fix: apply copilot suggestions

c1e9d04

Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>

achrinza dismissed coderabbitai[bot]’s stale review via c1e9d04 July 19, 2026 07:51

achrinza force-pushed the feat/property-validation branch from 57ca4c9 to c1e9d04 Compare July 19, 2026 07:51

coderabbitai Bot requested changes Jul 19, 2026

View reviewed changes

Comment thread content/jobs.md Outdated

coderabbitai Bot requested changes Jul 19, 2026

View reviewed changes

Comment thread content/jobs.md Outdated

fix: clarify property validation

4c4455f

- Document restriction to Draft 2020-12 - Explain zero-string validity for `type: "certificate"` - Fix incorrect `JSON Schema instance` to `JSON Schema document` Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>

achrinza force-pushed the feat/property-validation branch from 3217984 to 4c4455f Compare July 19, 2026 09:03

coderabbitai Bot approved these changes Jul 19, 2026

View reviewed changes

github-project-automation Bot moved this from Waiting for Changes | Open for Contribution to Pending Merge | Prioritized in Foundational Infrastructure Working Group Jul 19, 2026

Uh oh!

Conversation

achrinza commented Jul 12, 2026

Uh oh!

coderabbitai Bot commented Jul 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviews paused

Walkthrough

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

achrinza commented Jul 13, 2026

Uh oh!

coderabbitai Bot commented Jul 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

aramprice left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

aramprice commented Jul 16, 2026

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

coderabbitai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

coderabbitai Bot commented Jul 12, 2026 •

edited

Loading

coderabbitai Bot commented Jul 13, 2026 •

edited

Loading

aramprice left a comment •

edited

Loading