openapi-types

openapi-types is a cursor rule for Cursor from jaycewalzer1/SilverKey-Inc.. It costs 0 tokens per session (2,300 once invoked), scanned A, original, MIT.

A set of rules for OpenAPI-generated type definitions and their file layout. Generated files are produced by a tool and should normally be changed at their source, not by hand.

In plain words
What is it for?
It guides the placement and handling of generated API types.
Why use it?
It prevents manual edits from being overwritten and keeps generated code organized.

Cursor rule for Cursor

Written for Cursor: installed under .cursor/.

Needs its repository: it runs a file that does not travel with it, so clone the repository first. The line is bash scripts/generate-pydantic-models.sh.

Good fit It guides the placement and handling of generated API types.

Compare 6 cursor rules from other repositories ↓
Install

Getting it into your agent

It runs from inside its repository, so the clone comes first — what it calls does not travel with the file alone.

Clone the repo
git clone --depth 1 https://github.com/jaycewalzer1/SilverKey-Inc.
agentmods
npx agentmods add rules/jaycewalzer1/silverkey-inc./openapi-types

Made for: Cursor.

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 openapi-types

README.md
[![agentmods](https://agentmods.dev/badge/rules/jaycewalzer1/silverkey-inc./openapi-types/github.svg)](https://agentmods.dev/rules/jaycewalzer1/silverkey-inc./openapi-types)
Your own site
<a href="https://agentmods.dev/rules/jaycewalzer1/silverkey-inc./openapi-types"><img src="https://agentmods.dev/badge/rules/jaycewalzer1/silverkey-inc./openapi-types/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 openapi-types

Your own site · 80×15
<a href="https://agentmods.dev/rules/jaycewalzer1/silverkey-inc./openapi-types"><img src="https://agentmods.dev/badge/rules/jaycewalzer1/silverkey-inc./openapi-types.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 0 Nothing until a file matches its globs; then the whole rule loads.
When invoked 2,300 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.00000 $0.02300
Opus 5.5 $0.00000 $0.00920
Sonnet 5.5 $0.00000 $0.00460
Haiku 4.5 $0.00000 $0.00230

Measured 1mo ago against content hash 183447bf7e45, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

openapi-types 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 1mo ago.

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.

.cursor/rules/shared/openapi-types.mdc · 350 lines

How it starts

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

OpenAPI Type Management

Overview

The SilverKey codebase uses a centralized OpenAPI 3.1.0 specification as the single source of truth for all API types. TypeScript types are auto-generated from this specification.

File Structure

/
├── openapi/
│   ├── openapi.yaml                      # Main spec with $ref to components
│   └── components/
│       └── schemas/                      # Modular schema definitions by domain
│           ├── agent/                    # Agent workspace schemas
│           ├── auth/                     # Authentication schemas
│           ├── calendar/                 # Calendar and events
│           ├── search/                   # Property search
│           ├── user/                     # User-related schemas
│           └── shared/                   # Shared/common types
├── Server/
│   ├── scripts/
│   │   └── generate-pydantic-models.sh   # Backend codegen script
│   └── app/schemas/
│       └── generated.py                  # 🔥 AUTO-GENERATED (DO NOT EDIT)
└── Client/
    ├── scripts/
    │   └── generate-api-types.sh         # Frontend codegen script
    ├── package.json                       # Contains generate:api-types script
    └── packages/
        └── types/
            └── api.generated.ts           # 🔥 AUTO-GENERATED (DO NOT EDIT)

Note: Schemas are organized in separate YAML files under openapi/components/schemas/ by domain. See openapi-schema-organization.mdc for details on file organization.

Rules

1. Never Edit Generated Types

FORBIDDEN:

// ❌ NEVER edit this file
// Client/packages/types/api.generated.ts
export interface components {
  schemas: {
    User: { ... } // DO NOT MODIFY
  }
}

CORRECT:

# ✅ Edit openapi.yaml instead
components:
  schemas:
    User:
      type: object
      properties:
        id:
          type: string
        # ... more fields

2. Adding or Modifying API Types

Always follow this workflow:

  1. Edit the OpenAPI schema:
    # Option A: Edit individual schema file
    vim openapi/components/schemas/user/profile/UserProfile.yaml
    
    # Option B: Edit main spec
    vim openapi/openapi.yaml
    

Read the full file on GitHub · 350 lines

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. 1mo ago First seen · 350 lines · 0 tokens per session scan A 183447bf7e45

Subscribe to this mod's changes

openapi-types is a cursor rule published in the GitHub repository jaycewalzer1/SilverKey-Inc. (2 stars, last pushed 3d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 2,300 tokens. 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-08.