latest--java.schema

shared
Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/speakeasy-generation-config-file/_shared/latest--java.schema.json
Parent schema speakeasy-generation-config-file
Type: object

Schema for configuration specific to a java SDK

Properties

artifactID string required

The artifactID to use for namespacing the package. This is usually the name of your project. If publishing is enabled, it will also be used as the artifactId (e.g. com.your-org.).

pattern=^[\w0-9\/._-]+$
groupID string required

The groupID to use for namespacing the package. This is usually the reversed domain name of your organization. If publishing is enabled, it will also be used as the artifact's groupId (e.g. .my-artifact).

pattern=^\w[\w0-9.\-_]*$
projectName string required

Assigns Gradle rootProject.name, which gives a name to the Gradle build. https://docs.gradle.org/current/userguide/multi_project_builds.html#naming_recommendations

pattern=^[\w0-9.\-_]+$
version string required

The current version of the SDK

pattern=^[\w0-9.\-_]+$
clientServerStatusCodesAsErrors boolean

Whether to treat 4xx and 5xx status codes as errors.

companyEmail string

A support email address for your company. Sets metadata required by Maven.

companyName string

The name of your company. Sets metadata required by Maven.

companyURL string

Your company's homepage URL. Sets metadata required by Maven.

defaultErrorName string

The name of the default exception that is thrown when an API error occurs.

pattern=^[A-Z][a-zA-Z0-9]*$
flattenGlobalSecurity boolean

Flatten the global security configuration if there is only a single option in the spec

githubURL string

The github URL where the artifact is hosted. Sets metadata required by Maven.

pattern=github\.com\/[a-zA-z0-9_-]+?\/.+
inputModelSuffix string

The suffix to add to models with writeOnly fields that are created as input models

pattern=^[\w0-9.\-_]+$
maxMethodParams number

The maximum number of parameters a method can have before the resulting SDK endpoint is no longer 'flattened' and an input object is created instead. 0 will use input objects always. https://www.speakeasy.com/docs/customize-sdks/methods

pattern=^\d+$
ossrhURL

The URL of the staging repository to publish the SDK artifact to.

outputModelSuffix string

The suffix to add to models with writeOnly fields that are created as input models

pattern=^[\w0-9.\-_]+$
templateVersion string

The template version to use

pattern=v2