Skip to content

v14.1.0

Choose a tag to compare

View all tags
@GianfrancoFrau GianfrancoFrau released this 21 Nov 10:54
· 1 commit to master since this release
v14.1.0
4e1333d

🎉 What's New in v14.1.0

This release adds complete OpenAPI 3.1.0 support while maintaining 100% backward compatibility with existing code.

✨ Major Features

1. OpenAPI 3.1.0 Full Support

  • ✅ Upgraded from OpenAPI 3.0.2 to 3.1.0
  • ✅ Complete JSON Schema Draft 2020-12 support
  • ✅ jsonSchemaDialect property added to OpenAPI documents
  • ✅ All OpenAPI 3.1 features available

2. Backward Compatibility Layer

  • ✅ JSON_SCHEMA_DRAFT_7 alias maintains compatibility with existing code
  • ✅ No breaking changes - existing code continues to work
  • ✅ Gradual migration path available
  • ✅ Legacy nullable property still supported

3. New JSON Schema Draft 2020-12 Features

dependentRequired - Make fields required based on other fields:

{
  "properties": {
    "creditCard": { "type": "boolean" },
    "cardNumber": { "type": "string" },
    "billingAddress": { "type": "string" }
  },
  "dependentRequired": {
    "creditCard": ["cardNumber", "billingAddress"]
  }
}

dependentSchemas - Apply conditional schemas:

{
  "dependentSchemas": {
    "creditCard": {
      "properties": {
        "cardType": { "enum": ["visa", "mastercard"] }
      },
      "required": ["cardType"]
    }
  }
}

Other new features:

  • prefixItems for tuple validation
  • const for constant values
  • contentSchema for encoded content validation
  • Enhanced schema references with $dynamicRef

4. Comprehensive Test Suite

  • ✅ 15 new tests specifically for OpenAPI 3.1 features
  • ✅ 302 total tests passing (100% pass rate)
  • ✅ 97.8% code coverage maintained
  • ✅ Tests for backward compatibility

📦 Dependencies

  • openapi-police: 4.0.5 → 5.0.0-beta.1 (OpenAPI 3.1 support)

🔄 Migration Guide

No changes required! Your existing code will continue to work:

// This still works
import { JSON_SCHEMA_DRAFT_7 } from 'arrest';

// But you can also use the new name
import { JSON_SCHEMA_DRAFT_2020_12 } from 'arrest';

To adopt new features:

  1. Start using OpenAPI 3.1 features in your schemas
  2. Update nullable: true to type: ["string", "null"] (optional)
  3. Leverage new Draft 2020-12 validators

📊 Statistics

  • Tests: 302 passing (216 core + 71 MongoDB + 15 OpenAPI 3.1)
  • Coverage: 97.8% (non-MongoDB code)
  • Build: TypeScript compiles successfully
  • Breaking Changes: None

🐛 Bug Fixes

No bug fixes in this release - pure feature addition.

📝 Commits

  • 4e1333d chore: bump version to 14.1.0
  • 0a139d3 Add OpenAPI 3.1 backward compatibility and comprehensive tests
  • 78096a2 Merge feature/openapi-3.1-support: Add OpenAPI 3.1 support

🔗 Resources

⚠️ Known Issues

  • MongoDB tests require port 27017 to be available
  • Some validation features in dependentRequired may require openapi-police updates

Full Changelog: v14.0.1...v14.1.0

Assets 2
Loading