/tng-doc

Repository that contains the API documentation

Primary LanguageHTML

Build Status Join the chat at https://gitter.im/5gtango/tango-schema

5GTANGO DOCUMENTATION

This is the 5GTANGO Documentation Repository.

Please see details on the overall 5GTANGO architecture here.

How does this work?

After creating a new API or modifyng an existing one, the developer must create/update a swagger spec description file. This document will help the current team and newcomers to understand how their API works.

Here [https://swagger.io/docs/specification/about/], you can get full detailed info on how to create the swagger files.

After created, you only need to add the link to this file in 'urls' section in the 'index.html' of this project. And after some seconds your swagger spec doc file will be available in the tng-doc page [https://sonata-nfv.github.io/tng-doc/].

Other components are the following:

Developing

You can fork this repository, and add your new entries (links to your swagger files) to the index.html, in the urls section like this:

urls: [ {url: "https://raw.githubusercontent.com/sonata-nfv/repository_X/rest_api_model.json", name: "5GTANGO Repository X API v1"}, {url: "https://raw.githubusercontent.com/sonata-nfv/repository_Y/rest_api_model.yaml", name: "5GTANGO Repository Y v1"}, ],

After the pull request is accepted, new elements will be published in https://sonata-nfv.github.io/tng-doc/