Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

APIv3: Support filter paramters passed via filter_parameters array #8253

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

APIv3: Support filter paramters passed via filter_parameters array #8253

wants to merge 2 commits into from

Commits on Apr 18, 2024

  1. Handle filter parameters passed via a filter_parameters 

    Filter parameters can now be passed as a space separated array via the
filter_parameters query argument. They are then treated the same as
unlabeled filter parameters.

e.g. filter_parameters=date$gt%3D1491719030000 == date$gt=1491719030000

This is closer to matching the Swagger API definition.

Tests are added to verify the new behavior.
    @bniels707
    bniels707 committed Apr 18, 2024
    Configuration menu
    Copy the full SHA
    3ceed01 View commit details
    Browse the repository at this point in the history

  2. Change Swagger definition of filter_parameters to array 

    This updates the Swagger definition to reflect the fact
filter_parameters can now be passed as a space delimited string array.

The JSON file was generated using openapi-generator:

java -jar openapi-generator-cli-7.4.0.jar generate -i cgm-remote-monitor/lib/api3/swagger.yaml -g openapi --skip-validate-spec

It is possible there are other changes than just those made to
filter_parameters, but since the Swagger definition appears to only be
used for the API docs / "Try It Out" feature there shouldn't be any
risk to accepting the updated definition.
    @bniels707
    bniels707 committed Apr 18, 2024
    Configuration menu
    Copy the full SHA
    305e014 View commit details
    Browse the repository at this point in the history