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

Status: RESOLVED FIXED

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

Description

[:glob ✱]

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/

Comment 1

[:glob ✱]

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.

Comment 2

[Jonathan Claudius [:claudijd] (use NEEDINFO)]

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?)

Comment 3

[BMO Github Automation]

Attachment: [mozilla-bteam/bmo] Bug 1573509 - Document integration best practices (#2686)

Comment 4

[BMO Github Automation]

Authored by https://github.com/loganrosen
https://github.com/mozilla-bteam/bmo/commit/b8c4eb25856739536b4c509a47fb6c6b0230aef8
[master] Bug 1573509 - Document integration best practices