Skip to content

Commit 3abf49f

Browse files
committed
Fix links to JavaDoc
1 parent 6d66489 commit 3abf49f

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ compile 'com.yubico:webauthn-server-core:1.11.0'
4141
This library uses link:https://semver.org/[semantic versioning].
4242
The public API consists of all public classes, methods and fields in the `com.yubico.webauthn` package and its subpackages,
4343
i.e., everything covered by the
44-
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/latest/com/yubico/webauthn/package-summary.html[Javadoc].
44+
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core-minimal/latest/com/yubico/webauthn/package-summary.html[Javadoc].
4545

4646
Package-private classes and methods are NOT part of the public API.
4747
The `com.yubico:yubico-util` module is NOT part of the public API.
@@ -53,7 +53,7 @@ Breaking changes to these will NOT be reflected in version numbers.
5353
In addition to the main `webauthn-server-core` module, there are also:
5454

5555
- `webauthn-server-attestation`: A simple implementation of the
56-
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/latest/com/yubico/webauthn/attestation/MetadataService.html[`MetadataService`]
56+
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core-minimal/latest/com/yubico/webauthn/attestation/MetadataService.html[`MetadataService`]
5757
interface, which by default comes preloaded with attestation metadata for Yubico devices.
5858

5959
- `webauthn-server-core-minimal`: Alternative distribution of `webauthn-server-core`,
@@ -89,7 +89,7 @@ but the authentication mechanism alone does not make a security system.
8989
== Documentation
9090

9191
See the
92-
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/latest/com/yubico/webauthn/package-summary.html[Javadoc]
92+
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core-minimal/latest/com/yubico/webauthn/package-summary.html[Javadoc]
9393
for in-depth API documentation.
9494

9595

@@ -112,7 +112,7 @@ The client side involves:
112112
For this you need some way to encode `Uint8Array` values;
113113
this guide will assume use of link:https://github.com/beatgammit/base64-js[base64-js].
114114
However the built-in parser methods for
115-
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/latest/com/yubico/webauthn/data/PublicKeyCredential.html[`PublicKeyCredential`]
115+
link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core-minimal/latest/com/yubico/webauthn/data/PublicKeyCredential.html[`PublicKeyCredential`]
116116
expect URL-safe Base64 encoding, so the below examples will include this as an additional step.
117117

118118
Example code is given below.
@@ -122,15 +122,15 @@ link:webauthn-server-demo[`webauthn-server-demo`] for a complete demo server.
122122

123123
=== 1. Implement a `CredentialRepository`
124124

125-
The link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/latest/com/yubico/webauthn/CredentialRepository.html[`CredentialRepository`] interface
125+
The link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core-minimal/latest/com/yubico/webauthn/CredentialRepository.html[`CredentialRepository`] interface
126126
abstracts your database in a database-agnostic way.
127127
The concrete implementation will be different for every project, but you can use
128128
link:https://github.com/Yubico/java-webauthn-server/blob/master/webauthn-server-demo/src/main/java/demo/webauthn/InMemoryRegistrationStorage.java[`InMemoryRegistrationStorage`]
129129
as a simple example.
130130

131131
=== 2. Instantiate a `RelyingParty`
132132

133-
The link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core/latest/com/yubico/webauthn/RelyingParty.html[`RelyingParty`] class
133+
The link:https://developers.yubico.com/java-webauthn-server/JavaDoc/webauthn-server-core-minimal/latest/com/yubico/webauthn/RelyingParty.html[`RelyingParty`] class
134134
is the main entry point to the library.
135135
You can instantiate it using its builder methods,
136136
passing in your `CredentialRepository` implementation (called `MyCredentialRepository` here) as an argument:

0 commit comments

Comments
 (0)