Skip to content

Add usage log entry operations to Public API#1132

Open
ajwild wants to merge 2 commits intomainfrom
usage-log-public-api
Open

Add usage log entry operations to Public API#1132
ajwild wants to merge 2 commits intomainfrom
usage-log-public-api

Conversation

@ajwild
Copy link
Copy Markdown
Contributor

@ajwild ajwild commented Mar 30, 2026

  • Added addUsageLogEntry, updateUsageLogEntry and removeUsageLogEntry operations to media library patch endpoint of the Public API
  • Removed data/endpoints/patch-media-library-entry-2026-01.yaml because I thought they were only necessary when breaking changes were introduced
  • Fixed some invalid OpenAPI schema definitions so that the file will open again!

@ajwild ajwild requested a review from robinbisping March 30, 2026 15:39
Copy link
Copy Markdown
Contributor

@robinbisping robinbisping left a comment

Choose a reason for hiding this comment

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

There is an additional file that probably should be updated: /reference/public-api/changelog/

@@ -1,189 +0,0 @@
title: Patch a Media Library Entry
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.

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? 🤔

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.

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?

Copy link
Copy Markdown
Contributor

@robinbisping robinbisping Mar 31, 2026

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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.

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