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

Enrich OpenAPI specification #181

Closed
Tracked by #170
perdy opened this issue Mar 4, 2025 · 0 comments · Fixed by #182
Closed
Tracked by #170

Enrich OpenAPI specification #181

perdy opened this issue Mar 4, 2025 · 0 comments · Fixed by #182
Assignees
@perdy
Labels
feature request Request for a new feature
Milestone
1.10.0

Comments

@perdy
Copy link
Member

perdy commented Mar 4, 2025

Summary

Allow Flama to provide a detailed OpenAPI specification

Motivation

At this point Flama could only provide title, version and description fields for OpenAPI specification, apart from those that are inferred directly from the code.

It would be of interest to add a mechanism for providing the rest of the information contained in an OpenAPI specification.

Proposed changes

Modify the Flama application to:

  • drop title, version and description parameters,
  • add a new openapi parameter that allows to provide a dictionary with the static values of an OpenAPI specification, such as the info field.
@perdy perdy added the feature request Request for a new feature label Mar 4, 2025
@perdy perdy added this to the 1.10.0 milestone Mar 4, 2025
@perdy perdy self-assigned this Mar 4, 2025
@perdy perdy linked a pull request Mar 4, 2025 that will close this issue
Enrich OpenAPI and new docs page #182
Merged
@perdy perdy mentioned this issue Mar 4, 2025
Merged
7 tasks
perdy added a commit that referenced this issue Mar 4, 2025
@perdy
✨ Enrich OpenAPI specification (#181)
b84a4a5
perdy added a commit that referenced this issue Mar 4, 2025
@perdy
✨ Enrich OpenAPI specification (#181)
2f95f9f
github-actions bot pushed a commit that referenced this issue Mar 4, 2025
@semantic-release-bot
🔖 1.10.0 [skip ci]
cba4457 
# [v1.10.0](v1.9.8...v1.10.0) (2025-03-04)

## ✨ New Features
- [`ede5e71`](ede5e71)  Path params component (#171) (Issues: [`#171`](https://github.com/vortico/flama/issues/))
- [`20fb505`](20fb505)  Replace black and isort with ruff (#174) (Issues: [`#174`](https://github.com/vortico/flama/issues/))
- [`2be8599`](2be8599)  Replace poetry with uv (#175) (Issues: [`#175`](https://github.com/vortico/flama/issues/))
- [`acb3896`](acb3896)  Module for gathering telemetry data (#169) (Issues: [`#169`](https://github.com/vortico/flama/issues/))
- [`ee9ccad`](ee9ccad)  Update error pages (#178) (Issues: [`#178`](https://github.com/vortico/flama/issues/))
- [`2f95f9f`](2f95f9f)  Enrich OpenAPI specification (#181) (Issues: [`#181`](https://github.com/vortico/flama/issues/))
- [`e4c2587`](e4c2587)  Docs page using Scalar (#179) (Issues: [`#179`](https://github.com/vortico/flama/issues/))

## 🐛 Bug Fixes
- [`9d35c83`](9d35c83)  Remove warning from using marshmallow Number instad of Float
perdy added a commit that referenced this issue Mar 4, 2025
@perdy
✨ Enrich OpenAPI specification (#181)
33f00ac
github-actions bot pushed a commit that referenced this issue Mar 4, 2025
@semantic-release-bot
🔖 1.10.0 [skip ci]
f456a56 
# [v1.10.0](v1.9.8...v1.10.0) (2025-03-04)

## ✨ New Features
- [`ede5e71`](ede5e71)  Path params component (#171) (Issues: [`#171`](https://github.com/vortico/flama/issues/))
- [`20fb505`](20fb505)  Replace black and isort with ruff (#174) (Issues: [`#174`](https://github.com/vortico/flama/issues/))
- [`0df0f60`](0df0f60)  Replace poetry with uv (#175) (Issues: [`#175`](https://github.com/vortico/flama/issues/))
- [`47a418b`](47a418b)  Module for gathering telemetry data (#169) (Issues: [`#169`](https://github.com/vortico/flama/issues/))
- [`8bf6c95`](8bf6c95)  Update error pages (#178) (Issues: [`#178`](https://github.com/vortico/flama/issues/))
- [`33f00ac`](33f00ac)  Enrich OpenAPI specification (#181) (Issues: [`#181`](https://github.com/vortico/flama/issues/))
- [`9da8ba6`](9da8ba6)  Docs page using Scalar (#179) (Issues: [`#179`](https://github.com/vortico/flama/issues/))

## 🐛 Bug Fixes
- [`9d35c83`](9d35c83)  Remove warning from using marshmallow Number instad of Float
perdy added a commit that referenced this issue Mar 4, 2025
@perdy
✨ Enrich OpenAPI specification (#181)
461f909
perdy added a commit that referenced this issue Mar 4, 2025
@perdy
✨ Enrich OpenAPI specification (#181)
371630e
perdy added a commit that referenced this issue Mar 4, 2025
@perdy
✨ Enrich OpenAPI specification (#181)
82525a0
github-actions bot pushed a commit that referenced this issue Mar 4, 2025
@semantic-release-bot
🔖 1.10.0 [skip ci]
d5415ea 
# [v1.10.0](v1.9.8...v1.10.0) (2025-03-04)

## ✨ New Features
- [`ede5e71`](ede5e71)  Path params component (#171) (Issues: [`#171`](https://github.com/vortico/flama/issues/))
- [`20fb505`](20fb505)  Replace black and isort with ruff (#174) (Issues: [`#174`](https://github.com/vortico/flama/issues/))
- [`be86afa`](be86afa)  Replace poetry with uv (#175) (Issues: [`#175`](https://github.com/vortico/flama/issues/))
- [`dd8adcb`](dd8adcb)  Module for gathering telemetry data (#169) (Issues: [`#169`](https://github.com/vortico/flama/issues/))
- [`b73754a`](b73754a)  Update error pages (#178) (Issues: [`#178`](https://github.com/vortico/flama/issues/))
- [`82525a0`](82525a0)  Enrich OpenAPI specification (#181) (Issues: [`#181`](https://github.com/vortico/flama/issues/))
- [`e18e871`](e18e871)  Docs page using Scalar (#179) (Issues: [`#179`](https://github.com/vortico/flama/issues/))

## 🐛 Bug Fixes
- [`9d35c83`](9d35c83)  Remove warning from using marshmallow Number instad of Float
perdy added a commit that referenced this issue Mar 4, 2025
@perdy
✨ Enrich OpenAPI specification (#181)
e247c13
perdy added a commit that referenced this issue Mar 4, 2025
@perdy
✨ Enrich OpenAPI specification (#181)
b771b9f
github-actions bot pushed a commit that referenced this issue Mar 4, 2025
@semantic-release-bot
🔖 1.10.0 [skip ci]
f579405 
# [v1.10.0](v1.9.8...v1.10.0) (2025-03-04)

## ✨ New Features
- [`ede5e71`](ede5e71)  Path params component (#171) (Issues: [`#171`](https://github.com/vortico/flama/issues/))
- [`20fb505`](20fb505)  Replace black and isort with ruff (#174) (Issues: [`#174`](https://github.com/vortico/flama/issues/))
- [`0671bfe`](0671bfe)  Replace poetry with uv (#175) (Issues: [`#175`](https://github.com/vortico/flama/issues/))
- [`14faf81`](14faf81)  Module for gathering telemetry data (#169) (Issues: [`#169`](https://github.com/vortico/flama/issues/))
- [`3193d63`](3193d63)  Update error pages (#178) (Issues: [`#178`](https://github.com/vortico/flama/issues/))
- [`b771b9f`](b771b9f)  Enrich OpenAPI specification (#181) (Issues: [`#181`](https://github.com/vortico/flama/issues/))
- [`e99a739`](e99a739)  Docs page using Scalar (#179) (Issues: [`#179`](https://github.com/vortico/flama/issues/))

## 🐛 Bug Fixes
- [`9d35c83`](9d35c83)  Remove warning from using marshmallow Number instad of Float
@perdy perdy closed this as completed Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@perdy perdy

Labels
feature request Request for a new feature
Projects
None yet
Milestone
1.10.0
Development

Successfully merging a pull request may close this issue.

Enrich OpenAPI and new docs page vortico/flama
1 participant
@perdy