NIOS Swagger Documentation

This repository hosts Swagger documentation for the NIOS (Network Identity Operating System) API.

Access the Documentation

You can access the Swagger documentation through GitHub Pages:

NIOS Swagger Documentation

Available API Documentation

The following API documentation is available:

• DNS API
• DHCP API
• DTC API

API Resources

The repository includes JSON specification files for:

• DNS operations
• DHCP configuration
• DTC (DNS Traffic Control)
• Extended Attributes

Development

This project uses Swagger UI to render API documentation from JSON specification files.

Files Structure

• index.html: Main entry point for the Swagger UI
• /nios-swagger/: Contains the API specification JSON files
  • dns.json: DNS API specification
  • dhcp.json: DHCP API specification
  • dtc.json: DTC API specification
  • extAttributes.json: Extended attributes specification
  • ipam.json: IP Address Management API specification

Local Setup

To run this project locally:

1. Clone the repository
2. Navigate to the project directory
3. Open index.html in your browser

GitHub Pages

This documentation is hosted via GitHub Pages, making it easily accessible to users without requiring local setup.