Skip to content
Skills Library
Programming · Review & audit

pydantic-interface

/pydantic-interface

Use when adding, changing, fixing, or removing NuGuard package functionality that has a public Python or platform-facing interface. Keeps public Pydantic request/result models, streaming events and reducers, exports, JSON Schema snapshots, documentation, redaction, and compatibility tests synchronized with implementation changes.

Repository
nuguard ↗
Licence
Apache-2.0
Last repository change
25.10.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 25.10.2026, without references to retired models or APIs.

Licence

Apache-2.0, otwarta: można używać i zmieniać, z zachowaniem licencji i informacji o zmianach.

What it does and when to use it

Use when adding, changing, fixing, or removing NuGuard package functionality that has a public Python or platform-facing interface. Keeps public Pydantic request/result models, streaming events and reducers, exports, JSON Schema snapshots, documentation, redaction, and compatibility tests synchronized with implementation changes.

Original author description

Use when adding, changing, fixing, or removing NuGuard package functionality that has a public Python or platform-facing interface. Keeps public Pydantic request/result models, streaming events and reducers, exports, JSON Schema snapshots, documentation, redaction, and compatibility tests synchronized with implementation changes.

How it works

  1. Workflow
  2. Validation
Original SKILL.md headings · 43 lines, 291 words
SKILL.md preview
---
name: pydantic-interface
description: >
  Use when adding, changing, fixing, or removing NuGuard package functionality that has a
  public Python or platform-facing interface. Keeps public Pydantic request/result models,
  streaming events and reducers, exports, JSON Schema snapshots, documentation, redaction,
  and compatibility tests synchronized with implementation changes.
user-invocable: false
---

# Pydantic Interface Maintenance

Keep NuGuard's supported Pydantic boundary synchronized with functional changes.

## Workflow

1. Identify whether the changed behavior is callable by library, CLI, MCP, plugin, or platform
   consumers. Inspect the nearest `public_api.py`, existing exports, and contract tests before
   editing.
2. Reuse or extend public `BaseModel` request, result, configuration, event, and reducer types.
   Do not expose implementation dataclasses, private helpers, unresolved credentials, raw target
   responses, or mutable internal state.
3. Preserve existing public call signatures and import paths unless a breaking change is
   explicitly approved. Add normalization at the public boundary when an existing public model
   must interoperate with an internal model.
4. Ensure every public model is JSON-safe with `model_dump(mode="json")`, round-trips through
   validation, and has stable field names and constrained values. Use `SecretStr` for required
   credential inputs and omit secrets from results, events, cache metadata, logs, and errors.
5. For streaming changes, use `StreamEvent` and the public reducer. Preserve monotonic sequence
   and progress values, exactly one terminal event, settled cancellation, and sanitized stable
   failures.
6. Add focused tests for success, validation failure, serialization, backwards compatibility,
   side effects, and credential leakage. Public wrappers must not add filesystem or network side
   effects by default.
7. Register new public models in `tests/contracts/test_public_api_schema_contract.py`, regenerate
   `tests/contracts/public_api.schema.json`, and inspect the diff for accidental contract churn.
8. Update relevant library and platform-integration documentation, including cancellation,
   caching, persistence, authentication, and error behavior where applicable.

## Validation

Run the narrowest affected tests first, then complete these checks before finishing:

```powershell
uv run pytest tests/contracts/test_public_api_schema_contract.py -q
uv run ruff check nuguard/ tests/
uv run mypy nuguard/
uv run pytest tests/ -q
```

Search serialized results, events, logs, and public exception messages for fixture secrets when
the change handles repository URLs, API keys, authorization headers, cookies, or target output.

Versions

The database has no other skills named pydantic-interface.

Database snapshot: 13.11.2026 · package version 3beabfc77db4 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100pydantic-models-py
    Create Pydantic models following the multi-model pattern with Base, Create, Update, Response, and InDB variants. Use when defining API request/response schemas, database models, or data validation in Python applications using Pydantic v2.
  • 100pydantic-models-py
    Create Pydantic models following the multi-model pattern with Base, Create, Update, Response, and InDB variants. Use when defining API request/response schemas, database models, or data validation ...
  • 100mcp-json-schema-validation-design
    Use this skill when defining strict input parameter validation for MCP tools using Zod, Pydantic, and JSON Schema Draft-07.
  • 100saving-codeacts
    Save executed Python code as reusable tools in the gentools package. Use when preserving successful code executions for later reuse. Covers creating package structure (api.py, impl.py), defining Pydantic output models, and implementing the run() interface.
  • 100pydantic-v2
    Pydantic v2 models, validators, serialization, FastAPI schemas and v1-to-v2 migration. TRIGGER WHEN: writing or refactoring Pydantic v2 models in Python 3.10+, migrating from Pydantic v1, handling Decimal money fields, or designing FastAPI request/response schemas. DO NOT…
  • 100pydantic-v2
    Pydantic v2 models, validators, serialization, FastAPI schemas and v1-to-v2 migration. TRIGGER WHEN: writing or refactoring Pydantic v2 models in Python 3.10+, migrating from Pydantic v1, handling Decimal money fields, or designing FastAPI request/response schemas. DO NOT…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.