ai-instructions spring-boot-api-versioning.instructions.md

ai-instructions spring-boot-api-versioning.instructions.md is an instructions file for GitHub Copilot from lsampaioweb/ai-instructions. It costs 549 tokens per session, scanned A, original, MIT.

A set of rules for versioning Spring Boot web APIs, so different contract versions can coexist as an API changes.

In plain words
What is it for?
It is for defining versioned URL paths, backward-compatible changes, deprecation handling, and new versions for incompatible changes.
Why use it?
It helps clients keep working when endpoints or data fields evolve and makes breaking changes explicit.

Instructions file for GitHub Copilot

Written for GitHub Copilot: a Copilot chat mode or prompt.

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/lsampaioweb/ai-instructions/spring-boot-api-versioning
Clone the repo
git clone --depth 1 https://github.com/lsampaioweb/ai-instructions

Made for: GitHub Copilot.

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 ai-instructions spring-boot-api-versioning.instructions.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/lsampaioweb/ai-instructions/spring-boot-api-versioning.svg)](https://agentmods.dev/instructions/lsampaioweb/ai-instructions/spring-boot-api-versioning)
Your own site
<a href="https://agentmods.dev/instructions/lsampaioweb/ai-instructions/spring-boot-api-versioning"><img src="https://agentmods.dev/badge/instructions/lsampaioweb/ai-instructions/spring-boot-api-versioning.svg" alt="Measured on agentmods" height="20"></a>
Per session 549 This file is loaded in full into every session.
When invoked 549 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
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.00549 $0.00549
Opus 5 $0.00275 $0.00275
Sonnet 5 $0.00110 $0.00110
Haiku 4.5 $0.00055 $0.00055

Measured 2d ago against content hash ba88fb427e23, method: parsed. Prices are Anthropic first-party input rates as of 2026-09-05, from the pricing page.

Security

Grade A, and why

ai-instructions spring-boot-api-versioning.instructions.md 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 2d 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.

.github/instructions/spring-boot-api-versioning.instructions.md · 36 lines

How it starts

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

Spring Boot API-Versioning Engine

Rules

  • Use URL path versioning with an explicit /api/v1 prefix for all REST endpoints.
  • Use integer version numbers in the format /api/vN (e.g., /api/v1, /api/v2).
  • Do not use floating-point or date-based version identifiers such as /api/v1.1 or /api/2024-01.
  • Exclude MVC page controllers and view routes from API version-prefix enforcement.
  • Use one canonical versioning strategy across the entire project.
  • Declare version changes explicitly in controller route mappings.
  • Declare a shared base-path constant at the controller class level when the versioned route is reused across methods.
  • Keep v1 changes additive and backward compatible.
  • Treat these changes as additive and backward compatible: adding optional request fields with defaults, adding new response fields, and adding new endpoints.
  • Create a new API version for every breaking contract change.
  • Treat these changes as breaking: removing or renaming a field, changing a field type, making an optional field required, removing an endpoint, changing an endpoint path, or changing an HTTP method.
  • Keep request and response DTO changes backward compatible within the same version.
  • Use version-specific DTO suffixes when payload contracts diverge across versions (e.g., HolidayV1Response, HolidayV2Response).
  • Share the same DTO across versions only when the payload contract is identical.
  • Keep route versioning distinct from OpenAPI document version metadata.
  • Keep controller tests aligned with the active versioned route prefix.
  • When v2 or later is introduced, keep old and new versions available side by side until the old version is explicitly deprecated.
  • When v2 or later is introduced, document migration notes and client impact.
  • Announce a deprecated API version via a Deprecation response header per RFC 8594.
  • Announce a deprecated API version via a Sunset response header per RFC 8594.
  • Always set both Deprecation and Sunset headers together when a version is scheduled for removal.
  • Maintain a deprecated API version for at least one full release cycle after the deprecation announcement; remove a version only in a later release than the one that deprecates it.

Read the full file on GitHub · 36 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. 2d ago First seen · 36 lines · 549 tokens per session scan A ba88fb427e23

Subscribe to this mod's changes

ai-instructions spring-boot-api-versioning.instructions.md is an instructions file published in the GitHub repository lsampaioweb/ai-instructions (1 stars, last pushed 13d ago), licensed MIT. It adds 549 tokens to every session, about $0.0027 per session on Opus 5. 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-03.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 6,785 tokens

spec-kit AGENTS.md

AGENTS.md instructions for github/spec-kit, covering agents.md, about spec kit and specify, quickstart — add a new integration in 5 steps, integration architecture and integrationmanifest — file tracking.

github/spec-kit · 7,104 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,296 tokens

codex AGENTS.md

AGENTS.md instructions for openai/codex, covering rust/codex-rs, the codex-core crate, code review rules, crate api surface and model visible context.

openai/codex · 5,182 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,469 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, applying the notice (cutover) and fallback chain (never fail the build).

microsoft/vscode · 5,001 tokens