wehub-resource-sync
7a0da7932b
OSV-Scanner (Scheduled) / scan-scheduled (push) Failing after 0s
Create Release / test-gate (push) Has been cancelled
Create Release / release-gate (push) Has been cancelled
Create Release / ci-gate (push) Has been cancelled
Create Release / version-check (push) Has been cancelled
Create Release / e2e-test-gate (push) Has been cancelled
Create Release / responsive-test-gate (push) Has been cancelled
Create Release / compat-test-gate (push) Has been cancelled
Create Release / compose-integration-gate (push) Has been cancelled
Create Release / vulture-gate (push) Has been cancelled
Create Release / build (push) Has been cancelled
Create Release / provenance (push) Has been cancelled
Create Release / prerelease-docker (push) Has been cancelled
Create Release / publish-docker (push) Has been cancelled
Create Release / create-release (push) Has been cancelled
Create Release / cleanup-changelog (push) Has been cancelled
Create Release / trigger-pypi (push) Has been cancelled
Create Release / monitor-pypi (push) Has been cancelled
Create Release / Clean up orphan prerelease tags and signatures (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [research-form] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [research-metrics] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [research-workflow] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [settings-core] (push) Has been cancelled
CodeQL Advanced / Analyze (javascript-typescript) (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [history-news] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [library] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [link-analytics] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [chat-core] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [chat-lifecycle] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [error-benchmark] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [settings-pages] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) (push) Has been cancelled
Docker Tests (Consolidated) / Accessibility Tests (push) Has been cancelled
Docker Tests (Consolidated) / LLM Unit Tests (push) Has been cancelled
Docker Tests (Consolidated) / LLM Example Tests (push) Has been cancelled
Docker Tests (Consolidated) / Production Image Smoke Test (push) Has been cancelled
Docker Tests (Consolidated) / Infrastructure Tests (push) Has been cancelled
OSSF Scorecard / OSSF Security Scorecard Analysis (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [mobile] (push) Has been cancelled
Backwards Compatibility / Verify Encryption Constants (push) Has been cancelled
Backwards Compatibility / PyPI Version Compatibility (push) Has been cancelled
Backwards Compatibility / Database Migration Tests (push) Has been cancelled
CodeQL Advanced / Analyze (python) (push) Has been cancelled
Docker Tests (Consolidated) / detect-changes (push) Has been cancelled
Docker Tests (Consolidated) / Build Test Image (push) Has been cancelled
Docker Tests (Consolidated) / All Pytest Tests + Coverage (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [accessibility] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [api-crud] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [auth-login] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [auth-pages] (push) Has been cancelled
Docker Tests (Consolidated) / UI Tests (Puppeteer) [auth-register] (push) Has been cancelled
68 lines
2.2 KiB
Markdown
68 lines
2.2 KiB
Markdown
# Advanced HTTP API Examples
|
|
|
|
This folder contains more comprehensive HTTP API examples for learning advanced features and production use cases.
|
|
|
|
## 📁 Available Examples
|
|
|
|
### 📚 `simple_http_example.py` - **COMPREHENSIVE GUIDE**
|
|
- ✅ **Automatic user creation**
|
|
- 📊 **Multiple API examples** (research, settings, history)
|
|
- 🔍 **Progress monitoring** with status updates
|
|
- ⏱️ **Runtime:** 3-15 minutes (more comprehensive testing)
|
|
|
|
**Perfect for:** Learning different API endpoints, understanding the full API surface
|
|
|
|
### 🚀 `http_api_examples.py` - **ADVANCED CLIENT**
|
|
- 🔧 **Reusable client class** for integration
|
|
- 📈 **Advanced features** (batch processing, polling)
|
|
- 🎛️ **Comprehensive patterns** for production use
|
|
- ⏱️ **Runtime:** 5-30 minutes (extensive testing)
|
|
|
|
**Perfect for:** Building applications, production integration, advanced use cases
|
|
|
|
## 🚀 Quick Start
|
|
|
|
### 1. Run the Comprehensive Example
|
|
```bash
|
|
cd advanced
|
|
python simple_http_example.py
|
|
```
|
|
|
|
### 2. Try the Advanced Client
|
|
```bash
|
|
cd advanced
|
|
python http_api_examples.py
|
|
```
|
|
|
|
## ⚠️ Important Notes
|
|
|
|
- **Longer Runtime**: These examples take longer than the basic example
|
|
- **More Features**: They demonstrate additional API endpoints and patterns
|
|
- **Learning Focused**: Designed to help you understand the full API surface
|
|
- **Production Ready**: Advanced examples include patterns for production use
|
|
|
|
## 📚 What These Examples Demonstrate
|
|
|
|
### simple_http_example.py
|
|
- ✅ All basic functionality from the main example
|
|
- ✅ Settings management (get/update configuration)
|
|
- ✅ Research history access
|
|
- ✅ Progress polling and monitoring
|
|
- ✅ Multiple research scenarios
|
|
- ✅ Error handling patterns
|
|
|
|
### http_api_examples.py
|
|
- ✅ All functionality from simple_http_example.py
|
|
- ✅ Reusable client class for application integration
|
|
- ✅ Batch processing capabilities
|
|
- ✅ Advanced polling strategies
|
|
- ✅ Production-ready error handling
|
|
- ✅ Comprehensive API coverage
|
|
- ✅ Settings management patterns
|
|
|
|
## 🔗 Related Documentation
|
|
|
|
- [Main HTTP Examples](../README.md)
|
|
- [Basic Working Example](../simple_working_example.py)
|
|
- [API Documentation](../../../../README.md)
|