Skip to content

onedata/onepanel-swagger

Repository files navigation

Onepanel REST API defined using Swagger (http://swagger.io)

This repo contains Swagger specification of Oneprovider REST API.

Onepanel is part of Onedata, a distributed data management platform. Onepanel is an administrative service which enables management of other Onedata services including Onezone and Oneprovider.

For more details about Onepanel service please check (http://github.com/onedata/onepanel).

Compiling (Using Onedata docker repository):

./build.sh

Compiling from scratch:

# Install Node.js dependencies
npm install

# Aggregate Yaml specification files into a single swagger.json file
node resolve.js > swagger.json

After any of these steps you should have a complete swagger.json file, with specification of Onepanel REST API. The file can be used by Swagger code generator to produce example code for clients in various languages or viewed online using for instance Swagger Online Editor.