Skip to content

aiskillstore/marketplace / skills/0xdarkmatter/rest-patterns

rest-patterns

Verified

Quick reference for RESTful API design patterns, HTTP semantics, caching, and rate limiting. Triggers on: rest api, http methods, status codes, api design, endpoint design, api versioning, rate limiting, caching headers.

FileKindSize
SKILL.mdskill md2.9 KB
references/caching-patterns.mdmarkdown3.4 KB
references/rate-limiting.mdmarkdown3.6 KB
references/response-formats.mdmarkdown4.6 KB
references/status-codes.mdmarkdown4.9 KB
skill-report.jsonconfig34.5 KB

skill-report.json

View on GitHub
{
  "schema_version": "2.0",
  "meta": {
    "generated_at": "2026-07-06T00:40:38.844Z",
    "slug": "0xdarkmatter-rest-patterns",
    "source_url": "https://github.com/0xDarkMatter/claude-mods/tree/main/skills/rest-patterns",
    "source_ref": "main",
    "model": "codex",
    "analysis_version": "3.0.0",
    "source_type": "community",
    "content_hash": "5adf8274009a9a3fdc769bcc250f0a8d77b163906043b32a032deae489f6f343",
    "tree_hash": "c69726a4ffe1a887e698a0a4d7637200e0635a30fbd775e7048ac7dcb42cc67c",
    "provenance": {
      "model_requested": "gpt-5.5:high",
      "model_effective": "codex:gpt-5.5:high",
      "fallback_chain": [
        {
          "agent": "codex",
          "model": "gpt-5.5",
          "effort": "high",
          "outcome": "success"
        }
      ],
      "analysis_version": "3.0.0"
    }
  },
  "skill": {
    "name": "rest-patterns",
    "description": "Reference guide for REST API design, HTTP methods and status codes, caching headers, rate limiting, versioning, and response formats.",
    "summary": "Design consistent REST APIs with practical HTTP, caching, rate limiting, and response-format guidance.",
    "icon": "📦",
    "version": "1.0.0",
    "author": "0xDarkMatter",
    "license": "MIT",
    "tags": [
      "rest",
      "api-design",
      "http",
      "caching",
      "rate-limiting"
    ],
    "supported_tools": [
      "claude",
      "codex",
      "claude-code"
    ],
    "risk_factors": [
      "network",
      "external_commands"
    ],
    "category": "coding"
  },
  "security_audit": {
    "risk_level": "safe",
    "is_blocked": false,
    "safe_to_publish": true,
    "analysis_status": "ok",
    "summary": "All static findings are false positives after context review. The URLs, fetch call, curl commands, status-code text, and backtick markers appear inside Markdown reference examples, not executable skill code. No prompt injection or malicious intent was found in the reviewed files.",
    "remediation": [],
    "risk_factor_evidence": [
      {
        "factor": "network",
        "evidence": [
          {
            "file": "references/caching-patterns.md",
            "line_start": 159,
            "line_end": 159
          },
          {
            "file": "references/caching-patterns.md",
            "line_start": 162,
            "line_end": 162
          },
          {
            "file": "references/rate-limiting.md",
            "line_start": 157,
            "line_end": 157
          },
          {
            "file": "references/response-formats.md",
            "line_start": 19,
            "line_end": 19
          },
          {
            "file": "references/response-formats.md",
            "line_start": 62,
            "line_end": 62
          }
        ]
      },
      {
        "factor": "external_commands",
        "evidence": [
          {
            "file": "SKILL.md",
            "line_start": 26,
            "line_end": 26
          },
          {
            "file": "SKILL.md",
            "line_start": 38,
            "line_end": 50
          },
          {
            "file": "SKILL.md",
            "line_start": 50,
            "line_end": 60
          },
          {
            "file": "SKILL.md",
            "line_start": 60,
            "line_end": 66
          },
          {
            "file": "SKILL.md",
            "line_start": 66,
            "line_end": 66
          },
          {
            "file": "SKILL.md",
            "line_start": 76,
            "line_end": 77
          },
          {
            "file": "SKILL.md",
            "line_start": 77,
            "line_end": 78
          },
          {
            "file": "SKILL.md",
            "line_start": 78,
            "line_end": 79
          },
          {
            "file": "SKILL.md",
            "line_start": 79,
            "line_end": 80
          },
          {
            "file": "SKILL.md",
            "line_start": 80,
            "line_end": 93
          },
          {
            "file": "SKILL.md",
            "line_start": 93,
            "line_end": 94
          },
          {
            "file": "SKILL.md",
            "line_start": 94,
            "line_end": 95
          },
          {
            "file": "SKILL.md",
            "line_start": 95,
            "line_end": 96
          }
        ]
      }
    ],
    "static_findings": [
      {
        "id": "network:references/caching-patterns.md:159:hardcoded-url",
        "category": "network",
        "severity": "low",
        "pattern": "Hardcoded URL",
        "file": "references/caching-patterns.md",
        "line_start": 159,
        "line_end": 159,
        "snippet": "curl -X PURGE https://cdn.example.com/api/users/123"
      },
      {
        "id": "network:references/caching-patterns.md:162:hardcoded-url",
        "category": "network",
        "severity": "low",
        "pattern": "Hardcoded URL",
        "file": "references/caching-patterns.md",
        "line_start": 162,
        "line_end": 162,
        "snippet": "curl -X PURGE https://cdn.example.com \\"
      },
      {
        "id": "network:references/rate-limiting.md:157:fetch-api-call",
        "category": "network",
        "severity": "low",
        "pattern": "Fetch API call",
        "file": "references/rate-limiting.md",
        "line_start": 157,
        "line_end": 157,
        "snippet": "const response = await fetch(url, options);"
      },
      {
        "id": "network:references/response-formats.md:19:hardcoded-url",
        "category": "network",
        "severity": "low",
        "pattern": "Hardcoded URL",
        "file": "references/response-formats.md",
        "line_start": 19,
        "line_end": 19,
        "snippet": "\"documentation_url\": \"https://api.example.com/docs/errors#validation\""
      },
      {
        "id": "network:references/response-formats.md:62:hardcoded-url",
        "category": "network",
        "severity": "low",
        "pattern": "Hardcoded URL",
        "file": "references/response-formats.md",
        "line_start": 62,
        "line_end": 62,
        "snippet": "\"type\": \"https://api.example.com/errors/validation\","
      },
      {
        "id": "blocker:references/response-formats.md:13:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/response-formats.md",
        "line_start": 13,
        "line_end": 13,
        "snippet": "\"message\": \"Invalid input data\","
      },
      {
        "id": "blocker:references/response-formats.md:15:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/response-formats.md",
        "line_start": 15,
        "line_end": 15,
        "snippet": "{\"field\": \"email\", \"message\": \"Invalid email format\"},"
      },
      {
        "id": "blocker:references/response-formats.md:46:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/response-formats.md",
        "line_start": 46,
        "line_end": 46,
        "snippet": "\"message\": \"Must be a valid email address\""
      },
      {
        "id": "blocker:references/response-formats.md:65:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/response-formats.md",
        "line_start": 65,
        "line_end": 65,
        "snippet": "\"detail\": \"The request body contains invalid data\","
      },
      {
        "id": "blocker:references/response-formats.md:68:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/response-formats.md",
        "line_start": 68,
        "line_end": 68,
        "snippet": "{\"pointer\": \"/email\", \"detail\": \"Invalid format\"}"
      },
      {
        "id": "blocker:references/status-codes.md:44:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/status-codes.md",
        "line_start": 44,
        "line_end": 44,
        "snippet": "| **302 Found** | Found | Temporary redirect (avoid in APIs) |"
      },
      {
        "id": "blocker:references/status-codes.md:45:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/status-codes.md",
        "line_start": 45,
        "line_end": 45,
        "snippet": "| **304 Not Modified** | Not Modified | Client cache is valid (ETag match) |"
      },
      {
        "id": "blocker:references/status-codes.md:72:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/status-codes.md",
        "line_start": 72,
        "line_end": 72,
        "snippet": "| **400 Bad Request** | Bad Request | Invalid syntax, malformed JSON |"
      },
      {
        "id": "blocker:references/status-codes.md:73:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/status-codes.md",
        "line_start": 73,
        "line_end": 73,
        "snippet": "| **401 Unauthorized** | Unauthorized | Missing or invalid authentication |"
      },
      {
        "id": "blocker:references/status-codes.md:83:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/status-codes.md",
        "line_start": 83,
        "line_end": 83,
        "snippet": "| **422 Unprocessable Entity** | Unprocessable | Valid syntax, invalid semantics |"
      },
      {
        "id": "blocker:references/status-codes.md:88:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/status-codes.md",
        "line_start": 88,
        "line_end": 88,
        "snippet": "- **400**: Malformed request (invalid JSON, wrong types)"
      },
      {
        "id": "blocker:references/status-codes.md:89:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/status-codes.md",
        "line_start": 89,
        "line_end": 89,
        "snippet": "- **422**: Valid request, but business logic rejects it"
      },
      {
        "id": "blocker:references/status-codes.md:96:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/status-codes.md",
        "line_start": 96,
        "line_end": 96,
        "snippet": "→ {\"error\": \"Invalid JSON\"}"
      },
      {
        "id": "blocker:references/status-codes.md:116:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/status-codes.md",
        "line_start": 116,
        "line_end": 116,
        "snippet": "# 403 - Valid token, wrong permissions"
      },
      {
        "id": "blocker:references/status-codes.md:145:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "references/status-codes.md",
        "line_start": 145,
        "line_end": 145,
        "snippet": "| **502 Bad Gateway** | Bad Gateway | Upstream returned invalid response |"
      },
      {
        "id": "external_commands:SKILL.md:26:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 26,
        "line_end": 26,
        "snippet": "| **201** | Created | POST success (add `Location` header) |"
      },
      {
        "id": "external_commands:SKILL.md:38:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 38,
        "line_end": 50,
        "snippet": "```http"
      },
      {
        "id": "external_commands:SKILL.md:50:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 50,
        "line_end": 60,
        "snippet": "```"
      },
      {
        "id": "external_commands:SKILL.md:60:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 60,
        "line_end": 66,
        "snippet": "- [ ] Use `no-store` for sensitive responses"
      },
      {
        "id": "external_commands:SKILL.md:66:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 66,
        "line_end": 66,
        "snippet": "| Verbs in URLs | `/getUsers` → `/users` |"
      },
      {
        "id": "external_commands:SKILL.md:76:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 76,
        "line_end": 77,
        "snippet": "| Paginate | `?page=2&limit=20` |"
      },
      {
        "id": "external_commands:SKILL.md:77:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 77,
        "line_end": 78,
        "snippet": "| Sort | `?sort=field:asc` |"
      },
      {
        "id": "external_commands:SKILL.md:78:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 78,
        "line_end": 79,
        "snippet": "| Filter | `?status=active` |"
      },
      {
        "id": "external_commands:SKILL.md:79:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 79,
        "line_end": 80,
        "snippet": "| Sparse fields | `?fields=id,name` |"
      },
      {
        "id": "external_commands:SKILL.md:80:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 80,
        "line_end": 93,
        "snippet": "| Include related | `?include=orders` |"
      },
      {
        "id": "external_commands:SKILL.md:93:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 93,
        "line_end": 94,
        "snippet": "- `./references/status-codes.md` - Complete status code reference with examples"
      },
      {
        "id": "external_commands:SKILL.md:94:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 94,
        "line_end": 95,
        "snippet": "- `./references/caching-patterns.md` - Cache-Control, ETag, CDN patterns"
      },
      {
        "id": "external_commands:SKILL.md:95:ruby-shell-backtick-execution",
        "category": "external_commands",
        "severity": "medium",
        "pattern": "Ruby/shell backtick execution",
        "file": "SKILL.md",
        "line_start": 95,
        "line_end": 96,
        "snippet": "- `./references/rate-limiting.md` - Rate limiting strategies and headers"
      },
      {
        "id": "blocker:SKILL.md:28:system-reconnaissance",
        "category": "blocker",
        "severity": "low",
        "pattern": "System reconnaissance",
        "file": "SKILL.md",
        "line_start": 28,
        "line_end": 28,
        "snippet": "| **400** | Bad Request | Invalid syntax |"
      }
    ],
    "finding_verdicts": [
      {
        "id": "network:references/caching-patterns.md:159:hardcoded-url",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This is a curl example inside a Markdown bash code block for CDN cache invalidation. It uses example.com documentation placeholders and is not executed by the skill."
      },
      {
        "id": "network:references/caching-patterns.md:162:hardcoded-url",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This is a curl example inside a Markdown bash code block for CDN cache invalidation. It uses example.com documentation placeholders and is not executed by the skill."
      },
      {
        "id": "network:references/rate-limiting.md:157:fetch-api-call",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The fetch call appears inside a JavaScript retry-logic example in a Markdown reference file. The skill does not run this code or transmit data."
      },
      {
        "id": "network:references/response-formats.md:19:hardcoded-url",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The hardcoded URL is an example documentation link inside a JSON response-format sample. It uses api.example.com as placeholder documentation content, not an outbound request."
      },
      {
        "id": "network:references/response-formats.md:62:hardcoded-url",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The hardcoded URL is an example documentation link inside a JSON response-format sample. It uses api.example.com as placeholder documentation content, not an outbound request."
      },
      {
        "id": "blocker:references/response-formats.md:13:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of a sample API error-response body in a Markdown reference file. It describes validation output, not system reconnaissance."
      },
      {
        "id": "blocker:references/response-formats.md:15:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of a sample API error-response body in a Markdown reference file. It describes validation output, not system reconnaissance."
      },
      {
        "id": "blocker:references/response-formats.md:46:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of a sample API error-response body in a Markdown reference file. It describes validation output, not system reconnaissance."
      },
      {
        "id": "blocker:references/response-formats.md:65:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of a sample API error-response body in a Markdown reference file. It describes validation output, not system reconnaissance."
      },
      {
        "id": "blocker:references/response-formats.md:68:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of a sample API error-response body in a Markdown reference file. It describes validation output, not system reconnaissance."
      },
      {
        "id": "blocker:references/status-codes.md:44:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of an HTTP status-code reference table or example explaining normal API responses. It is not system reconnaissance or host inspection."
      },
      {
        "id": "blocker:references/status-codes.md:45:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of an HTTP status-code reference table or example explaining normal API responses. It is not system reconnaissance or host inspection."
      },
      {
        "id": "blocker:references/status-codes.md:72:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of an HTTP status-code reference table or example explaining normal API responses. It is not system reconnaissance or host inspection."
      },
      {
        "id": "blocker:references/status-codes.md:73:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of an HTTP status-code reference table or example explaining normal API responses. It is not system reconnaissance or host inspection."
      },
      {
        "id": "blocker:references/status-codes.md:83:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of an HTTP status-code reference table or example explaining normal API responses. It is not system reconnaissance or host inspection."
      },
      {
        "id": "blocker:references/status-codes.md:88:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of an HTTP status-code reference table or example explaining normal API responses. It is not system reconnaissance or host inspection."
      },
      {
        "id": "blocker:references/status-codes.md:89:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of an HTTP status-code reference table or example explaining normal API responses. It is not system reconnaissance or host inspection."
      },
      {
        "id": "blocker:references/status-codes.md:96:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of an HTTP status-code reference table or example explaining normal API responses. It is not system reconnaissance or host inspection."
      },
      {
        "id": "blocker:references/status-codes.md:116:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of an HTTP status-code reference table or example explaining normal API responses. It is not system reconnaissance or host inspection."
      },
      {
        "id": "blocker:references/status-codes.md:145:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is part of an HTTP status-code reference table or example explaining normal API responses. It is not system reconnaissance or host inspection."
      },
      {
        "id": "external_commands:SKILL.md:26:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown inline-code formatting for headers, paths, query strings, or reference filenames. There is no executable shell command or user-controlled command construction."
      },
      {
        "id": "external_commands:SKILL.md:38:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown code-fence delimiters around an HTTP example. They do not represent Ruby or shell execution."
      },
      {
        "id": "external_commands:SKILL.md:50:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown code-fence delimiters around an HTTP example. They do not represent Ruby or shell execution."
      },
      {
        "id": "external_commands:SKILL.md:60:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown inline-code formatting for headers, paths, query strings, or reference filenames. There is no executable shell command or user-controlled command construction."
      },
      {
        "id": "external_commands:SKILL.md:66:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown inline-code formatting for headers, paths, query strings, or reference filenames. There is no executable shell command or user-controlled command construction."
      },
      {
        "id": "external_commands:SKILL.md:76:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown inline-code formatting for headers, paths, query strings, or reference filenames. There is no executable shell command or user-controlled command construction."
      },
      {
        "id": "external_commands:SKILL.md:77:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown inline-code formatting for headers, paths, query strings, or reference filenames. There is no executable shell command or user-controlled command construction."
      },
      {
        "id": "external_commands:SKILL.md:78:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown inline-code formatting for headers, paths, query strings, or reference filenames. There is no executable shell command or user-controlled command construction."
      },
      {
        "id": "external_commands:SKILL.md:79:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown inline-code formatting for headers, paths, query strings, or reference filenames. There is no executable shell command or user-controlled command construction."
      },
      {
        "id": "external_commands:SKILL.md:80:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown inline-code formatting for headers, paths, query strings, or reference filenames. There is no executable shell command or user-controlled command construction."
      },
      {
        "id": "external_commands:SKILL.md:93:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown inline-code formatting for headers, paths, query strings, or reference filenames. There is no executable shell command or user-controlled command construction."
      },
      {
        "id": "external_commands:SKILL.md:94:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown inline-code formatting for headers, paths, query strings, or reference filenames. There is no executable shell command or user-controlled command construction."
      },
      {
        "id": "external_commands:SKILL.md:95:ruby-shell-backtick-execution",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "The flagged backticks are Markdown inline-code formatting for headers, paths, query strings, or reference filenames. There is no executable shell command or user-controlled command construction."
      },
      {
        "id": "blocker:SKILL.md:28:system-reconnaissance",
        "verdict": "false_positive",
        "confidence": 0.97,
        "reason": "This line is an HTTP status-code quick-reference entry. It does not request system information or perform reconnaissance."
      }
    ],
    "semantic_findings": [],
    "critical_findings": [],
    "high_findings": [],
    "medium_findings": [],
    "low_findings": [],
    "dangerous_patterns": [],
    "files_scanned": 5,
    "total_lines": 955,
    "audit_model": "codex",
    "audited_at": "2026-07-06T00:40:38.844Z",
    "agent_auto_install_policy": "allowed",
    "manual_install_policy": "allowed"
  },
  "content": {
    "user_title": "Design Reliable REST APIs",
    "value_statement": "REST APIs need consistent methods, status codes, caching, and rate limits. This skill gives Claude, Codex, and Claude Code quick patterns for practical API design.",
    "seo_keywords": [
      "Claude",
      "Codex",
      "Claude Code",
      "REST API design",
      "HTTP status codes",
      "API caching",
      "rate limiting",
      "error response formats",
      "API versioning",
      "endpoint design"
    ],
    "actual_capabilities": [
      "Compare HTTP methods, idempotency, and cacheability rules.",
      "Select common 2xx, 3xx, 4xx, and 5xx status codes.",
      "Review resource URLs, query parameters, pagination, sorting, and filtering patterns.",
      "Apply Cache-Control, ETag, CDN, and invalidation guidance.",
      "Design rate limit headers, retry handling, tiers, and endpoint limits.",
      "Structure error responses, versioning choices, bulk operations, and HATEOAS links."
    ],
    "limitations": [
      "It does not inspect live APIs or call external services.",
      "It does not generate a full framework implementation.",
      "Examples are generic and need project-specific adaptation.",
      "It does not replace a security or privacy review."
    ],
    "use_cases": [
      {
        "title": "Plan a New API",
        "target_user": "Backend engineer",
        "description": "Choose resource names, methods, status codes, pagination, caching, and rate limits before implementation."
      },
      {
        "title": "Review Endpoint Consistency",
        "target_user": "Technical lead",
        "description": "Compare an API contract against common REST patterns and identify inconsistent choices."
      },
      {
        "title": "Document Integration Behavior",
        "target_user": "Technical writer",
        "description": "Describe status codes, error formats, retry behavior, versioning, and cache semantics clearly."
      }
    ],
    "prompt_templates": [
      {
        "title": "Choose Basics",
        "scenario": "Beginner API planning",
        "prompt": "Use the rest-patterns skill to choose HTTP methods and status codes for these operations: create, read, update, delete, validation failure, and rate limiting."
      },
      {
        "title": "Design Collection Endpoints",
        "scenario": "Endpoint modeling",
        "prompt": "Use the rest-patterns skill to design collection endpoints for this resource. Include pagination, sorting, filtering, sparse fields, and included relationships."
      },
      {
        "title": "Add Caching and Limits",
        "scenario": "Production readiness",
        "prompt": "Use the rest-patterns skill to recommend caching headers, ETag behavior, CDN invalidation, and rate limit headers for these API endpoints."
      },
      {
        "title": "Audit an API Contract",
        "scenario": "Advanced design review",
        "prompt": "Use the rest-patterns skill to review this API contract for method semantics, status code choices, error response shape, versioning, bulk operations, and HATEOAS links."
      }
    ],
    "output_examples": [
      {
        "input": "I need status codes for create, update, delete, and validation failure.",
        "output": "Use 201 with Location for create, 200 or 204 for update, 204 for delete, and 422 for validation errors."
      },
      {
        "input": "Help me add caching to product catalog endpoints.",
        "output": "Use public cache headers for stable catalog data, ETags for validation, and no-store for personalized or sensitive responses."
      },
      {
        "input": "Review a rate limit policy for free and paid users.",
        "output": "Define separate tiers, return RateLimit and Retry-After headers, and document retry behavior for clients."
      }
    ],
    "best_practices": [
      "Start with resource nouns, standard HTTP methods, and clear collection pagination.",
      "Pair every error response with a stable code, message, and request identifier.",
      "Treat caching, authentication, and rate limits as part of endpoint design."
    ],
    "anti_patterns": [
      "Using verbs in URLs instead of method semantics.",
      "Returning 200 for validation, authentication, or authorization failures.",
      "Caching authenticated or sensitive responses without explicit no-store or private controls."
    ],
    "faq": [
      {
        "question": "What does this skill help with?",
        "answer": "It helps design REST APIs with consistent methods, status codes, resource paths, caching, rate limits, and response formats."
      },
      {
        "question": "Does this skill make network calls?",
        "answer": "No. It provides Markdown reference material and examples for API design decisions."
      },
      {
        "question": "Can it help choose status codes?",
        "answer": "Yes. It includes guidance for success, redirect, client error, and server error status codes."
      },
      {
        "question": "Does it cover rate limiting?",
        "answer": "Yes. It covers common headers, retry behavior, limit tiers, endpoint limits, and client backoff patterns."
      },
      {
        "question": "Does it support Claude, Codex, and Claude Code?",
        "answer": "Yes. The report lists support for Claude, Codex, and Claude Code."
      },
      {
        "question": "Should I copy the examples directly?",
        "answer": "Use them as patterns. Adapt names, limits, headers, and error details to your API contract."
      }
    ]
  },
  "file_structure": [
    {
      "name": "references",
      "type": "dir",
      "path": "references",
      "children": [
        {
          "name": "caching-patterns.md",
          "type": "file",
          "path": "references/caching-patterns.md",
          "lines": 193
        },
        {
          "name": "rate-limiting.md",
          "type": "file",
          "path": "references/rate-limiting.md",
          "lines": 202
        },
        {
          "name": "response-formats.md",
          "type": "file",
          "path": "references/response-formats.md",
          "lines": 290
        },
        {
          "name": "status-codes.md",
          "type": "file",
          "path": "references/status-codes.md",
          "lines": 173
        }
      ]
    },
    {
      "name": "SKILL.md",
      "type": "file",
      "path": "SKILL.md",
      "lines": 97
    }
  ]
}
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 322kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall