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

Update API docs #626

Open
grizz opened this issue Jan 9, 2020 · 8 comments
Open

Update API docs #626

grizz opened this issue Jan 9, 2020 · 8 comments
Assignees
Labels

Comments

@grizz
Copy link
Member

@grizz grizz commented Jan 9, 2020

Django Rest Framework is dropping support for the outdated coreapi used to generate our current API docs [0] in their next release, so we'll need to move off it soon.

Two popular options are Swagger UI and ReDoc, I prefer Swagger UI, but either look better than our current ones.

Might as well also take the time to add info to the docs themselves, as well as make it easier for the community to contribute docs.

[0] https://www.django-rest-framework.org/community/3.10-announcement/#continuing-to-use-coreapi
[1] https://swagger.io/tools/swagger-ui/
[2] https://github.com/Redocly/redoc

@grizz grizz added this to the 1 Decide milestone Jan 9, 2020
@grizz

This comment has been minimized.

Copy link
Member Author

@grizz grizz commented Jan 29, 2020

Need to make sure all extra query endpoints end up in here as well (for example, whereis on ixpfx).

@grizz

This comment has been minimized.

Copy link
Member Author

@grizz grizz commented Jan 29, 2020

@peeringdb/pc Could we get some +1 love here? :)

@arnoldnipper

This comment has been minimized.

Copy link
Contributor

@arnoldnipper arnoldnipper commented Jan 29, 2020

+1

@mcmanuss8

This comment has been minimized.

Copy link
Contributor

@mcmanuss8 mcmanuss8 commented Jan 29, 2020

Heavy +1

@shane-kerr

This comment has been minimized.

Copy link

@shane-kerr shane-kerr commented Jan 30, 2020

+1

We clearly need to switch to something maintained. Since I'm not really an application developer I have no strong feelings about what we change to.

@job

This comment has been minimized.

Copy link
Contributor

@job job commented Jan 30, 2020

@arnoldnipper

This comment has been minimized.

Copy link
Contributor

@arnoldnipper arnoldnipper commented Jan 30, 2020

@Shawna, is there anything needed to implement this issue?

@Shawna

This comment has been minimized.

Copy link

@Shawna Shawna commented Jan 30, 2020

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
7 participants
You can’t perform that action at this time.