api-contract-documentation SKILL.md skillA
api-contract-documentation from pranavnagrecha/awesomesalesforceskills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add pranavnagrecha/awesomesalesforceskills/api-contract-documentation@v1.1.0Pins v1.1.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- pranavnagrecha/awesomesalesforceskills
- Path
skills/admin/api-contract-documentation/SKILL.md- Versions recorded
- 3
- Latest version
- v1.1.0, committed Sep 5, 2026
- First version recorded
- Apr 16, 2026
- Size
- 24,445 bytes
- Repository stars
- 19
- License
- a license file GitHub does not identify
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 API rate limits, OpenAPI sObjects, API contract record, error contract, errorCode catalog, 410 GONE retired API version, HTTP 300 external ID upsert, idempotency key, deprecation…
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# 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. --- ## Questions to Ask Before Configuring …
Read the whole file at its exact version.
How to install
mdr add pranavnagrecha/awesomesalesforceskills/api-contract-documentation@sha256:0ec7dc4f40a073cbThe line at the top of this page pins the label v1.1.0, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_lqxl2ydtm2d7ts4w)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Apr 16, 2026 and Sep 5, 2026, about one every 71 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.1.0 latest | 2026-09-05 | 30dd063 | 24,445 B | A | view · diff |
| v1.0.0 | 2026-08-14 | 25df1fd | 11,881 B | A | view · diff |
| v1.0.0 | 2026-04-16 | edfb68e | 11,852 B | A | view |
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (24445 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
pranavnagrecha/awesomesalesforceskills · 19 stars · license a license file GitHub does not identify · pushed 2026-10-20 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_lqxl2ydtm2d7ts4w GET https://markdownregistry.com/api/v1/resolve?ref=pranavnagrecha/awesomesalesforceskills/api-contract-documentation GET https://markdownregistry.com/api/v1/blob/0ec7dc4f40a073cb39dd706efa3629792bccc228865961241dcd894303039b34
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.