api-contract-documentation

api-contract-documentation is a skill for Claude Code, Codex from BanibrataChatterjee/AwesomeSalesforceSkills. It costs 107 tokens per session (2,594 once invoked), scanned A, original, Apache-2.0.

A guide to documenting Salesforce API integrations, including request and response formats, version policies, error codes, rate limits, and OpenAPI specifications.

In plain words
What is it for?
Use it to produce or review API contracts for standard Salesforce REST endpoints and custom Apex REST services.
Why use it?
It gives teams a shared reference for building integrations and reduces failures caused by undocumented changes, unsupported API versions, or exceeded request limits.

Skill for Claude CodeCodex

Written for no agent in particular: nothing here depends on one.

Good fit Use it to produce or review API contracts for standard Salesforce REST endpoints and custom Apex REST services.

Compare 6 skills from other repositories ↓
Install with agentmods
npx agentmods add skills/banibratachatterjee/awesomesalesforceskills/api-contract-documentation
Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

Any agent
npx skills add BanibrataChatterjee/AwesomeSalesforceSkills --skill api-contract-documentation
Clone the repo
git clone --depth 1 https://github.com/BanibrataChatterjee/AwesomeSalesforceSkills

Made for: Claude Code, Codex.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for api-contract-documentation

README.md
[![agentmods](https://agentmods.dev/badge/skills/banibratachatterjee/awesomesalesforceskills/api-contract-documentation/github.svg)](https://agentmods.dev/skills/banibratachatterjee/awesomesalesforceskills/api-contract-documentation)
Your own site
<a href="https://agentmods.dev/skills/banibratachatterjee/awesomesalesforceskills/api-contract-documentation"><img src="https://agentmods.dev/badge/skills/banibratachatterjee/awesomesalesforceskills/api-contract-documentation/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for api-contract-documentation

Your own site · 80×15
<a href="https://agentmods.dev/skills/banibratachatterjee/awesomesalesforceskills/api-contract-documentation"><img src="https://agentmods.dev/badge/skills/banibratachatterjee/awesomesalesforceskills/api-contract-documentation.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 107 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 2,594 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.00107 $0.02594
Opus 5 $0.00053 $0.01297
Sonnet 5 $0.00021 $0.00519
Haiku 4.5 $0.00011 $0.00259

Measured 6d ago against content hash c628255df39a, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-09, from the pricing page.

Security

Grade A, and why

api-contract-documentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 6d ago.

The scan reads SKILL.md. This mod also ships 1 executable file (scripts/check_api_contract_documentation.py), listed below but not scanned — reading those needs a real analyzer, not pattern matching.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

skills/admin/api-contract-documentation/SKILL.md · 189 lines

How it starts

The opening of the file, as written. The whole thing — 189 lines — stays where its author put it; the contents beside it link to each section on GitHub.

API Contract Documentation

Use this skill when producing documentation artifacts for Salesforce REST API integrations — versioning policies, error code catalogs, rate limit specifications, and request/response schema documentation. Distinct from API implementation: this skill addresses the documentation layer that consumer teams use to build integrations safely.


Before Starting

Gather this context before working on anything in this domain:

  • What API version is the integration using? (e.g., v60.0). Is there a risk this version is approaching end-of-life?
  • Does the integration use standard sObjects REST API, custom Apex REST (@RestResource) endpoints, or both?
  • What are the daily API request limits for this org? (Check /services/data/vXX.0/limits or the Sforce-Limit-Info response header.)
  • Is an OpenAPI 3.0 document required? Note: Salesforce's OpenAPI beta covers sObjects REST API only — custom Apex REST endpoints must be hand-authored.

Core Concepts

Salesforce API Versioning Policy

Salesforce REST API versioning uses integer version numbers (e.g., v60.0, v61.0). The official policy guarantees:

  • A minimum 3-year support window for each released version
  • At least 1 year's advance notice before a version is retired
  • The /services/data/ endpoint enumerates all currently live API versions with their version, label, and url properties

The API end-of-life (EOL) policy is documented at developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/api_rest_eol.htm. Integrations should document the API version in use and set calendar reminders to check the EOL list with each Salesforce seasonal release.

Rate Limits and the Sforce-Limit-Info Header

Salesforce API request limits are tracked in a rolling 24-hour window. Two indicators:

  1. Sforce-Limit-Info response header — Every REST API response includes this header with the format: api-usage=XXXX/YYYY where XXXX is the number of calls used and YYYY is the daily limit. Consumer systems should log this header to track consumption trends.
  2. /services/data/vXX.0/limits resource — Returns the current org's limits across all limit types including DailyApiRequests. Poll this endpoint to proactively detect approaching exhaustion.

Read the full file on GitHub · 189 lines

Files

What ships with it

6 files beside SKILL.md in the same directory: the scripts, references and assets a skill reads on demand. Not counted in the per-session cost; read them before you install if any of them is executable.

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 6d ago First seen · 189 lines · 107 tokens per session scan A c628255df39a

Subscribe to this mod's changes

api-contract-documentation is a skill published in the GitHub repository BanibrataChatterjee/AwesomeSalesforceSkills (3 stars, last pushed 4mo ago), licensed Apache-2.0. It adds 107 tokens to every session and 2,594 once invoked, about $0.0005 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-09-03.

Related

Other skills, from other repositories

api-contract-documentation

Produce or review API contract documentation for Salesforce integrations: versioning policy artifacts, request/response schema specs, error code catalogs, rate limit documentation, OpenAPI generation for sObjects. Trigger keywords: Salesforce API versioning policy, API end-of-life policy, document API endpoints, REST…

PranavNagrecha/AwesomeSalesforceSkills · 116 tokens

api-design-patterns

Comprehensive REST and GraphQL API design patterns with versioning, pagination, error handling, and HATEOAS principles. Use when designing APIs, defining endpoints, or architecting service contracts requiring production-grade patterns.

NickCrew/Claude-Cortex · 48 tokens

bunjs-apidog

Use when creating OpenAPI specs for Bun.js APIs, integrating with Apidog, documenting endpoints with schemas, or automating API specification imports via Apidog REST API. See bunjs for basics.

MadAppGang/claude-code · 44 tokens

API Documentation Generator

AI-powered API documentation generation tool that auto-generates comprehensive API docs from source code, including OpenAPI/Swagger specs, Postman collections, and markdown documentation with examples and authentication details.

XSpoonAi/spoon-awesome-skill · 41 tokens

API Test Suite Generator

Automatically generate comprehensive API test suites from OpenAPI specifications covering CRUD operations, error handling, authentication, pagination, and edge cases.

PramodDutta/qaskills · 29 tokens

ocli-api

Turn any OpenAPI/Swagger API into CLI commands and call them. Search endpoints with BM25, check parameters, execute — no MCP server needed.

EvilFreelancer/openapi-to-cli · 34 tokens