Skip to content

docs: switch to getSchemaTemplates / getSecuritySchemes - #18

Merged
dskripchenko merged 1 commit into
masterfrom
docs/neutral-hook-names
Oct 26, 2026
Merged

dskripchenko merged 1 commit into
masterfrom
docs/neutral-hook-names

Conversation

@dskripchenko

Copy link
Copy Markdown
Owner

The neutral hook names from 6.1 become the documented ones, now that the IDE plugin reads them (laravel-api-idea 1.1.0).

What

  • Docs — README, docblock-tags.md, cookbook.md in en/ru/zh/de: code samples and prose use getSchemaTemplates() / getSecuritySchemes(). The "neutral names" note becomes "Names before 6.1": the earlier names keep working, the package reads the new ones, the plugin reads both from 1.1.0. API reference rows list the new names.
  • api:lint hints — "Add it to getSchemaTemplates() …" / "… getSecuritySchemes() …".
  • BaseApi docblocks — the template example moves to getSchemaTemplates(); the old methods point at the new ones.
  • CLAUDE.md, CHANGELOG ([Unreleased] → Changed).

Not changed: the code (nothing deprecated, both names keep working) and the test fixtures, which stay on the old names on purpose — they cover the fallback.

Snapshots

One snapshot changes — the lint report of BrokenApi, in its five hints only (getOpenApiTemplates() → getSchemaTemplates() ×3, getOpenApiSecurityDefinitions() → getSecuritySchemes() ×2). Everything else unchanged. 601 tests passing.

🤖 Generated with Claude Code

The documentation (en/ru/zh/de), the BaseApi docblocks and the api:lint
hints switch to the neutral hook names; the earlier names keep working
and are described as such. The IDE plugin reads both from 1.1.0. Test
fixtures keep the earlier names on purpose. The lint snapshot of the
broken fixture changes in its five hints only.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@dskripchenko
dskripchenko merged commit f2ca0c5 into master Oct 26, 2026
7 checks passed
@dskripchenko dskripchenko mentioned this pull request Oct 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant