org.jreleaser.sdk.github.api.GithubAPI Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jreleaser-github-java-sdk Show documentation

Java SDK for GitHub

There is a newer version: 1.14.0

Show newest version

/*
 * SPDX-License-Identifier: Apache-2.0
 *
 * Copyright 2020-2023 The JReleaser authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.jreleaser.sdk.github.api;

import feign.Headers;
import feign.Param;
import feign.QueryMap;
import feign.RequestLine;
import org.jreleaser.infra.nativeimage.annotations.ProxyConfig;
import org.jreleaser.sdk.github.internal.Page;

import java.net.URI;
import java.util.List;
import java.util.Map;

/**
 * @author Andres Almiray
 * @since 0.6.0
 */
@ProxyConfig
public interface GithubAPI {
    @RequestLine("PATCH /repos/{owner}/{repo}/releases/{id}")
    @Headers("Content-Type: application/json")
    void updateRelease(GhRelease release, @Param("owner") String owner, @Param("repo") String repo, @Param("id") Long id);

    @RequestLine("GET /search/users")
    @Headers("Content-Type: application/json")
    GhSearchUser searchUser(@QueryMap Map q);

    @RequestLine("GET /users/{username}")
    @Headers("Content-Type: application/json")
    GhUser getUser(@Param("username") String username);

    @RequestLine("POST /repos/{owner}/{repo}/releases/generate-notes")
    @Headers("Content-Type: application/json")
    GhReleaseNotes generateReleaseNotes(GhReleaseNotesParams params, @Param("owner") String owner, @Param("repo") String repo);

    @RequestLine("DELETE /user/packages/{packageType}/{packageName}/versions/{versionId}")
    @Headers("Content-Type: application/json")
    void deletePackageVersion(@Param("packageType") String packageType, @Param("packageName") String packageName, @Param("versionId") String versionId);

    @RequestLine("DELETE /user/packages/{packageType}/{packageName}")
    @Headers("Content-Type: application/json")
    void deletePackage(@Param("packageType") String packageType, @Param("packageName") String packageName);

    @RequestLine("GET /user/packages/{packageType}/{packageName}/versions")
    @Headers("Content-Type: application/json")
    Page> listPackageVersions0(@Param("packageType") String packageType, @Param("packageName") String packageName);

    @RequestLine("GET")
    @Headers("Content-Type: application/json")
    Page> listPackageVersions1(URI uri);
}