The API docs look better without the bulky text. The YAML uses a reference to re-use the same wording throughout the HTML. The best option is to put the Status Code descriptions in a new Web page and leave the Data Dictionary for JSON field descriptions. You know best how to optimise the Web page content.

@JArguello-WMF, Can this ticket be marked as Done?

Yes, and I mentioned it to Chuck in the eng channel

This ticket is unallocated. There is not enough detail for me to assess which fields the clients want in this "subset of Commons metadata fields".

In T355325#10079786, @creynolds wrote:

API Response Codes & Descriptors
mega rough init draft:

200: ok
Your request was processed successfully, and the server returned the expected result. Everything is good.
...

In T355325#9779368, @creynolds wrote:

DeDupe Path Descriptions & Operations Description or only use one

We use "operation descriptions" on /authentication/ docs but we use both "path description" and "operation description" on all other pages and endpoints. Unless there's a strong requirement to have both we should nuke the "operation description" and just use "path description" on everything. If there is a strong requirement to use them; they should not be dupes of path desc and should be unique per operation.

In T355325#9779365, @creynolds wrote:

Add GET Request Examples

Our POST sections all have "request body" examples; we should add GET url params JSON examples too where available

New Password Required:

• orig: Responds NEW_PASSWORD_REQUIRED challenge by receiving username and session token and setting new password.
• proposed: NEED ENG INSIGHT HERE -- Is this still needed???
  • why would it respond with this? anything helpful here? Feel free to ping chuck in slack with draft when ready.
  • How do we explain that better in the description?

Description from @HShaikh "The new password requirement was I think a last minute addition so really needs a deeper look on how that works. If I remember correctly, it was due to mark from internet archive losing password and having us redo his password for him"

• Forgot password, action needed? - this should be part of the same workflow and contextual

In T355325#9779242, @creynolds wrote:

Snapshot identifier description and examples

In Snapshot /snapshots/{identifier}/download docs we just show the description of "Snapshot identifier" and it's not very specific. In the getting started example calls page we say the following which also needs to be updated to be more helpful

Note the project identifier (e.g. “enwiki” for English Wikipedia) as that is the identifier you will use to identify that project in other calls and responses.

From Slack thread:

The identifier is a combination of project and namespace.
There are different things here:
project identifier : enwiki
namespace identifier : 0
snapshot identifier: enwiki_namesapce_0
language code : en
project code : wiki

Idea is to update the Snapshot path params description to be more helpful in understanding how to find/formulate that.
Similarly in docs examples we should be more helpful too.
Furthermore if the Data Dictionary identifier description should also be updated with this in mind.

We were sharing usage metrics for the users that registered around the time of @Chiahwu's Hackathon.

Error in HF:

Added a Google Doc in the Research folder

1. Potential API upgrade for Main API

Example of an infobox update, it added a signature to Josephine Baker:
https://en.wikipedia.org/w/api.php?action=compare&format=json&fromrev=1077682640&torev=1077690450&prop=diff%7Cids%7Ctitle%7Cdiffsize%7Cparsedcomment%7Crel%7Csize%7Ctimestamp%7Cuser%7Ccomment&slots=main&difftype=inline&formatversion=2

API call with all the available return props: https://en.wikipedia.org/w/api.php?action=compare&format=json&fromtitle=Template%3AUnsigned&totitle=Template%3AUnsignedIP&prop=diff%7Cids%7Ctitle%7Cdiffsize%7Cparsedcomment%7Crel%7Csize%7Ctimestamp%7Cuser%7Ccomment&slots=main&difftype=inline&formatversion=2

Check the Go code for more error codes that we should list in the docs and a description

Remove the \n from the example JSON. Explain why we need the \" on the inner double quotes in JSON syntax.

Partially done by Chuk already, the description is improved. Check the 3 event types are described and how they differ

Say "Project Identifier" and give examples of enwiki frwikinews eswikivoyage

1. Title change example:

1. Title change example:

Investigate call: https://en.wikipedia.org/w/api.php?action=compare&fromrev=1251322358&torev=1251557485&format=json&slots=*&difftype=inline

Updated description wrt the 2nd Acceptance Criteria:

Fixed the load_dotenv issue. I tidied up the Python dependencies.

Two sprints ago, I update most deps so dev and main were on latest (because I had to update WMF for the CC license update).

Fixed individual size query, not size.unit_text query. Work to do still

The error is caused by this line res, err := p.S3.SelectObjectContentWithContext(gcx.Request.Context(), sip) in proxy.go.

This is the cause of the object flattening: It's expected behaviour. If we change the code, the risk is that a dot notation will build a new object hierarchy, allowing users to build a JSON injection attack.

I deployed to the Main branch and QAed.

Event DD changes:

This is worth a read to understand the editor guidelines on citations: https://en.wikipedia.org/wiki/Wikipedia:Citing_sources