[DOCS-14372] Investigate changes in SERVER-56160: Exclude $setWindowFields from API Version 1 Created: 20/Apr/21  Updated: 13/Nov/23  Due: 14/May/21  Resolved: 11/May/21

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 5.0.0-rc0, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Joseph Dougherty
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-56160 Exclude $setWindowFields from API Ver... Closed
Participants:
Days since reply: 2 years, 39 weeks, 1 day ago
Epic Link: DOCSP-14217

 Description   

Description

Downstream Change Summary

Just wanted to over-communicate this change in case it surprises anyone. I don't think there's any action needed other than possibly documentation but wanted to make sure people are aware.

Description of Linked Ticket

The window functions are considered somewhat unstable while we validate with the beta program whether some of our design and semantic choices were reasonable. For example, what should the behavior be with unexpected types or null values? Or when combinations of arguments don't clearly interact well.

As one concrete example, to quote David Percy:

For range-based / time-based bounds, the sortBy field has to be a number / date, respectively. If the current document's sortBy is the wrong type, then it gets assigned 'null'. But maybe it would be clearer to throw an error instead?

We plan to add $setWindowFields to API Version 1 in the coming months as we gather some confidence on these decisions.

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Joseph Dougherty [ 11/May/21 ]

Tests confirm that $setWindowFields is not part of API V1. Closing this issue as there is nothing additional to document.

Generated at Thu Feb 08 08:10:14 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.