Skip to content

New Swagger API doc

Dany Marcoux edited this page Nov 17, 2021 · 13 revisions

New OBS API Documentation

We are rewriting our documentation using Swagger

As a guide, we are using: https://swagger.io/docs/specification/about/

The main configuration file is here: https://github.com/openSUSE/open-build-service/blob/master/src/api/public/apidocs-new/OBS-v2.10.50.yaml

How to test it:

start the development environment and point your browser to http://localhost:3000/apidocs-new/index.html

CAVEATS

Some people experience problems with Swagger and Rails, specially when a file get changed, either Rails doesn't reload it or browser caches it. To the second issue, normally running the browser in incognito/private mode helps.

Clone this wiki locally