Page MenuHomePhabricator
Create Task
Maniphest T333593

Add an endpoint to Device Analytics to serve the API spec
Closed, ResolvedPublic
Actions

Description

To make the API docs for Device Analytics publicly available, add an endpoint to Device Analytics that serves the raw swagger.json file at /api-spec.json

Details

SubjectRepoBranchLines +/-
endpoint for docs adding an endpoint to serve the swagger.json filegenerated-data-platform/aqs/device-analyticsmain+14 -0
Modifying testsgenerated-data-platform/aqs/device-analyticsmain+37 -2
api-spec refactoring api-spec endpoint that serves the swagger.json filegenerated-data-platform/aqs/device-analyticsmain+103 -0
Customize query in gerrit

Related Objects
Search...

Event Timeline

apaskulin created this task.Mar 30 2023, 6:23 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptMar 30 2023, 6:23 PM
apaskulin mentioned this in T324861: Plan deployment of API docs.Mar 30 2023, 6:24 PM
VirginiaPoundstone moved this task from Incoming to Needs Grooming on the API Platform board.Mar 31 2023, 6:26 PM
VirginiaPoundstone moved this task from Needs Grooming to Sprint 07 on the API Platform board.Apr 4 2023, 2:36 PM
VirginiaPoundstone edited projects, added API Platform (Sprint 07); removed API Platform.
JArguello-WMF moved this task from Incoming to In Current Sprint on the AQS2.0 board.Apr 6 2023, 5:34 PM
• codebug changed the task status from Open to In Progress.Apr 12 2023, 9:45 PM
• codebug claimed this task.
• codebug moved this task from Next Up to In Progress on the API Platform (Sprint 07) board.
apaskulin updated the task description. (Show Details)Apr 12 2023, 9:50 PM
gerritbot added a comment.Apr 18 2023, 4:03 PM

Change 909701 had a related patch set uploaded (by WQuarshie; author: WQuarshie):

[generated-data-platform/aqs/device-analytics@main] endpoint for docs adding an endpoint to serve the swagger.json file

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

gerritbot added a project: Patch-For-Review.Apr 18 2023, 4:03 PM
• codebug moved this task from In Progress to Ready for Code Review/ Ready for Tech input on the API Platform (Sprint 07) board.Apr 18 2023, 4:07 PM
SGupta-WMF claimed this task.Apr 19 2023, 5:04 AM
SGupta-WMF added a subscriber: • codebug.
JArguello-WMF edited projects, added AQS2.0 (Sprint 10); removed API Platform (Sprint 07), AQS2.0.Apr 26 2023, 2:56 PM
JArguello-WMF moved this task from Next Up to Ready for Code Review/ Ready for Tech input on the AQS2.0 (Sprint 10) board.
BPirkle reassigned this task from SGupta-WMF to • codebug.May 1 2023, 4:18 PM
BPirkle moved this task from Ready for Code Review/ Ready for Tech input to In Progress on the AQS2.0 (Sprint 10) board.
BPirkle added a subscriber: SGupta-WMF.
gerritbot added a comment.May 3 2023, 8:32 AM

Change 914707 had a related patch set uploaded (by WQuarshie; author: WQuarshie):

[generated-data-platform/aqs/device-analytics@main] api-spec refactoring api-spec endpoint that serves the swagger.json file

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

• codebug moved this task from In Progress to Ready for Code Review/ Ready for Tech input on the AQS2.0 (Sprint 10) board.May 3 2023, 8:32 AM
SGupta-WMF added a subscriber: BPirkle.EditedMay 4 2023, 4:22 AM

@apaskulin @BPirkle As per linked task , the endpoint should be unique-devices/api-spec.json. Please confirm!

SGupta-WMF claimed this task.May 4 2023, 5:29 AM
SGupta-WMF moved this task from Ready for Code Review/ Ready for Tech input to In code Review/ Tech Input on the AQS2.0 (Sprint 10) board.
SGupta-WMF added a comment.May 4 2023, 9:08 AM

@codebug Reviewed, added a couple of comments.

SGupta-WMF reassigned this task from SGupta-WMF to • codebug.May 4 2023, 9:09 AM
BPirkle added a comment.May 18 2023, 2:19 PM

After fairly extensive discussion in Slack, we decided to present the swagger spec at:

/device-analytics/api-spec.json

SGupta-WMF added a comment.May 22 2023, 10:48 AM

As discussed , @codebug is going to push remaining MR amends in a day or two.

SGupta-WMF added a parent task: T288298: AQS 2.0: Device Analytics service.May 23 2023, 6:15 AM
gerritbot added a comment.May 24 2023, 9:59 AM

Change 914707 merged by Sg912:

[generated-data-platform/aqs/device-analytics@main] api-spec refactoring api-spec endpoint that serves the swagger.json file

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

gerritbot added a comment.May 24 2023, 10:28 AM

Change 922811 had a related patch set uploaded (by Sg912; author: Sg912):

[generated-data-platform/aqs/device-analytics@main] Modifying tests

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

gerritbot added a comment.May 28 2023, 7:12 PM

Change 922811 merged by BPirkle:

[generated-data-platform/aqs/device-analytics@main] Modifying tests

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

BPirkle reassigned this task from • codebug to EChukwukere-WMF.May 30 2023, 1:04 PM
BPirkle moved this task from In code Review/ Tech Input to Ready for Testing on the AQS2.0 (Sprint 10) board.
SGupta-WMF claimed this task.Jun 5 2023, 6:19 AM
SGupta-WMF moved this task from Ready for Testing to In Testing on the AQS2.0 (Sprint 10) board.
SGupta-WMF added a subscriber: EChukwukere-WMF.
SGupta-WMF added a comment.Jun 5 2023, 9:15 AM

Verified this task , the api-specs is served at device-analytics/api-spec.json.It serves the swagger specs with detailed schemas

SGupta-WMF moved this task from In Testing to Sign off on the AQS2.0 (Sprint 10) board.Jun 5 2023, 10:27 AM
apaskulin awarded a token.Jun 5 2023, 4:26 PM
BPirkle moved this task from Sign off to Done on the AQS2.0 (Sprint 10) board.Jun 6 2023, 7:05 PM
JArguello-WMF closed this task as Resolved.Jun 9 2023, 2:45 PM
gerritbot added a comment.Aug 10 2023, 5:35 AM

Change 909701 abandoned by Sg912:

[generated-data-platform/aqs/device-analytics@main] endpoint for docs adding an endpoint to serve the swagger.json file

Reason:

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

Maintenance_bot removed a project: Patch-For-Review.Aug 10 2023, 6:10 AM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and 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 · Credits