User:Bhearsum/Balrog/Administration: Difference between revisions

Line 46: Line 46:
! Arguments
! Arguments
! width=40% | Description
! width=40% | Description
! Exception Status codes
! Status codes
|-
|-
| /releases
| rowspan=2 | /releases
| GET
| rowspan=2 | GET
|
| rowspan=2 |  
| Retrieves all release names
| rowspan=2 | Retrieves all release names
| 200 - Releases returned
|-
| 204 - No releases
|-
| rowspan=2 | /releases/[name]
| rowspan=2 | GET
| rowspan=2 |
| rowspan=2 | Retrieve the release identified by "name"
| 200 - Release returned
|-
|-
| /releases/[name]
| GET
| Retrieve the release identified by "name"
| 404 - Release doesn't exist
| 404 - Release doesn't exist
|-
|-
| /releases/[name]
| rowspan=3 | /releases/[name]
| PUT
| rowspan=3 | PUT
| details - the JSON blob associated with this release
| rowspan=3 | details - the JSON blob associated with this release
| Update the release with the supplied JSON data. If non-existent, it is created. Be careful when using this for existing releases that already have builds added to them -- the JSON blob given here overrides all data for the release, not just platform independent data.
| rowspan=3 | Update the release with the supplied JSON data. If non-existent, it is created. Be careful when using this for existing releases that already have builds added to them -- the JSON blob given here overrides all data for the release, not just platform independent data.
| 400 - The details value is malformed or NULL.
| 200 - Release modified
|-
| 201 - Release created
|-
| 400 - The details value is malformed or NULL
|-
| rowspan=2 | /releases/[name]
| rowspan=2 | DELETE
| rowspan=2 |
| rowspan=2 | Delete the release
| 200 - Release deleted
|-
|-
| /releases/[name]
| DELETE
|
| Delete the release
| 404 - Release does not exist
| 404 - Release does not exist
|-
|-
| /releases/[name]/builds
| rowspan=3 | /releases/[name]/builds
| GET
| rowspan=3 | GET
|
| rowspan=3 |
| Retrieve all builds from a release
| rowspan=3 | Retrieve all builds from a release
| 200 - Builds returned
|-
| 204 - No builds
|-
| 404 - Release does not exist
| 404 - Release does not exist
|-
|-
| /releases/[name]/builds/[platform]/[locale]
| rowspan=2 | /releases/[name]/builds/[platform]/[locale]
| GET
| rowspan=2 | GET
|
| rowspan=2 |
| Retrieve a specific build from a release
| rowspan=2 | Retrieve a specific build from a release
| 200 - Build returned
|-
| 404 - Release, platform, or locale doesn't exist
| 404 - Release, platform, or locale doesn't exist
|-
|-
| /releases/[name]/builds/[platform]/[locale]
| rowspan=3 |/releases/[name]/builds/[platform]/[locale]
| PUT
| rowspan=3 | PUT
| details - the JSON blob associated with this build
| rowspan=3 | details - the JSON blob associated with this build
| Update the build with the supplied JSON data. If any of the named release, platform, or locale don't exist, they will be created. If the specific build already exists, it will be overwritten with the supplied information.
| rowspan=3 | Update the build with the supplied JSON data. If any of the named release, platform, or locale don't exist, they will be created. If the specific build already exists, it will be overwritten with the supplied information.
| 200 - Build modified
|-
| 201 - Build created
|-
| 400 - The details value is malformed or NULL.
| 400 - The details value is malformed or NULL.
|-
|-
| /releases/[name]/builds/[platform]/[locale]
| rowspan=2 | /releases/[name]/builds/[platform]/[locale]
| DELETE
| rowspan=2 | DELETE
|
| rowspan=2 |
| Delete the build
| rowspan=2 | Delete the build
| 404 - The named build doesn't exist
| 200 - Release deleted
|-
| 404 - Build doesn't exist
|-
|-
| rowspan=15 | /rules
| rowspan=15 | /rules
Line 99: Line 122:
| priority
| priority
| rowspan=15 | Create a new rule with the supplied arguments.
| rowspan=15 | Create a new rule with the supplied arguments.
| rowspan=15 | 400 - One or more of the arguments is invalid
| rowspan=7 | 201 - Rule created
|-
|-
| mapping
| mapping
Line 114: Line 137:
|-
|-
| buildTarget
| buildTarget
| rowspan=8 | 400 - One or more of the arguments is invalid
|-
|-
| buildID
| buildID
Line 129: Line 153:
| comment
| comment
|-
|-
| /rules
| rowspan=2 | /rules
| GET
| rowspan=2 | GET
| Same as /rules POST
| rowspan=2 | Same as /rules POST
| Retrieve all of the rules that match the specified arguments. Any missing arguments are regarded as wildcards, therefore a request with no parameters returns all rules.
| rowspan=2 | Retrieve all of the rules that match the specified arguments. Any missing arguments are regarded as wildcards, therefore a request with no parameters returns all rules.
| 200 - Rules returned
|-
| 204 - No rules
|-
| rowspan=2 | /rules/[id]
| rowspan=2 | PUT
| rowspan=2 | Same as /rules POST
| rowspan=2 | Update the rule with the supplied arguments. Any missing arguments will be considered NULL.
| 200 - Rule modified
|-
| 400 - One or more of the arguments is invalid
|-
| rowspan=2 | /rules/[id]
| rowspan=2 | POST
| rowspan=2 | Same as /rules POST
| rowspan=2 | Update the rule with any arguments passed. Any missing arguments will not be changed.
| 200 - Rule modified
|-
|-
| /rules/[id]
| PUT
| Same as /rules POST
| Update the rule with the supplied arguments. Any missing arguments will be considered NULL.
| 400 - One or more of the arguments is invalid
| 400 - One or more of the arguments is invalid
|-
|-
| /rules/[id]
| rowspan=2 | /rules/[id]
| POST
| rowspan=2 | DELETE
| Same as /rules POST
| rowspan=2 |
| Update the rule with any arguments passed. Any missing arguments will not be changed.
| rowspan=2 | Delete the rule
| 200 - Rule deleted
|-
|-
| /rules/[id]
| DELETE
|
| Delete the rule
| 404 - Rule does not exist
| 404 - Rule does not exist
|}
|}
canmove, Confirmed users
6,441

edits