Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Kotlin docs updated #439

Merged
merged 1 commit into from
May 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 25 additions & 25 deletions docs/generators/kotlin.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,12 +171,12 @@ These options may be applied as additional-properties (cli) or configOptions (pl
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|schemas|✓|OAS3
|responses||OAS3
|parameters||OAS3
|responses||OAS3
|parameters||OAS3
|examples|✗|OAS3
|requestBodies||OAS3
|headers||OAS3
|securitySchemes||OAS3
|requestBodies||OAS3
|headers||OAS3
|securitySchemes||OAS3
|links|✗|OAS3
|callbacks|✗|OAS3
|pathItems|✗|OAS3
Expand Down Expand Up @@ -211,39 +211,39 @@ These options may be applied as additional-properties (cli) or configOptions (pl
| ---- | --------- | ---------- |
|Readme|✓|ToolingExtension
|Servers|✓|OAS3
|Security||OAS2,OAS3
|Security||OAS2,OAS3
|ComponentSchemas|✓|OAS3
|ComponentResponses||OAS3
|ComponentParameters||OAS3
|ComponentRequestBodies||OAS3
|ComponentHeaders||OAS3
|ComponentSecuritySchemes||OAS3
|ComponentResponses||OAS3
|ComponentParameters||OAS3
|ComponentRequestBodies||OAS3
|ComponentHeaders||OAS3
|ComponentSecuritySchemes||OAS3
|ComponentLinks|✗|OAS3
|ComponentCallbacks|✗|OAS3
|ComponentPathItems|✗|OAS3
|Api||ToolingExtension
|Api||ToolingExtension

### Global Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|Info||OAS2,OAS3
|Info||OAS2,OAS3
|Servers|✓|OAS3
|Paths||OAS2,OAS3
|Paths||OAS2,OAS3
|Webhooks|✗|OAS3
|Components|✓|OAS3
|Security||OAS2,OAS3
|Security||OAS2,OAS3
|Tags|✗|OAS2,OAS3
|ExternalDocs|✗|OAS2,OAS3

### Operation Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|Responses_HttpStatusCode||OAS3
|Responses_RangedResponseCodes||OAS3
|Responses_Default||OAS3
|Responses_RedirectionResponse||OAS3
|Security||OAS2,OAS3
|Servers||OAS3
|Responses_HttpStatusCode||OAS3
|Responses_RangedResponseCodes||OAS3
|Responses_Default||OAS3
|Responses_RedirectionResponse||OAS3
|Security||OAS2,OAS3
|Servers||OAS3

### Parameter Feature
| Name | Supported | Defined By |
Expand Down Expand Up @@ -315,10 +315,10 @@ These options may be applied as additional-properties (cli) or configOptions (pl
### Security Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|HTTP_Basic||OAS2,OAS3
|ApiKey||OAS2,OAS3
|HTTP_Basic||OAS2,OAS3
|ApiKey||OAS2,OAS3
|OpenIDConnect|✗|OAS3
|HTTP_Bearer||OAS2,OAS3
|HTTP_Bearer||OAS2,OAS3
|OAuth2_Implicit|✗|OAS2,OAS3
|OAuth2_Password|✗|OAS2,OAS3
|OAuth2_ClientCredentials|✗|OAS2,OAS3
Expand All @@ -327,7 +327,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
### Wire Format Feature
| Name | Supported | Defined By |
| ---- | --------- | ---------- |
|JSON||OAS2,OAS3
|JSON||OAS2,OAS3
|XML|✗|OAS2,OAS3
|PROTOBUF|✗|ToolingExtension
|Custom|✗|OAS2,OAS3
Original file line number Diff line number Diff line change
Expand Up @@ -228,42 +228,42 @@ public KotlinClientGenerator(GeneratorSettings generatorSettings, WorkflowSettin
.includeDocumentationFeatures(
DocumentationFeature.Readme,
DocumentationFeature.Servers,
DocumentationFeature.Security,
DocumentationFeature.ComponentSchemas,
DocumentationFeature.ComponentSecuritySchemes,
DocumentationFeature.ComponentRequestBodies,
DocumentationFeature.ComponentResponses,
DocumentationFeature.ComponentHeaders,
DocumentationFeature.ComponentParameters,
DocumentationFeature.Api
// DocumentationFeature.Security,
DocumentationFeature.ComponentSchemas
// DocumentationFeature.ComponentSecuritySchemes,
// DocumentationFeature.ComponentRequestBodies,
// DocumentationFeature.ComponentResponses,
// DocumentationFeature.ComponentHeaders,
// DocumentationFeature.ComponentParameters,
// DocumentationFeature.Api
)
.includeGlobalFeatures(
GlobalFeature.Components,
GlobalFeature.Servers,
GlobalFeature.Security,
GlobalFeature.Paths,
GlobalFeature.Info
GlobalFeature.Servers
// GlobalFeature.Security,
// GlobalFeature.Paths,
// GlobalFeature.Info
)
.includeComponentsFeatures(
ComponentsFeature.schemas,
ComponentsFeature.securitySchemes,
ComponentsFeature.requestBodies,
ComponentsFeature.responses,
ComponentsFeature.headers,
ComponentsFeature.parameters
ComponentsFeature.schemas
// ComponentsFeature.securitySchemes,
// ComponentsFeature.requestBodies,
// ComponentsFeature.responses,
// ComponentsFeature.headers,
// ComponentsFeature.parameters
)
.includeSecurityFeatures(
SecurityFeature.ApiKey,
SecurityFeature.HTTP_Basic,
SecurityFeature.HTTP_Bearer
// SecurityFeature.ApiKey,
// SecurityFeature.HTTP_Basic,
// SecurityFeature.HTTP_Bearer
)
.includeOperationFeatures(
OperationFeature.Security,
OperationFeature.Servers,
OperationFeature.Responses_Default,
OperationFeature.Responses_HttpStatusCode,
OperationFeature.Responses_RangedResponseCodes,
OperationFeature.Responses_RedirectionResponse
// OperationFeature.Security,
// OperationFeature.Servers,
// OperationFeature.Responses_Default,
// OperationFeature.Responses_HttpStatusCode,
// OperationFeature.Responses_RangedResponseCodes,
// OperationFeature.Responses_RedirectionResponse
)
.includeSchemaFeatures(
SchemaFeature.AdditionalProperties,
Expand Down Expand Up @@ -310,7 +310,7 @@ public KotlinClientGenerator(GeneratorSettings generatorSettings, WorkflowSettin
SchemaFeature.UniqueItems
)
.includeWireFormatFeatures(
WireFormatFeature.JSON
// WireFormatFeature.JSON
)
.build();
public static final GeneratorMetadata generatorMetadata = GeneratorMetadata.newBuilder()
Expand Down