Skip to content

Fix broken/outdated links #4704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JakeWharton merged 1 commit into from
Jul 18, 2026
Merged

Fix broken/outdated links #4704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 52 additions & 52 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Change Log

## [Unreleased]
[Unreleased]: https://github.com/square/retrofit/compare/3.0.0...HEAD
[Unreleased]: https://github.com/lysine-dev/retrofit/compare/3.0.0...HEAD

**New**

Expand All @@ -19,7 +19,7 @@


## [3.0.0] - 2025-05-15
[3.0.0]: https://github.com/square/retrofit/releases/tag/3.0.0
[3.0.0]: https://github.com/lysine-dev/retrofit/releases/tag/3.0.0

**Changed**

Expand All @@ -33,7 +33,7 @@ This means libraries compiled against 2.x can still be used with the 3.x version


## [2.12.0] - 2025-05-15
[2.12.0]: https://github.com/square/retrofit/releases/tag/2.12.0
[2.12.0]: https://github.com/lysine-dev/retrofit/releases/tag/2.12.0

**New**

Expand Down Expand Up @@ -78,7 +78,7 @@ This means libraries compiled against 2.x can still be used with the 3.x version
- `@Header`, `@Headers`, and `@HeaderMap` can now set non-ASCII values through the `allowUnsafeNonAsciiValues` annotation property. These are not technically compliant with the HTTP specification, but are often supported or required by services.
- Publish a BOM of all modules. The Maven coordinates are `com.squareup.retrofit2:retrofit-bom`.
- `Invocation` now exposes the service `Class<?>` and the instance on which the method was invoked. This disambiguates the source when service inheritence is used.
- A response type keeper annotation processor is now available for generating shrinker rules for all referenced types in your service interface. In some cases, it's impossible for static shrinker rules to keep the entirety of what Retrofit needs at runtime. This annotation processor generates those additional rules. For more info see [its README](https://github.com/square/retrofit/tree/trunk/retrofit-response-type-keeper#readme).
- A response type keeper annotation processor is now available for generating shrinker rules for all referenced types in your service interface. In some cases, it's impossible for static shrinker rules to keep the entirety of what Retrofit needs at runtime. This annotation processor generates those additional rules. For more info see [its README](https://github.com/lysine-dev/retrofit/tree/trunk/retrofit-response-type-keeper#readme).

**Changed**
- Add shrinker rules to retain the generic signatures of built-in types (`Call`, `Response`, etc.) which are used via reflection at runtime.
Expand Down Expand Up @@ -141,7 +141,7 @@ This means libraries compiled against 2.x can still be used with the 3.x version
**This release changes the minimum requirements to Java 8+ or Android 5+.**
See [this blog post](https://cashapp.github.io/2019-02-05/okhttp-3-13-requires-android-5) for more information on the change.

* New: Upgrade to OkHttp 3.14.4. Please see [its changelog for 3.x](https://square.github.io/okhttp/changelog_3x/).
* New: Upgrade to OkHttp 3.14.4. Please see [its changelog for 3.x](https://lysine.dev/okhttp/changelog_3x/).
* Fix: Allow service interfaces to extend other interfaces.
* Fix: Ensure a non-null body is returned by `Response.error`.

Expand Down Expand Up @@ -184,7 +184,7 @@ See [this blog post](https://cashapp.github.io/2019-02-05/okhttp-3-13-requires-a
You can also return `Response<User>` for access to the response metadata.

Currently this integration only supports non-null response body types. Follow
[issue 3075](https://github.com/square/retrofit/issues/3075) for nullable type support.
[issue 3075](https://github.com/lysine-dev/retrofit/issues/3075) for nullable type support.

* New: **`@Tag`** parameter annotation for setting tags on the underlying OkHttp `Request` object. These can be read
in `CallAdapter`s or OkHttp `Interceptor`s for tracing, analytics, varying behavior, and more.
Expand Down Expand Up @@ -604,7 +604,7 @@ Changes from beta 4:
* Fix: Support empty HTTP response status reason.
* If an `ErrorHandler` is supplied it will be invoked for `Callback` and `Observable` methods.
* HTTP `PATCH` method using `HttpUrlConnection` is no longer supported. Add the
[OkHttp](https://square.github.io/okhttp) jar to your project if you need this behavior.
[OkHttp](https://lysine.dev/okhttp) jar to your project if you need this behavior.
* Custom `Client` implementations should no longer set `Content-Type` or `Content-Length` headers
based on the `TypedInput` body of the `Request`. These headers will now be added automatically
as part of the standard `Request` header list.
Expand Down Expand Up @@ -711,49 +711,49 @@ Initial release.



[2.11.0]: https://github.com/square/retrofit/releases/tag/2.11.0
[2.10.0]: https://github.com/square/retrofit/releases/tag/2.10.0
[2.9.0]: https://github.com/square/retrofit/releases/tag/2.9.0
[2.8.2]: https://github.com/square/retrofit/releases/tag/2.8.2
[2.8.1]: https://github.com/square/retrofit/releases/tag/parent-2.8.1
[2.8.0]: https://github.com/square/retrofit/releases/tag/parent-2.8.0
[2.7.2]: https://github.com/square/retrofit/releases/tag/parent-2.7.2
[2.7.1]: https://github.com/square/retrofit/releases/tag/parent-2.7.1
[2.7.0]: https://github.com/square/retrofit/releases/tag/parent-2.7.0
[2.6.4]: https://github.com/square/retrofit/releases/tag/parent-2.6.4
[2.6.3]: https://github.com/square/retrofit/releases/tag/parent-2.6.3
[2.6.2]: https://github.com/square/retrofit/releases/tag/parent-2.6.2
[2.6.1]: https://github.com/square/retrofit/releases/tag/parent-2.6.1
[2.6.0]: https://github.com/square/retrofit/releases/tag/parent-2.6.0
[2.5.0]: https://github.com/square/retrofit/releases/tag/parent-2.5.0
[2.4.0]: https://github.com/square/retrofit/releases/tag/parent-2.4.0
[2.3.0]: https://github.com/square/retrofit/releases/tag/parent-2.3.0
[2.2.0]: https://github.com/square/retrofit/releases/tag/parent-2.2.0
[2.1.0]: https://github.com/square/retrofit/releases/tag/parent-2.1.0
[2.0.2]: https://github.com/square/retrofit/releases/tag/parent-2.0.2
[2.0.1]: https://github.com/square/retrofit/releases/tag/parent-2.0.1
[2.0.0]: https://github.com/square/retrofit/releases/tag/parent-2.0.0
[2.0.0-beta4]: https://github.com/square/retrofit/releases/tag/parent-2.0.0-beta4
[2.0.0-beta3]: https://github.com/square/retrofit/releases/tag/parent-2.0.0-beta3
[2.0.0-beta2]: https://github.com/square/retrofit/releases/tag/parent-2.0.0-beta2
[2.0.0-beta1]: https://github.com/square/retrofit/releases/tag/parent-2.0.0-beta1
[1.9.0]: https://github.com/square/retrofit/releases/tag/parent-1.9.0
[1.8.0]: https://github.com/square/retrofit/releases/tag/parent-1.8.0
[1.7.1]: https://github.com/square/retrofit/releases/tag/parent-1.7.1
[1.7.0]: https://github.com/square/retrofit/releases/tag/parent-1.7.0
[1.6.1]: https://github.com/square/retrofit/releases/tag/parent-1.6.1
[1.6.0]: https://github.com/square/retrofit/releases/tag/parent-1.6.0
[1.5.1]: https://github.com/square/retrofit/releases/tag/parent-1.5.1
[1.5.0]: https://github.com/square/retrofit/releases/tag/parent-1.5.0
[1.4.1]: https://github.com/square/retrofit/releases/tag/parent-1.4.1
[1.4.0]: https://github.com/square/retrofit/releases/tag/parent-1.4.0
[1.3.0]: https://github.com/square/retrofit/releases/tag/parent-1.3.0
[1.2.2]: https://github.com/square/retrofit/releases/tag/parent-1.2.2
[1.2.1]: https://github.com/square/retrofit/releases/tag/parent-1.2.1
[1.2.0]: https://github.com/square/retrofit/releases/tag/parent-1.2.0
[1.1.1]: https://github.com/square/retrofit/releases/tag/parent-1.1.1
[1.1.0]: https://github.com/square/retrofit/releases/tag/parent-1.1.0
[1.0.2]: https://github.com/square/retrofit/releases/tag/parent-1.0.2
[1.0.1]: https://github.com/square/retrofit/releases/tag/parent-1.0.1
[1.0.0]: https://github.com/square/retrofit/releases/tag/parent-1.0.0
[2.11.0]: https://github.com/lysine-dev/retrofit/releases/tag/2.11.0
[2.10.0]: https://github.com/lysine-dev/retrofit/releases/tag/2.10.0
[2.9.0]: https://github.com/lysine-dev/retrofit/releases/tag/2.9.0
[2.8.2]: https://github.com/lysine-dev/retrofit/releases/tag/2.8.2
[2.8.1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.8.1
[2.8.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.8.0
[2.7.2]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.7.2
[2.7.1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.7.1
[2.7.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.7.0
[2.6.4]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.6.4
[2.6.3]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.6.3
[2.6.2]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.6.2
[2.6.1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.6.1
[2.6.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.6.0
[2.5.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.5.0
[2.4.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.4.0
[2.3.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.3.0
[2.2.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.2.0
[2.1.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.1.0
[2.0.2]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.0.2
[2.0.1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.0.1
[2.0.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.0.0
[2.0.0-beta4]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.0.0-beta4
[2.0.0-beta3]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.0.0-beta3
[2.0.0-beta2]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.0.0-beta2
[2.0.0-beta1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-2.0.0-beta1
[1.9.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.9.0
[1.8.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.8.0
[1.7.1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.7.1
[1.7.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.7.0
[1.6.1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.6.1
[1.6.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.6.0
[1.5.1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.5.1
[1.5.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.5.0
[1.4.1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.4.1
[1.4.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.4.0
[1.3.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.3.0
[1.2.2]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.2.2
[1.2.1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.2.1
[1.2.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.2.0
[1.1.1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.1.1
[1.1.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.1.0
[1.0.2]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.0.2
[1.0.1]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.0.1
[1.0.0]: https://github.com/lysine-dev/retrofit/releases/tag/parent-1.0.0
[maven_provided]: https://maven.apache.org/guides/introduction/introduction-to-dependency-mechanism.html
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ License
limitations under the License.


[1]: https://square.github.io/retrofit/
[1]: https://lysine.dev/retrofit/
[2]: https://search.maven.org/remote_content?g=com.squareup.retrofit2&a=retrofit&v=LATEST
[snap]: https://s01.oss.sonatype.org/content/repositories/snapshots/
[proguard file]: https://github.com/square/retrofit/blob/master/retrofit/src/main/resources/META-INF/proguard/retrofit2.pro
[okhttp proguard]: https://square.github.io/okhttp/r8_proguard/
[okio proguard]: https://square.github.io/okio/#r8-proguard
[proguard file]: https://github.com/lysine-dev/retrofit/blob/master/retrofit/src/main/resources/META-INF/proguard/retrofit2.pro
[okhttp proguard]: https://lysine.dev/okhttp/r8_proguard/
[okio proguard]: https://lysine.dev/okio/#r8-proguard
8 changes: 4 additions & 4 deletions gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
GROUP=com.squareup.retrofit2
VERSION_NAME=3.1.0-SNAPSHOT

POM_URL=https://github.com/square/retrofit
POM_SCM_URL=https://github.com/square/retrofit/
POM_SCM_CONNECTION=scm:git:git://github.com/square/retrofit.git
POM_SCM_DEV_CONNECTION=scm:git:ssh://git@github.com/square/retrofit.git
POM_URL=https://github.com/lysine-dev/retrofit
POM_SCM_URL=https://github.com/lysine-dev/retrofit/
POM_SCM_CONNECTION=scm:git:git://github.com/lysine-dev/retrofit.git
POM_SCM_DEV_CONNECTION=scm:git:ssh://git@github.com/lysine-dev/retrofit.git

POM_LICENCE_NAME=The Apache Software License, Version 2.0
POM_LICENCE_URL=https://www.apache.org/licenses/LICENSE-2.0.txt
Expand Down
2 changes: 1 addition & 1 deletion retrofit-converters/simplexml/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Deprecated – Please switch to the JAXB Converter
------------------------------------------------

The Simple XML project is no longer maintained. We recommend switching to the
[JAXB converter](https://github.com/square/retrofit/tree/master/retrofit-converters/jaxb).
[JAXB converter](https://github.com/lysine-dev/retrofit/tree/master/retrofit-converters/jaxb).

-----

Expand Down
8 changes: 4 additions & 4 deletions retrofit/src/main/java/retrofit2/Retrofit.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -597,12 +597,12 @@ public Builder baseUrl(String baseUrl) {
* replace the scheme of {@code baseUrl}.
*
* <p>Base URL: http://example.com/<br>
* Endpoint: https://github.com/square/retrofit/<br>
* Result: https://github.com/square/retrofit/
* Endpoint: https://github.com/lysine-dev/retrofit/<br>
* Result: https://github.com/lysine-dev/retrofit/
*
* <p>Base URL: http://example.com<br>
* Endpoint: //github.com/square/retrofit/<br>
* Result: http://github.com/square/retrofit/ (note the scheme stays 'http')
* Endpoint: //github.com/lysine-dev/retrofit/<br>
* Result: http://github.com/lysine-dev/retrofit/ (note the scheme stays 'http')
*/
public Builder baseUrl(HttpUrl baseUrl) {
Objects.requireNonNull(baseUrl, "baseUrl == null");
Expand Down
2 changes: 1 addition & 1 deletion website/.env.release
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
SITE=https://square.github.io
SITE=https://lysine.dev
BASE_URL=/retrofit
2 changes: 1 addition & 1 deletion website/.env.snapshot
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
SITE=https://square.github.io
SITE=https://lysine.dev
BASE_URL=/retrofit/latest
8 changes: 4 additions & 4 deletions website/astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ let retrofitProperties = readFileSync('../gradle.properties');
let retrofitVersion = /VERSION_NAME=(.*?)\n/.exec(retrofitProperties)[1];

export default defineConfig({
site: 'https://square.github.io',
site: 'https://lysine.dev',
base: '/retrofit/latest',
env: {
schema: {
Expand All @@ -22,11 +22,11 @@ export default defineConfig({
'./src/styles/theme.css',
],
editLink: {
baseUrl: 'https://github.com/square/retrofit/edit/trunk/website',
baseUrl: 'https://github.com/lysine-dev/retrofit/edit/trunk/website',
},
social: [
{ icon: 'stackOverflow', label: 'StackOverflow', href: 'https://stackoverflow.com/questions/tagged/retrofit?sort=active' },
{ icon: 'github', label: 'GitHub', href: 'https://github.com/square/retrofit' },
{ icon: 'github', label: 'GitHub', href: 'https://github.com/lysine-dev/retrofit' },
],
sidebar: [
{
Expand All @@ -42,7 +42,7 @@ export default defineConfig({
{
label: 'Resources',
items: [
{ label: 'GitHub', link: 'https://github.com/square/retrofit' },
{ label: 'GitHub', link: 'https://github.com/lysine-dev/retrofit' },
{
label: 'Javadoc',
collapsed: true,
Expand Down
2 changes: 1 addition & 1 deletion website/src/content.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ export const collections = {
// In non-"release" mode, add a banner indicating snapshot documentation.
extend: z.object(import.meta.env.MODE == "release" && {} || {
banner: z.object({ content: z.string() }).default({
content: `You are viewing the snapshot documentation. Looking for the <a href="https://square.github.io/retrofit/">release documentation</a>?`,
content: `You are viewing the snapshot documentation. Looking for the <a href="https://lysine.dev/retrofit/">release documentation</a>?`,
}),
}),
}),
Expand Down
4 changes: 2 additions & 2 deletions website/src/content/docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Two delegating converters are provided:

### Custom converters

If you need to communicate with an API that uses a content-format that Retrofit does not support out of the box (e.g. YAML, txt, custom format) or you wish to use a different library to implement an existing format, you can easily create your own converter. Create a class that extends the [`Converter.Factory` class](https://github.com/square/retrofit/blob/master/retrofit/src/main/java/retrofit2/Converter.java) and pass in an instance when building your adapter.
If you need to communicate with an API that uses a content-format that Retrofit does not support out of the box (e.g. YAML, txt, custom format) or you wish to use a different library to implement an existing format, you can easily create your own converter. Create a class that extends the [`Converter.Factory` class](https://github.com/lysine-dev/retrofit/blob/master/retrofit/src/main/java/retrofit2/Converter.java) and pass in an instance when building your adapter.

### Third-party converters

Expand Down Expand Up @@ -79,7 +79,7 @@ This allows API requests to seamlessly compose with any existing threading model
### Custom call adapters

If you need to integration with a work library that Retrofit does not support out of the box, or you wish to use a different strategy to adapt an existing library, you can easily create your own call adapter.
Create a class that extends the [`CallAdapter.Factory` class](https://github.com/square/retrofit/blob/master/retrofit/src/main/java/retrofit2/CallAdapter.java) for a target type, and return an adapter which wraps the built-in `Call`.
Create a class that extends the [`CallAdapter.Factory` class](https://github.com/lysine-dev/retrofit/blob/master/retrofit/src/main/java/retrofit2/CallAdapter.java) for a target type, and return an adapter which wraps the built-in `Call`.

### Third-party call adapters

Expand Down
2 changes: 1 addition & 1 deletion website/src/content/docs/declarations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Similar to query parameters, for complex header combinations, a `Map` can be use
Call<User> getUser(@HeaderMap Map<String, String> headers)
```

Headers that need to be added to every request can be specified using an [OkHttp interceptor](https://square.github.io/okhttp/features/interceptors/).
Headers that need to be added to every request can be specified using an [OkHttp interceptor](https://lysine.dev/okhttp/features/interceptors/).

## Synchronous vs. asynchronous

Expand Down
6 changes: 3 additions & 3 deletions website/src/content/docs/download.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ export const mavenSnippet = `<dependency>
<version>` + VERSION + `</version>
</dependency>`;

The source code to the Retrofit, its samples, and this website is [available on GitHub](https://github.com/square/retrofit).
The source code to the Retrofit, its samples, and this website is [available on GitHub](https://github.com/lysine-dev/retrofit).

### Gradle

Expand All @@ -28,5 +28,5 @@ Retrofit requires at minimum Java 8+ or Android API 21+.

If you are using R8 the shrinking and obfuscation rules are included automatically.

ProGuard users must manually add the options from [retrofit2.pro](https://github.com/square/retrofit/blob/master/retrofit/src/main/resources/META-INF/proguard/retrofit2.pro).
You might also need rules for [OkHttp](https://square.github.io/okhttp/r8_proguard) and [Okio](https://github.com/square/okio#r8--proguard) which are dependencies of this library.
ProGuard users must manually add the options from [retrofit2.pro](https://github.com/lysine-dev/retrofit/blob/master/retrofit/src/main/resources/META-INF/proguard/retrofit2.pro).
You might also need rules for [OkHttp](https://lysine.dev/okhttp/r8_proguard) and [Okio](https://github.com/lysine-dev/okio#r8--proguard) which are dependencies of this library.
Loading