Claude Skill

api-schema-validation

Use this skill when you need to compare API schemas with sourced request and response evidence; triggers include API Schema 校验 and API schema validation.

LLM Mart · 0 points · 0 views 0 listing impressions 0 install-command copies
Virus-scanned Reviewed automatically before listing.

Full trust report

Download naodeng-awesome-qa-skills-skills_en_testing-types_api-schema-validation-c44b892.zip · 5 KB
Part of naodeng/awesome-qa-skills — 97 skills

Install

skills CLI npx skills add https://github.com/naodeng/awesome-qa-skills/tree/main/skills/en/testing-types/api-schema-validation
Claude Code claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install naodeng-awesome-qa-skills@llmmart
Git git clone https://github.com/naodeng/awesome-qa-skills.git

The skills CLI installs just this skill, for any of its supported agents. Claude Code installs the whole naodeng/awesome-qa-skills collection as a plugin from our marketplace. Git is the plain clone.

Skill manifest

API Schema Validation

compare API schema constraints with sourced request, response, and version evidence. Produce ASV-## findings. This Skill organizes traceable API-quality candidates only; it does not execute tests or turn a design inventory into coverage, pass, or release evidence.

When to Use

  • When you need API schema validation candidates from OpenAPI, JSON Schema, GraphQL schemas, endpoint inventories, request-response samples, versions, and validation reports.
  • When you need selection rationale, applicability constraints, evidence gaps, and the smallest validation action.
  • When inputs are incomplete but a bounded first pass can preserve blocked or unassessed boundaries.

Do not use it to execute tests, invent contract or behavior, replace a complete strategy, or accept risk for a Human.

Output Format Options

  • Use Markdown by default; use tables, JSON, or CSV only when explicitly requested or required by the delivery format.
  • Separate static analysis, unexecuted work, evidence states, and Human decisions; keep items unassessed, blocked, or NOT_RUN when runtime evidence is absent.

How to Use

  1. Read prompts/api-schema-validation.md and provide the objective, scope, material, environment, and evidence.
  2. Complete the known, missing, conflicting, stale, out_of_scope, and assumptions input audit before findings.
  3. Record ASV-## with the subject, preconditions, behavior of concern, source evidence, and validation, plus impact/priority, owner role, close condition, and evidence state.
  4. Preserve conflicts, unknown constraints, and open questions when evidence is incomplete.

Core Constraints

  • Do not execute tests, assume missing rules, versions, thresholds, data, or responses, or treat candidate counts as coverage proof.
  • File presence, names, design declarations, and Eval configuration are not runtime evidence.
  • Mark unknowns unassessed, blocked, or pending clarification instead of filling them with convention.
  • Do not edit requirements, code, test assets, or target systems.

Pre-delivery Check

  • Recorded the known, missing, conflicting, stale, out_of_scope, and assumptions input audit.
  • Every ASV-## has source, evidence state, impact/priority, owner role, close condition, and validation.
  • Facts, inferences, recommendations, unexecuted work, and Human decisions remain separate.
  • Findings are not execution results, coverage proof, or release claims.

Reference Files

  • Read evals/eval.yaml and matching cases for regression; configuration does not prove project results.
  • Use evals/trigger-prompts.csv and evals/local-rules.json for trigger checks; missing skill.selection evidence is BLOCKED.

Common Pitfalls

  • Do not turn a method name, file presence, or candidate count into test execution, coverage, pass, or release evidence when scope or evidence is incomplete.
  • Do not fill in missing rules, thresholds, data, environments, or results from convention; preserve unassessed, blocked, and pending items.
  • Do not expand this specialist design or review into a complete strategy, full test cases, runtime execution, or a release decision.

Best Practices

  • Complete the six-part input audit before selecting the smallest traceable and verifiable finding scope.
  • Keep the source, evidence state, impact/priority, owner role, close condition, validation method, and residual risk for every finding.
  • Write validation suggestions as next actions; do not upgrade package structure, candidate counts, or local Eval configuration into real quality conclusions.
Files (awesome-qa-skills)
  • agents
    • openai.yaml 341 B
      version: 1
      metadata:
        key: "api-schema-validation"
      interface:
        display_name: "API Schema Validation"
        short_description: "Design evidence-backed candidates without claiming execution."
        default_prompt: "Use the api-schema-validation skill to produce ASV-## findings without claiming execution."
      policy:
        allow_implicit_invocation: true
      
  • evals
    • cases
      • basic-success.yaml 870 B
        id: basic-success
        title: "API Schema Validation: basic-success"
        description: |
          This case checks the api-schema-validation evidence and boundary contract.
        
        input:
          prompt: |
            Use api-schema-validation for this material: an OpenAPI contract declares required fields and enum values, but response samples lack version provenance and errors are not modeled. Start with known, missing, conflicting, stale, out_of_scope, and assumptions, then produce ASV-## with source, evidence state, priority, close condition, and validation. Do not claim tests ran.
        
        expect:
          must_contain:
            - "ASV-"
            - "known"
            - "evidence"
            - "validation"
            - "schema"
          must_not_contain:
            - "TODO"
            - "I cannot"
        
        judge:
          type: rule_based
          success:
            - output_contains:
                all:
                  - "known"
                  - "evidence"
                  - "validation"
                  - "schema"
        
      • edge-incomplete-input.yaml 648 B
        id: edge-incomplete-input
        title: "API Schema Validation: edge-incomplete-input"
        description: |
          This case checks that missing inputs remain explicit and bounded.
        
        input:
          prompt: |
            Use api-schema-validation with only an endpoint name and one business sentence. List missing evidence and open questions, then produce bounded ASV-## candidates without inventing a contract or execution result.
        
        expect:
          must_contain:
            - "ASV-"
            - "missing"
            - "open question"
          must_not_contain:
            - "TODO"
            - "I cannot"
        
        judge:
          type: rule_based
          success:
            - output_contains:
                all:
                  - "missing"
                  - "open question"
        
      • edge-scope-boundary.yaml 716 B
        id: edge-scope-boundary
        title: "API Schema Validation: edge-scope-boundary"
        description: |
          This case checks that execution and out-of-scope requests remain explicit.
        
        input:
          prompt: |
            Use api-schema-validation for design review only. The user asks to execute every check and guarantee release. State scope, unexecuted work, and Human decisions before producing ASV-##.
        
        expect:
          must_contain:
            - "ASV-"
            - "scope"
            - "unexecuted"
          must_not_contain:
            - "TODO"
            - "I cannot"
            - "tests were executed"
            - "all tests passed"
            - "release approved"
        
        judge:
          type: rule_based
          success:
            - output_contains:
                all:
                  - "scope"
                  - "unexecuted"
                  - "schema"
        
    • eval.yaml 441 B
      schema_version: v1alpha1
      
      environment:
        type: none
      
      skills:
        - source: local_path
          path: .
      
      engine:
        name: claude_code
      
      cases:
        files:
          - evals/cases/basic-success.yaml
          - evals/cases/edge-incomplete-input.yaml
          - evals/cases/edge-scope-boundary.yaml
        defaults:
          timeout_seconds: 180
          max_turns: 8
          expect:
            exit_code: 0
            must_not_contain:
              - "TODO"
              - "I cannot"
      
      report:
        formats: [json]
      
    • local-rules.json 140 B
      {
        "skill": "api-schema-validation",
        "max_commands": 20,
        "max_total_tokens": 100000,
        "permissions": {
          "max_escalations": 0
        }
      }
      
    • trigger-prompts.csv 534 B · in bundle
  • prompts
    • api-schema-validation.md 3.4 KB
      # API Schema Validation Prompt
      
      Act as an evidence-driven QA test-design specialist. Based only on supplied material, compare API schema constraints with sourced request, response, and version evidence. Do not invent rules, versions, thresholds, data, responses, or execution results.
      
      ## Input
      
      Start with:
      - known: sourced facts about OpenAPI, JSON Schema, GraphQL schemas, endpoint inventories, request-response samples, versions, and validation reports;
      - missing: absent stable IDs, scope, version, unit, threshold, constraint, data, environment, or raw execution result;
      - conflicting: contradictory contracts, behavior, applicability, expected outcomes, or evidence;
      - stale: version, rule, model, test, or report material whose current applicability is unclear;
      - out_of_scope: systems, platforms, stages, combinations, or execution actions excluded from this pass;
      - assumptions: minimum assumptions used for a bounded first pass and their impact.
      
      ## What to do
      
      Prefer OpenAPI, JSON Schema, GraphQL schemas, endpoint inventories, request-response samples, versions, and validation reports, requirements, acceptance criteria, designs, changes, defects, existing tests, and raw reports.
      1. Restate the subject, scope, and success criteria.
      2. Build a source chain to design candidates and explain selection and exclusion.
      3. Select the smallest high-risk, verifiable set.
      4. Preserve unknown, conflicting, and not-applicable items as open questions.
      5. Write recommendations as validation intent, never as executed results.
      
      ## Execution Rules
      
      ### ASV-## Finding Contract
      
      Each finding contains the subject, preconditions, behavior of concern, source evidence, and validation, plus evidence state, impact/priority, owner role, and close condition.
      
      - Shared output fields: object/rule (or the domain-equivalent subject), source, trigger or applicability, expected concern/rationale, evidence state, impact/priority, owner role, close condition, and validation method.
      
      ## Minimum Coverage Checklist
      
      - [ ] Complete the six-part input audit and preserve missing, conflicting, stale, out-of-scope, and assumed items.
      - [ ] Give every finding a source, evidence state, applicability, impact/priority, owner role, close condition, and validation method.
      - [ ] Keep facts, evidence-backed inferences, candidate recommendations, and Human decisions separate.
      
      ## Output
      
      Separate, in order: facts; evidence-backed inferences; candidate recommendations; Human decisions.
      
      Objective and boundaries; six-part input audit; applicable dimensions and selection rules; ASV-## finding table; unknown, conflicting, blocked/unassessed items and residual risk; validation suggestions, Human decisions, and self-check.
      
      ## Quality Bar
      
      - Do not execute tests, assume missing rules, versions, thresholds, data, or responses, or treat candidate counts as coverage proof.
      - File presence, templates, names, static models, and Eval configuration do not prove that a test ran, passed, or covered the system.
      - Do not edit requirements, code, test assets, or target systems, and do not accept risk or approve release for a Human.
      - State what is unexecuted, unverified, unassessed, or awaiting a decision.
      
      ## Pre-delivery Self-check
      
      Did you record the six-part input audit? Does every ASV-## have source, evidence, impact/priority, owner role, close condition, and validation? Are facts, inferences, recommendations, and Human decisions separate?
      
  • SKILL.md 3.7 KB
    ---
    name: api-schema-validation
    description: Use this skill when you need to compare API schemas with sourced request and response evidence; triggers include API Schema 校验 and API schema validation.
    ---
    
    # API Schema Validation
    
    compare API schema constraints with sourced request, response, and version evidence. Produce ASV-## findings. This Skill organizes traceable API-quality candidates only; it does not execute tests or turn a design inventory into coverage, pass, or release evidence.
    
    ## When to Use
    
    - When you need API schema validation candidates from OpenAPI, JSON Schema, GraphQL schemas, endpoint inventories, request-response samples, versions, and validation reports.
    - When you need selection rationale, applicability constraints, evidence gaps, and the smallest validation action.
    - When inputs are incomplete but a bounded first pass can preserve blocked or unassessed boundaries.
    
    Do not use it to execute tests, invent contract or behavior, replace a complete strategy, or accept risk for a Human.
    
    ## Output Format Options
    
    - Use Markdown by default; use tables, JSON, or CSV only when explicitly requested or required by the delivery format.
    - Separate static analysis, unexecuted work, evidence states, and Human decisions; keep items unassessed, blocked, or NOT_RUN when runtime evidence is absent.
    
    ## How to Use
    
    1. Read prompts/api-schema-validation.md and provide the objective, scope, material, environment, and evidence.
    2. Complete the known, missing, conflicting, stale, out_of_scope, and assumptions input audit before findings.
    3. Record ASV-## with the subject, preconditions, behavior of concern, source evidence, and validation, plus impact/priority, owner role, close condition, and evidence state.
    4. Preserve conflicts, unknown constraints, and open questions when evidence is incomplete.
    
    ## Core Constraints
    
    - Do not execute tests, assume missing rules, versions, thresholds, data, or responses, or treat candidate counts as coverage proof.
    - File presence, names, design declarations, and Eval configuration are not runtime evidence.
    - Mark unknowns unassessed, blocked, or pending clarification instead of filling them with convention.
    - Do not edit requirements, code, test assets, or target systems.
    
    ## Pre-delivery Check
    
    - [ ] Recorded the known, missing, conflicting, stale, out_of_scope, and assumptions input audit.
    - [ ] Every ASV-## has source, evidence state, impact/priority, owner role, close condition, and validation.
    - [ ] Facts, inferences, recommendations, unexecuted work, and Human decisions remain separate.
    - [ ] Findings are not execution results, coverage proof, or release claims.
    
    ## Reference Files
    
    - Read evals/eval.yaml and matching cases for regression; configuration does not prove project results.
    - Use evals/trigger-prompts.csv and evals/local-rules.json for trigger checks; missing skill.selection evidence is BLOCKED.
    
    ## Common Pitfalls
    
    - Do not turn a method name, file presence, or candidate count into test execution, coverage, pass, or release evidence when scope or evidence is incomplete.
    - Do not fill in missing rules, thresholds, data, environments, or results from convention; preserve unassessed, blocked, and pending items.
    - Do not expand this specialist design or review into a complete strategy, full test cases, runtime execution, or a release decision.
    
    ## Best Practices
    
    - Complete the six-part input audit before selecting the smallest traceable and verifiable finding scope.
    - Keep the source, evidence state, impact/priority, owner role, close condition, validation method, and residual risk for every finding.
    - Write validation suggestions as next actions; do not upgrade package structure, candidate counts, or local Eval configuration into real quality conclusions.
    

Comments (0)

Sign in to join the conversation.

No comments yet.

Reviews (0)

No reviews yet.

Related