OpenApiEnumValuesDescriptionExtension Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Extension element for OpenAPI to add enum values descriptions. Based of the AutoRest specification https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-enum
public class OpenApiEnumValuesDescriptionExtension : Microsoft.OpenApi.IOpenApiExtensiontype OpenApiEnumValuesDescriptionExtension = class
interface IOpenApiExtensionPublic Class OpenApiEnumValuesDescriptionExtension
Implements IOpenApiExtension- Inheritance
-
OpenApiEnumValuesDescriptionExtension
- Implements
Constructors
| Name | Description |
|---|---|
| OpenApiEnumValuesDescriptionExtension() | |
Properties
| Name | Description |
|---|---|
| EnumName |
The of the enum. |
| Name |
Name of the extension as used in the description. |
| ValuesDescriptions |
Descriptions for the enum symbols, where the value MUST match the enum symbols in the main description |
Methods
| Name | Description |
|---|---|
| Parse(JsonNode) |
Parse the extension from the raw IOpenApiAny object. |
| Write(IOpenApiWriter, OpenApiSpecVersion) |
Write out contents of custom extension |