governing-payload-structure

What problem does it solve?

This Skill enforces consistent and predictable API payload structures, preventing inconsistencies that lead to complex client-side parsing logic and potential integration issues.

Core Features & Use Cases

• Enforces Top-Level Object Rule: Ensures all API responses are JSON objects, not bare arrays.
• Standardizes Collection Wrapping: Mandates the use of an items array for collections.
• Promotes I-JSON Compliance: Adheres to RFC 7493 for better interoperability.
• Defines Contract Type Taxonomy: Categorizes payloads (State Representation, Desired State, etc.) for clarity.
• Establishes Semantic Field Ontology: Guides the naming and placement of fields (identity, attributes, relationships, etc.).
• Use Case: When designing a new API endpoint that returns a list of projects, use this Skill to ensure the response is structured as {"items": [...], "next_page_token": "...", "total_count": N} rather than a bare array [...].

Quick Start

Review the API response for the endpoint that retrieves user profiles to ensure it follows the defined payload structure conventions.