io.bdeploy.api.schema.v1.PublicSchemaResource Maven / Gradle / Ivy

Go to download

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

Public API including dependencies, ready to be used for integrations and plugins.

There is a newer version: 7.3.6

package io.bdeploy.api.schema.v1;

import io.bdeploy.jersey.JerseyAuthenticationProvider.Unsecured;
import io.swagger.v3.oas.annotations.Operation;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;

@Path("/public/v1/schema")
public interface PublicSchemaResource {

    public enum Schema {
        appInfoYaml,
        productInfoYaml,
        productVersionYaml,
        applicationTemplateYaml,
        instanceTemplateYaml,
        parameterTemplateYaml,
        instanceVariableTemplateYaml,
        systemTemplateYaml,
        productValidationYaml,
    }

    @Operation(summary = "Get a YAML Schema", description = "Retrieve a JSON schema for various BDeploy YAML file formats.")
    @GET
    @Unsecured
    @Path("{schema}")
    public String getSchema(@PathParam("schema") Schema schema);

}