Skip to content

Add Hypercerts API consumer skill - #32

Merged
Kzoeps merged 1 commit into
mainfrom
docs/consume-hypercerts-api
Oct 7, 2026
Merged

Kzoeps merged 1 commit into
mainfrom
docs/consume-hypercerts-api

Conversation

@Kzoeps

@Kzoeps Kzoeps commented Oct 7, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Add a standalone hypercerts-api skill for calling the public read-only XRPC API directly, without needing the API repository.
  • Bundle a compact OpenAPI contract snapshot: all 55 operations, all 128 schemas, parameters, responses, and declared errors.
  • List Staging, Test, and Production in the docs README server example; Staging remains the default.
  • Update AGENTS.md to keep the portable consumer skill synchronized with API contract and externally visible behavior changes.

Contract snapshot size

The bundled snapshot is 134.4 KiB, down from the 230.5 KiB source through compact formatting and removal of repository-only provenance/coverage metadata. All 55 operations and 128 referenced schemas are preserved. Gzip size is about 14.9 KiB.

Validation

  • python3 /home/kzoeps/.agents/skills/skill-creator/scripts/quick_validate.py .agents/skills/hypercerts-api — passed.
  • Structural comparison against docs/openapi.json confirmed all operations/schemas and resolved references; the endpoint map matches all 55 NSIDs.
  • README server JSON parses; Staging is first/default and Production is listed.
  • git show --check HEAD — passed.
  • Independent read-only Herdr review approved the portable skill with no actionable findings.
  • No live Hypercerts API requests were made.

Summary by CodeRabbit

  • Documentation
    • Added guidance for using the public, read-only Hypercerts API, including endpoint selection, request construction, pagination, and error handling.
    • Added workflow examples and notes on identifiers, response values, data freshness, and deployment availability.

@vercel

vercel Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
api-endpoints Ready Ready Preview Oct 7, 2026 6:03am UTC

Request Review

@changeset-bot

changeset-bot Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 1048f1f

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai

coderabbitai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 711bd51f-68af-4e12-8633-f76d8f2dce61
📥 Commits

Reviewing files that changed from the base of the PR and between 97de800 and 93fecbb.

📒 Files selected for processing (6)
  • .agents/skills/hypercerts-api/SKILL.md
  • .agents/skills/hypercerts-api/references/endpoint-map.md
  • .agents/skills/hypercerts-api/references/recipes.md
  • .agents/skills/hypercerts-api/references/reliability.md
  • .agents/skills/hypercerts-api/references/request-patterns.md
  • docs/README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Adds a skill guide and references for the public, read-only HappyView XRPC query API. The materials describe endpoint selection, request construction, pagination, common query workflows, and result interpretation. The Staging server URL in the README example also changes.

Changes

HappyView API guidance

Layer / File(s) Summary
API scope and endpoint selection
.agents/skills/hypercerts-api/SKILL.md, .agents/skills/hypercerts-api/references/endpoint-map.md, docs/README.md
Defines the API’s documented scope and local contract sources. The endpoint map covers query tasks and endpoint-specific distinctions. The README changes the Staging URL to https://api.staging.hypercerts.dev.
Request construction and pagination
.agents/skills/hypercerts-api/references/request-patterns.md
Documents GET requests, array parameters, cursor use, operation-specific contract checks, and XRPC error handling.
Consumer workflow recipes
.agents/skills/hypercerts-api/references/recipes.md
Adds guidance for activity queries, collection items, profile and organization lookups, and badge-award status.
Result interpretation and reliability
.agents/skills/hypercerts-api/references/reliability.md
Describes identifier distinctions, indexed-data freshness, result and error states, and failure diagnosis.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 93fec

The guidance is mergeable on the available evidence. Confirm the staging hostname with the deployment owner before relying on that environment.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the main change: adding a Hypercerts API consumer skill.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@sonarqubecloud

sonarqubecloud Bot commented Oct 7, 2026

Copy link
Copy Markdown

@Kzoeps
Kzoeps merged commit fd96994 into main Oct 7, 2026
8 checks passed
@Kzoeps
Kzoeps deleted the docs/consume-hypercerts-api branch October 7, 2026 06:09

This branch was successfully deployed

1 active deployment
Preview — 1048f1f7 Deployed Oct 7, 2026 by vercel[bot]
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