Browse the schemas at https://schemas.sourcemeta.com/sourcemeta/std

Building professional OpenAPI specifications demands precision, but mastering JSON Schema is hard. This library eliminates that burden by providing production-ready schemas that encode industry standards and best practices. Reference them directly in your API specifications and focus on what matters: designing great APIs.

Led and maintained by a member of the JSON Schema Technical Steering Committee

Use this library to:

• Build production-grade OpenAPI specifications without writing schemas from scratch
• Skip the JSON Schema learning curve while maintaining expert-level quality
• Meet compliance and regulatory requirements with standards-based validation
• Establish a solid foundation for your organisation's API governance program

• 🚀 Getting Started
  • From Sourcemeta Schemas
  • From GitHub Releases
  • Using Git Submodules
  • Using Vendorpull
• 🎓 Citing
• 📄 License
• 🤝 Contributing
• 📧 Contact

While you can always copy-paste schemas directly, here are more convenient and maintainable ways to consume them.

We periodically publish the JSON Schema standard library to Sourcemeta Schemas, our free service for hosting open-source schemas. Each schema gets a unique HTTPS URL that you can directly reference from your OpenAPI specifications using the $ref keyword. For example:

schema:
  type: object
  properties:
    email:
      $ref: 'https://schemas.sourcemeta.com/sourcemeta/std/<version>/ietf/email/address'

To de-reference and embed these external URLs when distributing your OpenAPI specification, use standard tools like redocly bundle.

We publish archives of the JSON Schema standard library to GitHub Releases. Download and extract an archive to your preferred location, then reference the JSON files from your OpenAPI specifications using the $ref keyword with a relative path. For example:

schema:
  type: object
  properties:
    email:
      $ref: "../path/to/sourcemeta-std/ietf/email/address.json"

If your OpenAPI specification lives in a Git repository, you can add this library as a git submodule. This approach keeps the schemas versioned alongside your code and ensures consistent access across your team. Add the submodule to your repository:

git submodule add https://github.com/sourcemeta/std std

Then reference the schemas using the $ref keyword with a relative path. For example:

schema:
  type: object
  properties:
    email:
      $ref: './std/schemas/ietf/email/address.json'

Vendorpull is our tool for vendoring Git repositories, which we use across our projects. It provides an easier alternative to submodules by committing upstream contents directly into your repository while letting you easily manage and update them. Add this line to your DEPENDENCIES file:

std https://github.com/sourcemeta/std v<x.y.z>

Then pull the library into your vendor directory:

./vendor/vendorpull/pull std

Reference the schemas using the $ref keyword with a relative path. For example:

schema:
  type: object
  properties:
    email:
      $ref: './vendor/std/schemas/ietf/email/address.json'

If you use this library in your research or project, please cite it using the DOI provided above. You can find citation information in various formats (BibTeX, APA, etc.) by clicking the "Cite as" button on the Zenodo record.

While the project is publicly available on GitHub, it operates under a source-available license rather than a traditional open-source model. You may freely use these schemas for non-commercial purposes, but commercial use requires a paid commercial license.

We are happy to discuss OEM and white-label distribution options for incorporating these schemas into commercial products.

We welcome contributions! By sending a pull request, you agree to our contributing guidelines. Meaningful contributions to this repository can be taken into consideration towards a discounted (or even free) commercial license.

If you have any questions or comments, don't hesitate in opening a ticket on GitHub Discussions or writing to us at [email protected].