<!-- 
RSS generated by JIRA (9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66) at Thu Feb 08 09:00:28 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>[JAVA-3803] API docs are confusing</title>
                <link>https://jira.mongodb.org/browse/JAVA-3803</link>
                <project id="10006" key="JAVA">Java Driver</project>
                    <description>&lt;p&gt;Currently it&apos;s very difficult to find the API documentation for any types from mongod-driver-core.  They are published (e.g. at &lt;a href=&quot;http://mongodb.github.io/mongo-java-driver/4.1/apidocs/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://mongodb.github.io/mongo-java-driver/4.1/apidocs/&lt;/a&gt;), but there is no direct link to that, so the only way to get to these types is via links from one of the top-level drivers (e.g. &lt;a href=&quot;http://mongodb.github.io/mongo-java-driver/4.1/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#countDocuments(com.mongodb.client.ClientSession,org.bson.conversions.Bson,com.mongodb.client.model.CountOptions&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://mongodb.github.io/mongo-java-driver/4.1/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#countDocuments(com.mongodb.client.ClientSession,org.bson.conversions.Bson,com.mongodb.client.model.CountOptions&lt;/a&gt;)).  And some classes don&apos;t have any direct links to them, e.g. most of the exception types.  So they are very difficult to find as a result. &lt;/p&gt;

&lt;p&gt;A couple of options to consider:&lt;/p&gt;

&lt;ol&gt;
	&lt;li&gt;Just add a link to the mongodb-driver-core API docs to &lt;a href=&quot;http://mongodb.github.io/mongo-java-driver/4.1/apidocs/&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;http://mongodb.github.io/mongo-java-driver/4.1/apidocs/&lt;/a&gt;&lt;/li&gt;
	&lt;li&gt;Add the shared types to each of the top-level driver API docs.  So there would be four copies of all the shared types published, but they would at least be easy to find from each of the top-level drivers.&lt;/li&gt;
&lt;/ol&gt;
</description>
                <environment></environment>
        <key id="1426460">JAVA-3803</key>
            <summary>API docs are confusing</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="ross@mongodb.com">Ross Lawley</assignee>
                                    <reporter username="jeff.yemin@mongodb.com">Jeffrey Yemin</reporter>
                        <labels>
                    </labels>
                <created>Mon, 3 Aug 2020 12:53:16 +0000</created>
                <updated>Sat, 28 Oct 2023 11:21:36 +0000</updated>
                            <resolved>Mon, 24 Aug 2020 15:15:45 +0000</resolved>
                                                    <fixVersion>4.1.0</fixVersion>
                                    <component>Documentation</component>
                                        <votes>2</votes>
                                    <watches>4</watches>
                                                                                                                <comments>
                            <comment id="3355294" author="xgen-internal-githook" created="Mon, 24 Aug 2020 15:16:29 +0000"  >&lt;p&gt;Author:&lt;/p&gt;
{&apos;name&apos;: &apos;Ross Lawley&apos;, &apos;email&apos;: &apos;ross.lawley@gmail.com&apos;, &apos;username&apos;: &apos;rozza&apos;}
&lt;p&gt;Message: Docs: Added a link to the shared core (#564)&lt;/p&gt;

&lt;p&gt;&lt;a href=&quot;https://jira.mongodb.org/browse/JAVA-3803&quot; title=&quot;API docs are confusing&quot; class=&quot;issue-link&quot; data-issue-key=&quot;JAVA-3803&quot;&gt;&lt;del&gt;JAVA-3803&lt;/del&gt;&lt;/a&gt;&lt;br/&gt;
Branch: master&lt;br/&gt;
&lt;a href=&quot;https://github.com/mongodb/mongo-java-driver/commit/a3f1e2efa456d87fad2f582d8c568aa2ae86718b&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-java-driver/commit/a3f1e2efa456d87fad2f582d8c568aa2ae86718b&lt;/a&gt;&lt;/p&gt;</comment>
                            <comment id="3344652" author="ross@10gen.com" created="Tue, 18 Aug 2020 10:26:17 +0000"  >&lt;p&gt;PR: &lt;a href=&quot;https://github.com/mongodb/mongo-java-driver/pull/564&quot; class=&quot;external-link&quot; target=&quot;_blank&quot; rel=&quot;nofollow noopener&quot;&gt;https://github.com/mongodb/mongo-java-driver/pull/564&lt;/a&gt;&lt;/p&gt;</comment>
                    </comments>
                    <attachments>
                    </attachments>
                <subtasks>
                    </subtasks>
                <customfields>
                                                                                                                                                                                                                                                    <customfield id="customfield_13552" key="com.go2group.jira.plugin.crm:crm_generic_field">
                        <customfieldname>Case</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue><![CDATA[[5002K00000pCPugQAG]]]></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_12550" key="com.pyxis.greenhopper.jira:gh-lexo-rank">
                        <customfieldname>Rank</customfieldname>
                        <customfieldvalues>
                            <customfieldvalue>2|hr6tdz:</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>
                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            </customfields>
    </item>
</channel>
</rss>