Enumerate model properties in Filter/Where schema

The pull request #1679 is adding getFilterJsonSchemaFor API for obtaining a JSON/OpenAPI schema of a filter argument. The initial implementation is generic and does not describe the actual model properties in the schema. Let's fix that!

LB4 models are strict by default (extra properties are not allowed).
It's possible to create a LB4 model that allows additional properties, Filter schema needs to detect and support this case.
Besides model properties, where object can contain operators like and, or, inq. See their full list in our docs: Where filter: Operators.
Besides where condition, model properties are used by fields property too.

@bajtos

Hello @bajtos, I'm working on this as my first open-source commit.

Here is how I made it work for fields:

fields: {
    type: 'object',
    properties: Object.assign(
        {},
        ...Object.keys(modelCtor.definition.properties).map(k => ({
            [k]: {type: 'boolean'},
        })),
    ),
    additionalProperties: true,
}

I can follow the same principle for other properties if you think I'm going in the right direction.

Here is my pull request: #2241

I am very excited to start contributing to such a great project. Please tell me if there is something I can improve to get my PRs accepted.

Closing as done via #2241

Navigation Menu

Repository navigation

Enumerate model properties in Filter/Where schema #1748

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Enumerate model properties in Filter/Where schema #1748

Description

Activity

ghsamm commented on Jan 12, 2019

bajtos commented on Feb 8, 2019

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions