chore(release): 1.3.0-dev.1 [skip ci]

# [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](491533d3f4))

CHANGELOG.md

@@ -1,3 +1,40 @@
+# [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)
 
 

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
 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
 
 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
-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
    docker run -d --name revanced-api \
     # Mount the .env file
     -v $(pwd)/.env:/app/.env \
     # Mount the configuration.toml file
     -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
     -v $(pwd)/persistence:/app/persistence \
     # 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
 3. In the same folder, create a `configuration.toml` file
 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
 
@@ -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
 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
-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
 

docker-compose.example.yml

@@ -13,5 +13,5 @@ services:
     environment:
       - COMMAND=start
     ports:
-      - 8888:8888
+      - "8888:8888"
     restart: unless-stopped

gradle.properties

@@ -1,4 +1,4 @@
 org.gradle.parallel = true
 org.gradle.caching = true
 kotlin.code.style = official
-version = 1.2.0-dev.2
+version = 1.3.0-dev.1

src/main/kotlin/app/revanced/api/configuration/Extensions.kt

@@ -1,5 +1,6 @@
 package app.revanced.api.configuration
 
+import io.bkbn.kompendium.core.metadata.MethodInfo
 import io.bkbn.kompendium.core.plugin.NotarizedRoute
 import io.ktor.http.*
 import io.ktor.http.content.*
@@ -40,3 +41,11 @@ internal fun Route.staticFiles(
         extensions("json")
     },
 ) = staticFiles(remotePath, dir.toFile(), null, block)
+
+internal fun MethodInfo.Builder<*>.canRespondUnauthorized() {
+    canRespond {
+        responseCode(HttpStatusCode.Unauthorized)
+        description("Unauthorized")
+        responseType<Unit>()
+    }
+}

src/main/kotlin/app/revanced/api/configuration/repository/ConfigurationRepository.kt

@@ -17,6 +17,7 @@ import kotlinx.serialization.json.JsonNamingStrategy
 import kotlinx.serialization.json.decodeFromStream
 import java.io.File
 import java.nio.file.Path
+import kotlin.io.path.createDirectories
 
 /**
  * The repository storing the configuration for the API.
@@ -60,6 +61,11 @@ internal class ConfigurationRepository(
     @SerialName("about-json-file-path")
     val about: APIAbout,
 ) {
+    init {
+        staticFilesPath.createDirectories()
+        versionedStaticFilesPath.createDirectories()
+    }
+
     /**
      * Am asset configuration whose asset is signed.
      *

src/main/kotlin/app/revanced/api/configuration/repository/GitHubBackendRepository.kt

@@ -98,7 +98,7 @@ class GitHubBackendRepository(client: HttpClient) : BackendRepository(client) {
                 gpgKeys =
                 BackendMember.GpgKeys(
                     ids = gpgKeys.map { it.keyId },
-                    url = "https://api.github.com/users/${user.login}.gpg",
+                    url = "https://github.com/${user.login}.gpg",
                 ),
             )
         }

src/main/kotlin/app/revanced/api/configuration/routes/Announcements.kt

@@ -1,5 +1,6 @@
 package app.revanced.api.configuration.routes
 
+import app.revanced.api.configuration.canRespondUnauthorized
 import app.revanced.api.configuration.installCache
 import app.revanced.api.configuration.installNotarizedRoute
 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.APIResponseAnnouncementId
 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.oas.payload.Parameter
 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 {
     tags = setOf("Announcements")
 
+    parameters = listOf(authHeaderParameter)
+
     post = PostInfo.builder {
         description("Create a new announcement")
         summary("Create announcement")
@@ -153,6 +161,7 @@ private fun Route.installAnnouncementRouteDocumentation() = installNotarizedRout
             responseCode(HttpStatusCode.OK)
             responseType<Unit>()
         }
+        canRespondUnauthorized()
     }
 }
 
@@ -239,6 +248,7 @@ private fun Route.installAnnouncementArchiveRouteDocumentation() = installNotari
             description = "The date and time the announcement to be archived",
             required = false,
         ),
+        authHeaderParameter,
     )
 
     post = PostInfo.builder {
@@ -249,6 +259,7 @@ private fun Route.installAnnouncementArchiveRouteDocumentation() = installNotari
             responseCode(HttpStatusCode.OK)
             responseType<Unit>()
         }
+        canRespondUnauthorized()
     }
 }
 
@@ -263,6 +274,7 @@ private fun Route.installAnnouncementUnarchiveRouteDocumentation() = installNota
             description = "The id of the announcement to unarchive",
             required = true,
         ),
+        authHeaderParameter,
     )
 
     post = PostInfo.builder {
@@ -273,6 +285,7 @@ private fun Route.installAnnouncementUnarchiveRouteDocumentation() = installNota
             responseCode(HttpStatusCode.OK)
             responseType<Unit>()
         }
+        canRespondUnauthorized()
     }
 }
 
@@ -287,6 +300,7 @@ private fun Route.installAnnouncementIdRouteDocumentation() = installNotarizedRo
             description = "The id of the announcement to update",
             required = true,
         ),
+        authHeaderParameter,
     )
 
     patch = PatchInfo.builder {
@@ -301,6 +315,7 @@ private fun Route.installAnnouncementIdRouteDocumentation() = installNotarizedRo
             responseCode(HttpStatusCode.OK)
             responseType<Unit>()
         }
+        canRespondUnauthorized()
     }
 
     delete = DeleteInfo.builder {
@@ -311,6 +326,7 @@ private fun Route.installAnnouncementIdRouteDocumentation() = installNotarizedRo
             responseCode(HttpStatusCode.OK)
             responseType<Unit>()
         }
+        canRespondUnauthorized()
     }
 }
 

src/main/kotlin/app/revanced/api/configuration/routes/ApiRoute.kt

@@ -4,6 +4,7 @@ import app.revanced.api.configuration.*
 import app.revanced.api.configuration.installCache
 import app.revanced.api.configuration.installNoCache
 import app.revanced.api.configuration.installNotarizedRoute
+import app.revanced.api.configuration.repository.ConfigurationRepository
 import app.revanced.api.configuration.respondOrNotFound
 import app.revanced.api.configuration.schema.APIAbout
 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.AuthService
 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.server.application.*
 import io.ktor.server.auth.*
 import io.ktor.server.plugins.ratelimit.*
 import io.ktor.server.response.*
 import io.ktor.server.routing.*
+import kotlinx.serialization.json.Json.Default.configuration
 import kotlin.time.Duration.Companion.days
 import org.koin.ktor.ext.get as koinGet
 
@@ -165,16 +169,38 @@ private fun Route.installContributorsRouteDocumentation() = installNotarizedRout
 }
 
 private fun Route.installTokenRouteDocumentation() = installNotarizedRoute {
+    val configuration = koinGet<ConfigurationRepository>()
+
     tags = setOf("API")
 
     get = GetInfo.builder {
         description("Get a new 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 {
             description("The authorization token")
             mediaTypes("application/json")
             responseCode(HttpStatusCode.OK)
             responseType<String>()
         }
+        canRespondUnauthorized()
     }
 }

src/main/kotlin/app/revanced/api/configuration/routes/ManagerRoute.kt

@@ -14,9 +14,18 @@ import io.ktor.server.routing.*
 import org.koin.ktor.ext.get as koinGet
 
 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>()
 
-    installManagerRouteDocumentation()
+    installManagerRouteDocumentation(deprecated)
 
     rateLimit(RateLimitName("weak")) {
         get {
@@ -24,7 +33,7 @@ internal fun Route.managerRoute() = route("manager") {
         }
 
         route("version") {
-            installManagerVersionRouteDocumentation()
+            installManagerVersionRouteDocumentation(deprecated)
 
             get {
                 call.respond(managerService.latestVersion())
@@ -33,10 +42,11 @@ internal fun Route.managerRoute() = route("manager") {
     }
 }
 
-private fun Route.installManagerRouteDocumentation() = installNotarizedRoute {
+private fun Route.installManagerRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
     tags = setOf("Manager")
 
     get = GetInfo.builder {
+        if (deprecated) isDeprecated()
         description("Get the current manager release")
         summary("Get current manager release")
         response {
@@ -48,10 +58,11 @@ private fun Route.installManagerRouteDocumentation() = installNotarizedRoute {
     }
 }
 
-private fun Route.installManagerVersionRouteDocumentation() = installNotarizedRoute {
+private fun Route.installManagerVersionRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
     tags = setOf("Manager")
 
     get = GetInfo.builder {
+        if (deprecated) isDeprecated()
         description("Get the current manager release version")
         summary("Get current manager release version")
         response {

src/main/kotlin/app/revanced/api/configuration/routes/PatchesRoute.kt

@@ -17,9 +17,18 @@ import kotlin.time.Duration.Companion.days
 import org.koin.ktor.ext.get as koinGet
 
 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>()
 
-    installPatchesRouteDocumentation()
+    installPatchesRouteDocumentation(deprecated)
 
     rateLimit(RateLimitName("weak")) {
         get {
@@ -27,7 +36,7 @@ internal fun Route.patchesRoute() = route("patches") {
         }
 
         route("version") {
-            installPatchesVersionRouteDocumentation()
+            installPatchesVersionRouteDocumentation(deprecated)
 
             get {
                 call.respond(patchesService.latestVersion())
@@ -37,7 +46,7 @@ internal fun Route.patchesRoute() = route("patches") {
 
     rateLimit(RateLimitName("strong")) {
         route("list") {
-            installPatchesListRouteDocumentation()
+            installPatchesListRouteDocumentation(deprecated)
 
             get {
                 call.respondBytes(ContentType.Application.Json) { patchesService.list() }
@@ -49,7 +58,7 @@ internal fun Route.patchesRoute() = route("patches") {
         route("keys") {
             installCache(356.days)
 
-            installPatchesPublicKeyRouteDocumentation()
+            installPatchesPublicKeyRouteDocumentation(deprecated)
 
             get {
                 call.respond(patchesService.publicKeys())
@@ -58,10 +67,11 @@ internal fun Route.patchesRoute() = route("patches") {
     }
 }
 
-private fun Route.installPatchesRouteDocumentation() = installNotarizedRoute {
+private fun Route.installPatchesRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
     tags = setOf("Patches")
 
     get = GetInfo.builder {
+        if (deprecated) isDeprecated()
         description("Get the current patches release")
         summary("Get current patches release")
         response {
@@ -73,10 +83,11 @@ private fun Route.installPatchesRouteDocumentation() = installNotarizedRoute {
     }
 }
 
-private fun Route.installPatchesVersionRouteDocumentation() = installNotarizedRoute {
+private fun Route.installPatchesVersionRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
     tags = setOf("Patches")
 
     get = GetInfo.builder {
+        if (deprecated) isDeprecated()
         description("Get the current patches release version")
         summary("Get current patches release version")
         response {
@@ -88,10 +99,11 @@ private fun Route.installPatchesVersionRouteDocumentation() = installNotarizedRo
     }
 }
 
-private fun Route.installPatchesListRouteDocumentation() = installNotarizedRoute {
+private fun Route.installPatchesListRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
     tags = setOf("Patches")
 
     get = GetInfo.builder {
+        if (deprecated) isDeprecated()
         description("Get the list of patches from the current patches release")
         summary("Get list of patches from current patches release")
         response {
@@ -103,10 +115,11 @@ private fun Route.installPatchesListRouteDocumentation() = installNotarizedRoute
     }
 }
 
-private fun Route.installPatchesPublicKeyRouteDocumentation() = installNotarizedRoute {
+private fun Route.installPatchesPublicKeyRouteDocumentation(deprecated: Boolean) = installNotarizedRoute {
     tags = setOf("Patches")
 
     get = GetInfo.builder {
+        if (deprecated) isDeprecated()
         description("Get the public keys for verifying patches and integrations assets")
         summary("Get patches and integrations public keys")
         response {