Skip to content

docs: sync API changelog (nvm-monorepo@995eeb3) #225

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
eruizgar91 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: sync API changelog (nvm-monorepo@995eeb3) #225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions docs/development-guide/api-changelog.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: "API Changelog"
description: "Every wire-shape change between supported Nevermined API versions. The version identifier is the platform release MAJOR.MINOR."

Check warning on line 3 in docs/development-guide/api-changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (neverminedag) - vale-spellcheck

docs/development-guide/api-changelog.mdx#L3 

Did you really mean 'Nevermined'?
---

{/* GENERATED FILE — DO NOT EDIT. */}
{/* Source of truth: nvm-monorepo apps/api/src/api-versioning/registry.ts. */}
{/* Synced by the sync-api-changelog-docs workflow. */}

Clients pin an API version per API key (editable in the dashboard) or per request
via the `Nevermined-Version` header; the platform reshapes requests and responses so
every supported pin keeps working. See the [versioning guide](/docs/development-guide/api-versioning).

- **Floor (oldest supported version):** `1.0`
- **Live current version:** `GET /api/v1/meta/versions`

## 1.1

_Changes relative to `1.0`:_

- **Remove the legacy creditsConfig.proofRequired request alias — the canonical key is onchainMirror (clients below 1.1 keep the alias)** (`request`)

Check warning on line 21 in docs/development-guide/api-changelog.mdx

View check run for this annotation

Mintlify / Mintlify Validation (neverminedag) - vale-spellcheck

docs/development-guide/api-changelog.mdx#L21 

Did you really mean 'onchainMirror'?
- `POST /api/v1/protocol/plans`
- `POST /api/v1/protocol/agents/plans`
- **Remove the deprecated always-null permission slots orderLimit/planCost/creditsPerOrder from responses (clients below 1.1 keep receiving them as null)** (`response`)
- `GET /api/v1/x402/permissions`
- `GET /api/v1/x402/permissions/:permissionHash`