io.swagger.v3.oas.annotations.ExternalDocumentation Java Examples

/**
 * Return the configuration used for the current active instance of the server.  Null is returned if
 * the server instance is not running.
 *
 * @param userId  user that is issuing the request
 * @param serverName  local server name
 * @return configuration properties used to initialize the server or null if not running or
 * OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or
 * OMAGInvalidParameterException the server name is invalid or
 * OMAGConfigurationErrorException there is a problem using the supplied configuration.
 */
@GetMapping(path = "/instance/configuration")

@Operation(summary="Retrieve active server's running configuration",
        description="Retrieve the configuration document used to start a running instance of a server.  The stored configuration" +
                "document may have changed since the server was started.  This operation makes it possible to verify the " +
                "configuration values actually being used in the running server. \n" +
                "\n" +
                "Null is returned if the server is not running.",
        externalDocs=@ExternalDocumentation(description="Configuration Documents",
                url="https://egeria.odpi.org/open-metadata-implementation/admin-services/docs/concepts/configuration-document.html"))

public OMAGServerConfigResponse getActiveConfiguration(@PathVariable String           userId,
                                                       @PathVariable String           serverName)
{
    return operationalServices.getActiveConfiguration(userId, serverName);
}
 

@GetMapping("/persons/{subscriptionId}")
@Operation(operationId = "operationId", summary = "Operation Summary", description = "Operation Description", tags = {
		"Example Tag" }, externalDocs = @ExternalDocumentation(description = "External documentation description", url = "http://url.com"), parameters = {
		@Parameter(in = ParameterIn.PATH, name = "subscriptionId", required = true, description = "parameter description", allowEmptyValue = true, allowReserved = true, schema = @Schema(type = "string", format = "uuid", description = "the generated UUID", accessMode = Schema.AccessMode.READ_ONLY)) }, responses = {
		@ApiResponse(responseCode = "200", description = "voila!", content = @Content(mediaType = "application/json", schema = @Schema(implementation = String.class))) })
public String persons(String subscriptionId) {
	return "OK";
}
 

/**
 * Activate the Open Metadata and Governance (OMAG) server using the configuration document stored for this server.
 *
 * @param userId  user that is issuing the request
 * @param serverName  local server name
 * @return void response or
 * OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or
 * OMAGInvalidParameterException the server name is invalid or
 * OMAGConfigurationErrorException there is a problem using the supplied configuration.
 */
@PostMapping(path = "/instance")

@Operation(summary="Activate server with stored configuration document",
           description="Activate the named OMAG server using the appropriate configuration document found in the configuration store.",
        externalDocs=@ExternalDocumentation(description="Configuration Documents",
                url="https://egeria.odpi.org/open-metadata-implementation/admin-services/docs/concepts/configuration-document.html"))

public SuccessMessageResponse activateWithStoredConfig(@PathVariable String userId,
                                                       @PathVariable String serverName)
{
    return operationalServices.activateWithStoredConfig(userId, serverName);
}
 

/**
 * Activate the open metadata and governance services using the supplied configuration
 * document.
 *
 * @param userId  user that is issuing the request
 * @param configuration  properties used to initialize the services
 * @param serverName  local server name
 * @return void response or
 * OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or
 * OMAGInvalidParameterException the server name is invalid or
 * OMAGConfigurationErrorException there is a problem using the supplied configuration.
 */
@PostMapping(path = "/instance/configuration")

@Operation(summary="Activate server with supplied configuration document",
        description="Activate the named OMAG server using the supplied configuration document. This configuration " +
                "document is added to the configuration store, over-writing any previous configuration for this server.",
        externalDocs=@ExternalDocumentation(description="Configuration Documents",
                url="https://egeria.odpi.org/open-metadata-implementation/admin-services/docs/concepts/configuration-document.html"))

public SuccessMessageResponse activateWithSuppliedConfig(@PathVariable String           userId,
                                                         @PathVariable String           serverName,
                                                         @RequestBody  OMAGServerConfig configuration)
{
    return operationalServices.activateWithSuppliedConfig(userId, serverName, configuration);
}
 

/**
 * Add a new open metadata archive to running repository.
 *
 * @param userId  user that is issuing the request.
 * @param serverName  local server name.
 * @param fileName name of the open metadata archive file.
 * @return void response or
 * OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or
 * OMAGInvalidParameterException invalid serverName or fileName parameter.
 */
@PostMapping(path = "/instance/open-metadata-archives/file")

@Operation(summary="Load open metadata archive",
        description="An open metadata archive contains metadata types and instances.  This operation loads an open metadata " +
                "archive into an OMAG server.  It will only be successful if the server has a local repository defined.",
        externalDocs=@ExternalDocumentation(description="Open Metadata Archives",
                url="https://egeria.odpi.org/open-metadata-resources/open-metadata-archives/index.html"))

public VoidResponse addOpenMetadataArchiveFile(@PathVariable String userId,
                                               @PathVariable String serverName,
                                               @RequestBody  String fileName)
{
    return operationalServices.addOpenMetadataArchiveFile(userId, serverName, fileName);
}
 

/**
 * Add a new open metadata archive to running repository.
 *
 * @param userId  user that is issuing the request.
 * @param serverName  local server name.
 * @param connection connection for the open metadata archive.
 * @return void response or
 * OMAGNotAuthorizedException the supplied userId is not authorized to issue this command or
 * OMAGInvalidParameterException invalid serverName or connection parameter.
 */
@PostMapping(path = "/instance/open-metadata-archives/connection")

@Operation(summary="Load open metadata archive",
        description="An open metadata archive contains metadata types and instances.  This operation loads an open metadata " +
                "archive into an OMAG server.  It will only be successful if the server has a local repository defined.",
        externalDocs=@ExternalDocumentation(description="Open Metadata Archives",
                url="https://egeria.odpi.org/open-metadata-resources/open-metadata-archives/index.html"))

public VoidResponse addOpenMetadataArchiveFile(@PathVariable String     userId,
                                               @PathVariable String     serverName,
                                               @RequestBody  Connection connection)
{
    return operationalServices.addOpenMetadataArchiveFile(userId, serverName, connection);
}
 

public Operation parseMethod(
								Method method,
								List<Parameter> globalParameters,
								Produces methodProduces,
								Produces classProduces,
								Consumes methodConsumes,
								Consumes classConsumes,
								List<SecurityRequirement> classSecurityRequirements,
								Optional<io.swagger.v3.oas.models.ExternalDocumentation> classExternalDocs,
								Set<String> classTags,
								List<io.swagger.v3.oas.models.servers.Server> classServers,
								boolean isSubresource,
								RequestBody parentRequestBody,
								ApiResponses parentResponses,
								JsonView jsonViewAnnotation,
								io.swagger.v3.oas.annotations.responses.ApiResponse[] classResponses)
{
	JavaType classType = TypeFactory.defaultInstance().constructType(method.getDeclaringClass());
	return parseMethod(
						classType.getClass(),
						method,
						globalParameters,
						methodProduces,
						classProduces,
						methodConsumes,
						classConsumes,
						classSecurityRequirements,
						classExternalDocs,
						classTags,
						classServers,
						isSubresource,
						parentRequestBody,
						parentResponses,
						jsonViewAnnotation,
						classResponses);
}
 

@Parameter(name = JAXRSService.PARAM_REALM, description = "realms define a hierarchical security domain tree, "
        + "primarily meant for containing Users, Groups and Any Objects", schema =
        @Schema(implementation = String.class, defaultValue = SyncopeConstants.ROOT_REALM, externalDocs =
                @ExternalDocumentation(description = "Apache Syncope Reference Guide",
                        url = "http://syncope.apache.org/docs/2.1/reference-guide.html#realms")))
public String getRealm() {
    return realm;
}
 

@Parameter(name = JAXRSService.PARAM_FIQL, description = "Feed Item Query Language (FIQL, pronounced “fickle”) is "
        + "a simple but flexible, URI-friendly syntax for expressing filters across the entries in a syndicated "
        + "feed.", example = "username==rossini", schema =
        @Schema(implementation = String.class, externalDocs =
                @ExternalDocumentation(description = "Apache Syncope Reference Guide",
                        url = "http://syncope.apache.org/docs/2.1/reference-guide.html#search")))
@QueryParam(JAXRSService.PARAM_FIQL)
public void setFiql(final String fiql) {
    this.fiql = fiql;
}
 

@Operation(tags = {"Example Tag", "Second Tag"})
@Tag(name = "Third Tag")
@Tag(name = "Second Tag")
@Tag(name = "Fourth Tag Full", description = "desc", externalDocs = @ExternalDocumentation(description = "docs desc"))
@ApiResponse(description = "default response")
ServiceCall<NotUsed, NotUsed> test();