1387064 - make admin swagger spec OpenAPI 2.0 compliant

Status: RESOLVED WONTFIX

(Release Engineering Graveyard :: Applications: Balrog (backend), enhancement, P3)

Description

[[e-mail] (:bhearsum)]

We've recently started using OpenAPI-style specs to define both our admin and public APIs. We use Connexion to load and create routes for them in Flask. It turns out that Connexion has some extensions that make it possible for us to have Connexion-compatible specs that aren't OpenAPI 2.0 compliant. The consequence of this is that we cannot make use of other OpenAPI 2.0 tools, such as https://github.com/swagger-api/swagger-codegen.

This bug is to track making the admin API spec OpenAPI 2.0 compliant.

Comment 1

[[e-mail] (:bhearsum)]

Lowering priority on this - we may end up building a new API from the ground up instead.

Comment 3

[Nick Thomas [:nthomas] (UTC+12)]

Bug 1487261 is about our python dep swagger-spec-validator becoming strict about OpenAPI 2.0 compliance in v2.4.0, and we're pinned to the last version before that.

https://github.com/mozilla/balrog/pull/834 tried to update another dep, connexion, to 2.0.0. That switched from swagger-spec-validator to openapi-spec-validator, which is also strict about compliance. So connexion also pinned now.

Comment 4

[Allan [:asilva]]

Update: The new release of connexion, comes with OAS 3 support.

https://github.com/zalando/connexion/issues/420

Comment 5

[[e-mail] (:bhearsum)]

We won't be fixing this. The time is better spent upgrading to 3.0.