One-click install
npx skills add https://github.com/cheetah-alo/NegritaOS --skill jsonapi-cheetah-alo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: jsonapi
Source: https://github.com/cheetah-alo/NegritaOS/tree/main/.codex/skills/jsonapi
Command: npx skills add https://github.com/cheetah-alo/NegritaOS --skill jsonapi-cheetah-alo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents broken client-server integrations by enforcing strict adherence to the JSON:API v1.1 specification, including response structure, headers, relationship linkage, error formatting, and required HTTP status codes.

Core Features & Use Cases

  • Spec-compliant response validation: Ensures only valid combinations are returned (e.g., never data and errors together) and that required members like type/id use the correct formats.
  • Correct error object construction: Produces errors arrays with string status values and field-level source.pointer when applicable.
  • Endpoint request/response governance for APIs: Guides implementers to validate spec requirements before creating or modifying endpoints, especially for relationship updates, compound documents (include), and pagination/filter/sort behaviors.
  • DRF implementation pairing guidance: Use alongside django-drf for implementation patterns while this skill focuses on MUST/MUST-NOT rules.

Quick Start

Validate your proposed API endpoint request and response payloads against the JSON:API v1.1 MUST/MUST-NOT rules, using this skill as the compliance gate.

Frequently Asked Questions about jsonapi

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate my API response structure for JSON:API compliance?

JSON:API error objects must be returned in an errors array with string status values. This skill ensures proper error object construction, including field-level source pointers when applicable, to maintain strict spec compliance.

What HTTP status codes and headers are required for JSON:API endpoints?

JSON:API endpoints require correct Content-Type and Accept media types alongside mandated HTTP status code behaviors. This skill validates endpoint headers and status strings to ensure your API responses meet strict specification standards.

How do I format relationship linkage objects in a JSON:API payload?

Relationship linkage objects in JSON:API payloads require proper structure for relationship updates and compound documents. This skill governs endpoint requests and responses to validate spec-aligned relationship linkage before endpoint modification.

Does this JSON:API spec validation work with Django REST Framework?

Yes, this JSON:API spec validation pairs with Django REST Framework for implementation patterns. Use django-drf alongside this skill, which focuses exclusively on enforcing MUST and MUST-NOT compliance rules for your API.