Skip to content

misc: Improve API docs and annotations for rom endpoints #2033

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

Merged
merged 1 commit into from
Jun 30, 2025

Conversation

adamantike
Copy link
Contributor

Description

  • Add type annotations for FastAPI header, query, and path parameters.
  • Add type annotations for request body content.
  • Update docstrings to clarify endpoint functionality, and remove unnecessary details.

Checklist

  • I've tested the changes locally
  • I've updated relevant comments
  • I've assigned reviewers for this PR
  • I've added unit tests that cover the changes

* Add type annotations for FastAPI header, query, and path parameters.
* Add type annotations for request body content.
* Update docstrings to clarify endpoint functionality, and remove
  unnecessary details.
@adamantike adamantike requested review from gantoine and zurdi15 June 29, 2025 14:58
Copy link

trunk-io bot commented Jun 29, 2025

Running Code Quality on PRs by uploading data to Trunk will soon be removed. You can still run checks on your PRs using trunk-action - see the migration guide for more information.

Copy link

Test Results

91 tests   91 ✅  31s ⏱️
 1 suites   0 💤
 1 files     0 ❌

Results for commit 195a189.

Copy link
Member

@gantoine gantoine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

very nice, looking forward to more of these

@adamantike adamantike merged commit 5ca59e0 into master Jun 30, 2025
9 checks passed
@adamantike adamantike deleted the misc/improve-api-docs-rom-endpoints branch June 30, 2025 02:34
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

Successfully merging this pull request may close these issues.

2 participants