DEV Community

Discussion on: State of the API, October/November 2019

Collapse
shiraazm profile image
Shiraaz Moollatjie • Edited on

Nice update! What I also found is that if you you're writing a series, the series name is not being returned on get articles.

Another update is that there's an unofficial go API wrapper too! Check out devtogo on github.

Let's build some great apps together 😍

Collapse
rhymes profile image
rhymes Author

Nice update! What I also found is that if you you're writing a series, the series name is not being returned on get articles.

Yeah, that's a work in progress. We have an an issue open about this:

API: Return properties regarding series in GET request data #3669

cdvillard avatar
cdvillard commented on Aug 09, 2019

Is your feature request related to a problem? Please describe.

When creating articles using the API, it's possible to assign the article to a series. However, when querying for articles from the API, no information regarding series is made available in either the objects returned /api/articles/?=${queryString} or the data returned from /api/articles/${id}.

Describe the solution you'd like

Ideally, a series property would be returned along with the rest of the data for each article from either endpoint with the title or some other identifier of the series to which the article belongs.

Describe alternatives you've considered

Additional context

this lead to a PR in which we added the collection/series ID to the response and the ability to filter by it:

Add collection ids to Api (reading + filtering) #4180

cyrillefr avatar
cyrillefr commented on Oct 01, 2019
  • refactored controller
  • modifyied views
  • added tests

What type of PR is this? (check all applicable)

  • [ ] Refactor
  • [x] Feature
  • [ ] Bug Fix
  • [ ] Documentation Update

Description

Add collection_id field for retrieving and filtering

Related Tickets & Documents

#3669

Mobile & Desktop Screenshots/Recordings (if there are UI changes)

Added to documentation?

  • [ ] docs.dev.to
  • [ ] readme
  • [x] no documentation needed

[optional] What gif best describes this PR or how it makes you feel?

alt_text

We still need to add the ability to query collections or find out which articles belong to a collection

Another update is that there's an unofficial go API wrapper too! Check out devtogo on github.

Cool! I'm going to tweet about it, sorry I didn't notice the article earlier!