#226 API docs need authentication examples
Closed: Fixed None Opened 8 years ago by codeblock.

We need some documentation describing how to auth to the API (explaining that tokens are per-project, explaining that you must send the Authorization header, and explaining that you need to write the word "token" before the actual token, in the header.


This relates to https://pagure.io/pagure/issue/11, we need more doc indeed :)

Note that for 0.2 the API will still be marked as unstable.

Working on an API doc. I am writing according the unit test scripts :)

Working on an API doc. I am writing according the unit test scripts :)

You are aware of the existing API documentation, right?
(Just to make sure there is no duplicated work)

Working on an API doc. I am writing according the unit test scripts :)

You are aware of the existing API documentation, right?
(Just to make sure there is no duplicated work)

Yes, thanks! I am also checking and testing the current doc. There are some endpoints not included in the current version, so I also refer to the unit test scripts :)

@yangl1996, have you made some progress? Do you need help with anything?

Thanks :)

@yangl1996, have you made some progress? Do you need help with anything?
Thanks :)

Hi, I've written the authentication part and the project part. Last weeks I've been dealing with my final exams, and I will continue the work this week ;)

@yangl1996, have you made some progress? Do you need help with anything?
Thanks :)

Hi, I've written the authentication part and the project part. Last weeks I've been dealing with my final exams, and I will continue the work this week ;)

Feel free to push your changes to your fork, then we can see how you started and
provide feedback early (if you wish of course).

@yangl1996, have you made some progress? Do you need help with anything?
Thanks :)
Hi, I've written the authentication part and the project part. Last weeks I've been dealing with my final exams, and I will continue the work this week ;)

Feel free to push your changes to your fork, then we can see how you started and
provide feedback early (if you wish of course).

Good idea! Thanks :)

I've created the pull request ;)

The doc is based on the unit test and the original reference at /api/0/. There's some endpoints not included in the original reference, so I add them according to the unit test code.

If there are endpoints missing in /api/0/, we should fix it, it's a bug :)

Pull-request merged

Thanks for your help @yangl1996

Pull-request merged
Thanks for your help @yangl1996

My pleasure! :D

Login to comment on this ticket.

Metadata