Package software.aws.awsprototypingsdk.openapigateway

Interface OpenApiGatewayTsProjectOptions

  • All Superinterfaces:
    io.github.cdklabs.projen.github.GitHubProjectOptions, software.amazon.jsii.JsiiSerializable, io.github.cdklabs.projen.javascript.NodePackageOptions, io.github.cdklabs.projen.javascript.NodeProjectOptions, OpenApiSpecConfig, io.github.cdklabs.projen.ProjectOptions, io.github.cdklabs.projen.release.ReleaseProjectOptions, io.github.cdklabs.projen.typescript.TypeScriptProjectOptions
    All Known Implementing Classes:
    OpenApiGatewayTsProjectOptions.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.61.0 (build abf4039)",
           date="2022-06-17T03:54:58.792Z")
@Stability(Experimental)
public interface OpenApiGatewayTsProjectOptions
extends software.amazon.jsii.JsiiSerializable, io.github.cdklabs.projen.typescript.TypeScriptProjectOptions, OpenApiSpecConfig
    (experimental) Configuration for the OpenApiGatewayTsProject.

    • Method Summary

      All Methods Static Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      static OpenApiGatewayTsProjectOptions.Builder builder()  
      List<ClientLanguage> getClientLanguages()
      (experimental) The list of languages for which clients will be generated.
      default String getGeneratedCodeDir()
      (experimental) The directory in which generated client code will be generated, relative to the outdir of this project.
      default String getSpecDir()
      (experimental) The directory in which the OpenAPI spec should be generated, relative to the outdir of this project.

      • Methods inherited from interface io.github.cdklabs.projen.github.GitHubProjectOptions

        getAutoApproveOptions, getAutoMerge, getAutoMergeOptions, getClobber, getDevContainer, getGithub, getGithubOptions, getGitpod, getMergify, getMergifyOptions, getProjectType, getProjenCredentials, getProjenTokenSecret, getReadme, getStale, getStaleOptions, getVscode

      • Methods inherited from interface software.amazon.jsii.JsiiSerializable

        $jsii$toJson

      • Methods inherited from interface io.github.cdklabs.projen.javascript.NodePackageOptions

        getAllowLibraryDependencies, getAuthorEmail, getAuthorName, getAuthorOrganization, getAuthorUrl, getAutoDetectBin, getBin, getBugsEmail, getBugsUrl, getBundledDeps, getCodeArtifactOptions, getDeps, getDescription, getDevDeps, getEntrypoint, getHomepage, getKeywords, getLicense, getLicensed, getMaxNodeVersion, getMinNodeVersion, getNpmAccess, getNpmRegistry, getNpmRegistryUrl, getNpmTokenSecret, getPackageManager, getPackageName, getPeerDependencyOptions, getPeerDeps, getRepository, getRepositoryDirectory, getScopedPackagesOptions, getScripts, getStability

      • Methods inherited from interface io.github.cdklabs.projen.javascript.NodeProjectOptions

        getArtifactsDirectory, getAutoApproveUpgrades, getBuildWorkflow, getBuildWorkflowTriggers, getBundlerOptions, getCodeCov, getCodeCovTokenSecret, getCopyrightOwner, getCopyrightPeriod, getDefaultReleaseBranch, getDependabot, getDependabotOptions, getDepsUpgrade, getDepsUpgradeOptions, getGitignore, getJest, getJestOptions, getMutableBuild, getNpmignore, getNpmignoreEnabled, getPackageValue, getPrettier, getPrettierOptions, getProjenDevDependency, getProjenrcJs, getProjenrcJsOptions, getProjenVersion, getPullRequestTemplate, getPullRequestTemplateContents, getRelease, getReleaseToNpm, getReleaseWorkflow, getWorkflowBootstrapSteps, getWorkflowGitIdentity, getWorkflowNodeVersion

      • Methods inherited from interface io.github.cdklabs.projen.ProjectOptions

        getLogging, getName, getOutdir, getParent, getProjenCommand, getProjenrcJson, getProjenrcJsonOptions, getRenovatebot, getRenovatebotOptions

      • Methods inherited from interface io.github.cdklabs.projen.release.ReleaseProjectOptions

        getJsiiReleaseVersion, getMajorVersion, getNpmDistTag, getPostBuildSteps, getPrerelease, getPublishDryRun, getPublishTasks, getReleaseBranches, getReleaseEveryCommit, getReleaseFailureIssue, getReleaseFailureIssueLabel, getReleaseSchedule, getReleaseTagPrefix, getReleaseTrigger, getReleaseWorkflowName, getReleaseWorkflowSetupSteps, getVersionrcOptions, getWorkflowContainerImage, getWorkflowRunsOn

      • Methods inherited from interface io.github.cdklabs.projen.typescript.TypeScriptProjectOptions

        getDisableTsconfig, getDocgen, getDocsDirectory, getEntrypointTypes, getEslint, getEslintOptions, getLibdir, getProjenrcTs, getProjenrcTsOptions, getSampleCode, getSrcdir, getTestdir, getTsconfig, getTsconfigDev, getTsconfigDevFile, getTypescriptVersion

    • Method Detail

      • getClientLanguages

        @Stability(Experimental)
@NotNull
List<ClientLanguage> getClientLanguages()
        (experimental) The list of languages for which clients will be generated.

        A typescript client will always be generated.

      • getGeneratedCodeDir

        @Stability(Experimental)
@Nullable
default String getGeneratedCodeDir()
        (experimental) The directory in which generated client code will be generated, relative to the outdir of this project.

        Default: "generated"

      • getSpecDir

        @Stability(Experimental)
@Nullable
default String getSpecDir()
        (experimental) The directory in which the OpenAPI spec should be generated, relative to the outdir of this project.

        Default: "spec"