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.

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

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

Open
greglanthier opened this issue Mar 24, 2019 · 0 comments

Comments

@greglanthier
Copy link
Owner

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.

greglanthier added a commit that referenced this issue Mar 30, 2019
Trying to work around #2
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant