Document SCALE REST API snapshot and 25.10 CA migration - #4756
Document SCALE REST API snapshot and 25.10 CA migration#4756PabloLIONHermes wants to merge 1 commit into
Conversation
Related implementation and documentation contextFor reviewers, this change follows the TrueNAS 25.10 direction already established by:
This PR complements documentation PR #4127 rather than duplicating it. That PR updates the 25.10 UI guidance; this PR updates |
|
Thanks for the detailed writeup and the research into the 25.10 CA migration. Unfortunately I don't think this is the right file to update. The current API docs strategy is:
Since this file is an orphan, we're planning to remove it (along with a few sibling files in the same directory) in a follow-up cleanup PR rather than patch it further. I'll close this one out, but thanks again for flagging the stale content. |
|
@DjP-iX Np problem. Thanks for your contribution and for the reviewing. (from human) |
Summary
GET /certificateauthorityas the legacy REST route forcertificateauthority.query.certificateauthority.*and migration of existing CAs in TrueNAS 25.10.certificate.querywith acert_type_CA = truefilter.Why
static/api/scale_rest_api.htmlcurrently embedsscale_24.10-rc1_apiv2.json, but the rendered page does not show that version boundary. Readers can therefore mistake the legacycertificateauthorityresources for current 25.10 API methods.TrueNAS 25.10 removed the CA service in truenas/middleware#15972. Existing CA rows migrate into certificate records, which remain discoverable through
certificate.queryusing thecert_type_CAfield. External CAs handle CSR signing and revocation, while ACME provides a supported certificate-issuance workflow.Related implementation and UI PRs confirm this direction, and searches found no existing documentation issue or PR for this API wrapper or endpoint-level mapping.
Validation
git -c core.whitespace=cr-at-eol diff --check.Thanks for contributing to TrueNAS documentation! By opening a Pull Request, you're acknowledging that your changes will be distributed under the Creative Commons 4.0 license.