mirror of
https://github.com/ReVanced/revanced-api.git
synced 2026-01-18 08:53:57 +00:00
Compare commits
18 Commits
v1.1.0-dev
...
v1.3.0-dev
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
84ea5e4a41 | ||
|
|
491533d3f4 | ||
|
|
ef5f0b5ddd | ||
|
|
c0dc763f99 | ||
|
|
11327af879 | ||
|
|
9f0eb5bfe9 | ||
|
|
d2575d5191 | ||
|
|
32bedb7fad | ||
|
|
d605efd54a | ||
|
|
74e53891a1 | ||
|
|
27b18c62f5 | ||
|
|
df116bd221 | ||
|
|
2d7b4e7b7f | ||
|
|
4e8e83db1a | ||
|
|
e113daa089 | ||
|
|
170edd3157 | ||
|
|
d18e09cba3 | ||
|
|
bc919b85f5 |
64
CHANGELOG.md
64
CHANGELOG.md
@@ -1,3 +1,67 @@
|
|||||||
|
# [1.3.0-dev.1](https://github.com/ReVanced/revanced-api/compare/v1.2.0...v1.3.0-dev.1) (2024-09-11)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* Add missing parameter and response documentation ([491533d](https://github.com/ReVanced/revanced-api/commit/491533d3f44ccd716eee80123d0875a05eb9435b))
|
||||||
|
|
||||||
|
# [1.2.0](https://github.com/ReVanced/revanced-api/compare/v1.1.0...v1.2.0) (2024-09-06)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* Add back deprecated routes for backwards compatibility ([9f0eb5b](https://github.com/ReVanced/revanced-api/commit/9f0eb5bfe9d0436e76462b9c094f8b1158e04a44))
|
||||||
|
* Make sure, expected paths in configuration exist ([32bedb7](https://github.com/ReVanced/revanced-api/commit/32bedb7fad3eef8116625964e5e1f0a2543ea2a4))
|
||||||
|
* Return correct GPG keys url ([#187](https://github.com/ReVanced/revanced-api/issues/187)) ([74e5389](https://github.com/ReVanced/revanced-api/commit/74e53891a17bd3f76f358477e4228550e6f70149))
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* Move /latest routes to parent ([4e8e83d](https://github.com/ReVanced/revanced-api/commit/4e8e83db1a20c76a81967af4e7e3a8634649790a))
|
||||||
|
* Respond to all ping request methods ([df116bd](https://github.com/ReVanced/revanced-api/commit/df116bd22134c8222c72b28e9387bc9871d3473e))
|
||||||
|
|
||||||
|
# [1.2.0-dev.4](https://github.com/ReVanced/revanced-api/compare/v1.2.0-dev.3...v1.2.0-dev.4) (2024-09-06)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* Add back deprecated routes for backwards compatibility ([9f0eb5b](https://github.com/ReVanced/revanced-api/commit/9f0eb5bfe9d0436e76462b9c094f8b1158e04a44))
|
||||||
|
* Make sure, expected paths in configuration exist ([32bedb7](https://github.com/ReVanced/revanced-api/commit/32bedb7fad3eef8116625964e5e1f0a2543ea2a4))
|
||||||
|
|
||||||
|
# [1.2.0-dev.3](https://github.com/ReVanced/revanced-api/compare/v1.2.0-dev.2...v1.2.0-dev.3) (2024-09-04)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* Return correct GPG keys url ([#187](https://github.com/ReVanced/revanced-api/issues/187)) ([74e5389](https://github.com/ReVanced/revanced-api/commit/74e53891a17bd3f76f358477e4228550e6f70149))
|
||||||
|
|
||||||
|
# [1.2.0-dev.2](https://github.com/ReVanced/revanced-api/compare/v1.2.0-dev.1...v1.2.0-dev.2) (2024-08-24)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* Respond to all ping request methods ([df116bd](https://github.com/ReVanced/revanced-api/commit/df116bd22134c8222c72b28e9387bc9871d3473e))
|
||||||
|
|
||||||
|
# [1.2.0-dev.1](https://github.com/ReVanced/revanced-api/compare/v1.1.0...v1.2.0-dev.1) (2024-08-16)
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* Move /latest routes to parent ([4e8e83d](https://github.com/ReVanced/revanced-api/commit/4e8e83db1a20c76a81967af4e7e3a8634649790a))
|
||||||
|
|
||||||
|
# [1.1.0](https://github.com/ReVanced/revanced-api/compare/v1.0.0...v1.1.0) (2024-07-15)
|
||||||
|
|
||||||
|
|
||||||
|
### Bug Fixes
|
||||||
|
|
||||||
|
* Don't encode public keys & instead send them raw ([435beae](https://github.com/ReVanced/revanced-api/commit/435beae3831fc8ce161aec676ff20f253b1caf66))
|
||||||
|
|
||||||
|
|
||||||
|
### Features
|
||||||
|
|
||||||
|
* Add static file paths to remove env specific files in resources ([39d0b78](https://github.com/ReVanced/revanced-api/commit/39d0b78c7919f684439b6f052ab3f064159c2a70))
|
||||||
|
* Convert static about file to documented route & add key parameter to about route ([dfe6df3](https://github.com/ReVanced/revanced-api/commit/dfe6df3ef6006d06681673bcfaf87c44c40ad446))
|
||||||
|
|
||||||
# [1.1.0-dev.1](https://github.com/ReVanced/revanced-api/compare/v1.0.0...v1.1.0-dev.1) (2024-07-15)
|
# [1.1.0-dev.1](https://github.com/ReVanced/revanced-api/compare/v1.0.0...v1.1.0-dev.1) (2024-07-15)
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
22
README.md
22
README.md
@@ -96,20 +96,30 @@ so before you can pull the image, you need to [authenticate to the Container reg
|
|||||||
|
|
||||||
1. Create an `.env` file using [.env.example](.env.example) as a template
|
1. Create an `.env` file using [.env.example](.env.example) as a template
|
||||||
2. Create a `configuration.toml` file using [configuration.example.toml](configuration.example.toml) as a template
|
2. Create a `configuration.toml` file using [configuration.example.toml](configuration.example.toml) as a template
|
||||||
3. Create a `docker-compose.yml` file using [docker-compose.example.yml](docker-compose.example.yml) as a template
|
3. Create an `about.json` file using [about.example.json](about.example.json) as a template
|
||||||
4. Run `docker-compose up -d` to start the server
|
4. Create a `docker-compose.yml` file using [docker-compose.example.yml](docker-compose.example.yml) as a template
|
||||||
|
5. Run `docker-compose up -d` to start the server
|
||||||
|
|
||||||
### 💻 Docker CLI
|
### 💻 Docker CLI
|
||||||
|
|
||||||
1. Create an `.env` file using [.env.example](.env.example) as a template
|
1. Create an `.env` file using [.env.example](.env.example) as a template
|
||||||
2. Create a `configuration.toml` file using [configuration.example.toml](configuration.example.toml) as a template
|
2. Create a `configuration.toml` file using [configuration.example.toml](configuration.example.toml) as a template
|
||||||
3. Start the container using the following command:
|
3. Create an `about.json` file using [about.example.json](about.example.json) as a template
|
||||||
|
4. Start the container using the following command:
|
||||||
```shell
|
```shell
|
||||||
docker run -d --name revanced-api \
|
docker run -d --name revanced-api \
|
||||||
# Mount the .env file
|
# Mount the .env file
|
||||||
-v $(pwd)/.env:/app/.env \
|
-v $(pwd)/.env:/app/.env \
|
||||||
# Mount the configuration.toml file
|
# Mount the configuration.toml file
|
||||||
-v $(pwd)/configuration.toml:/app/configuration.toml \
|
-v $(pwd)/configuration.toml:/app/configuration.toml \
|
||||||
|
# Mount the patches public key
|
||||||
|
-v $(pwd)/patches-public-key.asc:/app/patches-public-key.asc \
|
||||||
|
# Mount the integrations public key
|
||||||
|
-v $(pwd)/integrations-public-key.asc:/app/integrations-public-key.asc \
|
||||||
|
# Mount the static folder
|
||||||
|
-v $(pwd)/static:/app/static \
|
||||||
|
# Mount the about.json file
|
||||||
|
-v $(pwd)/about.json:/app/about.json \
|
||||||
# Mount the persistence folder
|
# Mount the persistence folder
|
||||||
-v $(pwd)/persistence:/app/persistence \
|
-v $(pwd)/persistence:/app/persistence \
|
||||||
# Expose the port 8888
|
# Expose the port 8888
|
||||||
@@ -132,7 +142,8 @@ A Java Runtime Environment (JRE) must be installed.
|
|||||||
2. In the same folder, create an `.env` file using [.env.example](.env.example) as a template
|
2. In the same folder, create an `.env` file using [.env.example](.env.example) as a template
|
||||||
3. In the same folder, create a `configuration.toml` file
|
3. In the same folder, create a `configuration.toml` file
|
||||||
using [configuration.example.toml](configuration.example.toml) as a template
|
using [configuration.example.toml](configuration.example.toml) as a template
|
||||||
4. Run `java -jar revanced-api.jar start` to start the server
|
4. In the same folder, create an `about.json` file using [about.example.json](about.example.json) as a template
|
||||||
|
5. Run `java -jar revanced-api.jar start` to start the server
|
||||||
|
|
||||||
### 🛠️ From source
|
### 🛠️ From source
|
||||||
|
|
||||||
@@ -141,7 +152,8 @@ A Java Development Kit (JDK) and Git must be installed.
|
|||||||
1. Run `git clone git@github.com:ReVanced/revanced-api.git` to clone the repository
|
1. Run `git clone git@github.com:ReVanced/revanced-api.git` to clone the repository
|
||||||
2. Copy [.env.example](.env.example) to `.env` and fill in the required values
|
2. Copy [.env.example](.env.example) to `.env` and fill in the required values
|
||||||
3. Copy [configuration.example.toml](configuration.example.toml) to `configuration.toml` and fill in the required values
|
3. Copy [configuration.example.toml](configuration.example.toml) to `configuration.toml` and fill in the required values
|
||||||
4. Run `gradlew run --args=start` to start the server
|
4. Copy [about.example.json](about.example.json) to `about.json` and fill in the required values
|
||||||
|
5. Run `gradlew run --args=start` to start the server
|
||||||
|
|
||||||
## 📚 Everything else
|
## 📚 Everything else
|
||||||
|
|
||||||
|
|||||||
@@ -13,5 +13,5 @@ services:
|
|||||||
environment:
|
environment:
|
||||||
- COMMAND=start
|
- COMMAND=start
|
||||||
ports:
|
ports:
|
||||||
- 8888:8888
|
- "8888:8888"
|
||||||
restart: unless-stopped
|
restart: unless-stopped
|
||||||
|
|||||||
@@ -1,4 +1,4 @@
|
|||||||
org.gradle.parallel = true
|
org.gradle.parallel = true
|
||||||
org.gradle.caching = true
|
org.gradle.caching = true
|
||||||
kotlin.code.style = official
|
kotlin.code.style = official
|
||||||
version = 1.1.0-dev.1
|
version = 1.3.0-dev.1
|
||||||
|
|||||||
@@ -10,8 +10,8 @@ ktor = "2.3.7"
|
|||||||
ktoml = "0.5.2"
|
ktoml = "0.5.2"
|
||||||
picocli = "4.7.6"
|
picocli = "4.7.6"
|
||||||
datetime = "0.6.0"
|
datetime = "0.6.0"
|
||||||
revanced-patcher = "19.3.1"
|
revanced-patcher = "20.0.0"
|
||||||
revanced-library = "2.3.0"
|
revanced-library = "3.0.1-dev.1"
|
||||||
caffeine = "3.1.8"
|
caffeine = "3.1.8"
|
||||||
bouncy-castle = "1.78.1"
|
bouncy-castle = "1.78.1"
|
||||||
|
|
||||||
|
|||||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
Binary file not shown.
4
gradle/wrapper/gradle-wrapper.properties
vendored
4
gradle/wrapper/gradle-wrapper.properties
vendored
@@ -1,7 +1,7 @@
|
|||||||
distributionBase=GRADLE_USER_HOME
|
distributionBase=GRADLE_USER_HOME
|
||||||
distributionPath=wrapper/dists
|
distributionPath=wrapper/dists
|
||||||
distributionSha256Sum=a4b4158601f8636cdeeab09bd76afb640030bb5b144aafe261a5e8af027dc612
|
distributionSha256Sum=d725d707bfabd4dfdc958c624003b3c80accc03f7037b5122c4b1d0ef15cecab
|
||||||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.8-bin.zip
|
distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
|
||||||
networkTimeout=10000
|
networkTimeout=10000
|
||||||
validateDistributionUrl=true
|
validateDistributionUrl=true
|
||||||
zipStoreBase=GRADLE_USER_HOME
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
|
|||||||
5
gradlew
vendored
5
gradlew
vendored
@@ -15,6 +15,8 @@
|
|||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
#
|
#
|
||||||
|
# SPDX-License-Identifier: Apache-2.0
|
||||||
|
#
|
||||||
|
|
||||||
##############################################################################
|
##############################################################################
|
||||||
#
|
#
|
||||||
@@ -84,7 +86,8 @@ done
|
|||||||
# shellcheck disable=SC2034
|
# shellcheck disable=SC2034
|
||||||
APP_BASE_NAME=${0##*/}
|
APP_BASE_NAME=${0##*/}
|
||||||
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
|
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
|
||||||
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
|
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
|
||||||
|
' "$PWD" ) || exit
|
||||||
|
|
||||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||||
MAX_FD=maximum
|
MAX_FD=maximum
|
||||||
|
|||||||
2
gradlew.bat
vendored
2
gradlew.bat
vendored
@@ -13,6 +13,8 @@
|
|||||||
@rem See the License for the specific language governing permissions and
|
@rem See the License for the specific language governing permissions and
|
||||||
@rem limitations under the License.
|
@rem limitations under the License.
|
||||||
@rem
|
@rem
|
||||||
|
@rem SPDX-License-Identifier: Apache-2.0
|
||||||
|
@rem
|
||||||
|
|
||||||
@if "%DEBUG%"=="" @echo off
|
@if "%DEBUG%"=="" @echo off
|
||||||
@rem ##########################################################################
|
@rem ##########################################################################
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
package app.revanced.api.configuration
|
package app.revanced.api.configuration
|
||||||
|
|
||||||
|
import io.bkbn.kompendium.core.metadata.MethodInfo
|
||||||
import io.bkbn.kompendium.core.plugin.NotarizedRoute
|
import io.bkbn.kompendium.core.plugin.NotarizedRoute
|
||||||
import io.ktor.http.*
|
import io.ktor.http.*
|
||||||
import io.ktor.http.content.*
|
import io.ktor.http.content.*
|
||||||
@@ -40,3 +41,11 @@ internal fun Route.staticFiles(
|
|||||||
extensions("json")
|
extensions("json")
|
||||||
},
|
},
|
||||||
) = staticFiles(remotePath, dir.toFile(), null, block)
|
) = staticFiles(remotePath, dir.toFile(), null, block)
|
||||||
|
|
||||||
|
internal fun MethodInfo.Builder<*>.canRespondUnauthorized() {
|
||||||
|
canRespond {
|
||||||
|
responseCode(HttpStatusCode.Unauthorized)
|
||||||
|
description("Unauthorized")
|
||||||
|
responseType<Unit>()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ import kotlinx.serialization.json.JsonNamingStrategy
|
|||||||
import kotlinx.serialization.json.decodeFromStream
|
import kotlinx.serialization.json.decodeFromStream
|
||||||
import java.io.File
|
import java.io.File
|
||||||
import java.nio.file.Path
|
import java.nio.file.Path
|
||||||
|
import kotlin.io.path.createDirectories
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The repository storing the configuration for the API.
|
* The repository storing the configuration for the API.
|
||||||
@@ -60,6 +61,11 @@ internal class ConfigurationRepository(
|
|||||||
@SerialName("about-json-file-path")
|
@SerialName("about-json-file-path")
|
||||||
val about: APIAbout,
|
val about: APIAbout,
|
||||||
) {
|
) {
|
||||||
|
init {
|
||||||
|
staticFilesPath.createDirectories()
|
||||||
|
versionedStaticFilesPath.createDirectories()
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Am asset configuration whose asset is signed.
|
* Am asset configuration whose asset is signed.
|
||||||
*
|
*
|
||||||
|
|||||||
@@ -98,7 +98,7 @@ class GitHubBackendRepository(client: HttpClient) : BackendRepository(client) {
|
|||||||
gpgKeys =
|
gpgKeys =
|
||||||
BackendMember.GpgKeys(
|
BackendMember.GpgKeys(
|
||||||
ids = gpgKeys.map { it.keyId },
|
ids = gpgKeys.map { it.keyId },
|
||||||
url = "https://api.github.com/users/${user.login}.gpg",
|
url = "https://github.com/${user.login}.gpg",
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
package app.revanced.api.configuration.routes
|
package app.revanced.api.configuration.routes
|
||||||
|
|
||||||
|
import app.revanced.api.configuration.canRespondUnauthorized
|
||||||
import app.revanced.api.configuration.installCache
|
import app.revanced.api.configuration.installCache
|
||||||
import app.revanced.api.configuration.installNotarizedRoute
|
import app.revanced.api.configuration.installNotarizedRoute
|
||||||
import app.revanced.api.configuration.respondOrNotFound
|
import app.revanced.api.configuration.respondOrNotFound
|
||||||
@@ -8,10 +9,7 @@ import app.revanced.api.configuration.schema.APIAnnouncementArchivedAt
|
|||||||
import app.revanced.api.configuration.schema.APIResponseAnnouncement
|
import app.revanced.api.configuration.schema.APIResponseAnnouncement
|
||||||
import app.revanced.api.configuration.schema.APIResponseAnnouncementId
|
import app.revanced.api.configuration.schema.APIResponseAnnouncementId
|
||||||
import app.revanced.api.configuration.services.AnnouncementService
|
import app.revanced.api.configuration.services.AnnouncementService
|
||||||
import io.bkbn.kompendium.core.metadata.DeleteInfo
|
import io.bkbn.kompendium.core.metadata.*
|
||||||
import io.bkbn.kompendium.core.metadata.GetInfo
|
|
||||||
import io.bkbn.kompendium.core.metadata.PatchInfo
|
|
||||||
import io.bkbn.kompendium.core.metadata.PostInfo
|
|
||||||
import io.bkbn.kompendium.json.schema.definition.TypeDefinition
|
import io.bkbn.kompendium.json.schema.definition.TypeDefinition
|
||||||
import io.bkbn.kompendium.oas.payload.Parameter
|
import io.bkbn.kompendium.oas.payload.Parameter
|
||||||
import io.ktor.http.*
|
import io.ktor.http.*
|
||||||
@@ -138,9 +136,19 @@ internal fun Route.announcementsRoute() = route("announcements") {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
private val authHeaderParameter = Parameter(
|
||||||
|
name = "Authorization",
|
||||||
|
`in` = Parameter.Location.header,
|
||||||
|
schema = TypeDefinition.STRING,
|
||||||
|
required = true,
|
||||||
|
examples = mapOf("Bearer authentication" to Parameter.Example("Bearer abc123")),
|
||||||
|
)
|
||||||
|
|
||||||
private fun Route.installAnnouncementRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installAnnouncementRouteDocumentation() = installNotarizedRoute {
|
||||||
tags = setOf("Announcements")
|
tags = setOf("Announcements")
|
||||||
|
|
||||||
|
parameters = listOf(authHeaderParameter)
|
||||||
|
|
||||||
post = PostInfo.builder {
|
post = PostInfo.builder {
|
||||||
description("Create a new announcement")
|
description("Create a new announcement")
|
||||||
summary("Create announcement")
|
summary("Create announcement")
|
||||||
@@ -153,6 +161,7 @@ private fun Route.installAnnouncementRouteDocumentation() = installNotarizedRout
|
|||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<Unit>()
|
responseType<Unit>()
|
||||||
}
|
}
|
||||||
|
canRespondUnauthorized()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -239,6 +248,7 @@ private fun Route.installAnnouncementArchiveRouteDocumentation() = installNotari
|
|||||||
description = "The date and time the announcement to be archived",
|
description = "The date and time the announcement to be archived",
|
||||||
required = false,
|
required = false,
|
||||||
),
|
),
|
||||||
|
authHeaderParameter,
|
||||||
)
|
)
|
||||||
|
|
||||||
post = PostInfo.builder {
|
post = PostInfo.builder {
|
||||||
@@ -249,6 +259,7 @@ private fun Route.installAnnouncementArchiveRouteDocumentation() = installNotari
|
|||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<Unit>()
|
responseType<Unit>()
|
||||||
}
|
}
|
||||||
|
canRespondUnauthorized()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -263,6 +274,7 @@ private fun Route.installAnnouncementUnarchiveRouteDocumentation() = installNota
|
|||||||
description = "The id of the announcement to unarchive",
|
description = "The id of the announcement to unarchive",
|
||||||
required = true,
|
required = true,
|
||||||
),
|
),
|
||||||
|
authHeaderParameter,
|
||||||
)
|
)
|
||||||
|
|
||||||
post = PostInfo.builder {
|
post = PostInfo.builder {
|
||||||
@@ -273,6 +285,7 @@ private fun Route.installAnnouncementUnarchiveRouteDocumentation() = installNota
|
|||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<Unit>()
|
responseType<Unit>()
|
||||||
}
|
}
|
||||||
|
canRespondUnauthorized()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -287,6 +300,7 @@ private fun Route.installAnnouncementIdRouteDocumentation() = installNotarizedRo
|
|||||||
description = "The id of the announcement to update",
|
description = "The id of the announcement to update",
|
||||||
required = true,
|
required = true,
|
||||||
),
|
),
|
||||||
|
authHeaderParameter,
|
||||||
)
|
)
|
||||||
|
|
||||||
patch = PatchInfo.builder {
|
patch = PatchInfo.builder {
|
||||||
@@ -301,6 +315,7 @@ private fun Route.installAnnouncementIdRouteDocumentation() = installNotarizedRo
|
|||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<Unit>()
|
responseType<Unit>()
|
||||||
}
|
}
|
||||||
|
canRespondUnauthorized()
|
||||||
}
|
}
|
||||||
|
|
||||||
delete = DeleteInfo.builder {
|
delete = DeleteInfo.builder {
|
||||||
@@ -311,6 +326,7 @@ private fun Route.installAnnouncementIdRouteDocumentation() = installNotarizedRo
|
|||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<Unit>()
|
responseType<Unit>()
|
||||||
}
|
}
|
||||||
|
canRespondUnauthorized()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import app.revanced.api.configuration.*
|
|||||||
import app.revanced.api.configuration.installCache
|
import app.revanced.api.configuration.installCache
|
||||||
import app.revanced.api.configuration.installNoCache
|
import app.revanced.api.configuration.installNoCache
|
||||||
import app.revanced.api.configuration.installNotarizedRoute
|
import app.revanced.api.configuration.installNotarizedRoute
|
||||||
|
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||||
import app.revanced.api.configuration.respondOrNotFound
|
import app.revanced.api.configuration.respondOrNotFound
|
||||||
import app.revanced.api.configuration.schema.APIAbout
|
import app.revanced.api.configuration.schema.APIAbout
|
||||||
import app.revanced.api.configuration.schema.APIContributable
|
import app.revanced.api.configuration.schema.APIContributable
|
||||||
@@ -12,12 +13,15 @@ import app.revanced.api.configuration.schema.APIRateLimit
|
|||||||
import app.revanced.api.configuration.services.ApiService
|
import app.revanced.api.configuration.services.ApiService
|
||||||
import app.revanced.api.configuration.services.AuthService
|
import app.revanced.api.configuration.services.AuthService
|
||||||
import io.bkbn.kompendium.core.metadata.*
|
import io.bkbn.kompendium.core.metadata.*
|
||||||
|
import io.bkbn.kompendium.json.schema.definition.TypeDefinition
|
||||||
|
import io.bkbn.kompendium.oas.payload.Parameter
|
||||||
import io.ktor.http.*
|
import io.ktor.http.*
|
||||||
import io.ktor.server.application.*
|
import io.ktor.server.application.*
|
||||||
import io.ktor.server.auth.*
|
import io.ktor.server.auth.*
|
||||||
import io.ktor.server.plugins.ratelimit.*
|
import io.ktor.server.plugins.ratelimit.*
|
||||||
import io.ktor.server.response.*
|
import io.ktor.server.response.*
|
||||||
import io.ktor.server.routing.*
|
import io.ktor.server.routing.*
|
||||||
|
import kotlinx.serialization.json.Json.Default.configuration
|
||||||
import kotlin.time.Duration.Companion.days
|
import kotlin.time.Duration.Companion.days
|
||||||
import org.koin.ktor.ext.get as koinGet
|
import org.koin.ktor.ext.get as koinGet
|
||||||
|
|
||||||
@@ -72,7 +76,7 @@ internal fun Route.apiRoute() {
|
|||||||
|
|
||||||
installPingRouteDocumentation()
|
installPingRouteDocumentation()
|
||||||
|
|
||||||
head {
|
handle {
|
||||||
call.respond(HttpStatusCode.NoContent)
|
call.respond(HttpStatusCode.NoContent)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -165,16 +169,38 @@ private fun Route.installContributorsRouteDocumentation() = installNotarizedRout
|
|||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installTokenRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installTokenRouteDocumentation() = installNotarizedRoute {
|
||||||
|
val configuration = koinGet<ConfigurationRepository>()
|
||||||
|
|
||||||
tags = setOf("API")
|
tags = setOf("API")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get a new authorization token")
|
description("Get a new authorization token")
|
||||||
summary("Get authorization token")
|
summary("Get authorization token")
|
||||||
|
parameters(
|
||||||
|
Parameter(
|
||||||
|
name = "Authorization",
|
||||||
|
`in` = Parameter.Location.header,
|
||||||
|
schema = TypeDefinition.STRING,
|
||||||
|
required = true,
|
||||||
|
examples = mapOf(
|
||||||
|
"Digest access authentication" to Parameter.Example(
|
||||||
|
value = "Digest " +
|
||||||
|
"username=\"ReVanced\", " +
|
||||||
|
"realm=\"ReVanced\", " +
|
||||||
|
"nonce=\"abc123\", " +
|
||||||
|
"uri=\"/v${configuration.apiVersion}/token\", " +
|
||||||
|
"algorithm=SHA-256, " +
|
||||||
|
"response=\"yxz456\"",
|
||||||
|
),
|
||||||
|
), // Provide an example for the header
|
||||||
|
),
|
||||||
|
)
|
||||||
response {
|
response {
|
||||||
description("The authorization token")
|
description("The authorization token")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<String>()
|
responseType<String>()
|
||||||
}
|
}
|
||||||
|
canRespondUnauthorized()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,33 +14,41 @@ import io.ktor.server.routing.*
|
|||||||
import org.koin.ktor.ext.get as koinGet
|
import org.koin.ktor.ext.get as koinGet
|
||||||
|
|
||||||
internal fun Route.managerRoute() = route("manager") {
|
internal fun Route.managerRoute() = route("manager") {
|
||||||
|
configure()
|
||||||
|
|
||||||
|
// TODO: Remove this deprecated route eventually.
|
||||||
|
route("latest") {
|
||||||
|
configure(deprecated = true)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun Route.configure(deprecated: Boolean = false) {
|
||||||
val managerService = koinGet<ManagerService>()
|
val managerService = koinGet<ManagerService>()
|
||||||
|
|
||||||
route("latest") {
|
installManagerRouteDocumentation(deprecated)
|
||||||
installLatestManagerRouteDocumentation()
|
|
||||||
|
rateLimit(RateLimitName("weak")) {
|
||||||
|
get {
|
||||||
|
call.respond(managerService.latestRelease())
|
||||||
|
}
|
||||||
|
|
||||||
|
route("version") {
|
||||||
|
installManagerVersionRouteDocumentation(deprecated)
|
||||||
|
|
||||||
rateLimit(RateLimitName("weak")) {
|
|
||||||
get {
|
get {
|
||||||
call.respond(managerService.latestRelease())
|
call.respond(managerService.latestVersion())
|
||||||
}
|
|
||||||
|
|
||||||
route("version") {
|
|
||||||
installLatestManagerVersionRouteDocumentation()
|
|
||||||
|
|
||||||
get {
|
|
||||||
call.respond(managerService.latestVersion())
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installLatestManagerRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installManagerRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
|
||||||
tags = setOf("Manager")
|
tags = setOf("Manager")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the latest manager release")
|
if (deprecated) isDeprecated()
|
||||||
summary("Get latest manager release")
|
description("Get the current manager release")
|
||||||
|
summary("Get current manager release")
|
||||||
response {
|
response {
|
||||||
description("The latest manager release")
|
description("The latest manager release")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
@@ -50,14 +58,15 @@ private fun Route.installLatestManagerRouteDocumentation() = installNotarizedRou
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installLatestManagerVersionRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installManagerVersionRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
|
||||||
tags = setOf("Manager")
|
tags = setOf("Manager")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the latest manager release version")
|
if (deprecated) isDeprecated()
|
||||||
summary("Get latest manager release version")
|
description("Get the current manager release version")
|
||||||
|
summary("Get current manager release version")
|
||||||
response {
|
response {
|
||||||
description("The latest manager release version")
|
description("The current manager release version")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<APIReleaseVersion>()
|
responseType<APIReleaseVersion>()
|
||||||
|
|||||||
@@ -17,32 +17,39 @@ import kotlin.time.Duration.Companion.days
|
|||||||
import org.koin.ktor.ext.get as koinGet
|
import org.koin.ktor.ext.get as koinGet
|
||||||
|
|
||||||
internal fun Route.patchesRoute() = route("patches") {
|
internal fun Route.patchesRoute() = route("patches") {
|
||||||
|
configure()
|
||||||
|
|
||||||
|
// TODO: Remove this deprecated route eventually.
|
||||||
|
route("latest") {
|
||||||
|
configure(deprecated = true)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun Route.configure(deprecated: Boolean = false) {
|
||||||
val patchesService = koinGet<PatchesService>()
|
val patchesService = koinGet<PatchesService>()
|
||||||
|
|
||||||
route("latest") {
|
installPatchesRouteDocumentation(deprecated)
|
||||||
installLatestPatchesRouteDocumentation()
|
|
||||||
|
|
||||||
rateLimit(RateLimitName("weak")) {
|
rateLimit(RateLimitName("weak")) {
|
||||||
get {
|
get {
|
||||||
call.respond(patchesService.latestRelease())
|
call.respond(patchesService.latestRelease())
|
||||||
}
|
|
||||||
|
|
||||||
route("version") {
|
|
||||||
installLatestPatchesVersionRouteDocumentation()
|
|
||||||
|
|
||||||
get {
|
|
||||||
call.respond(patchesService.latestVersion())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
rateLimit(RateLimitName("strong")) {
|
route("version") {
|
||||||
route("list") {
|
installPatchesVersionRouteDocumentation(deprecated)
|
||||||
installLatestPatchesListRouteDocumentation()
|
|
||||||
|
|
||||||
get {
|
get {
|
||||||
call.respondBytes(ContentType.Application.Json) { patchesService.list() }
|
call.respond(patchesService.latestVersion())
|
||||||
}
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
rateLimit(RateLimitName("strong")) {
|
||||||
|
route("list") {
|
||||||
|
installPatchesListRouteDocumentation(deprecated)
|
||||||
|
|
||||||
|
get {
|
||||||
|
call.respondBytes(ContentType.Application.Json) { patchesService.list() }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -51,7 +58,7 @@ internal fun Route.patchesRoute() = route("patches") {
|
|||||||
route("keys") {
|
route("keys") {
|
||||||
installCache(356.days)
|
installCache(356.days)
|
||||||
|
|
||||||
installPatchesPublicKeyRouteDocumentation()
|
installPatchesPublicKeyRouteDocumentation(deprecated)
|
||||||
|
|
||||||
get {
|
get {
|
||||||
call.respond(patchesService.publicKeys())
|
call.respond(patchesService.publicKeys())
|
||||||
@@ -60,14 +67,15 @@ internal fun Route.patchesRoute() = route("patches") {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installLatestPatchesRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installPatchesRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
|
||||||
tags = setOf("Patches")
|
tags = setOf("Patches")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the latest patches release")
|
if (deprecated) isDeprecated()
|
||||||
summary("Get latest patches release")
|
description("Get the current patches release")
|
||||||
|
summary("Get current patches release")
|
||||||
response {
|
response {
|
||||||
description("The latest patches release")
|
description("The current patches release")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<APIRelease<APIPatchesAsset>>()
|
responseType<APIRelease<APIPatchesAsset>>()
|
||||||
@@ -75,14 +83,15 @@ private fun Route.installLatestPatchesRouteDocumentation() = installNotarizedRou
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installLatestPatchesVersionRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installPatchesVersionRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
|
||||||
tags = setOf("Patches")
|
tags = setOf("Patches")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the latest patches release version")
|
if (deprecated) isDeprecated()
|
||||||
summary("Get latest patches release version")
|
description("Get the current patches release version")
|
||||||
|
summary("Get current patches release version")
|
||||||
response {
|
response {
|
||||||
description("The latest patches release version")
|
description("The current patches release version")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
responseCode(HttpStatusCode.OK)
|
responseCode(HttpStatusCode.OK)
|
||||||
responseType<APIReleaseVersion>()
|
responseType<APIReleaseVersion>()
|
||||||
@@ -90,12 +99,13 @@ private fun Route.installLatestPatchesVersionRouteDocumentation() = installNotar
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installLatestPatchesListRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installPatchesListRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
|
||||||
tags = setOf("Patches")
|
tags = setOf("Patches")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
description("Get the list of patches from the latest patches release")
|
if (deprecated) isDeprecated()
|
||||||
summary("Get list of patches from latest patches release")
|
description("Get the list of patches from the current patches release")
|
||||||
|
summary("Get list of patches from current patches release")
|
||||||
response {
|
response {
|
||||||
description("The list of patches")
|
description("The list of patches")
|
||||||
mediaTypes("application/json")
|
mediaTypes("application/json")
|
||||||
@@ -105,10 +115,11 @@ private fun Route.installLatestPatchesListRouteDocumentation() = installNotarize
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
private fun Route.installPatchesPublicKeyRouteDocumentation() = installNotarizedRoute {
|
private fun Route.installPatchesPublicKeyRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
|
||||||
tags = setOf("Patches")
|
tags = setOf("Patches")
|
||||||
|
|
||||||
get = GetInfo.builder {
|
get = GetInfo.builder {
|
||||||
|
if (deprecated) isDeprecated()
|
||||||
description("Get the public keys for verifying patches and integrations assets")
|
description("Get the public keys for verifying patches and integrations assets")
|
||||||
summary("Get patches and integrations public keys")
|
summary("Get patches and integrations public keys")
|
||||||
response {
|
response {
|
||||||
|
|||||||
@@ -4,8 +4,8 @@ import app.revanced.api.configuration.repository.BackendRepository
|
|||||||
import app.revanced.api.configuration.repository.BackendRepository.BackendOrganization.BackendRepository.BackendRelease.Companion.first
|
import app.revanced.api.configuration.repository.BackendRepository.BackendOrganization.BackendRepository.BackendRelease.Companion.first
|
||||||
import app.revanced.api.configuration.repository.ConfigurationRepository
|
import app.revanced.api.configuration.repository.ConfigurationRepository
|
||||||
import app.revanced.api.configuration.schema.*
|
import app.revanced.api.configuration.schema.*
|
||||||
import app.revanced.library.PatchUtils
|
import app.revanced.library.serializeTo
|
||||||
import app.revanced.patcher.PatchBundleLoader
|
import app.revanced.patcher.patch.loadPatchesFromJar
|
||||||
import com.github.benmanes.caffeine.cache.Caffeine
|
import com.github.benmanes.caffeine.cache.Caffeine
|
||||||
import kotlinx.coroutines.Dispatchers
|
import kotlinx.coroutines.Dispatchers
|
||||||
import kotlinx.coroutines.withContext
|
import kotlinx.coroutines.withContext
|
||||||
@@ -94,7 +94,7 @@ internal class PatchesService(
|
|||||||
configurationRepository.patches.publicKeyId,
|
configurationRepository.patches.publicKeyId,
|
||||||
)
|
)
|
||||||
) {
|
) {
|
||||||
PatchBundleLoader.Jar(patchesFile)
|
loadPatchesFromJar(setOf(patchesFile))
|
||||||
} else {
|
} else {
|
||||||
// Use an empty set of patches if the signature is invalid.
|
// Use an empty set of patches if the signature is invalid.
|
||||||
emptySet()
|
emptySet()
|
||||||
@@ -103,7 +103,7 @@ internal class PatchesService(
|
|||||||
patchesFile.delete()
|
patchesFile.delete()
|
||||||
|
|
||||||
ByteArrayOutputStream().use { stream ->
|
ByteArrayOutputStream().use { stream ->
|
||||||
PatchUtils.Json.serialize(patches, outputStream = stream)
|
patches.serializeTo(outputStream = stream)
|
||||||
|
|
||||||
stream.toByteArray()
|
stream.toByteArray()
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user