Skip to content

ZirgomHaidar/ROS-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

RisingOS API [v1.0.0]

A RESTful API made using FASTAPI written in Python(v3.11 and above) service that provides OTA (Over-The-Air) update information for RisingOS ROM. This API fetches and serves data from the RisingOTA repository, making it easy to access device-specific ROM information programmatically.

TODO List

  • Endpoints rename to API naming convention
  • Project Restructure with separate concerns (routes, services, models)

Features

  • RESTful endpoints for accessing ROM information
  • Real-time data synchronization with RisingOTA repository
  • Cached responses for improved performance
  • Comprehensive device and build information
  • JSON response format

Prerequisites

  • fastapi[standard]>=0.112.0
  • requests
  • pydantic
  • apscheduler
  • git

API Documentation

you can access:

API Endpoints

  1. API status
GET /
  1. DeviceList
GET /api/v1/device/deviceList
  1. Device Variants and Information
GET /api/v1/device/{codename}

example: /device/lynx, /device/cancunf, etc.

Project Structure

├── main.py
└── ROSAPI
│   ├── functions
│   │   ├── DeviceList.py
│   │   └── DeviceVaraints.py
│   ├── __init__.py
│   └── Models
│       ├── DnListModel.py
│       └── __init__.py
│
├── README.md
├── requirements.txt

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages