Skip to content

Commit

Permalink
swagger: Document schema in TmfConfigurationSourceType
Browse files Browse the repository at this point in the history
Signed-off-by: Bernd Hufmann <[email protected]>
  • Loading branch information
bhufmann committed Sep 18, 2024
1 parent ad96ce3 commit ae2a663
Showing 1 changed file with 20 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,25 @@ public interface ConfigurationSourceType {
* configuration instance of this type. Use 'path' key for file
* URIs.
*/
@Schema(description = "A list of configuration parameter descriptors to be passed when creating or updating a configuration instance of this type.")
@Schema(description = "A list of configuration parameter descriptors to be "
+ "passed when creating or updating a configuration instance of this "
+ "type. Use this instead of schema. Omit if not used.")
List<ConfigurationParameterDescriptor> getParameterDescriptors();

/**
* @return a JSON schema that describes the parameters that the front-end
* needs to provide with corresponding values. Use this for complex
* parameter descriptions instead of parameterDescriptors.
*/
@Schema(description = "A JSON object that describes a schema for parameters that "
+ "the front-end needs to provide with corresponding values. "
+ "Use this for complex parameter descriptions instead of parameterDescriptors. "
+ "Omit if not used.")
OptionalSchema getSchema();

/**
* A JSON Object defining a schema.
*/
interface OptionalSchema {
}
}

0 comments on commit ae2a663

Please sign in to comment.