hu.icellmobilsoft.roaster.zephyr.common.client.api.JiraRestClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of roaster-zephyr-common Show documentation

The newest version!

/*-
 * #%L
 * Roaster
 * %%
 * Copyright (C) 2020 i-Cell Mobilsoft Zrt.
 * %%
 * 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
 *
 *      http://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.
 * #L%
 */
package hu.icellmobilsoft.roaster.zephyr.common.client.api;

import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

import org.eclipse.microprofile.rest.client.annotation.RegisterClientHeaders;
import org.eclipse.microprofile.rest.client.inject.RegisterRestClient;

import hu.icellmobilsoft.roaster.zephyr.common.client.JiraAuthHeadersFactory;
import hu.icellmobilsoft.roaster.zephyr.dto.domain.jira.User;

/**
 * Interface for microprofile rest client. 

 * 

 * For details see the JIRA Server platform REST API reference
 *
 * @author mark.vituska
 * @since 0.11.0
 */
@RegisterRestClient(configKey = "roaster.zephyr.server")
@RegisterClientHeaders(JiraAuthHeadersFactory.class)
@Path("/rest/api/3")
public interface JiraRestClient {

    /**
     * Returns the data of the logged-in user
     *
     * @return the data of the logged-in user
     */
    @GET
    @Produces(MediaType.APPLICATION_JSON)
    @Path("/myself")
    User getSelf();

}