Files

T

agent-company a615b7ebfd feat: implement docs-site, legal docs, metrics standard, flux manifests

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

2026-05-24 23:20:33 +00:00

3.8 KiB

Raw Permalink Blame History

Terms of Service

Effective Date: 2026-05-24
Contact: legal@leeworks.dev

1. Acceptance of Terms

By accessing or using any API offered by leeworks.dev ("Services"), you agree to be bound by these Terms of Service. If you do not agree, do not use the Services.

2. Description of Services

leeworks.dev provides data API services including:

ZIP Enrichment API (zip.leeworks.dev)
Holidays API (holidays.leeworks.dev)
Air Quality API (aqi.leeworks.dev)

These APIs are offered via RapidAPI and directly. Access requires a valid API key.

3. API Usage Limits

Each plan has defined rate limits (requests per minute and per month). Exceeding your plan's limits will result in HTTP 429 responses.
You must not circumvent rate limiting through multiple accounts, shared keys, or other technical means.
Free and Basic plan users are limited to non-commercial use unless explicitly stated otherwise.

4. Prohibited Use

You may not use the Services to:

Resell or redistribute the API data or API access without written permission
Scrape, download, or replicate the underlying dataset in bulk
Build a competing API product using our data
Violate any applicable laws, including data privacy regulations
Harass, harm, or interfere with other users or our infrastructure

5. Account Registration and Security

You are responsible for keeping your API key confidential.
You are responsible for all activity under your API key.
Notify us immediately at legal@leeworks.dev if you suspect unauthorized use.

6. Payment and Billing

Paid plans are billed through RapidAPI according to their billing terms.
Refunds are handled at our discretion on a case-by-case basis. Contact legal@leeworks.dev within 7 days of a charge.
We reserve the right to change pricing with 30 days' notice.

7. Data Accuracy Disclaimer

The data provided by leeworks.dev APIs is sourced from public datasets. We make no warranty as to the accuracy, completeness, or fitness for any particular purpose. You use the data at your own risk.

8. Service Availability

We target 99.9% uptime but make no formal SLA guarantee on free or Basic plans.
We reserve the right to take the service down for maintenance with or without notice.
See status.leeworks.dev for real-time uptime information.

9. Intellectual Property

The APIs, documentation, and underlying software are the intellectual property of leeworks.dev.
Response data may be used in your own products subject to these Terms.
You may not claim ownership of the data or present it as proprietary to you.

10. Termination

We may suspend or terminate your access to the Services immediately, without prior notice, for:

Violation of these Terms
Suspected abuse or fraud
Non-payment of applicable fees

Upon termination, your license to use the Services ceases immediately.

11. Limitation of Liability

TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, LEEWORKS.DEV SHALL NOT BE LIABLE FOR ANY INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL, OR PUNITIVE DAMAGES, INCLUDING LOSS OF PROFITS, DATA, OR BUSINESS, ARISING OUT OF OR IN CONNECTION WITH YOUR USE OF THE SERVICES.

12. Indemnification

You agree to indemnify and hold harmless leeworks.dev from any claims, damages, or expenses (including legal fees) arising from your use of the Services or violation of these Terms.

13. Changes to Terms

We may modify these Terms at any time. We will post changes on this page with an updated effective date. Continued use of the Services after changes constitutes acceptance.

14. Governing Law

These Terms are governed by the laws of the United States. Any disputes shall be resolved in the courts of appropriate jurisdiction.

15. Contact

Questions about these Terms? Contact us at: legal@leeworks.dev

3.8 KiB Raw Permalink Blame History