Conversation
robinbisping
left a comment
There was a problem hiding this comment.
There is an additional file that probably should be updated: /reference/public-api/changelog/
| @@ -1,189 +0,0 @@ | |||
| title: Patch a Media Library Entry | |||
There was a problem hiding this comment.
The preserveUpdatedAt parameter is only available in API versions 2026-03 and newer. Deleting this file makes it now appear as if it were available for all API versions.
It's different from the {{< added-in "release-2026-03" block >}} tag, which are about the release not the API version.
I would restore the file, what do you think? 🤔
There was a problem hiding this comment.
Wouldn't that mean that (almost) every time we have a changelog entry we should also have a new page? I don't think we've done it this way previously, although I'm not against it. Should I open another PR to add more versions?
There was a problem hiding this comment.
Maybe @marcbachmann can explain his intention ones again. I'm not sure. My understanding is that functionality restricted to certain API versions should only appear in the docs for these API versions (e.g. preserveUpdatedAt). On the other hand, features added to all API versions (e.g. the new usage log commands) don't require new pages.
There was a problem hiding this comment.
Yes, every release that got an addition needs to be new yaml declaration. And the apiVersionConstraints should be aligned.
So basically copy the file without release postfix in the name to the older release till it was valid and change the apiVersionConstaints to fit the ranges.
There was a problem hiding this comment.
Thank you both for explaining. I've restored the file.
One thing I haven't been doing is editing the old endpoint data. I only touch the one without the release suffix. Should I be adding the changes I've made in data/endpoints/patch-media-library-entry.yaml to patch-media-library-entry-2026-01.yaml as well? Technically these changes are available in the v1 and beta endpoints, even if they would not work unless you're on release-2026-05 or above.
There was a problem hiding this comment.
I would add them to both API version files and tag them with an {{< added-in "release-2026-05" >}} shortcode.
c86d185 to
735ecdb
Compare
735ecdb to
4de92d7
Compare
addUsageLogEntry,updateUsageLogEntryandremoveUsageLogEntryoperations to media library patch endpoint of the Public API