SuperAPI AI Directory

api-schema-validation

Testing & quality

View repository

Updated 10-16 09:33

About this skill

API Schema Validation

Perform a traceable comparison of API Schema constraints against request, response, and version evidence, and output ASV-## findings. It only organizes traceable API quality candidates; it does not execute tests, nor does it write design checklists as coverage, pass, or release evidence.

When to Use

  • When API Schema validation candidates need to be extracted from OpenAPI, JSON Schema, GraphQL Schema, interface inventories, request/response samples, versions, and validation reports.
  • When the rationale for selection, applicable constraints, evidence gaps, and minimal verification actions need to be explained.
  • When materials are incomplete but a limited initial version still needs to be delivered, with blocked or unassessed boundaries clearly stated.

Not applicable to directly executing tests, generating contracts or behaviors without sources, replacing a complete test strategy, or accepting risk on behalf of the Human.

Output Format Options

  • Default output is Markdown; tables, JSON, or CSV are used only when the user explicitly needs them or the existing delivery format requires them.
  • Keep static analysis, unexecuted items, evidence status, and Human decisions separate; when there is no execution evidence, keep them as unassessed, blocked, or NOT_RUN.

How to Use

  1. Read prompts/api-schema-validation.md, and provide the goal, scope, materials, environment, and existing evidence.
  2. First complete the six-category input audit: known, missing, conflicting, stale, out_of_scope, and assumptions.
  3. Use ASV-## to record the object, preconditions, behavior of interest, source evidence, and verification method, retaining impact/priority, responsible role, closure conditions, and evidence status.
  4. When materials conflict, constraints are missing, or there is no execution evidence, retain both sides and the open questions.

Domain Execution Points

  • First confirm OpenAPI/JSON Schema/GraphQL and the specific version or dialect, operation/direction, content type, reference root, and resolution context; when the version is unknown, pause judgments that depend on the version.
  • Deliver the dialect, reference resolution status, and sample × constraint determination table; "missing" and "value is null" must be determined separately, and non-null cannot be inferred from required.
  • When forming domain candidates, you must read and follow prompts/api-schema-validation.md for the domain operations and determination process, retaining valid comparisons, evidence gaps, and verification actions item by item.

Core Constraints

  • Do not execute tests, do not assume rules, versions, thresholds, data, or responses that were not provided, and do not treat the number of candidates as proof of coverage.
  • File existence, name matching, design declarations, or Eval configuration do not equal real execution evidence.
  • Mark unknown items as unassessed, blocked, or to be confirmed; do not fill them in with common sense.
  • Do not modify requirements, code, test assets, or the target system.

Pre-Delivery Self-Check

  • The six-category input audit has been recorded: known, missing, conflicting, stale, out_of_scope, and assumptions.
  • Each ASV-## has a source, evidence status, impact/priority, responsible role, closure conditions, and verification method.
  • Facts, inferences, recommendations, unexecuted items, and Human decisions have been distinguished.
  • Design candidates have not been written as execution results, coverage proof, or release conclusions.

Reference Files

  • During regression, read evals/eval.yaml and the matching test cases; configuration does not prove real project results.
  • Trigger validation uses evals/trigger-prompts.csv and evals/local-rules.json; when skill.selection evidence is missing, report BLOCKED.

Common Pitfalls

  • When the scope or evidence is incomplete, do not write method names, file existence, or candidate counts as evidence that tests have been executed, covered, passed, or released.
  • Do not use common sense to fill in rules, thresholds, data, environments, or results that were not provided; retain unassessed, blocked, and to-be-confirmed items.
  • Do not expand this Skill's specialized candidates into a complete strategy, complete test cases, actual execution, or release decisions.

Best Practices

  • Complete the six-category input audit first, then choose the smallest, traceable, and verifiable discovery scope.
  • For each finding, retain the source, evidence status, impact/priority, responsible role, closure conditions, and verification method, and clearly state the residual risk.
  • Write verification recommendations as next-step actions, and do not upgrade the Skill package structure, candidate counts, or local Eval configuration into real quality conclusions.