|
| 1 | +imports: |
| 2 | + logging: logging.yml |
| 3 | +types: |
| 4 | + GeneratorConfig: |
| 5 | + properties: |
| 6 | + dryRun: boolean |
| 7 | + irFilepath: string |
| 8 | + originalReadmeFilepath: optional<string> |
| 9 | + license: optional<LicenseConfig> |
| 10 | + output: GeneratorOutputConfig |
| 11 | + publish: |
| 12 | + type: optional<GeneratorPublishConfig> |
| 13 | + docs: Deprecated. Use output.mode instead. |
| 14 | + workspaceName: string |
| 15 | + organization: string |
| 16 | + customConfig: unknown |
| 17 | + environment: GeneratorEnvironment |
| 18 | + whitelabel: boolean |
| 19 | + writeUnitTests: boolean |
| 20 | + generatePaginatedClients: optional<boolean> |
| 21 | + generateOauthClients: boolean |
| 22 | + LicenseConfig: |
| 23 | + union: |
| 24 | + basic: BasicLicense |
| 25 | + custom: CustomLicense |
| 26 | + BasicLicense: |
| 27 | + properties: |
| 28 | + id: LicenseId |
| 29 | + LicenseId: |
| 30 | + enum: |
| 31 | + - MIT |
| 32 | + - name: apache2 |
| 33 | + value: Apache-2.0 |
| 34 | + CustomLicense: |
| 35 | + properties: |
| 36 | + filename: string |
| 37 | + GeneratorOutputConfig: |
| 38 | + properties: |
| 39 | + path: string |
| 40 | + snippetFilepath: optional<string> |
| 41 | + snippetTemplateFilepath: optional<string> |
| 42 | + publishingMetadata: optional<PublishingMetadata> |
| 43 | + mode: OutputMode |
| 44 | + OutputMode: |
| 45 | + union: |
| 46 | + publish: GeneratorPublishConfig |
| 47 | + downloadFiles: {} |
| 48 | + github: GithubOutputMode |
| 49 | + GeneratorPublishConfig: |
| 50 | + properties: |
| 51 | + registries: |
| 52 | + type: GeneratorRegistriesConfig |
| 53 | + docs: Deprecated, use publishTargets instead. |
| 54 | + registriesV2: |
| 55 | + type: GeneratorRegistriesConfigV2 |
| 56 | + docs: Deprecated, use publishTargets instead. |
| 57 | + publishTarget: optional<GeneratorPublishTarget> |
| 58 | + version: string |
| 59 | + GithubOutputMode: |
| 60 | + properties: |
| 61 | + version: string |
| 62 | + repoUrl: |
| 63 | + type: string |
| 64 | + docs: A full repo url (i.e. https://github.com/fern-api/fern) |
| 65 | + installationToken: |
| 66 | + type: optional<string> |
| 67 | + docs: > |
| 68 | + The token scoped to installing the repository. If not specified, the |
| 69 | + generator |
| 70 | +
|
| 71 | + should NOT attempt to clone the repository. |
| 72 | + publishInfo: optional<GithubPublishInfo> |
| 73 | + OutputMetadataAuthor: |
| 74 | + properties: |
| 75 | + name: string |
| 76 | + email: string |
| 77 | + OutputMetadata: |
| 78 | + properties: |
| 79 | + description: optional<string> |
| 80 | + authors: optional<list<OutputMetadataAuthor>> |
| 81 | + PublishingMetadata: |
| 82 | + docs: >- |
| 83 | + This should effectively be deprecated in favor of a more specific |
| 84 | + configuration per-output mode (pypi, maven, etc.). |
| 85 | + properties: |
| 86 | + package_description: optional<string> |
| 87 | + publisher_email: optional<string> |
| 88 | + reference_url: optional<string> |
| 89 | + publisher_name: optional<string> |
| 90 | + GithubPublishInfo: |
| 91 | + union: |
| 92 | + npm: NpmGithubPublishInfo |
| 93 | + maven: MavenGithubPublishInfo |
| 94 | + postman: PostmanGithubPublishInfo |
| 95 | + pypi: PypiGithubPublishInfo |
| 96 | + rubygems: RubyGemsGithubPublishInfo |
| 97 | + nuget: NugetGithubPublishInfo |
| 98 | + EnvironmentVariable: string |
| 99 | + NpmGithubPublishInfo: |
| 100 | + properties: |
| 101 | + registryUrl: string |
| 102 | + packageName: string |
| 103 | + tokenEnvironmentVariable: EnvironmentVariable |
| 104 | + shouldGeneratePublishWorkflow: optional<boolean> |
| 105 | + MavenCentralSignatureGithubInfo: |
| 106 | + properties: |
| 107 | + keyIdEnvironmentVariable: EnvironmentVariable |
| 108 | + passwordEnvironmentVariable: EnvironmentVariable |
| 109 | + secretKeyEnvironmentVariable: EnvironmentVariable |
| 110 | + MavenGithubPublishInfo: |
| 111 | + properties: |
| 112 | + registryUrl: string |
| 113 | + coordinate: string |
| 114 | + usernameEnvironmentVariable: EnvironmentVariable |
| 115 | + passwordEnvironmentVariable: EnvironmentVariable |
| 116 | + signature: optional<MavenCentralSignatureGithubInfo> |
| 117 | + shouldGeneratePublishWorkflow: optional<boolean> |
| 118 | + PostmanGithubPublishInfo: |
| 119 | + properties: |
| 120 | + apiKeyEnvironmentVariable: EnvironmentVariable |
| 121 | + workspaceIdEnvironmentVariable: EnvironmentVariable |
| 122 | + PypiMetadata: |
| 123 | + extends: OutputMetadata |
| 124 | + properties: |
| 125 | + keywords: optional<list<string>> |
| 126 | + documentationLink: optional<string> |
| 127 | + homepageLink: optional<string> |
| 128 | + PypiGithubPublishInfo: |
| 129 | + properties: |
| 130 | + registryUrl: string |
| 131 | + packageName: string |
| 132 | + usernameEnvironmentVariable: EnvironmentVariable |
| 133 | + passwordEnvironmentVariable: EnvironmentVariable |
| 134 | + pypiMetadata: optional<PypiMetadata> |
| 135 | + shouldGeneratePublishWorkflow: optional<boolean> |
| 136 | + RubyGemsGithubPublishInfo: |
| 137 | + properties: |
| 138 | + registryUrl: string |
| 139 | + packageName: string |
| 140 | + apiKeyEnvironmentVariable: EnvironmentVariable |
| 141 | + shouldGeneratePublishWorkflow: optional<boolean> |
| 142 | + NugetGithubPublishInfo: |
| 143 | + properties: |
| 144 | + registryUrl: string |
| 145 | + packageName: string |
| 146 | + apiKeyEnvironmentVariable: EnvironmentVariable |
| 147 | + shouldGeneratePublishWorkflow: optional<boolean> |
| 148 | + GeneratorRegistriesConfig: |
| 149 | + properties: |
| 150 | + maven: MavenRegistryConfig |
| 151 | + npm: NpmRegistryConfig |
| 152 | + MavenCentralSignature: |
| 153 | + properties: |
| 154 | + keyId: string |
| 155 | + password: string |
| 156 | + secretKey: string |
| 157 | + MavenRegistryConfig: |
| 158 | + properties: |
| 159 | + registryUrl: string |
| 160 | + username: string |
| 161 | + password: string |
| 162 | + group: string |
| 163 | + signature: optional<MavenCentralSignature> |
| 164 | + NpmRegistryConfig: |
| 165 | + properties: |
| 166 | + registryUrl: string |
| 167 | + token: string |
| 168 | + scope: string |
| 169 | + GeneratorRegistriesConfigV2: |
| 170 | + properties: |
| 171 | + maven: MavenRegistryConfigV2 |
| 172 | + npm: NpmRegistryConfigV2 |
| 173 | + pypi: PypiRegistryConfig |
| 174 | + rubygems: RubyGemsRegistryConfig |
| 175 | + nuget: NugetRegistryConfig |
| 176 | + GeneratorPublishTarget: |
| 177 | + union: |
| 178 | + maven: MavenRegistryConfigV2 |
| 179 | + npm: NpmRegistryConfigV2 |
| 180 | + pypi: PypiRegistryConfig |
| 181 | + postman: PostmanConfig |
| 182 | + rubygems: RubyGemsRegistryConfig |
| 183 | + nuget: NugetRegistryConfig |
| 184 | + MavenRegistryConfigV2: |
| 185 | + properties: |
| 186 | + registryUrl: string |
| 187 | + username: string |
| 188 | + password: string |
| 189 | + coordinate: string |
| 190 | + signature: optional<MavenCentralSignature> |
| 191 | + NpmRegistryConfigV2: |
| 192 | + properties: |
| 193 | + registryUrl: string |
| 194 | + token: string |
| 195 | + packageName: string |
| 196 | + PypiRegistryConfig: |
| 197 | + properties: |
| 198 | + registryUrl: string |
| 199 | + username: string |
| 200 | + password: string |
| 201 | + packageName: string |
| 202 | + pypiMetadata: optional<PypiMetadata> |
| 203 | + RubyGemsRegistryConfig: |
| 204 | + properties: |
| 205 | + registryUrl: string |
| 206 | + apiKey: string |
| 207 | + packageName: string |
| 208 | + NugetRegistryConfig: |
| 209 | + properties: |
| 210 | + registryUrl: string |
| 211 | + apiKey: string |
| 212 | + packageName: string |
| 213 | + PostmanConfig: |
| 214 | + properties: |
| 215 | + apiKey: string |
| 216 | + workspaceId: string |
| 217 | + GeneratorEnvironment: |
| 218 | + union: |
| 219 | + local: {} |
| 220 | + remote: RemoteGeneratorEnvironment |
| 221 | + discriminant: |
| 222 | + name: type |
| 223 | + value: _type |
| 224 | + RemoteGeneratorEnvironment: |
| 225 | + properties: |
| 226 | + coordinatorUrl: string |
| 227 | + coordinatorUrlV2: string |
| 228 | + id: logging.TaskId |
0 commit comments