src.main.kotlin.com.gabrielfeo.develocity.api.MetaApi.kt Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of develocity-api-kotlin Show documentation

A library to use the Develocity API in Kotlin

The newest version!

package com.gabrielfeo.develocity.api

import com.gabrielfeo.develocity.api.internal.infrastructure.CollectionFormats.*
import retrofit2.http.*
import retrofit2.Response
import okhttp3.RequestBody
import com.squareup.moshi.Json

import com.gabrielfeo.develocity.api.model.ApiProblem
import com.gabrielfeo.develocity.api.model.DevelocityVersion

@JvmSuppressWildcards
interface MetaApi {
    /**
     * Provides the version of Develocity.
     * This endpoint can be accessed by any authenticated user.
     * Responses:
     *  - 200: Successful version response
     *  - 404: The referenced resource either does not exist or the permissions to know about it are missing.
     *  - 500: The server encountered an unexpected error.
     *
     * @return [DevelocityVersion]
     */
    @GET("api/version")
    suspend fun getVersion(): DevelocityVersion

}