<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 05:36:29 UTC 2024

It is possible to restrict the fields that are returned in this document by specifying the 'field' parameter in your request.
For example, to request only the issue key and summary append 'field=key&field=summary' to the URL of your request.
-->
<rss version="0.92" >
<channel>
    <title>MongoDB Jira</title>
    <link>https://jira.mongodb.org</link>
    <description>This file is an XML representation of an issue</description>
    <language>en-us</language>    <build-info>
        <version>9.7.1</version>
        <build-number>970001</build-number>
        <build-date>13-04-2023</build-date>
    </build-info>


<item>
            <title>[SERVER-55444] APIStrictError should describe how to migrate from unversioned APIs</title>
                <link>https://jira.mongodb.org/browse/SERVER-55444</link>
                <project id="10000" key="SERVER">Core Server</project>
                    <description>&lt;p&gt;When a client tries to use a feature that&apos;s not in API Version 1, if the client passes&#160;apiVersion: &quot;1&quot; and apiStrict: true, the server replies with APIStrictError. In as many cases as possible, let&apos;s accompany the error with a message describing how to migrate to the Versioned API. E.g., when &quot;mapreduce&quot; returns APIStrictError, it should say, &quot;Use aggregate instead&quot;, and link to the docs. Ideally, there is a page in the docs that helps users rewrite their mapreduce jobs as aggregations.&lt;/p&gt;

&lt;p&gt;Similar for &quot;distinct&quot; (if we choose not to include it in Version 1), and other unversioned APIs with versioned alternatives.&lt;/p&gt;</description>
                <environment></environment>
        <key id="1656332">SERVER-55444</key>
            <summary>APIStrictError should describe how to migrate from unversioned APIs</summary>
                <type id="4" iconUrl="https://jira.mongodb.org/secure/viewavatar?size=xsmall&amp;avatarId=14710&amp;avatarType=issuetype">Improvement</type>
                                            <priority id="3" iconUrl="https://jira.mongodb.org/images/icons/priorities/major.svg">Major - P3</priority>
                        <status id="6" iconUrl="https://jira.mongodb.org/images/icons/statuses/closed.png" description="The issue is considered finished, the resolution is correct. Issues which are closed can be reopened.">Closed</status>
                    <statusCategory id="3" key="done" colorName="success"/>
                                    <resolution id="13201">Fixed</resolution>
                                        <assignee username="maddie.zechar@mongodb.com">Maddie Zechar</assignee>
                                    <reporter username="jesse@mongodb.com">A. Jesse Jiryu Davis</reporter>
                        <labels>
                    </labels>
                <created>Tue, 23 Mar 2021 14:28:18 +0000</created>
                <updated>Sun, 29 Oct 2023 21:55:53 +0000</updated>
                            <resolved>Mon, 28 Jun 2021 14:55:55 +0000</resolved>
                                                    <fixVersion>5.0.0-rc5</fixVersion>
                    <fixVersion>5.1.0-rc0</fixVersion>
                                    <component>Query Language</component>
                                        <votes>0</votes>
                                    <watches>5</watches>
                                                                                                                <comments>
                            <comment id="4108270" author="JIRAUSER1259052" created="Wed, 6 Oct 2021 19:02:07 +0000"  >&lt;p&gt;Updating the fixversion since branching activities occurred yesterday. This ticket will be in rc0 when it&#8217;s been triggered. For more active release information, please keep an eye on #server-release. Thank you!&lt;/p&gt;</comment>
                            <comment id="3900720" author="xgen-internal-githook" created="Fri, 25 Jun 2021 15:31:52 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Maddie Zechar&apos;, &apos;email&apos;: &apos;mez2113@columbia.edu&apos;, &apos;username&apos;: &apos;madelinezec&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/SERVER-55444&quot; title=&quot;APIStrictError should describe how to migrate from unversioned APIs&quot; class=&quot;issue-link&quot; data-issue-key=&quot;SERVER-55444&quot;&gt;&lt;del&gt;SERVER-55444&lt;/del&gt;&lt;/a&gt;: APIStrictError directs user to docs for migration suggestions&lt;br/&gt;
Branch: v5.0&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo/commit/9d535c51e86246b21a2ca3f36fcde418020c40e4&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo/commit/9d535c51e86246b21a2ca3f36fcde418020c40e4&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="3899142" author="xgen-internal-githook" created="Thu, 24 Jun 2021 22:50:40 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Maddie Zechar&apos;, &apos;email&apos;: &apos;mez2113@columbia.edu&apos;, &apos;username&apos;: &apos;madelinezec&apos;}
&lt;p&gt;Message: &lt;a href=&quot;https://jira.mongodb.org/browse/SERVER-55444&quot; title=&quot;APIStrictError should describe how to migrate from unversioned APIs&quot; class=&quot;issue-link&quot; data-issue-key=&quot;SERVER-55444&quot;&gt;&lt;del&gt;SERVER-55444&lt;/del&gt;&lt;/a&gt;: APIStrictError directs user to docs for migration suggestions&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo/commit/30be200dfcf31bf49073fafe322a2d4998266253&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo/commit/30be200dfcf31bf49073fafe322a2d4998266253&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="3892276" author="maddie.zechar" created="Tue, 22 Jun 2021 18:42:54 +0000"  >&lt;p&gt;hi &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=ethan.zhang&quot; class=&quot;user-hover&quot; rel=&quot;ethan.zhang&quot;&gt;ethan.zhang&lt;/a&gt;&lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=jesse&quot; class=&quot;user-hover&quot; rel=&quot;jesse&quot;&gt;jesse&lt;/a&gt;, we have shared this with Pawel who is on board with this approach. The server manual writers are prepared to add information on unsupported commands, supported migrations to their existing, centralized API version 1 doc, once they get that info from us. We should have a better idea of who will gather this information and a &quot;due date&quot; for sharing it with the writers in the next couple of days. &lt;/p&gt;</comment>
                            <comment id="3886239" author="jesse" created="Fri, 18 Jun 2021 01:12:30 +0000"  >&lt;p&gt;Right, for certain commands where there is a clear migration path, such as migrating from mapreduce to aggregate, this ticket is my request that we provide command-specific migration instructions.&lt;/p&gt;</comment>
                            <comment id="3885708" author="JIRAUSER1257640" created="Thu, 17 Jun 2021 19:16:45 +0000"  >&lt;p&gt;I feel it will be nice to have. I vaguely remember this was brought up in some meetings.&lt;/p&gt;</comment>
                            <comment id="3885688" author="maddie.zechar" created="Thu, 17 Jun 2021 19:10:20 +0000"  >&lt;p&gt;another follow up question for &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=ethan.zhang&quot; class=&quot;user-hover&quot; rel=&quot;ethan.zhang&quot;&gt;ethan.zhang&lt;/a&gt; &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=ana.meza&quot; class=&quot;user-hover&quot; rel=&quot;ana.meza&quot;&gt;ana.meza&lt;/a&gt; &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=jesse&quot; class=&quot;user-hover&quot; rel=&quot;jesse&quot;&gt;jesse&lt;/a&gt;: currently, the server manual has a single, centralized page detailing the commands supported in API Version 1 and how to use them. You can see it here: &lt;a href=&quot;https://docs.mongodb.com/v5.0/reference/versioned-api/#api-v1-commands&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://docs.mongodb.com/v5.0/reference/versioned-api/#api-v1-commands&lt;/a&gt; &lt;/p&gt;

&lt;p&gt;Is this sufficient? Or do we also want information on commands not supported in API Version 1, how to migrate (eg use aggregate instead of map reduce), or some information on the APIStrictError ? cc &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=jeffrey.allen&quot; class=&quot;user-hover&quot; rel=&quot;jeffrey.allen&quot;&gt;jeffrey.allen&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="3885650" author="maddie.zechar" created="Thu, 17 Jun 2021 18:57:56 +0000"  >&lt;p&gt;That makes sense &lt;a href=&quot;https://jira.mongodb.org/secure/ViewProfile.jspa?name=jesse&quot; class=&quot;user-hover&quot; rel=&quot;jesse&quot;&gt;jesse&lt;/a&gt;! I apologize for all the pings. I wanted to correct my comment after reading the doc a little more. &lt;/p&gt;

&lt;p&gt;Jacob and I want to confirm the commands not supported in version 1. The doc mentions that any commands not listed are not supported in API Version 1. Is there a list somewhere (of all mongo commands) that Jacob and I could refer to, so we could cross reference it with the commands that are supported (and deduce from that a complete list of all commands not supported)? &lt;/p&gt;</comment>
                            <comment id="3885447" author="jesse" created="Thu, 17 Jun 2021 17:48:07 +0000"  >&lt;p&gt;If the user calls distinct (etc) with apiStrict: true the command fails with an error message every time, and the error message is returned to the user. So, I opened this ticket to propose that the error message (which must be returned 100% of the time) provide instructions to fix the user&#8217;s mistake.&lt;/p&gt;

&lt;p&gt;Logging to the log file, in contrast, COULD be reduced to a fraction of the times this error occurs. But this error should be rare (it&#8217;s a user mistake, they&#8217;ll discover it in testing and correct it immediately) so on second thought let&#8217;s do nothing special about rate-limiting the log message. &lt;/p&gt;</comment>
                            <comment id="3885410" author="jesse" created="Thu, 17 Jun 2021 17:31:56 +0000"  >&lt;p&gt;I&#8217;m not sure what you mean by &#8220;log to the user&#8221;. Every error returned in the command reply should include an informative message. I think it should be logged to the log file as often as other command errors due to user mistakes. Eg however often we log &#8220;unrecognized operator&#8221; or &#8220;unrecognized command name&#8221;, this error is comparable. &lt;/p&gt;</comment>
                            <comment id="3844933" author="jacob.evans" created="Thu, 27 May 2021 15:01:45 +0000"  >&lt;p&gt;We should avoid producing messages here for the commands covered by deprecation messages as part of PM-2251.&lt;/p&gt;</comment>
                            <comment id="3682296" author="jesse" created="Wed, 24 Mar 2021 19:18:54 +0000"  >&lt;p&gt;Those all sound like reasonable ideas to me!&lt;/p&gt;</comment>
                            <comment id="3679342" author="JIRAUSER1257640" created="Tue, 23 Mar 2021 15:11:10 +0000"  >&lt;p&gt;Can this be handled in idl in a more generic way?&lt;/p&gt;

&lt;p&gt;Should we pass this to the docs team to create some messages first?&lt;/p&gt;

&lt;p&gt;Instead of giving customized suggestions for each feature, can we create a centralized doc page and just provide a link to this page in the error message?&lt;/p&gt;</comment>
                            <comment id="3679333" author="JIRAUSER1257467" created="Tue, 23 Mar 2021 15:09:35 +0000"  >&lt;p&gt;We think this is just a matter of documentation and should probably not involve code changes, passing over to QO to take a look&lt;/p&gt;</comment>
                    </comments>
                <issuelinks>
                            <issuelinktype id="10420">
                    <name>Backports</name>
                                            <outwardlinks description="backported by">
                                                        </outwardlinks>
                                                        </issuelinktype>
                            <issuelinktype id="10012">
                    <name>Related</name>
                                                                <inwardlinks description="is related to">
                                                        </inwardlinks>
                                    </issuelinktype>
                    </issuelinks>
                <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                <customfield id="customfield_10050" key="com.atlassian.jira.toolkit:comments">
                        <customfieldname># Replies</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>14.0</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_18555" key="com.onresolve.jira.groovy.groovyrunner:scripted-field">
                        <customfieldname># of Sprints</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2.0</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                <customfield id="customfield_12450" key="com.atlassian.jira.plugin.system.customfieldtypes:multicheckboxes">
                        <customfieldname>Backport Requested</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="21777"><![CDATA[v5.0]]></customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10011" key="com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons">
                        <customfieldname>Backwards Compatibility</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="10038"><![CDATA[Fully Compatible]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_10055" key="com.atlassian.jira.ext.charting:firstresponsedate">
                        <customfieldname>Date of 1st Reply</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>Tue, 23 Mar 2021 15:09:35 +0000</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10052" key="com.atlassian.jira.toolkit:dayslastcommented">
                        <customfieldname>Days since reply</customfieldname>
                        <customfieldvalues>
                                        2 years, 18 weeks ago
    
                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_18254" key="com.onresolve.jira.groovy.groovyrunner:scripted-field">
                        <customfieldname>Dependencies</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue><![CDATA[]]></customfieldvalue>


                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_15850" key="com.atlassian.jira.plugins.jira-development-integration-plugin:devsummary">
                        <customfieldname>Development</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                        <customfield id="customfield_17050" key="com.atlassian.jira.plugin.system.customfieldtypes:radiobuttons">
                        <customfieldname>Downstream Team Attention</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue key="16941"><![CDATA[Not Needed]]></customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_10057" key="com.atlassian.jira.toolkit:lastusercommented">
                        <customfieldname>Last comment by Customer</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>true</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_10056" key="com.atlassian.jira.toolkit:lastupdaterorcommenter">
                        <customfieldname>Last commenter</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>luke.bonanomi@mongodb.com</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_11151" key="com.atlassian.jira.toolkit:LastCommentDate">
                        <customfieldname>Last public comment date</customfieldname>
                        <customfieldvalues>
                            2 years, 18 weeks ago
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                    <customfield id="customfield_10051" key="com.atlassian.jira.toolkit:participants">
                        <customfieldname>Participants</customfieldname>
                        <customfieldvalues>
                                        <customfieldvalue>jesse@mongodb.com</customfieldvalue>
            <customfieldvalue>ana.meza@mongodb.com</customfieldvalue>
            <customfieldvalue>ethan.zhang@mongodb.com</customfieldvalue>
            <customfieldvalue>xgen-internal-githook</customfieldvalue>
            <customfieldvalue>jacob.evans@mongodb.com</customfieldvalue>
            <customfieldvalue>maddie.zechar@mongodb.com</customfieldvalue>
            <customfieldvalue>vivian.ge@mongodb.com</customfieldvalue>
    
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_14254" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Product Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hz0qn3:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                <customfield id="customfield_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hylxun:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                <customfield id="customfield_10558" key="com.pyxis.greenhopper.jira:gh-global-rank">
                        <customfieldname>Rank (Obsolete)</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>9223372036854775807</customfieldvalue>
                        </customfieldvalues>
                    </customfield>
                                                                                            <customfield id="customfield_23361" key="com.onresolve.jira.groovy.groovyrunner:scripted-field">
                        <customfieldname>Requested By</customfieldname>
                        <customfieldvalues>
                                

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                        <customfield id="customfield_10557" key="com.pyxis.greenhopper.jira:gh-sprint">
                        <customfieldname>Sprint</customfieldname>
                        <customfieldvalues>
                                <customfieldvalue id="4702">Query Optimization 2021-05-17</customfieldvalue>
    <customfieldvalue id="4708">Query Optimization 2021-06-28</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                            <customfield id="customfield_10053" key="com.atlassian.jira.ext.charting:timeinstatus">
                        <customfieldname>Time In Status</customfieldname>
                        <customfieldvalues>
                            
                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                        <customfield id="customfield_22870" key="com.onresolve.jira.groovy.groovyrunner:scripted-field">
                        <customfieldname>Triagers</customfieldname>
                        <customfieldvalues>
                                

                        </customfieldvalues>
                    </customfield>
                                                                                                                                                                                                                                                                                                                                                                                    <customfield id="customfield_14350" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>serverRank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>1|hz0cw7:</customfieldvalue>

                        </customfieldvalues>
                    </customfield>
                                    </customfields>
    </item>
</channel>
</rss>