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.

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

fix: update docs and auth behavior #50

Merged
merged 7 commits into from
Feb 9, 2025

Conversation

devin-ai-integration[bot]
Copy link
Contributor

Update Documentation and Fix Authentication Behavior

This PR updates the documentation to focus on the OpenAI-compatible API endpoint and fixes the authentication behavior to match the documented functionality.

Changes

  • Reorganized documentation to focus on OpenAI-compatible endpoint
  • Removed outdated web server API section while preserving essential setup instructions
  • Fixed authentication to be optional when no secret is set, matching the documented behavior
  • Kept Docker setup instructions as they're needed for both APIs

Authentication Behavior

  • When no secret is set: requests are allowed without authentication
  • When secret is set: requests require Bearer token authentication

Testing

Changes will be verified by CI tests.

Link to Devin run: https://app.devin.ai/sessions/abba20d77c44405a89e14a1bc5005271

- Remove outdated web server section from README
- Keep OpenAI-compatible API documentation
- Fix authentication to be optional when no secret is set

Co-Authored-By: Han Xiao <[email protected]>
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add "(aside)" to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@hanxiao hanxiao merged commit 0be2a91 into main Feb 9, 2025
1 check passed
@hanxiao hanxiao deleted the devin/1739064778-fix-auth-and-docs branch February 9, 2025 05:37
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.

1 participant