Skip to content

Commit a2235cc

Browse files
committed
Docs: Fix API documentation links
JAVA-3844
1 parent e6aa286 commit a2235cc

File tree

15 files changed

+20
-23
lines changed

15 files changed

+20
-23
lines changed

docs/reference/content/driver-reactive/getting-started/quick-start-primer.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,7 @@ For more information about reactive streams go to: [http://www.reactive-streams.
4545
## Subscribers
4646

4747
The MongoDB Reactive Streams Driver API mirrors the Sync driver API and any methods that cause network IO return a `Publisher<T>`,
48-
where `T` is the type of response for the operation.
49-
The exception to that rule is for methods in the async driver that return a `Void` value in the callback.
50-
In [reactive streams](http://www.reactive-streams.org) this is forbidden, so in those circumstances we
51-
return a [`Success`]({{< apiref "mongodb-driver-reactivestreams" "com/mongodb/reactivestreams/client/Success.html" >}}) on the operation.
48+
where `T` is the type of response for the operation.
5249

5350
{{% note %}}
5451
All [`Publishers`](http://www.reactive-streams.org/reactive-streams-1.0.1-javadoc/?org/reactivestreams/Publisher.html) returned

docs/reference/content/driver-reactive/tutorials/change-streams.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ In the following example the change stream prints out all changes it observes, f
101101
- First it uses a [`$match`]({{< docsref "reference/operator/aggregation/match/" >}}) stage to filter for documents where the `operationType`
102102
is either an `insert`, `update`, `replace` or `delete`.
103103

104-
- Then, it sets the `fullDocument` to [`FullDocument.UPDATE_LOOKUP`]({{< apiref "mongodb-driver-core" "com/mongodb/client/model/FullDocument.html#UPDATE_LOOKUP" >}}),
104+
- Then, it sets the `fullDocument` to [`FullDocument.UPDATE_LOOKUP`]({{< apiref "mongodb-driver-core" "com/mongodb/client/model/changestream/FullDocument.html#UPDATE_LOOKUP" >}}),
105105
so that the document after the update is included in the results.
106106

107107
```java

docs/reference/content/driver-scala/bson/macros.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Many simple Scala types are supported and they will be marshaled into their corr
3535
To create a codec for your case class use the `Macros` object helper methods. Unless there is a good reason you should use the
3636
`Macros.createCodecProvider` method to create a [`CodecProvider`]({{< apiref "bson" "org/bson/codecs/configuration/CodecProvider.html" >}}).
3737
A `CodecProvider` will pass the configured [`CodecRegistry`]({{< apiref "bson" "org/bson/codecs/configuration/CodecRegistry.html" >}}) to the
38-
underlying [`Codec`]({{< apiref "bson" "org/bson/codecs/configuration/Codec.html" >}}) and provide access to all the configured codecs.
38+
underlying [`Codec`]({{< apiref "bson" "org/bson/codecs/Codec.html" >}}) and provide access to all the configured codecs.
3939

4040
To create a `CodecProvider` all you need to do is to set the case class type when calling `createCodecProvider` like so:
4141

@@ -102,7 +102,7 @@ val personCodecProvider = Macros.createCodecProviderIgnoreNone[Person]()
102102

103103
## Alternative field names
104104

105-
The [`BsonProperty`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/bson/annotations$$BsonProperty" >}}) annotation can be used to configure a the bson
105+
The [`BsonProperty`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/bson/annotations/BsonProperty" >}}) annotation can be used to configure a the bson
106106
field key to be used for a given property. In the following example uses the `BsonProperty` annotation to change how the `firstName`
107107
property is stored:
108108

docs/reference/content/driver-scala/getting-started/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ val mongoClient: MongoClient = MongoClient(
9090
.build())
9191
```
9292

93-
- You can specify the [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/ConnectionString$.html" >}}):
93+
- You can specify the [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/package$$ConnectionString$.html" >}}):
9494

9595
```scala
9696
val mongoClient: MongoClient = MongoClient("mongodb://hostOne:27017")

docs/reference/content/driver-scala/tutorials/compression.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ the [ismaster]({{<docsref "reference/command/isMaster/" >}}) command response.
2727
import org.mongodb.scala._
2828
```
2929

30-
To specify compression with [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/ConnectionString$.html" >}}), specify `compressors` as part of the connection
30+
To specify compression with [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/package$$ConnectionString$.html" >}}), specify `compressors` as part of the connection
3131
string, as in:
3232

3333
```scala

docs/reference/content/driver-scala/tutorials/connect-to-mongodb.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,7 @@ To connect to a [replica set]({{<docsref "replication/" >}}), you must specify o
8888
MongoDB will auto-discover the primary and the secondaries.
8989
{{% /note %}}
9090

91-
- You can specify the members using a [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/ConnectionString$.html" >}}):
91+
- You can specify the members using a [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/package$$ConnectionString$.html" >}}):
9292

9393
- To specify at least two members of the replica set:
9494

@@ -122,7 +122,7 @@ or instances to a `MongoClients` create method.
122122

123123
To connect to a single `mongos` instance:
124124

125-
- You can specify the hostname and the port in a [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/ConnectionString$.html" >}})
125+
- You can specify the hostname and the port in a [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/package$$ConnectionString$.html" >}})
126126

127127
```scala
128128
val mongoClient = MongoClient( "mongodb://localhost:27017" )
@@ -136,7 +136,7 @@ val mongoClient = MongoClient()
136136

137137
To connect to multiple `mongos` instances:
138138

139-
- You can specify the [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/ConnectionString$.html" >}}) with their hostnames and ports:
139+
- You can specify the [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/package$$ConnectionString$.html" >}}) with their hostnames and ports:
140140

141141
```scala
142142
val mongoClient = MongoClient("mongodb://host1:27017,host2:27017")

docs/reference/content/driver-scala/tutorials/gridfs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ To download a file by its file `_id`, pass the `_id` to the method. The followin
128128
val downloadById = gridFSBucket.downloadToObservable(fileId).results()
129129
```
130130

131-
If you don't know the `_id` of the file but know the filename, then you can pass the filename to the [`downloadToObservable`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/gridfs/GridFSBucket.html#downloadToObservable(filename:String,options:org.mongodb.scala.gridfs.GridFSDownloadOptions):org.mongodb.scala.gridfs.GridFSDownloadObservable" >}}) method. By default, it will download the latest version of the file. Use the [`GridFSDownloadOptions`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/gridfs/model/GridFSDownloadOptions.html" >}}) to configure which version to download.
131+
If you don't know the `_id` of the file but know the filename, then you can pass the filename to the [`downloadToObservable`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/gridfs/GridFSBucket.html#downloadToObservable(filename:String,options:org.mongodb.scala.gridfs.GridFSDownloadOptions):org.mongodb.scala.gridfs.GridFSDownloadObservable" >}}) method. By default, it will download the latest version of the file. Use the [`GridFSDownloadOptions`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/gridfs/model/index.html#GridFSDownloadOptions=com.mongodb.client.gridfs.model.GridFSDownloadOptions" >}}) to configure which version to download.
132132

133133
The following example downloads the original version of the file named "mongodb-tutorial":
134134

docs/reference/content/driver-scala/tutorials/indexes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ pre = "<i class='fa'></i>"
1313
[Indexes]({{<docsref "indexes" >}}) support the efficient execution of queries in MongoDB. To create an [index]({{<docsref "indexes" >}}) on a field or fields, pass an index specification document to the [`MongoCollection.createIndex()`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/MongoCollection.html#createIndex(key:org.mongodb.scala.bson.conversions.Bson,options:org.mongodb.scala.model.IndexOptions):org.mongodb.scala.SingleObservable[String]" >}}) method.
1414

1515
The MongoDB Scala Driver provides
16-
the [`Indexes`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/model/Indexes.html" >}}) class that
16+
the [`Indexes`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/model/Indexes$.html" >}}) class that
1717
includes helper methods to create index specification
1818
documents for the various MongoDB Index key types.
1919

docs/reference/content/driver-scala/tutorials/perform-read-operations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ For read operations on [replica sets]({{<docsref "replication/" >}}) or [sharded
171171
.build())
172172
```
173173

174-
- Via [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/ConnectionString$.html" >}}), as in the following example:
174+
- Via [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/package$$ConnectionString$.html" >}}), as in the following example:
175175

176176
```scala
177177
val mongoClient = MongoClient("mongodb://host1:27017,host2:27017/?readPreference=secondary")
@@ -214,7 +214,7 @@ For read operations on [replica sets]({{<docsref "replication/" >}}) or [sharded
214214
.build())
215215
```
216216

217-
- Via [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/ConnectionString$.html" >}}), as in the following example:
217+
- Via [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/package$$ConnectionString$.html" >}}), as in the following example:
218218

219219
```scala
220220
val mongoClient = MongoClient("mongodb://host1:27017,host2:27017/?readConcernLevel=majority")

docs/reference/content/driver-scala/tutorials/perform-write-operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,7 @@ Applications can configure [write concern]({{<docsref "reference/write-concern"
260260
.build())
261261
```
262262

263-
- Via [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/ConnectionString$.html" >}}), as in the following example:
263+
- Via [`ConnectionString`]({{< apiref "mongo-scala-driver" "org/mongodb/scala/package$$ConnectionString$.html" >}}), as in the following example:
264264

265265
```scala
266266
val mongoClientt = MongoClient("mongodb://host1:27017,host2:27017/?w=majority")

0 commit comments

Comments
 (0)