-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
Milestone
Description
Description
Overview
Create a versioned, public API endpoint that allows developers to search and retrieve detailed information about applications in the DeployStack catalog, similar to npm's package search API.
Current Situation
Currently, application information is only accessible through the deploystack.io website. There's no programmatic way to:
- Search for applications
- Retrieve container specifications
- Get deployment configurations
Suggested Solution
Proposed API Design
Base URL
https://deploystack.io/api/v1
Endpoints
- Search Applications -
GET /search?q={query}
- Get Application Details -
GET /apps/{app_name}
Technical Requirements
API Infrastructure
- RESTful API design
- API versioning (starting with v1)
- Rate limiting
- Authentication for higher rate limits
- CORS configuration
- API documentation using OpenAPI/Swagger
Search Functionality
First version will include the app_name
variable
Documentation Requirements
- OpenAPI/Swagger specification
- Usage examples
- Rate limit documentation
- SDK examples in popular languages