Skip to content

Commit

Permalink
Simplify and clarify the whole sentence about validations
Browse files Browse the repository at this point in the history
Co-authored-by: Henne Vogelsang <hvogel@opensuse.org>
  • Loading branch information
ncounter and hennevogel committed Apr 27, 2023
1 parent d5827ec commit 32f7173
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/api/public/apidocs-new/OBS-v2.10.50.yaml
Expand Up @@ -66,9 +66,10 @@ 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 complex requests and responses are in the expected format, a validation check is executed on sending and receiving commands.
All validations are made against either XML Schema Definition (`.xsd`) files or RELAX NG Schemas (`.rng`) files mentioned in the endpoint. If there is no Schema file mentioned, no validation is done.
In case a defined format is not respected, a validation error is reported.
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'
Expand Down

0 comments on commit 32f7173

Please sign in to comment.