Open Bug 1573509 Opened 6 years ago Updated 2 years ago

move 'Integration Best Practice' wiki page into bmo API documentation

Categories

(bugzilla.mozilla.org :: Documentation, task, P2)

Production

Tracking

()

People

(Reporter: glob, Assigned: emceeaich)

Details

To make the "Integration Best Practice" wiki page discoverable it should be moved into the existing BMO API documentation on readthedocs.

https://wiki.mozilla.org/BMO/Integration_Best_Practice --> https://bmo.readthedocs.io/en/latest/api/

Assignee: nobody → ehumphries
Priority: -- → P2
Version: Staging → Production

While investigating a different issue I discovered that https://bmo.readthedocs.io/en/latest/api/core/v1/general.html#authentication is missing the references to the X- authentication headers which are visibile on https://bugzilla.readthedocs.io/en/latest/api/core/v1/general.html#authentication (landed on BMO via bug 1045145).

we'll need to add that too.

I submit a PR to try and true this up, but still keep the focus on using X- header auth for API's only.

https://github.com/mozilla-bteam/bmo/pull/1439

I welcome review and feedback. I'm also curious if upstream would be interested in accepting this or whether we think this will reside as BMO-only doc mods. (at the risk of them being overwritten in a future true up?)

You need to log in before you can comment on or make changes to this bug.