Skip to content

Unable to generate a client that uses multi-level deepObject serialization  #2

@greglanthier

Description

@greglanthier

TL;DR:

Coming up with a way to encode a multi-dimensional deep object query parameter in an OpenAPI specification is not well defined right now (see OAI/OpenAPI-Specification#1706)

This will make it difficult to generate a 100% complete API client from an OpenAPI spec that fully supports the CFL API.

Background

The CFL API operations that use filters rely on what the OpenAPI specification calls deepObject serialization. The current OpenAPI specification only covers the case where the object in question is one level deep, i.e.:

.../foo?filter[key]=value

{"key":"value"}

The filters on the Games APIs are two levels deep, i.e.:

/v1/games?filter[team][eq]=TOR

{
  "team" : {
    "eq" : "TOR"
  }
}

Until I come up with a workaround for this it will not be possible to support filter operations in the CFL API.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions