ReleaseEngineering/Applications/Mapper: Difference between revisions

defer to live docs for all needing authentication.
(Updated links from staging -> production)
(defer to live docs for all needing authentication.)
Line 61: Line 61:
= API methods =
= API methods =


Below are the 7 API methods currently supported, together with example urls from the staging environment.
Below is a summary of the 3 unauthenticated API methods currently usable, together with example urls from the production environment.


Please note, mapper uses secure authentication (provided by RelEng API), so you will not be able to use the POST examples below, but you will be able query mapper using e.g. the example GET requests below.
For fuller details, and endpoints requiring authentication, the in process documentation is authoritative: [https://api.pub.build.mozilla.org/docs/usage/mapper/ production] or [https://api-pub-build.allizom.org/docs/usage/mapper/ staging] instances.


== GET Routes ==
== GET Routes ==
Line 80: Line 80:
* Example: https://api.pub.build.mozilla.org/mapper/build-mozharness/mapfile/since/29.05.2014%2017:02:09%20CEST
* Example: https://api.pub.build.mozilla.org/mapper/build-mozharness/mapfile/since/29.05.2014%2017:02:09%20CEST


== POST Routes ==
=== Returns list of projects ===
 
''Not yet live, follow progress in {{bug|1174215}}''
=== Inserts a mappings file strictly (no duplicates allowed) ===
* GET:  /projects
* POST: /<project>/insert
* Example: https://api.pub.build.mozilla.org/mapper/projects
* Example: https://api.pub.build.mozilla.org/mapper/insert
 
=== Inserts a mappings file, allowing duplicates ===
* POST: /<project>/insert/ignoredups
* Example: https://api.pub.build.mozilla.org/mapper/insert/ignoredups
 
=== Inserts an individual mapping ===
* POST:  /<project>/insert/<git_commit>/<hg_changeset>
* Example: https://api.pub.build.mozilla.org/mapper/insert/69d64a8a18e6e001eb015646a82bcdaba0e78a24/68f1b2b9996c4e33aa57771b3478932c9fb7e161
 
=== Inserts a new project ===
* POST:  /<project>
* Example: https://api.pub.build.mozilla.org/mapper/build-puppet


= Staging =
= Staging =


The staging environment is available under https://api-pub-build.allizom.org/mapper
The staging environment is available under https://api-pub-build.allizom.org/mapper
Confirmed users
1,351

edits