io.github.honhimw.ms.api.Keys Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of meilisearch-rest-client Show documentation
Reactive meilisearch rest client powered by reactor-netty-http.
There is a newer version: 1.11.0.0
Show newest version
/*
 * 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.
 */

package io.github.honhimw.ms.api;

import io.github.honhimw.ms.model.*;
import io.github.honhimw.ms.api.annotation.Operation;
import jakarta.annotation.Nullable;

import java.util.Optional;
import java.util.function.Consumer;

/**
 * Manage API keys for a Meilisearch instance. Each key has a given set of permissions.
 * You must have the master key or the default admin key to access the keys route.
 * More information about the keys and their rights.
 *
 * @author hon_him
 * @since 2024-01-02
 */

public interface Keys {

    /**
     * Get all Keys
     *
     * @param offset Number of results to skip.
     * @param limit  Maximum number of results to return.
     * @return Returns the 20 most recently created keys in a results array. Expired keys are included in the response, but deleted keys are not.
     */
    @Operation(method = "GET", paths = "/keys")
    Page list(@Nullable Integer offset, @Nullable Integer limit);

    /**
     * Get all Keys
     *
     * @param page page builder
     * @return Returns the most recently created keys in a results array. Expired keys are included in the response, but deleted keys are not.
     */
    @Operation(method = "GET", paths = "/keys")
    default Page list(Consumer page) {
        PageRequest pageRequest = new PageRequest();
        page.accept(pageRequest);
        return list(pageRequest.toOffset(), pageRequest.toLimit());
    }

    /**
     * Get information on the specified key. Attempting to use this endpoint with a non-existent or deleted key will result in an error.
     *
     * @param keyOrUid key value of the requested API key, uid of the requested API key
     * @return Returns information on the specified key.
     */
    @Operation(method = "GET", paths = "/keys/{key_or_uid}")
    Optional get(String keyOrUid);

    /**
     * Create an API key with the provided description, permissions, and expiration date.
     *
     * @param request CreateKeyRequest
     * @return Returns information on the created key.
     */
    @Operation(method = "POST", paths = "/keys/{key_or_uid}")
    Key create(CreateKeyRequest request);

    /**
     * Create an API key with the provided description, permissions, and expiration date.
     *
     * @param builder request builder
     * @return Returns information on the created key.
     */
    @Operation(method = "POST", paths = "/keys/{key_or_uid}")
    Key create(Consumer builder);

    /**
     * A valid API key or uid is required.
     *
     * @param keyOrUid key value of the requested API key, uid of the requested API key
     * @param request  UpdateKeyRequest request
     * @return Returns information on the updated key.
     */
    @Operation(method = "PATCH", paths = "/keys/{key_or_uid}")
    Key update(String keyOrUid, UpdateKeyRequest request);

    /**
     * A valid API key or uid is required.
     * @param keyOrUid key value of the requested API key, uid of the requested API key
     * @param builder request builder
     * @return Returns information on the updated key.
     */
    @Operation(method = "PATCH", paths = "/keys/{key_or_uid}")
    Key update(String keyOrUid, Consumer builder);

    /**
     * Delete the specified key. Attempting to use this endpoint with a non-existent or deleted key will result in an error.
     * @param keyOrUid key value of the requested API key, uid of the requested API key
     */
    @Operation(method = "DELETE", paths = "/keys/{key_or_uid}")
    void delete(String keyOrUid);

}