Skip to content

Conversation

@janbuchar
Copy link
Contributor

@janbuchar janbuchar commented Jan 14, 2026

Note

Improves OpenAPI docs and simplifies schema for run usage fields.

  • Adds detailed descriptions for usageTotalUsd and usageUsd specifying availability based on ownership and Actor pricing models
  • Simplifies usage and usageUsd definitions by replacing allOf/oneOf composition with nullable: true and direct $ref to RunUsage.yaml

Written by Cursor Bugbot for commit d92e3f1. Configure here.

@janbuchar janbuchar requested a review from fnesveda as a code owner January 14, 2026 11:26
@janbuchar janbuchar added the t-tooling Issues with this label are in the ownership of the tooling team. label Jan 14, 2026
@janbuchar janbuchar requested a review from stetizu1 January 14, 2026 11:26
@github-actions github-actions bot added this to the 132nd sprint - Tooling team milestone Jan 14, 2026
@apify-service-account
Copy link

Preview for this PR was built for commit e549938 and is ready at https://pr-2179.preview.docs.apify.com!

nullable: true
description: >-
Platform usage costs breakdown in USD. Only present if you own the run AND are paying for platform usage
(Pay-Per-Usage, Rental, or Pay-Per-Event with usage costs like standby Actors).
Copy link
Contributor

@stetizu1 stetizu1 Jan 14, 2026

Choose a reason for hiding this comment

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

I am technically missing there "if you are Actor owner" case - you are then only paying for usage

Copy link
Contributor Author

Choose a reason for hiding this comment

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

That seems like too much detail to me honestly...

description: >-
Total cost in USD for this run. Represents what you actually pay.
For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model.
For non-owners: only available for Pay-Per-Event actors (event costs only).
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe specify that "run non-owners"? I know, it is a bit complicated.

nullable: true
description: >-
Total cost in USD for this run. Represents what you actually pay.
For run owners: includes platform usage (compute units) and/or event costs depending on the Actor's pricing model.
Copy link
Contributor

Choose a reason for hiding this comment

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

depends on pricing model - yes - but also depends on "if you own the Actor" 😅

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I mean, this is written under "For run owners:", so the "if you own the Actor" condition is already satisfied, right?

Copy link
Contributor

@stetizu1 stetizu1 left a comment

Choose a reason for hiding this comment

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

Kept some suggestions, but overall ok 😅

janbuchar and others added 2 commits January 14, 2026 17:17
Co-authored-by: Zuzana Štětinová <40138689+stetizu1@users.noreply.github.com>
Co-authored-by: Zuzana Štětinová <40138689+stetizu1@users.noreply.github.com>
@apify-service-account
Copy link

Preview for this PR was built for commit c2af22a and is ready at https://pr-2179.preview.docs.apify.com!

1 similar comment
@apify-service-account
Copy link

Preview for this PR was built for commit c2af22a and is ready at https://pr-2179.preview.docs.apify.com!

Co-authored-by: František Nesveda <fnesveda@users.noreply.github.com>
@apify-service-account
Copy link

Preview for this PR was built for commit 9fb19a2 and is ready at https://pr-2179.preview.docs.apify.com!

@janbuchar janbuchar changed the title feat: Better describe the circumstances under which run usage infor is included in API responses feat: Better describe the circumstances under which run usage info is included in API responses Jan 15, 2026
@janbuchar janbuchar added the adhoc Ad-hoc unplanned task added during the sprint. label Jan 15, 2026
@apify-service-account
Copy link

Preview for this PR was built for commit 059a95ff and is ready at https://pr-2179.preview.docs.apify.com!

@janbuchar janbuchar merged commit d529203 into master Feb 3, 2026
14 of 24 checks passed
@janbuchar janbuchar deleted the describe-get-run-response-better branch February 3, 2026 09:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

adhoc Ad-hoc unplanned task added during the sprint. t-tooling Issues with this label are in the ownership of the tooling team.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants