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

docs: write documentation for the /cgi/auth.pl endpoint #7465

Open
VaiTon opened this issue Oct 10, 2022 · 5 comments
Open

docs: write documentation for the /cgi/auth.pl endpoint #7465

VaiTon opened this issue Oct 10, 2022 · 5 comments
Labels
🔐 API auth The API requires auth in order to perform editing.There is a common mechanism & a Robotoff mechanism 📚 Documentation Documentation issues improve the project for everyone. Hacktoberfest ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. ✅ Task

Comments

@VaiTon
Copy link
Member

VaiTon commented Oct 10, 2022

What

Part of

@VaiTon VaiTon added 📚 Documentation Documentation issues improve the project for everyone. 🔐 API auth The API requires auth in order to perform editing.There is a common mechanism & a Robotoff mechanism Hacktoberfest ✅ Task labels Oct 10, 2022
@jainshubham766
Copy link

I would like to resolve this issue, under hacktoberfeast.
Please assign

@VaiTon
Copy link
Member Author

VaiTon commented Oct 13, 2022

Sure @jainshubham766. Feel free to write here or on slack to get some guidance. Happy hacktoberfest!

@jainshubham766
Copy link

jainshubham766 commented Oct 14, 2022

Can u please help me with what exactly needs to be done and the format to make a doc in.
Link for the file

lil guidance will help me resolve it fast

@alexgarel
Copy link
Member

@jainshubham766 it's to be documented using OpenAPI. You can see all OpenAPI files in the docs/reference, notably the api.yml file.
One possible tool is stoplight studio (in editor mode). We are using OpenAPI v3.1 (not all tools are compatible).
@Roxie-32 might also help you.

Copy link
Contributor

This issue has been open 90 days with no activity. Can you give it a little love by linking it to a parent issue, adding relevant labels and projets, creating a mockup if applicable, adding code pointers from https://github.com/openfoodfacts/openfoodfacts-server/blob/main/.github/labeler.yml, giving it a priority, editing the original issue to have a more comprehensive description… Thank you very much for your contribution to 🍊 Open Food Facts

@github-actions github-actions bot added the ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. label Dec 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🔐 API auth The API requires auth in order to perform editing.There is a common mechanism & a Robotoff mechanism 📚 Documentation Documentation issues improve the project for everyone. Hacktoberfest ⏰ Stale This issue hasn't seen activity in a while. You can try documenting more to unblock it. ✅ Task
Projects
Status: To discuss and validate
Development

No branches or pull requests

3 participants