Page MenuHomePhabricator

Image Suggestion API "Hello World"
Closed, ResolvedPublic5 Estimated Story Points

Description

Acceptance Criteria
  • As an Image Suggestions API stakeholder, I want a publicly accessible endpoint that returns a 200, Hello World response.
  • As a PET developer, I want to have a place to check-in code, so that my changes are continuously integrated
Subtasks
  • Investigate WMF data policy for how this data can be accessed if in a data store
  • Investigate the WMF checklist for getting a service hosted on toolforge
  • Request code repository on gerrit (with github mirror)
  • Request toolforge instance
  • Set up CI (Jenkins CI, toolforge instance updated with current version of master branch)
  • Deploy service

Event Timeline

I can request a new gerrit repository for us, i think it belongs in /mediawiki/services directory, any objection to just /mediawiki/services/image-recommendation-api?

I can request a new gerrit repository for us, i think it belongs in /mediawiki/services directory, any objection to just /mediawiki/services/image-recommendation-api?

No objection here.

I'm pretty flexible on where the POC implementation lives and how we deploy to it. My only criteria is that it be somewhere on a WMF server (not necessarily a production one) and that it be accessible via a predictable url (vs. needing to update an IP address every time something changes without warning in the backend). If we have actual gerrit and CI, that's great. But I could live with ad-hoc for the POC if we have to.

The actual production deployment, of course, will need all the bells and whistles.

@nnikkhoui @BPirkle do you all think it's reasonable to have an Acceptance Criteria about having our API spec published on wmflabs as part of this task? Or do you think it should be a separate task

@nnikkhoui @BPirkle do you all think it's reasonable to have an Acceptance Criteria about having our API spec published on wmflabs as part of this task? Or do you think it should be a separate task

I'd suggest a separate task. We tried to keep this one focused on just the "ready to start writing real code" portion of the work.

@sdkim By API spec do you mean the Swagger docs or something else?

Cool ok! The only difference will be that our docs will be part of the api itself on toolforge, as the ?doc endpoint is part of the service-template scaffolding already, and is the thing that will deliver the swagger docs just like that example you have above, so it will all just be in one place. But I agree with Bill that it should be a separate task :)

sdkim set the point value for this task to 5.
sdkim renamed this task from Image Recommendation API "Hello World" to Image Suggestion API "Hello World".Feb 3 2021, 5:36 PM
sdkim updated the task description. (Show Details)

Change 661771 had a related patch set uploaded (by BPirkle; owner: BPirkle):
[mediawiki/services/image-suggestion-api@master] Initial commit

https://gerrit.wikimedia.org/r/661771

Change 661771 merged by BPirkle:
[mediawiki/services/image-suggestion-api@master] Initial commit

https://gerrit.wikimedia.org/r/661771

Change 661796 had a related patch set uploaded (by Nikki Nikkhoui; owner: Nikki Nikkhoui):
[integration/config@master] CI jobs for image-suggestion-api service

https://gerrit.wikimedia.org/r/661796

Change 661822 had a related patch set uploaded (by Nikki Nikkhoui; owner: Nikki Nikkhoui):
[mediawiki/services/image-suggestion-api@master] Update swagger docs, set env for toolforge

https://gerrit.wikimedia.org/r/661822

Change 661822 merged by Nikki Nikkhoui:
[mediawiki/services/image-suggestion-api@master] Update swagger docs, set env for toolforge

https://gerrit.wikimedia.org/r/661822

Change 662760 had a related patch set uploaded (by Nikki Nikkhoui; owner: Nikki Nikkhoui):
[mediawiki/services/image-suggestion-api@master] Change listening port

https://gerrit.wikimedia.org/r/662760

Change 662760 merged by BPirkle:
[mediawiki/services/image-suggestion-api@master] Change listening port

https://gerrit.wikimedia.org/r/662760

Change 661796 merged by jenkins-bot:
[integration/config@master] CI jobs for image-suggestion-api service

https://gerrit.wikimedia.org/r/661796

Change 663339 had a related patch set uploaded (by Nikki Nikkhoui; owner: Nikki Nikkhoui):
[integration/config@master] Remove publish step

https://gerrit.wikimedia.org/r/663339

Change 663339 merged by jenkins-bot:
[integration/config@master] Remove image-suggestion-api publish step

https://gerrit.wikimedia.org/r/663339

I think we can consider the _info endpoint the "hello world" health check endpoint.
https://image-suggestion-api.toolforge.org/_info