Commands on processing sources globally. Possible commands are
branch: branch a set of packages based on attributes or on existing request
createmaintenanceincident: create mainatenance incident projects based on attribute search

attribute: attribute used for package search, default is OBS:Maintained
update_project_attribute: attribute name used to find out possible existing update projects of a package
request: branch by request, branch all packages in actions of request for superseding it
noaccess: the new created project will be read protected
target_project: project which will get used or created

GET /source/<project>/_meta

Arguments:

project - Project name

Read project meta file.

rev: revision, mandatory

Result: Example Schema

PUT /source/<project>/_meta

Arguments:

project - Project name

Write project meta file.

comment: comment, optional

Body: Example Schema

Result: Example Schema

DELETE /source/<project>

Arguments:

project - Project name

Deletes specified project. All packages of this project are deleted as if a
DELETE request were issued for each package.

force: If force = 1, the project is deleted even if repositories of other
projects include a path to a repository from this project. The path
in the other repository is replaced by one pointing to 'deleted/standard',
preventing the build and publishing of the other repository.
comment: comment, optional

Result: Example Schema

GET /source/<project>/_attribute/<attribute>

Arguments:

project - Project name
attribute

Get all attributes or a specific one

Body: attribute

POST /source/<project>/_attribute/<attribute>

Arguments:

project - Project name
attribute

Modifies a specific attribute as in body

comment: comment, optional

Result: Example Schema

DELETE /source/<project>/_attribute/<attribute>

Arguments:

project - Project name
attribute

Removes a specific attribute

comment: comment, optional

Result: Example Schema

GET /source/<project>/_config

Arguments:

project - Project name

Read project configuration

rev: revision, mandatory

Result: configuration as text/plain

PUT /source/<project>/_config

Arguments:

project - Project name

Change project configuration

comment: comment, optional

Result: Example Schema

GET /source/<project>/_pattern

Arguments:

project - Project name

Get list of all patterns set up for this project

Result: Schema

GET /source/<project>/_pattern/<patternfile>

Arguments:

project - Project name
patternfile

Get pattern

Result: Schema

PUT /source/<project>/_pattern/<patternfile>

Arguments:

project - Project name
patternfile

Write pattern

Body: Schema

Result: Example Schema

DELETE /source/<project>/_pattern/<patternfile>

Arguments:

project - Project name
patternfile

Remove pattern

Result: Example Schema

GET /source/<project>/_pubkey

Arguments:

project - Project name

Get project GPG key. If the project has no own key (default), it uses
the first available one in the namespace hierarchy, ending at the global
buildservice key.

Result: gpgkey

DELETE /source/<project>/_pubkey

Arguments:

project - Project name

Removes the current gpg key. Has no effect if no key is set.

Result: Example Schema

POST /source/<project>

Arguments:

project - Project name

Multiple commands on processing sources in package. Possible commands are
createkey: Generate a new gpg key. If the project already has an own gpg key, the old key is discarded.
extendkey: Extend the expiration date of gpg keys.
undelete: undelete the project and all packages existing when the project got removed.
showlinked: List all projects linking to this one
copy: copy the entire project
createmaintenanceincident: create a single mainatenance incident project as sub project
createpatchinfo: create a new patchinfo package collecting all mentioned issues in sources
set_flag: change a defined flag, requires at least flag and status parameters
remove_flag: remove a defined flag, requires at least flag and status parameters
unlock: unlock a locked project

noaccess: the new created project will be read protected
repository: set_flag for given repository (optional)
arch: set_flag for given arch (optional)
flag: modify this flag (build/publish/..) for set_flag command
status: enable or disable for set_flag command
comment: description for the history
# for copy command only:
resign: resign all binaries with new target project key
makeolder: make a split, the source is bumped by two numbers and target by one
withhistory: copies sources with history on copy command
withbinaries: copies also binaries on copy command

GET /source/<project>

Arguments:

project - Project name

Read list of packages.

Result: Example Schema

deleted: show deleted package instead of existing
expand: include also packages from linked projects
view: issues, optional, can be used to show all tracked issues for all packages in project

GET /source/<project>/<package>

Arguments:

project - Project name
package - Package name

Package source listing

rev: revision of new package, optional
linkrev: linked revision, optional
emptylink: bool, , optional
expand: bool, expand links, optional
meta: bool, switch to meta files, optional
view: The "info" view will show data like source version, md5sums and build description files. May be used together with parse, arch or repository parameter, optional
"issues" can be used to show all tracked issues for all packages in project, optional
extension: filter for file extension, optional
lastworking: bool, show sources of last mergeable sources in case of conflicting changes, optional
withlinked: bool, show all used package containers (in case of multiple link indirections) in linkinfo information, optional
deleted: bool, show content of deleted package instance
parse: bool, for view=info: take build description into account, optional
arch: string, for view=info: parse buildinfo for this architecture, optinal
repository: string, for view=info: parse buildinfo for this repository, optinal

Result: Example Schema

GET /source/<project>/<package>/_meta

Arguments:

project - Project name
package - Package name

Read project meta data.

rev: revision of new package, optional

Result: Example Schema

PUT /source/<project>/<package>/_meta

Arguments:

project - Project name
package - Package name

Write project meta data. Writing of the project meta data commits the packages
contained in the project to the build backend.

comment: comment, optional

Body: Example Schema

Result: Example Schema

DELETE /source/<project>/<package>

Arguments:

project - Project name
package - Package name

Deletes specified package including all source files

comment: comment, optional

Result: Example Schema

GET /source/<project>/<package>/_attribute/<attribute>

Arguments:

project - Project name
package - Package name
attribute

Get all attributes or a specific one

Body: attribute

POST /source/<project>/<package>/_attribute/<attribute>

Arguments:

project - Project name
package - Package name
attribute

Modifies a specific attribute as in body

comment: comment, optional

Result: Example Schema

DELETE /source/<project>/<package>/_attribute/<attribute>

Arguments:

project - Project name
package - Package name
attribute

Removes a specific attribute

comment: comment, optional

Result: Example Schema

GET /source/<project>/<package>/_history

Arguments:

project - Project name
package - Package name

Get package commit history

Result: Example

POST /source/<project>/<package>?cmd=showlinked

Arguments:

project - Project name
package - Package name

List all package instances linking to this one.

Result: package list

POST /source/<project>/<package>?cmd=diff

Arguments:

project - Project name
package - Package name

Create a source diff

rev: revision of new package, optional
oproject: old project, optional
opackage: old package, optional
orev: old revision, optional

Result: diff as text/plain

POST /source/<project>/<package>?cmd=unlock

Arguments:

project - Project name
package - Package name

Unlocks a locked package

comment: description for the history

Result: Example Schema

POST /source/<project>/<package>?cmd=branch

Arguments:

project - Project name
package - Package name

Create a source link from a package of an existing project to a
new subproject of the requesters home project.
The default target is home:<user>:branches:<project>/<package>
A possible defined devel project in the package meta data gets ignored.

ignoredevel: bool, optional
target_project: target project name, optional
target_package: target package name, optional
noaccess: the new created project will be read protected, bool, optional
missingok: the target package does not exist
add_repositories: bool, optional, adds repositories base on source project (default for new projects)
extend_package_names: bool, optional, extends package and repository names to allow multiple instances of same package

Result: Example Schema

POST /source/<project>/<package>?cmd=set_flag

Arguments:

project - Project name
package - Package name

Modify or set a defined flag for package

repository: set_flag for given repository (optional)
arch: set_flag for given arch (optional)
flag: modify this flag (build/publish/..) for set_flag command
status: enable or disable for set_flag command

Result: Example Schema

POST /source/<project>/<package>?cmd=createSpecFileTemplate

Arguments:

project - Project name
package - Package name

Create template for RPM SPEC file. Returns an error, if the SPEC file already
exists.

Result: Example Schema

POST /source/<project>/<package>?cmd=commit

Arguments:

project - Project name
package - Package name

Commits package changes to buildservice

rev: revision, mandatory
comment: comment, optional

Result: Example Schema

POST /source/<project>/<package>?deleteuploadrev

Arguments:

project - Project name
package - Package name

Removes all changes made to the upload revision and reverts to last revision

none

Result: Example Schema

GET /source/<project>/<package>

Arguments:

project - Project name
package - Package name

Get directory listing of all source files in the package

rev: package source revision, optional
linkrev: linked revision, optional
expand: expand links, optional
meta: switch to meta files
lastworking: auto detect last working link revision, optional
view: The "cpio" view will stream all files as cpio, optional
extension: filter for file extension, optional

GET /source/<project>/<package>/<filename>

Arguments:

project - Project name
package - Package name
filename - File name

Read source file.

Result: Content of file

meta: switch to meta files

PUT /source/<project>/<package>/<filename>

Arguments:

project - Project name
package - Package name
filename - File name

Write source file.

rev: if set to 'upload', multiple files can be uploaded one by one in one commit, before
finishing the commit with cmd=commit (see below), optional
comment: comment, optional
keeplink: bool, optional
meta: switch to meta files

Body: Content of file

Result: Example Schema

DELETE /source/<project>/<package>/<filename>

Arguments:

project - Project name
package - Package name
filename - File name

Delete source file.

Result: Example Schema

meta: switch to meta files

POST /source/<project>/<package>

Arguments:

project - Project name
package - Package name

Multiple commands on processing sources in package. Possible commands are
diff: for server side diff
linkdiff: for server side diff of a linked or branched package
servicediff: shows the changes of the service run
commit: commit files in upload revision
commitfilelist: commit defined files in upload revision
deleteuploadrev: delete all uploaded sources which are not committed yet
copy: copy package sources from another package
undelete: undelete the package
unlock: unlock a package with lock enabled. A comment is required.
branch: branch a package into another one
linktobranch: convert a plain source link into a full branch
updatepatchinfo: update _patchinfo file, esp. the issues list
remove_flag: remove a specific flag from meta (flag must be defined, optionally arch and repository)
set_flag: remove a specific flag from meta (flag must be defined, optionally arch and repository)
showlinked: show all source packages linking to this one
deleteuploadrev: delete all uploaded, but not yet commited files.
rebuild: rebuild all builds
getprojectservices: list all service defined in project spaces defined for this package.
runservice: trigger run of defined services in _service file
wipe: wipe all build results of this package

rev: package source revision, optional
linkrev: linked revision, optional
orev: origin package source revision as defined in opackage/project, optional
olinkrev: origin linked revision, optional
oproject: origin project, used as base project
opackage: origin package, used as base package
requestid: log the requestid in source history, optional (copy and commitfilelist only)
expand: expand links, optional
keeplink: keep link on source commit, optional
repairlink: repair link on source commit, optional
dontupdatesource: Do not update origin package, optional (copy only)
comment: comment for history, optional
meta: switch to meta files
arch: architecture when using flag modifing command
repository: repository when using flag modifing command
view: may be "xml" for structured answered (for diff commands)
withissues: set to get issues parsed from changelogs (for diff commands)
onlyissues: used to limit to issues (for diff commands)

GET /source/<project>/<package>/<binary>/_attribute/<attribute>

Arguments:

project - Project name
package - Package name
binary
attribute

Get all attributes or a specific one

Body: attribute

POST /source/<project>/<package>/<binary>/_attribute/<attribute>

Arguments:

project - Project name
package - Package name
binary
attribute

Modifies a specific attribute as in body

comment: comment, optional

Result: Example Schema

DELETE /source/<project>/<package>/<binary>/_attribute/<attribute>

Arguments:

project - Project name
package - Package name
binary
attribute

Removes a specific attribute

comment: comment, optional

Result: Example Schema

GET /request

Get a list of requests. When using the "view=collection" you need also to filter
either by user, project or package.

view: collection, return a collection of requests instead of directory listing
user: filter for given user, includes all target projects and packages where
the user is maintainer and also open review requests
project: limit to result to defined target project or review requests
package: limit to result to defined target package or review requests
states: filter for given request state, multiple matches can be added as comma seperated list (eg states=new,review)
types: filter for given action types (comma seperated)
roles: filter for given roles (creator, maintainer, reviewer, source or target)

Result: collection

GET /request/<id>

Arguments:

id

Get a request

Result: Example Schema

POST /request

Create a new request

Result: Example Schema

Commands on processing requests
create: to crfeate a new request

addrevision: ask the server to add revisions of current sources to the request

PUT /request/<id>

Arguments:

id

Modify a request. NOTE: Only admins can change all parts of a request.

Result: Example Schema

POST /request/<id>?cmd=diff

Arguments:

id

Shows the diff of all affected packages.

Result: diff as text/plain

POST /request/<id>

Arguments:

id

Modify a request state

Result: Example Schema

Commands on processing requests
changestate: Modifies the state of a request

newstate: to define the new state of a request

DELETE /request/<id>

Arguments:

id

Delete a request

GET /attribute/

List all attribute namespaces

Result: Example Schema

GET /attribute/<namespace>/

Arguments:

namespace

List all attributes under given namespace

Result: Example Schema

GET /attribute/<namespace>/_meta

Arguments:

namespace

shows namespace setup

Result: Example Schema

DELETE /attribute/<namespace>/_meta

Arguments:

namespace

Delete a attribute namespace and all attributes below

Result: Example Schema

PUT /attribute/<namespace>/_meta

Arguments:

namespace

change attribute namespace meta

Body: attribute_namespace_meta_data

Result: Example Schema

GET /attribute/<namespace>/<name>/_meta

Arguments:

namespace
name

shows attribute setup

Result: attribute_meta

DELETE /attribute/<namespace>/<name>/_meta

Arguments:

namespace
name

Delete a attribute and all its values in projects or packages

Result: Example Schema

PUT /attribute/<namespace>/<name>/_meta

Arguments:

namespace
name

change attribute meta

Body: attribute_meta_data

Result: Example Schema

GET /build/

List all repositories

Result: Example Schema

GET /build/_workerstatus

Lists all running jobs, waiting jobs, status of the backend services and general statistics.

Result: Example

GET /build/<project>

Arguments:

project - Project name

List all repositories of the specified project

Result: Example Schema

GET /build/<project>/<repository>

Arguments:

project - Project name
repository

List all architectures of the specified project repository

Result: Example Schema

GET /build/<project>/<repository/<arch>

Arguments:

project - Project name
repository/<arch

List all packages used in this project repository for given architecture.

Result: Example Schema

GET /build/<project>/<repository>/<arch>/<package>

Arguments:

project - Project name
repository
arch
package - Package name

Get list of binaries built by the sources of the given package

Result: binarylist

GET /build/<project>/<repository>/<arch>/<package>/<binaryname>

Arguments:

project - Project name
repository
arch
package - Package name
binaryname

Get single binary from build results of given package

Result: binary file

GET /build/<project>/<repository>/<arch>/<package>/<binaryname>?view=fileinfo

Arguments:

project - Project name
repository
arch
package - Package name
binaryname

GET /build/<project>/<repository>/<arch>/<package>/<binaryname>?view=fileinfo_ext

Arguments:

project - Project name
repository
arch
package - Package name
binaryname

Get information about the binary from build results of given package

Result: fileinfo

GET /build/<project>/<repository>/<arch>/_builddepinfo?package=<package>

Arguments:

project - Project name
repository
arch

Shows all build dependencies of one or more packages, a change in any of them will
trigger a build.

view=pkgnames show package names instead of binary names
view=revpkgnames show which packages will be triggered if the package is changed

Result: build dependencies

GET /build/<project>/<repository>/<arch>/_jobhistory?package=<package>&code=succeeded&limit=10

Arguments:

project - Project name
repository
arch

Get the build log of all finished builds in this repository, including
time and trigger reason. Optional filtering for one ore more packages/codes is
possible.

Result: jobhistory

GET /build/<project>/<repository>/<arch>/_repository

Arguments:

project - Project name
repository
arch

Get list of binaries in given repository (binaries produced by all packages
of the project)

Result: binarylist

POST /build/<project>/<repository>/<arch>/_repository?match=

Arguments:

project - Project name
repository
arch

Uploads binaries to a given repository. ADMIN ONLY

Result: status

PUT /build/<project>/<repository>/<arch>/_repository/<file>

Arguments:

project - Project name
repository
arch
file

Uploads binaries into the repository. ADMIN ONLY.

Result: status

GET /build/<project>/<repository>/<arch>/_repository/<binaryname>

Arguments:

project - Project name
repository
arch
binaryname

Get single binary from the given repository

Result: binary file

GET /build/<project>/_result

Arguments:

project - Project name

Return build results for the packages, architectures and repositories
specified by the parameters. If no parameters are given, all results for the
project are returned.

The view parameter specifies which sections are included in the results.
view=summary includes the summary of the status values. view=status includes
detailed status information. view=binarylist includes the list of generated
binary files. If no view parameter is given, view=status is assumed. To
combine views the parameter can be given multiple times.

package: package name, optional, multiple
arch: architecture, optional, multiple
repository: name of repository, optional, multiple
view: summary | status | binarylist
lastbuild: bool, optional

Result: Example

GET /build/<project>/<repository>/<arch>/<package>/_history

Arguments:

project - Project name
repository
arch
package - Package name

Get build history

Result: Example Schema

GET /build/<project>/<repository>/<arch>/<package>/_reason

Arguments:

project - Project name
repository
arch
package - Package name

Detailed reason, why the last build got triggered. This may be
caused by a source change, meta change (binary package below changed) or
release number sync.
A user triggered build will show up as source change.

Result: buildreason

GET /build/<project>/<repository>/<arch>/<package>/_status

Arguments:

project - Project name
repository
arch
package - Package name

Get build status of the specified project/package/repo/arch combination

Result: buildstatus

GET /build/<project>/<repository>/<arch>/<package>/_log

Arguments:

project - Project name
repository
arch
package - Package name

Get build log.

Result: Build log as text file.

POST /build/<project>?cmd=rebuild

Arguments:

project - Project name

Triggers package rebuild for the repositories/architectures of the package
specified by the parameters. If no parameters are given, all packages of the
project are completely rebuilt.

Possible values for the code parameter are:

succeeded - build succeeded
failed - build failed
disabled - build is disabled in package config
excluded - build is excluded in spec file
scheduled - package is ready to be built
building - package is building on a worker
broken - package source is bad (i.e. no specfile)
unresolvable - build needs unavailable binary packages

package: package name, optional, multiple
arch: architecture, optional, multiple
repository: name of repository, optional, multiple
code: build status code, optional, multiple

Result: Example Schema

POST /build/<project>?cmd=abortbuild

Arguments:

project - Project name

Kill all running builds, marking them as failed

see cmd=rebuild

POST /build/<project>?cmd=restartbuild

Arguments:

project - Project name

Restart all running builds

see cmd=rebuild

POST /build/<project>?cmd=wipe

Arguments:

project - Project name

Delete all binary packages from the packages

see cmd=rebuild

GET /build/<project>/<repository>/<arch>/<package>/_buildinfo

Arguments:

project - Project name
repository
arch
package - Package name

Get build information for local building

Result: buildinfo

POST /build/<project>/<repository>/<arch>/<package>/_buildinfo

Arguments:

project - Project name
repository
arch
package - Package name

Get build info for local building using the POSTed specfile.
<package> can be "_repository", if the designated package does not yet exist
on the server. Usefull for local build test before committing the initial package.

Body: specfile

Result: buildinfo

GET /build/<project>/<repository>/<arch>/_repository

Arguments:

project - Project name
repository
arch

Returns list of binaries contained in the specified repository

Result: Example

GET /build/<project>/<repository>/<arch>/_repository/<binaryname>

Arguments:

project - Project name
repository
arch
binaryname

Returns binary

Result: binary file

GET /build/<project>/<repository>/<arch>/<package>

Arguments:

project - Project name
repository
arch
package - Package name

Returns list of binaries contained in the specified repository

Result: Example

GET /build/<project>/<repository>/<arch>/<package>/_buildinfo

Arguments:

project - Project name
repository
arch
package - Package name

Build info according to the committed sources

Result: buildinfo

POST /build/<project>/<repository>/<arch>/<package>/_buildinfo

Arguments:

project - Project name
repository
arch
package - Package name

Build info according to the uploaded sources

Result: buildinfo

GET /build/<project>/<repository>/<arch>/_builddepinfo

Arguments:

project - Project name
repository
arch

Returns dependency information of packages in the specified repository. One or more
packages can be specified with the 'package' parameter. By default dependencies for
all packages are returned.

Result: builddepinfo

GET /build/<project>/<repository>/_buildconfig

Arguments:

project - Project name
repository

Build configuration for this repository, all base package requirements, mappings and macros.

GET /search/project

Searches for project metadata using xpath. A xpath predicate has to be
specified using the match parameter. The predicate will be used in this
expression: /project[<match>]. Only complete meta files will be returned.