Skip to content

Commit

Permalink
Fix Staging API docs
Browse files Browse the repository at this point in the history
Mark this API as unstable. Add a description parameter as you can not create a
Staging::RequestExclusion without a description.
  • Loading branch information
hennevogel committed Nov 22, 2018
1 parent a56bfb6 commit 26abbfb
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/api/api/api.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1932,13 +1932,15 @@ XmlResult: required_checks


== Staging
WARNING: This API is currently in beta and unstable

=== Excluded Requests

<project>: The name of the main project of a Staging, e.g. openSUSE_Tumbleweed
<request>: The number of the request, e.g. 12345
<description>: A string of text (url encoded)

POST /staging_excluded_requests/<request>/<project>
POST /staging_excluded_requests/<request>/<project>?description=<description>
Exclude this request from this Staging

DELETE /staging_excluded_requests/<request>
Expand Down

0 comments on commit 26abbfb

Please sign in to comment.