Skip to content

Commit

Permalink
Merge pull request #14254 from ncounter/document-api-validations
Browse files Browse the repository at this point in the history
Document the validation checks
  • Loading branch information
ncounter committed Apr 27, 2023
2 parents 6efdfc8 + 32f7173 commit e71cb3c
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions src/api/public/apidocs-new/OBS-v2.10.50.yaml
Expand Up @@ -67,6 +67,11 @@ info:
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)
In order to make sure that the XML that is send in a requests body is in the expected format, the API validates it.
Either against a XML Schema Definition (`.xsd`) or a RELAX NG Schema (`.rng`). The schemas are mentioned
in the endpoint documentation. If there is no schema file mentioned, no validation of the XML is done.
In case the XML is not valid, a validation error is reported.
The legacy API documentation is reachable [here](https://api.opensuse.org/apidocs/index).
version: '2.10.50'
title: Open Build Service API
Expand Down

0 comments on commit e71cb3c

Please sign in to comment.