Skip to content

Commit

Permalink
Add general documentation to API new documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Dany Marcoux committed Jan 20, 2021
1 parent 9449c66 commit c496cf7
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion src/api/public/apidocs-new/OBS-v2.10.50.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,18 @@ tags:
- name: Groups

info:
description: Open Build Service API
description: |
The _Open Build Service API_ is a XML API.
To authenticate, use [HTTP basic authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) by passing the _Authorization_ header in the form of `Authorization: Basic <credentials>`.
There is no API versioning as there is no need for it right now.
Only rudimentary rate limiting is implemented, so please be gentle when using the API concurrently, especially with potentially expensive operations.
In case of abuse, we will limit/remove your access.
For command-line users, we recommend using [osc](https://github.com/openSUSE/osc) with its _api_ command to interact with the API.
It's as simple as this example: `osc api /about` (_about_ is one of the endpoints documented below)
version: '2.10.50'
title: Open Build Service API
contact:
Expand Down

0 comments on commit c496cf7

Please sign in to comment.