Giter VIP home page Giter VIP logo

Comments (4)

horejsek avatar horejsek commented on July 18, 2024

I don't understand what you mean. Can you provide an example?

from python-fastjsonschema.

niksabaldun avatar niksabaldun commented on July 18, 2024

When application users add new items, they have to provide all the properties. But if they are changing an existing item, they may only change one or two properties, so the document being validated will only contain those properties and therefore validation will fail if there are required properties defined in schema. In Cerberus validation library, for example, it is possible to provide update=True argument to validate method, in which case no error is raised if required properties are missing.

from python-fastjsonschema.

horejsek avatar horejsek commented on July 18, 2024

I would recommend to have one definition without required field and then create second one with added required. So instead of something like that:

DEFINITION = {
    'type': 'object',
    'required': ['name', 'surname'],
    'name': {'type': 'string'},
    'surname': {'type': 'string'},
    'age': {'type': 'number'},
}

def create(data):
    data = fastjsonschema.validate(DEFINITION, data)
    # ...

def update(data):
    data = fastjsonschema.validate(DEFINITION, data, update=True)  # or more clearly ignore_required=True
    # ...

You would have:

DEFINITION_UPDATE = {
    'type': 'object',
    'name': {'type': 'string'},
    'surname': {'type': 'string'},
    'age': {'type': 'number'},
}

DEFINITION_CREATE = copy.deepcopy(DEFINITION_UPDATE)
DEFINITION_CREATE['required'] = ['name', 'surname']

def create(data):
    data = fastjsonschema.validate(DEFINITION_CREATE, data)
    # ...

def update(data):
    data = fastjsonschema.validate(DEFINITION_UPDATE, data)
    # ...

The second version is also better approach because sometimes even during update you would need to require some attributes. It's then more clear what is really needed. It's more explicit. :-)

from python-fastjsonschema.

niksabaldun avatar niksabaldun commented on July 18, 2024

Yes, you are right. Just ignoring required properties is not enough, there could be properties depending on the value or existence of another property. Thanks for the advice.

from python-fastjsonschema.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.