Documentation: review details about how to use all-projects and all-[family]-projects keywords
Closed, ResolvedPublic2 Estimated Story Points
Actions

Assigned To

Authored By

	Sfaci
	Oct 3 2023, 11:03 AM

Description

Epic: T288664: AQS 2.0 user documentation

Description

How to use all-projects and all-[family]-projects keywords is not always clear. Some endpoints explain explicitly you can use it and others don't but you can really use it. For example: it can be used when requesting edits/per-page/ab.wikipedia/Абжьыуа_жәлақәа/all-editor-types/daily/20230301/20230601 but it's not explained in the documentation for that endpoint

Acceptance Criteria

Documentation for all services has been reviewed to include all the details about how and when to use all-projects and all-[family]-projects keywords

Required

In case you make any change, run make docs to generate the updated specification before pushing to the repo

TODO

device analytics (review)
- all-[family]-projects is accepted
geo-analytics
- no keyword is accepted (nothing to do here)
media-analytics
- no keyword is accepted (nothing to do here)
page-analytics
- all-projects can be use with aggregate and top-by-country endpoints (it's already done. Nothing to do here)
edit-analytics (review)
- both keywords are accepted in all the endpoints except in edited-pages/aggregate endpoint
editor-analytics (review)
- both keywords are accepted in all endpoints except in aggregate

Details

Subject	Repo	Branch	Lines +/-
Added some details to documentation about how/when to use all-[family]-projects keyword	generated-data-platform/aqs/device-analytics	main	+5 -4
Added some details to documentation about how/when to use all-projects and all-[family]-projects keywords	generated-data-platform/aqs/editor-analytics	main	+692 -942
Added some details to documentation about how/when to use all-projects and all-[family]-projects keywords	generated-data-platform/aqs/edit-analytics	main	+27 -21

Customize query in gerrit

Related Objects
Search...

Status	Assigned	Task
Stalled	None	T324931 Clean up open RESTBase related tickets
In Progress	None	T262315 <CORE TECHNOLOGY> API Migration & RESTbase Sunset
In Progress	• DAbad	T263489 AQS 2.0
Open	apaskulin	T288664 AQS 2.0 user documentation
Resolved	SGupta-WMF	T347974 Documentation: review details about how to use all-projects and all-[family]-projects keywords

Event Timeline

Sfaci created this task.Oct 3 2023, 11:03 AM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptOct 3 2023, 11:03 AM

Sfaci moved this task from Incoming to Sprint 02 on the Data Products board.Oct 3 2023, 1:43 PM

Sfaci edited projects, added Data Products (Sprint 02); removed Data Products.

Sfaci triaged this task as Medium priority.Oct 3 2023, 2:05 PM

Sfaci added a subscriber: SGupta-WMF.Oct 6 2023, 6:03 AM

Sfaci added a parent task: T288664: AQS 2.0 user documentation.Oct 6 2023, 6:22 AM

Sfaci mentioned this in T348565: Estimate Sprint 02 tasks - Santi.Oct 11 2023, 12:59 PM

WDoranWMF set the point value for this task to 2.Oct 17 2023, 11:09 AM

Sfaci claimed this task.Oct 17 2023, 12:00 PM

Sfaci moved this task from Sprint Backlog to In Process on the Data Products (Sprint 02) board.

Sfaci added a project: Documentation.

Sfaci moved this task from In Process to Paused on the Data Products (Sprint 02) board.Oct 19 2023, 8:49 AM

Sfaci moved this task from Paused to In Process on the Data Products (Sprint 02) board.Oct 19 2023, 11:40 AM

geo-analytics service only accepts requests about wikipedia projects (non-wikipedia projects are not available) and that details was missing in the documentation for AQS 2.0.
We'll take the opportunity to fix that as well.

Sfaci updated the task description. (Show Details)Oct 20 2023, 10:52 AM

Sfaci updated the task description. (Show Details)Oct 20 2023, 11:08 AM

Change 967428 had a related patch set uploaded (by Santiago Faci; author: Santiago Faci):

[generated-data-platform/aqs/device-analytics@main] Added dome details about how to use all-[family]-projects keyword

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

gerritbot added a project: Patch-For-Review.Oct 20 2023, 11:10 AM

Sfaci updated the task description. (Show Details)Oct 20 2023, 11:10 AM

Change 967431 had a related patch set uploaded (by Santiago Faci; author: Santiago Faci):

[generated-data-platform/aqs/edit-analytics@main] Added some details to documentation about how/when to use all-projects and all-[family]-projects keywords

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

Change 967435 had a related patch set uploaded (by Santiago Faci; author: Santiago Faci):

[generated-data-platform/aqs/editor-analytics@main] Added some details to documentation about how/when to use all-projects and all-[family]-projects keywords

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

Sfaci updated the task description. (Show Details)Oct 20 2023, 11:56 AM

Sfaci updated the task description. (Show Details)

Sfaci reassigned this task from Sfaci to SGupta-WMF.Oct 20 2023, 11:59 AM

Sfaci moved this task from In Process to Ready for Code Review on the Data Products (Sprint 02) board.

Sfaci updated the task description. (Show Details)Oct 20 2023, 12:08 PM

apaskulin awarded a token.Oct 20 2023, 5:48 PM

WDoranWMF moved this task from Ready for Code Review to Teleport to Sprint 03 on the Data Products (Sprint 02) board.Oct 24 2023, 12:22 PM

WDoranWMF edited projects, added Data Products (Data Products (Sprint 03)); removed Data Products (Sprint 02).

WDoranWMF moved this task from Sprint Backlog to In code review / Tech Input on the Data Products (Data Products (Sprint 03)) board.

SGupta-WMF reassigned this task from SGupta-WMF to Sfaci.Oct 27 2023, 10:50 AM

Sfaci reassigned this task from Sfaci to apaskulin.Oct 30 2023, 12:30 PM

Reviewed and +1'd. Thanks!

Change 967431 merged by jenkins-bot:

[generated-data-platform/aqs/edit-analytics@main] Added some details to documentation about how/when to use all-projects and all-[family]-projects keywords

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

Change 967435 merged by jenkins-bot:

[generated-data-platform/aqs/editor-analytics@main] Added some details to documentation about how/when to use all-projects and all-[family]-projects keywords

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

Change 967428 merged by jenkins-bot:

[generated-data-platform/aqs/device-analytics@main] Added some details to documentation about how/when to use all-[family]-projects keyword

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

Sfaci reassigned this task from apaskulin to EChukwukere-WMF.Oct 31 2023, 4:27 PM

Sfaci moved this task from In code review / Tech Input to Ready for Testing on the Data Products (Data Products (Sprint 03)) board.

Sfaci added a subscriber: apaskulin.

cjming moved this task from Ready for Testing to Sign Off on the Data Products (Data Products (Sprint 03)) board.Nov 6 2023, 5:15 PM

Sfaci reassigned this task from EChukwukere-WMF to SGupta-WMF.Nov 7 2023, 1:08 PM

Sfaci added a subscriber: EChukwukere-WMF.

SGupta-WMF moved this task from Sign Off to Done on the Data Products (Data Products (Sprint 03)) board.Nov 9 2023, 1:06 PM

WDoranWMF closed this task as Resolved.Nov 20 2023, 5:44 PM