Skip to content

Added API: Users and Status/Health Endpoints #117

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

mtthidoteu
Copy link

  • Introduced API key model and related functions for creating, authenticating, and managing API keys.
  • Enhanced the settings page to allow users to create, delete, and toggle API keys.
  • Updated app to include API for Managing Users, as well as a generic status/health endpoint
  • Updated README to document the new health check feature.

mtthidoteu and others added 2 commits July 11, 2025 14:38
- Introduced API key model and related functions for creating, authenticating, and managing API keys.
- Updated FastAPI application to include a health check endpoint.
- Enhanced the settings page to allow users to create, delete, and toggle API keys.
- Updated README to document the new health check feature.
@mtthidoteu
Copy link
Author

I am the developer of Wizarr and having a User endpoint would be great, as I would love to integrate it !

@markbeep
Copy link
Owner

Looks okay on a first glance, thanks! Will do a more thorough review when I have the time in a few days.

Have been considering to support json on basically all endpoints to allow for easier scriptability and compatibility with other apps. Thanks for starting with that.

Copy link
Owner

@markbeep markbeep left a comment

Choose a reason for hiding this comment

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

Thanks for the PR. It's a nice addition. But yes, there's a lot of AI slop that is not required. A large part of the PR can be deleted.

I adjusted the API key authentication (api.py, authentication.py), so that it also automatically generates the docs for the api key. Please merge in the changes from the api-authentication-pr117 branch before fixing the other things.

After the points I mentioned, type errors, and formatting is fixed, it should be almost ready to merge.

mtthidoteu and others added 2 commits July 19, 2025 11:44
- Renamed ApiKey model to APIKey for consistency.
- Updated references to ApiKey in authentication and settings modules.
- Removed deprecated health check test script.
- Simplified API routes and removed unused endpoints.
- Enhanced API key management in settings with improved UI.
- Added comprehensive API documentation for key management and usage.
- Removed generate_openapi.py script as it is no longer needed.
- Created a new Alembic migration for API key table.
@mtthidoteu mtthidoteu requested a review from markbeep July 19, 2025 14:46
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