@schana I had a chat with Ellery about this. Whenever you are ready to work on this task, please do so.

I'm thinking it may be more useful to design what we want the production API to look like before creating a swagger spec for the current schema. Right now the API is a single path, api/, that takes a variety of parameters and returns

{'articles': [
    {
       'title': title,
       'pageviews': pageviews,
       'wikidata_id': wikidata_id
    } for r in recs
]}

In T139366#2465388, @schana wrote:

I'm thinking it may be more useful to design what we want the production API to look like before creating a swagger spec for the current schema. Right now the API is a single path, api/, that takes a variety of parameters and returns

{'articles': [
    {
       'title': title,
       'pageviews': pageviews,
       'wikidata_id': wikidata_id
    } for r in recs
]}

We need to make sure that the newly-specified API provides all of the functionality provided by the current API, which is complicated by the fact that the existing API is not specified or described anywhere. If the existing API is simple enough that you are sure you are not omitting anything, it's OK to skip this step.

First attempt is here:
https://github.com/wikimedia-research/translation-recs-app/pull/64

@schana if you are waiting for Ori or Ellery's review, please assign the task to one of them. :)

@ori I sent a collaboration request on github for the project. If you accept, I could assign you to the pull request for review (as I did @ellery)

The branch needs updated to reflect the change in package structure before it can be merged.