Page MenuHomePhabricator
Create Task
Maniphest T273225

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

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

Details

ProjectBranchLines +/-Subject
integration/configmaster+1 -1Remove image-suggestion-api publish step
integration/configmaster+5 -0CI jobs for image-suggestion-api service
mediawiki/services/image-suggestion-apimaster+1 -1Change listening port
mediawiki/services/image-suggestion-apimaster+87 -26Update swagger docs, set env for toolforge
mediawiki/services/image-suggestion-apimaster+3 K -0Initial commit
Customize query in gerrit

Related Objects
Search...

Event Timeline

sdkim created this task.Jan 28 2021, 8:54 PM
sdkim edited projects, added Platform Team Workboards (Image Suggestion API); removed Research, Growth-Structured-Tasks, Growth-Team, Wikipedia-Android-App-Backlog.Jan 28 2021, 9:08 PM
sdkim removed subscribers: MMiller_WMF, RHo, Miriam and 7 others.Jan 28 2021, 9:10 PM
sdkim updated the task description. (Show Details)Jan 28 2021, 9:20 PM
sdkim mentioned this in T272721: List unillustrated pages and their image suggestions (ImageMatchingAlgorithm only).Jan 28 2021, 9:25 PM
nnikkhoui added a subscriber: nnikkhoui.Jan 29 2021, 6:00 PM

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?

BPirkle added a subscriber: BPirkle.Jan 31 2021, 9:24 PM
In T273225#6787742, @nnikkhoui wrote:

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 updated the task description. (Show Details)Feb 1 2021, 6:50 PM
nnikkhoui updated the task description. (Show Details)Feb 1 2021, 6:54 PM
sdkim added a comment.EditedFeb 1 2021, 8:14 PM

@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

BPirkle added a comment.Feb 1 2021, 8:18 PM
In T273225#6793732, @sdkim wrote:

@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.

nnikkhoui added a comment.Feb 1 2021, 8:33 PM

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

sdkim added a comment.Feb 1 2021, 9:37 PM

Something like this! > https://mobileapps.wmflabs.org/?doc#/

nnikkhoui added a comment.Feb 1 2021, 10:31 PM

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 reassigned this task from sdkim to nnikkhoui.Feb 2 2021, 3:56 PM
sdkim set the point value for this task to 5.
sdkim moved this task from Backlog to In progress on the Platform Team Workboards (Image Suggestion API) board.
nnikkhoui moved this task from To Do to In Progress on the Image-Recommendations board.Feb 3 2021, 4:20 PM
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)
nnikkhoui updated the task description. (Show Details)Feb 4 2021, 4:00 PM
gerritbot added a comment.Feb 4 2021, 6:52 PM

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

gerritbot added a project: Patch-For-Review.Feb 4 2021, 6:52 PM
gerritbot added a comment.Feb 4 2021, 7:00 PM

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

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

BPirkle mentioned this in rMSIS926d44b43701: Initial commit.Feb 4 2021, 7:09 PM
Maintenance_bot removed a project: Patch-For-Review.Feb 4 2021, 7:10 PM
gerritbot added a comment.Feb 4 2021, 8:06 PM

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

gerritbot added a project: Patch-For-Review.Feb 4 2021, 8:06 PM
gerritbot added a comment.Feb 5 2021, 12:08 AM

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

gerritbot added a comment.Feb 8 2021, 7:07 PM

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

gerritbot added a comment.Feb 8 2021, 7:13 PM

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

gerritbot added a comment.Feb 8 2021, 8:04 PM

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

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

nnikkhoui updated the task description. (Show Details)Feb 8 2021, 8:14 PM
gerritbot added a comment.Feb 9 2021, 11:30 PM

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

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

nnikkhoui updated the task description. (Show Details)Feb 9 2021, 11:31 PM
Maintenance_bot removed a project: Patch-For-Review.Feb 10 2021, 12:10 AM
sdkim updated the task description. (Show Details)Feb 10 2021, 6:13 PM
gerritbot added a comment.Feb 11 2021, 12:44 AM

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

gerritbot added a project: Patch-For-Review.Feb 11 2021, 12:44 AM
gerritbot added a comment.Feb 11 2021, 1:11 AM

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

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

nnikkhoui moved this task from In progress to In review on the Platform Team Workboards (Image Suggestion API) board.Feb 11 2021, 1:17 AM
nnikkhoui moved this task from In review to Done on the Platform Team Workboards (Image Suggestion API) board.
nnikkhoui moved this task from Done to In progress on the Platform Team Workboards (Image Suggestion API) board.Feb 11 2021, 1:19 AM
Maintenance_bot removed a project: Patch-For-Review.Feb 11 2021, 2:10 AM
nnikkhoui updated the task description. (Show Details)Feb 16 2021, 7:03 PM

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

nnikkhoui updated the task description. (Show Details)Feb 16 2021, 7:07 PM
nnikkhoui closed this task as Resolved.Feb 16 2021, 7:13 PM
sdkim moved this task from In progress to Done on the Platform Team Workboards (Image Suggestion API) board.Mar 8 2021, 6:26 PM
Content licensed under Creative Commons Attribution-ShareAlike 3.0 (CC-BY-SA) unless otherwise noted; code licensed under GNU General Public License (GPL) or other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL