Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

✨ Add additonal OpenAPI metadata parameters toFastAPI class, shown on the automatic API docs UI#1812

Merged
tiangolo merged 11 commits intofastapi:masterfrom
dkreeft:add-info-parameters
Jul 29, 2021
Merged

✨ Add additonal OpenAPI metadata parameters toFastAPI class, shown on the automatic API docs UI#1812
tiangolo merged 11 commits intofastapi:masterfrom
dkreeft:add-info-parameters

Conversation

@dkreeft
Copy link
Contributor

As described in#843 that I needed and stumbled upon. This PR adds extra metadata parameters to the code and docs. So now you can specify contact and license information as well as terms of service.

I tried to keep the naming of the parameters in line with thespecification, but unfortunatelylicense is a Python built-in, so I went withlicense_info instead.

@dkreeftdkreeft marked this pull request as draftJuly 30, 2020 13:01
@codecov
Copy link

codecovbot commentedJul 30, 2020•
edited
Loading

Codecov Report

Merging#1812 (69e3b4b) intomaster (6c80e9a) willnot change coverage.
The diff coverage is100.00%.

Impacted file tree graph

@@            Coverage Diff            @@##            master     #1812   +/-   ##=========================================  Coverage   100.00%   100.00%           =========================================  Files          401       401             Lines        10080     10090   +10     =========================================+ Hits         10080     10090   +10
Impacted FilesCoverage Δ
docs_src/metadata/tutorial001.py100.00% <100.00%> (ø)
fastapi/applications.py100.00% <100.00%> (ø)
fastapi/openapi/utils.py100.00% <100.00%> (ø)
...ts/test_tutorial/test_metadata/test_tutorial001.py100.00% <100.00%> (ø)

Continue to review full report at Codecov.

Legend -Click here to learn more
Δ = absolute <relative> (impact),ø = not affected,? = missing data
Powered byCodecov. Last update6c80e9a...69e3b4b. Read thecomment docs.

@dkreeftdkreeft marked this pull request as ready for reviewJuly 30, 2020 13:10
Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>
@github-actions
Copy link
Contributor

📝 Docs preview for commitd977bce at:https://5f22d4d7fd565b6ce626f92a--fastapi.netlify.app

@dkreeft
Copy link
ContributorAuthor

@Kludex do you mind approving this PR? Thanks!

@github-actions
Copy link
Contributor

📝 Docs preview for commit01144e1 at:https://5f2ae80bbc92b5c8d4e9f3cc--fastapi.netlify.app

@dkreeft
Copy link
ContributorAuthor

@tiangolo any ETA for approving this request? In my team we are waiting for this change.

@tiangolo
Copy link
Member

Thanks@dkreeft! 🚀

I updated it a bit, updated the type annotations, order of arguments, and the docs.

Thanks for your contribution! ☕ 🍰

This will be available later today in FastAPI version0.68.0 🔖🎉

@github-actions
Copy link
Contributor

📝 Docs preview for commit69e3b4b at:https://6102c48f4a903a39c0f03146--fastapi.netlify.app

@tiangolotiangolo changed the titleAdd extra metadata parameters to code and docs✨ Add additonal OpenAPI metadata parameters toFastAPI class, shown on the automatic API docs UIJul 29, 2021
@tiangolotiangolo merged commit6f45f43 intofastapi:masterJul 29, 2021
solomein-sv pushed a commit to solomein-sv/fastapi that referenced this pull requestJul 30, 2021
… on the automatic API docs UI (fastapi#1812)Co-authored-by: Marcelo Trylesinski <marcelotryle@gmail.com>Co-authored-by: dkreeft <dkreeft@xccelerated.io>Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@KludexKludexKludex left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@dkreeft@tiangolo@Kludex

Comments

[8]ページ先頭
©2009-2026 Movatter.jp