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

The user creation API is not documented #10868

Open
teolemon opened this issue Oct 6, 2024 · 3 comments
Open

The user creation API is not documented #10868

teolemon opened this issue Oct 6, 2024 · 3 comments
Labels
API Issues related to the Open Food Facts API. More specific labels exist & should be used (API WRITE…) 📚 Documentation Documentation issues improve the project for everyone. Signup Page 👥 User management

Comments

@teolemon
Copy link
Member

teolemon commented Oct 6, 2024

Problem

  • The user creation API is not documented
@teolemon teolemon added API Issues related to the Open Food Facts API. More specific labels exist & should be used (API WRITE…) 📚 Documentation Documentation issues improve the project for everyone. labels Oct 6, 2024
@github-project-automation github-project-automation bot moved this to To discuss and validate in 🍊 Open Food Facts Server issues Oct 6, 2024
@hangy
Copy link
Member

hangy commented Oct 6, 2024

I think it's not supposed to be documented as it's only internal for the Flutter app? IMHO it should be deprecated after most users of the Flutter app have moved to Keycloak, so that it can be removed. After moving to Keycloak, user registration should not be the responsibility of the OFF API any more, that I'd probably skip documenting a functionality that's supposed to be deprecated soon.

@teolemon
Copy link
Member Author

teolemon commented Oct 6, 2024

Agreed, but at least a page in the main doc explaining that would be great.
My starting point was the NodeJS SDK.
Also, should https://openfoodfacts-explorer.vercel.app/settings or projects like that be able to empower user creation ?

@hangy
Copy link
Member

hangy commented Oct 15, 2024

Also, should https://openfoodfacts-explorer.vercel.app/settings or projects like that be able to empower user creation ?

Yes ideally by redirecting to Keycloak, showing it as an iframe or similar. Especially with the idea of requiring email validation and allowing users to use social login providers or Passkeys to register or sign in, the best practice would be to enforce the use of the Keycloak UI for that as much as possible.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Issues related to the Open Food Facts API. More specific labels exist & should be used (API WRITE…) 📚 Documentation Documentation issues improve the project for everyone. Signup Page 👥 User management
Projects
Status: To discuss and validate
Status: Todo
Status: To be triaged
Development

No branches or pull requests

2 participants