Is there any property that I can add to the MongoDB validation schema to add additional information without impacting the validation of new documents?

Question

Is there any way I can insert a property into this validator for inserting documents into MongoDB that will not impact validation but that I can retrieve via query?

To give some context: I use the validator to create a form dynamically, and I need some extra information to create the form according to my needs.

{
  $jsonSchema: {
    bsonType: 'object',
    required: [
      'active',
      'productive',
      'translation',
      'code'
    ],
    properties: {
      code: {
        bsonType: 'string',
        minLength: 0,
        maxLength: 50,
      },
      active: {
        bsonType: 'bool'
      },
      productive: {
        bsonType: 'bool'
      },
      translation: {
        bsonType: 'object',
        properties: {
          'pt-BR': {
            bsonType: 'object',
            required: [
              'description'
            ],
            properties: {
              description: {
                bsonType: 'string',
                minLength: 0,
                maxLength: 50
              }
            }
          },
          'en-US': {
            bsonType: 'object',
            required: [
              'description'
            ],
            properties: {
              description: {
                bsonType: 'string',
                minLength: 0,
                maxLength: 50
              }
            }
          }
        }
      },
      audit: {
        bsonType: 'object',
        required: [
          'user'
        ],
        properties: {
          user: {
            bsonType: 'string'
          }
        }
      }
    }
  }
}

Jeremy Fiel · Accepted Answer · 2024-12-04 19:29:36Z

0

MongoDB is based on JSON Schema draft-04. By the Specification, unknown keywords should be ignored during validation.

A common pattern for unknown or custom keywords is to prefix x-

{
  $jsonSchema: {
    bsonType: 'object',
    x-mycustomKeyword: {
      bsonType: 'string'
    }
  }
}

answered Dec 4, 2024 at 19:29

Jeremy Fiel

3,6502 gold badges14 silver badges27 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Is there any property that I can add to the MongoDB validation schema to add additional information without impacting the validation of new documents?

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related