Skip to content

Enhance FedRAMP JSON schema and add auto-generated documentation#25

Merged
pete-gov merged 4 commits intopwx-afr-policiesfrom
json-schema-updates
Nov 17, 2025
Merged

Enhance FedRAMP JSON schema and add auto-generated documentation#25
pete-gov merged 4 commits intopwx-afr-policiesfrom
json-schema-updates

Conversation

@dan-fedramp
Copy link
Contributor


Overview

This pull request introduces improvements to the FedRAMP.schema.json file by adding detailed descriptions to properties for clarity and enhancing the validation rules. Additionally, it implements json-schema-for-humans to automatically generate documentation for the schema. The README has been updated with instructions for generating this documentation.

Changes

  • Added detailed descriptions to properties in FedRAMP.schema.json.
  • Enhanced schema validation rules to improve usability.
  • Implemented json-schema-for-humans to generate human-readable schema documentation.
  • Updated README file with documentation generation instructions.

Checklist

  • Tests added or updated, if applicable
  • Documentation updated, if needed
  • Validation rules tested and verified

@dan-fedramp dan-fedramp requested a review from pete-gov November 17, 2025 18:14
@pete-gov pete-gov merged commit 657ee09 into pwx-afr-policies Nov 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants