kippt / api-documentation Goto Github PK

The API documentation mentions that the /api/clips/ endpoint delivers an answer that starts like:

{
    {
        next: "/api/clips/?limit=20&offset=20",
        total_count: 1512,
        previous: null,
        limit: 20,
        offset: 0
    },

But the actual API response is missing the entry total_count. I guess the total count has been there before - but is now missing.

Can the total_count be re-added to the API response?

Or is there another way to get the total count of a user's clips (public and private together)?

The issue mrimann/kippt-tools#4 is the reason for asking this.

I like that you're documenting even the unsupported features, but I wonder if it would be better to put them in a separate branch or something so that we have to go (slightly) out of our way to learn about them.

It would at least make it clear what is and isn't supported from the top level.

When I try to open the documentation page about GET /api/lists/following/ endpoint I get a 404 error page.
The page should be here: https://github.com/kippt/api-documentation/blob/master/endpoints/lists/GET_lists_following.md

The clip search endpoint can still take a list ID as a filter at the moment (like the old API) but I can't see it documented on the GET_clips_search page.

• /api/clips/search/?list=...&q=...

Is that still going to be supported? Or maybe it would suit the new API better to have something like this:

• /api/lists/:list_id/clips/search?q=...

Hi. I can't read the documentation when it's not in a wiki. Can you guys please move the documentation to the GitHub Wiki that's in this repo?

Is there a way of adding collaborators when creating/updating lists, for example by submitting the list of collaborator's ids or usernames ?
Does is_private flag is supported when creating/updating lists ?

The documentation page for endpoint GET /api/lists/search/ is missing.

Expected page:
https://github.com/kippt/api-documentation/blob/master/endpoints/clips/GET_lists_search.md

At endpoints like GET /api/clips/, could Kippt add a feature to allow filtering by a specific url_domain? Or perhaps add a feature to search only over a specific field with GET /api/clips/search/?

GET /api/clips/ and many other endpoints already allow filtering by url.

I was trying to delete a list using DELETE api/lists/{id}. Everything works just fine and i got my 204 response. Then i went back to re-fetch my lists and the deleted list was there. I've tried to re-delete the list and all i got is 404.