Package io.bdeploy.api.validation.v1.dto

Class ProductValidationDescriptorApi

java.lang.Object

io.bdeploy.api.validation.v1.dto.ProductValidationDescriptorApi

@JsonClassDescription("This descriptor references all files which should be validated during raw product validation.")
public class ProductValidationDescriptorApi
extends Object

This descriptor references all files which should be validated during raw product validation.

Applications (`app-info.yaml` files) are not directly referenced from `product-info.yaml` files, thus this descriptor creates the required association.

Field Summary

Fields

Modifier and Type	Field	Description
Map<String,String>	applications	A map of application names to their respective `app-info.yaml` files.
static final String	FILE_NAME	The internal file name used when packaging the ProductValidationDescriptorApi in a ZIP file to send to the server.
String	product	Path to the `product-info.yaml` file which defines the root product to be validated.

Constructor Summary

Constructors

Constructor	Description
ProductValidationDescriptorApi()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

FILE_NAME

public static final String FILE_NAME

The internal file name used when packaging the ProductValidationDescriptorApi in a ZIP file to send to the server.

The input file for validation may have a different name.

See Also:

• Constant Field Values

product

@JsonPropertyDescription("The relative or absolute path to the product-info.yaml for the product to validate.")
public String product

Path to the `product-info.yaml` file which defines the root product to be validated.

applications

@JsonPropertyDescription("Relative or absolute paths to the individual app-info.yaml files for each application.")
public Map<String,String> applications

A map of application names to their respective `app-info.yaml` files. The names should give a human an idea of which application is referenced here, however they need not match the application IDs in the `product-info.yaml`. This is to allow specifying the same application multiple times for different OS in case they have different descriptors per OS.

Constructor Details

ProductValidationDescriptorApi

public ProductValidationDescriptorApi()