Skip to content

docs(OPTI-2846): clarify stopDate is exclusive in analytics API documentation#658

Merged
craig-johnston merged 1 commit into
mainfrom
devin/OPTI-2846-stopdate-exclusive-docs
May 21, 2026
Merged

docs(OPTI-2846): clarify stopDate is exclusive in analytics API documentation#658
craig-johnston merged 1 commit into
mainfrom
devin/OPTI-2846-stopdate-exclusive-docs

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

Summary

Updates the Millicast analytics conceptual guide (millicast/analytics/index.md) to explicitly clarify that the stopDate parameter is exclusive.

Two changes:

  1. Added a sentence after the date format explanation: "Note that stopDate is exclusive: data is returned for the period starting from startDate up to but not including stopDate."
  2. Updated the January query example explanation to: "Because stopDate is exclusive, this query returns the total bandwidth usage for the month of January 2021 only — data for February 1st is not included in the results."

Jira: OPTI-2846

Review & Testing Checklist for Human

  • Verify the updated wording reads naturally in the rendered documentation page
  • Confirm the explanation accurately reflects the actual API behavior

Notes

Companion PR for the OpenAPI schema description update is in millicast/Millicast.DashApi.

Link to Devin session: https://dolby.devinenterprise.com/sessions/17a9f76a21f4472e880eff1d16301056
Requested by: @craig-johnston

…entation

Co-Authored-By: craig.johnston <cjohn@dolby.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 21, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-05-21 23:43 UTC

Copy link
Copy Markdown
Contributor Author

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

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

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@craig-johnston craig-johnston marked this pull request as ready for review May 21, 2026 23:42
@craig-johnston craig-johnston requested a review from a team as a code owner May 21, 2026 23:42
@craig-johnston craig-johnston merged commit 7ba95a3 into main May 21, 2026
4 checks passed
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.

1 participant