Spectral linting rules defining API design standards and conventions for Ironclad Clickwrap.
0 Rules
Authorship not recorded
No authorship marker is recorded for this file. It is not presented as the provider's; it was most likely written by an API Evangelist pass before outputs were stamped.
x-aid: ironclad-clickwrap
x-name: Ironclad Clickwrap Rules
description: >-
Governance and curation rules for the Ironclad Clickwrap company entry
and its clickwrap REST API documentation within the API Evangelist network.
rules:
- name: API Identification
description: Each Ironclad Clickwrap API is identified and documented.
conditions:
- Each API entry must have an aid, name, description, humanURL, and baseURL.
- APIs[] must reference the OpenAPI under openapi/ironclad-clickwrap-openapi.yml.
- Tags must reflect clickwrap, contracts, and legal use cases.
- name: OpenAPI Hygiene
description: Keep the OpenAPI accurate and useful.
conditions:
- The OpenAPI must specify https://pactsafe.io as the production server.
- Endpoints for sites, groups, contracts, signers, and activity events are documented.
- Bearer token security scheme must reflect API key authentication.
- name: Metadata Currency
description: Maintain accurate timestamps and links.
conditions:
- Update modified date when apis.yml or OpenAPI change.
- Common properties include Portal, Website, and Support.
- README.md kept in sync with apis.yml content.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.