apigateway:download-api-definition

Full name:

br.com.ingenieux:apigateway-maven-plugin:1.5.6:download-api-definition

Description:

(no description)

Attributes:

  • Requires a Maven project to be executed.

Required Parameters

Name Type Since Description
<curProject> MavenProject - (no description)
User property is: project.
<restApiName> String - (no description)
Default value is: ${project.artifactId}.
User property is: apigateway.restApiName.
<session> MavenSession - (no description)
Default value is: ${session}.
<stageName> String - (no description)
Default value is: dev.
User property is: apigateway.stageName.

Optional Parameters

Name Type Since Description
<credentialId> String - The credential id (on ~/.aws/credentials file) to use)
Default value is: default.
User property is: beanstalker.credentialId.
<ignoreExceptions> boolean - Ignore Exceptions?
Default value is: false.
User property is: beanstalker.ignoreExceptions.
<outputFile> File - Output File
Default value is: ${project.build.outputDirectory}/apigateway-swagger.json.
User property is: apigateway.outputFile.
<regionName> String -

Service region e.g. "us-east-1"

See this list for reference.


User property is: beanstalker.region.
<serverId> String - The server id in maven settings.xml to use for AWS Services Credentials (accessKey / secretKey)
Default value is: aws.amazon.com.
User property is: beanstalker.serverId.
<verbose> boolean - Verbose Logging?
Default value is: false.
User property is: beanstalker.verbose.

Parameter Details

<credentialId>

The credential id (on ~/.aws/credentials file) to use)
  • Type: java.lang.String
  • Required: No
  • User Property: beanstalker.credentialId
  • Default: default

<curProject>

(no description)
  • Type: org.apache.maven.project.MavenProject
  • Required: Yes
  • User Property: project

<ignoreExceptions>

Ignore Exceptions?
  • Type: boolean
  • Required: No
  • User Property: beanstalker.ignoreExceptions
  • Default: false

<outputFile>

Output File
  • Type: java.io.File
  • Required: No
  • User Property: apigateway.outputFile
  • Default: ${project.build.outputDirectory}/apigateway-swagger.json

<regionName>

Service region e.g. "us-east-1"

See this list for reference.

  • Type: java.lang.String
  • Required: No
  • User Property: beanstalker.region

<restApiName>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: apigateway.restApiName
  • Default: ${project.artifactId}

<serverId>

The server id in maven settings.xml to use for AWS Services Credentials (accessKey / secretKey)
  • Type: java.lang.String
  • Required: No
  • User Property: beanstalker.serverId
  • Default: aws.amazon.com

<session>

(no description)
  • Type: org.apache.maven.execution.MavenSession
  • Required: Yes
  • Default: ${session}

<stageName>

(no description)
  • Type: java.lang.String
  • Required: Yes
  • User Property: apigateway.stageName
  • Default: dev

<verbose>

Verbose Logging?
  • Type: boolean
  • Required: No
  • User Property: beanstalker.verbose
  • Default: false