Skip to content

docs: update information about deprecated API - #2886

Merged
kjaskiewiczz merged 1 commit into
mendersoftware:masterfrom
kjaskiewiczz:deprecations
Aug 26, 2026
Merged

docs: update information about deprecated API#2886
kjaskiewiczz merged 1 commit into
mendersoftware:masterfrom
kjaskiewiczz:deprecations

Conversation

@kjaskiewiczz

Copy link
Copy Markdown
Contributor

External Contributor Checklist

🚨 Please review the guidelines for contributing to this repository.

  • Make sure that all commits follow the conventional commit specification for the Mender project.

The majority of our contributions are fixes, which means your commit should have
the form below:

fix: <SHORT DESCRIPTION OF FIX>

<OPTIONAL LONGER DESCRIPTION>

<OPTIONAL Changelog: <USER-FRIENDLY CHANGE DESCRIPTION>>
<OPTIONAL Ticket: <TICKET NUMBER>>
  • Make sure that all commits are signed with git --signoff. Also note that the signoff author must match the author of the commit.

Description

Please describe your pull request.

Thank you!

remains supported for at least the same period, so the effective migration window
is the same regardless of deployment model.

Some of the endpoints above were announced as deprecated more than 12 months ago but

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This note will be somewhat obsolete when we add more to this list later. I think it could be removed, they already have dates.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

| `to_release` | `GET /deployments/deployments/releases/delta/jobs/{id}` | Management v2 | 2025-12-03 | 2027-08-25 | 2027-08-25 | `to_version`, which contains the same information |
| `propagate` | `POST /useradm/tenants/{tenant_id}/users` | Internal v1 | 2023-07-06 | 2027-08-25 | 2027-08-25 | None required. Propagation of user information to tenantadm is permanently disabled |

Deprecated fields follow the same 12 month grace period as deprecated APIs, and share the

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here- I think I'd remove this.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

endpoint that exposes them. The endpoints below remain supported; only the listed
field is deprecated.

| Field | API | Version | Deprecated since | EOL (hosted Mender) | EOL (on-premise) | Replacement |

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would put the API first, like above, so it's easier to see if you're actually using that path.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@estenberg estenberg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor comments, but good overall.

Do we have warnings on the API level when these endpoints are used.

Signed-off-by: Krzysztof Jaskiewicz <krzysztof.jaskiewicz@northern.tech>
@kjaskiewiczz
kjaskiewiczz merged commit 13b7988 into mendersoftware:master Aug 26, 2026
1 check passed
@kjaskiewiczz
kjaskiewiczz deleted the deprecations branch August 26, 2026 11:06
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.

3 participants