agent-company
a615b7ebfd
Closes leeworks-agents/api-company#5 (docs-site Astro scaffold) Closes leeworks-agents/api-company#9 (metrics instrumentation standard) Closes leeworks-agents/api-company#10 (Gitea Actions openapi aggregation pipeline) Closes leeworks-agents/api-company#11 (docs-site Flux HelmRelease) Closes leeworks-agents/api-company#12 (SEO blog posts x3) Closes leeworks-agents/api-company#13 (legal docs ToS/Privacy/AUP) Closes leeworks-agents/api-company#14 (DNS documentation) ## Changes ### docs/legal/ - terms-of-service.md — API usage, liability, account termination, governing law - privacy-policy.md — request log retention (90d), no PII sold, data sharing - acceptable-use-policy.md — rate limit abuse, scraping prohibition, resale ban ### docs/metrics-standard.md - Defines api_requests_total, api_response_duration_seconds, api_data_freshness_seconds - Fastify (TypeScript) and FastAPI (Python) reference middleware implementations - Prometheus scrape config and Grafana dashboard guidance ### docs/registry.md - Decision: use Gitea built-in container registry (no new infra) - Image naming convention, auth, Kubernetes imagePullSecrets, ingress config ### docs/dns.md - Required A records for all 6 subdomains - cert-manager ClusterIssuer and Ingress TLS examples - Verification commands and human-operator action items ### docs-site/ - Astro 4 + MDX + sitemap scaffold - Base layout with nav linking all APIs, blog, RapidAPI, status - Landing page with API cards - Per-API Redoc viewer pages (zip-enrichment, holidays, air-quality) - Blog index + 3 SEO blog posts (~1000 words each with JSON-LD) - Dockerfile (multi-stage: node build + nginx serve) - nginx.conf with gzip, caching, health endpoint ### flux/ - gitea-runner/: gitea-act-runner HelmRelease (org-scope, dind) - monitoring/: kube-prometheus-stack + Gatus HelmReleases - Prometheus with pod annotation scraping - Grafana at grafana.leeworks.dev with persistence - Gatus status page at status.leeworks.dev, 90-day retention - docs-site/: Deployment + Service + Ingress via raw chart - api-company-source/: GitRepository + Kustomization reference manifests - kustomization.yaml: root kustomize entry point (build validated) ### .gitea/workflows/build-docs.yaml - Aggregates openapi.yaml from zip-enrichment, holidays, air-quality repos - Builds Astro docs-site - Pushes image to registry.leeworks.dev/leeworks-agents/docs-site - Triggered on push to main, schedule daily 02:00 UTC, workflow_dispatch
94 lines
3.0 KiB
Markdown
94 lines
3.0 KiB
Markdown
# Acceptable Use Policy
|
|
|
|
**Effective Date:** 2026-05-24
|
|
**Contact:** legal@leeworks.dev
|
|
|
|
---
|
|
|
|
## 1. Purpose
|
|
|
|
This Acceptable Use Policy ("AUP") defines the rules for using leeworks.dev APIs. It applies to all users regardless of plan. Violations may result in immediate account suspension.
|
|
|
|
## 2. Rate Limits and Abuse
|
|
|
|
### 2.1 Respect Your Plan Limits
|
|
|
|
Each subscription plan includes defined rate limits:
|
|
|
|
| Plan | Requests/min | Requests/month |
|
|
|------|-------------|---------------|
|
|
| Free | 10 | 500 |
|
|
| Basic | 60 | 10,000 |
|
|
| Pro | 300 | 100,000 |
|
|
| Ultra | 1,000 | 1,000,000 |
|
|
|
|
You must not exceed your plan's limits through any means.
|
|
|
|
### 2.2 Prohibited Rate Limit Circumvention
|
|
|
|
The following are explicitly prohibited:
|
|
- Using multiple API keys or accounts to aggregate quota
|
|
- Caching responses for redistribution beyond your own application
|
|
- Rotating IP addresses to avoid throttling
|
|
- Using proxies or VPNs specifically to bypass rate limits
|
|
|
|
## 3. Prohibited Uses
|
|
|
|
### 3.1 Data Scraping and Bulk Download
|
|
|
|
You may **not**:
|
|
- Download or cache the entire dataset backing any API
|
|
- Make sequential requests designed to reconstruct the underlying database
|
|
- Use automated tools to systematically extract all available data points
|
|
|
|
### 3.2 Resale and Redistribution
|
|
|
|
You may **not**:
|
|
- Resell, sublicense, or redistribute API access to third parties
|
|
- Build a competing API product that serves our data to others
|
|
- Offer a "proxy" service that wraps our API for other developers
|
|
|
|
### 3.3 Malicious and Illegal Use
|
|
|
|
You may **not**:
|
|
- Use the APIs for any illegal purpose under applicable law
|
|
- Use the APIs to harass, stalk, or harm any individual
|
|
- Attempt to compromise the security or integrity of our systems
|
|
- Reverse-engineer our APIs beyond what's documented in the OpenAPI spec
|
|
- Use the APIs to generate or distribute spam
|
|
|
|
### 3.4 Infrastructure Attacks
|
|
|
|
You may **not**:
|
|
- Perform denial-of-service attacks against our infrastructure
|
|
- Probe our systems for vulnerabilities without prior written authorization
|
|
- Exploit bugs or errors to gain elevated access
|
|
|
|
## 4. Acceptable Uses
|
|
|
|
The following are examples of acceptable use:
|
|
- Integrating ZIP code, holiday, or air quality data into your own product
|
|
- Building dashboards, mobile apps, or internal tools
|
|
- Academic research (within Free plan limits)
|
|
- Automated data fetching within your plan's rate limits
|
|
|
|
## 5. Monitoring and Enforcement
|
|
|
|
We continuously monitor API usage for abuse. Automated systems may flag suspicious patterns. Flagged accounts may be:
|
|
- Throttled further without notice
|
|
- Required to verify identity
|
|
- Temporarily suspended pending review
|
|
- Permanently terminated for serious violations
|
|
|
|
## 6. Reporting Abuse
|
|
|
|
If you observe misuse of our APIs (e.g., someone redistributing your API key), please report it to **legal@leeworks.dev** immediately.
|
|
|
|
## 7. Changes
|
|
|
|
We may update this AUP at any time. Significant changes will be announced with an updated effective date. Continued use constitutes acceptance.
|
|
|
|
## 8. Contact
|
|
|
|
Questions about this policy: **legal@leeworks.dev**
|