Skip to content

feat(api): introduce v1/ namespace with GitHub Pages deployment#3

Merged
jonathan-alfonso merged 1 commit into
mainfrom
chore/prepare-github-pages
May 23, 2026
Merged

feat(api): introduce v1/ namespace with GitHub Pages deployment#3
jonathan-alfonso merged 1 commit into
mainfrom
chore/prepare-github-pages

Conversation

@jonathan-alfonso
Copy link
Copy Markdown
Contributor

Move the dataset under v1/ to establish an immutable API namespace, and add the infrastructure needed to publish it on GitHub Pages with client-friendly cache invalidation.

  • Reorganize global_countries.json and locales/*.json under v1/
  • Add v1/manifest.json (gitignored, regenerated at deploy time) exposing per-resource SHA-256 + last-commit timestamps so KMP clients can re-download only what changed
  • Add scripts/generate-manifest.sh to build the manifest from current file contents and git history
  • Add .github/workflows/deploy-pages.yml: validates JSON, regenerates the manifest, uploads the artifact and deploys to Pages on push to main
  • Rewrite README with base URL, endpoints, KMP/cURL/JS usage examples, data schemas, caching strategy and versioning policy

Move the dataset under v1/ to establish an immutable API namespace, and
add the infrastructure needed to publish it on GitHub Pages with
client-friendly cache invalidation.

- Reorganize global_countries.json and locales/*.json under v1/
- Add v1/manifest.json (gitignored, regenerated at deploy time) exposing
  per-resource SHA-256 + last-commit timestamps so KMP clients can
  re-download only what changed
- Add scripts/generate-manifest.sh to build the manifest from current
  file contents and git history
- Add .github/workflows/deploy-pages.yml: validates JSON, regenerates
  the manifest, uploads the artifact and deploys to Pages on push to main
- Rewrite README with base URL, endpoints, KMP/cURL/JS usage examples,
  data schemas, caching strategy and versioning policy
@jonathan-alfonso jonathan-alfonso merged commit 719c52f into main May 23, 2026
2 checks passed
@jonathan-alfonso jonathan-alfonso deleted the chore/prepare-github-pages branch May 23, 2026 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant