From c496cf77b4ba3906ef695f0569774209ee98e4a3 Mon Sep 17 00:00:00 2001 From: Dany Marcoux Date: Mon, 18 Jan 2021 14:35:03 +0100 Subject: [PATCH] Add general documentation to API new documentation --- src/api/public/apidocs-new/OBS-v2.10.50.yaml | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/src/api/public/apidocs-new/OBS-v2.10.50.yaml b/src/api/public/apidocs-new/OBS-v2.10.50.yaml index e694d88f545..d4b0bec07c5 100644 --- a/src/api/public/apidocs-new/OBS-v2.10.50.yaml +++ b/src/api/public/apidocs-new/OBS-v2.10.50.yaml @@ -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 `. + + 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: