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

Is there an api to add deck and cards #34

Open
sibambaspec opened this issue Sep 2, 2024 · 3 comments
Open

Is there an api to add deck and cards #34

sibambaspec opened this issue Sep 2, 2024 · 3 comments

Comments

@sibambaspec
Copy link

How to send api request
Is there an api to add deck and cards

@VikashKothary
Copy link
Member

VikashKothary commented Sep 5, 2024

I think I have an openapi spec for the API locally. Let me find it and upload it.

But you can see the routes here: https://github.com/ankicommunity/ankicommunity-api-server/blob/develop/src/djankiserv_api/urls.py

@sibambaspec
Copy link
Author

sibambaspec commented Sep 5, 2024 via email

@VikashKothary
Copy link
Member

VikashKothary commented Sep 6, 2024

Hi @sibambaspec,

I had a look and unfortunately I don't have an openapi spec for this API. While I do plan on writing one in the future, I can try and provide you a rough list of endpoints that have currently been implemented:

GET /health
GET /api/v1/auth/token
GET /api/v1/auth/refresh
POST /api/v1/notes/add
POST /api/v1/notes
POST /api/v1/notes/delete
GET /api/v1/decks
GET /api/v1/decks/conf
GET /api/v1/tags
GET /api/v1/models

There's also an GET /admin which is the Django Admin page.

There are also the sync endpoints but I assume that's not what you're looking for.

Is there any specific endpoints you're looking for? The long term vision is to have CRUD endpoints for all resources but it looks like we're not there yet.

I'm a bit busy right now but if you want to contribute or request features, I'm happy to work with you to make it happen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants