Page MenuHomeVyOS Platform
Create Task
Maniphest T2395

HTTP API move to flask/flask-restx as microframework
Closed, ResolvedPublicFEATURE REQUEST
Actions

Description

Flask is a microframework similar to bottle, which is currently used for the HTTP API. The Flask extension flask-restx provides Swagger support for exposing the existing api as an OpenAPI document.

Details

Difficulty level
Unknown (require assessment)
Version
vyos 1.3
Why the issue appeared?
Will be filled on close
Is it a breaking change?
Perfectly compatible
Issue type
Internal change (not visible to end users)

Related Objects
Search...

Event Timeline

jestabro changed the task status from Open to In progress.Apr 29 2020, 5:26 AM
jestabro triaged this task as Normal priority.
jestabro created this task.
jestabro created this object in space S1 VyOS Public.
jestabro added a comment.Apr 29 2020, 5:35 AM

https://github.com/vyos/vyos-1x/compare/current...jestabro:openapi?expand=1

This has a dependency on python3-flask-restx, which will need to be added using, for example, T2396.

jestabro added a subtask: T2396: Add debian package for flask-restx.Apr 29 2020, 5:36 AM
jestabro added a subtask: T2397: HTTP API: export OpenAPI definition.Apr 29 2020, 6:04 AM
pasik added a subscriber: pasik.Apr 30 2020, 9:40 AM
jestabro edited projects, added VyOS 1.3 Equuleus; removed VyOS 1.2 Crux.Apr 30 2020, 7:06 PM
jestabro changed the status of subtask T2397: HTTP API: export OpenAPI definition from In progress to Needs testing.May 27 2020, 7:13 PM
jestabro closed this task as Resolved.May 27 2020, 7:27 PM
jestabro moved this task from Need Triage to Finished on the VyOS 1.3 Equuleus board.

The dependency on flask-restx was dropped, in favor of FastAPI. The move to Flask itself for stability was completed,

jestabro removed a subtask: T2397: HTTP API: export OpenAPI definition.May 27 2020, 7:27 PM
jestabro closed subtask T2396: Add debian package for flask-restx as Invalid.
jestabro added a subtask: T3412: HTTP API: move to FastAPI as web framework.Mar 16 2021, 4:54 PM
jestabro changed the status of subtask T3412: HTTP API: move to FastAPI as web framework from In progress to Needs testing.Mar 17 2021, 9:20 PM
jestabro closed subtask T3412: HTTP API: move to FastAPI as web framework as Resolved.Mar 26 2021, 8:49 PM
erkin set Issue type to Internal change (not visible to end users).Aug 30 2021, 6:30 AM
erkin removed a subscriber: Active contributors.
syncer edited projects, added VyOS 1.3 Equuleus (1.3.0); removed VyOS 1.3 Equuleus.Aug 30 2022, 2:01 PM
syncer moved this task from Need Triage to Finished on the VyOS 1.3 Equuleus (1.3.0) board.