OpenApiConvertSettings Class

Definition

Namespace:

Microsoft.OpenApi.OData

Assembly:

Microsoft.OpenApi.OData.Reader.dll

Package:

Microsoft.OpenApi.OData v1.4.0

Convert settings.

public class OpenApiConvertSettings

type OpenApiConvertSettings = class

Public Class OpenApiConvertSettings

Inheritance

Object

OpenApiConvertSettings

Constructors

OpenApiConvertSettings()

Properties

AddAlternateKeyPaths	Gets/sets a value indicating whether or not to generate paths with alternate key parameters
AddEnumDescriptionExtension	Gets/sets a value indicating whether or not to add a "x-ms-enum" extension to the enum type schema for V2 and V3 descriptions. V3.1 will won't add the extension. https://github.com/Azure/autorest/blob/main/docs/extensions/readme.md#x-ms-enum
AddSingleQuotesForStringParameters	Gets/sets a value indicating whether or not single quotes surrounding string parameters in url templates should be added.
AppendBoundOperationsOnDerivedTypeCastSegments	Gets/sets a value indicating whether or not to append bound operations on derived type cast segments.
CustomHttpMethodLinkRelMapping	Get/Sets a dictionary containing a mapping of HTTP methods to custom link relation types
CustomXMLAttributesMapping	Gets/sets a dictionary containing a mapping of custom atttribute names and extension names.
DeclarePathParametersOnPathItem	Gets/Sets a value indicating whether path parameters should be declared on path item object. If true, path parameters will be declared on the path item object, otherwise they will be declared on the operation object.
EnableAliasForOperationSegments	Enables the use of aliases for operation segments to shorten the url path.
EnableAliasForTypeCastSegments	Enables the use of aliases for the type cast segments to shorten the url path.
EnableCount	Gets/sets a value indicating whether or not to allow the count of a collection of entities.
EnableDeprecationInformation	Gets/sets a value indicating whether or not to set the deprecated tag for the operation when a revision is present as well as the "x-ms-deprecation" extension with additional information.
EnableDerivedTypesReferencesForRequestBody	Gets/sets a value indicating whether or not to show the derived types of a base type reference in the requestBody payload.
EnableDerivedTypesReferencesForResponses	Gets/sets a value indicating whether or not to show the derived types of a base type reference in the responses payload.
EnableDiscriminatorValue	Gets/sets a value indicating whether or not to allow discriminator value support.
EnableDollarCountPath	Gets/sets a value indicating whether or not add OData $count segments in the description for collections.
EnableKeyAsSegment	Gets/set a value indicating whether to output key as segment path.
EnableNavigationPropertyPath	Gets/set a value indicating whether to output the path for Edm navigation property.
EnableODataAnnotationReferencesForResponses	Gets/sets a value indicating whether or not to reference @odata.nextLink, @odata.deltaLink and @odata.count in responses
EnableODataTypeCast	Gets/sets a value indicating whether or not to include the OData type cast segments.
EnableOperationId	Gets/sets a value indicating to set the OperationId on Open API operation.
EnableOperationImportPath	Gets/set a value indicating whether to output the path for Edm operation import.
EnableOperationPath	Gets/set a value indicating whether to output the path for Edm operation.
EnablePagination	Gets/sets a value indicating whether or not to allow paging a collection of entities.
EnableTypeDisambiguationForDefaultValueOfOdataTypeProperty	Gets/sets a value indicating whether to set the default value for a structured type's @odata.type property. If false, the value will be set conditionally based on whether the type's base type is abstract (and not entity) and is referenced in the properties of a structural property or an action.
EnableUnqualifiedCall	Gets/set a value indicating whether to output un-qualified operation call.
EnableUriEscapeFunctionCall	Gets/sets a value indicating whether to output the binding function as Uri escape function if applied the UriEscapeFunction term.
ErrorResponsesAsDefault	Gets/sets a value indicating whether the error responses should be described as a default response or as 4XX and 5XX error responses.
ExpandDerivedTypesNavigationProperties	Gets/Sets a value indicating whether or not to expand derived types to retrieve their declared navigation properties.
IEEE754Compatible	Gets/sets a value indicating whether the server is IEEE754 compatible. If it is IEEE754Compatible, the server will write quoted string for INT64 and decimal to prevent data loss; otherwise keep number without quotes.
IncludeAssemblyInfo	Gets/Sets a value indicating whether to show the version of the assembly used for generating Open API document
InnerErrorComplexTypeName	Gets/Sets the name of the complex type to look for in the main namespace to use as the inner error type.
NamespacePrefixToStripForInMethodPaths	The namespace prefix to be stripped from the in method paths.
OpenApiSpecVersion	Gets/sets a value indicating whether the version of openApi to serialize to is v2. Currently only impacts nullable references for EdmTypeSchemaGenerator
PageableOperationName	Gets/sets a value that specifies the name of the operation for retrieving the next page in a collection of entities.
PathPrefix	Gets/sets a value that specifies a prefix to be prepended to all generated paths.
PathProvider	Gets/sets a the path provider.
PrefixEntityTypeNameBeforeKey	Gets/set a value indicating whether we prefix entity type name before single key.
RefBaseCollectionPaginationCountResponse	Obsolete. Gets/sets a value indicating whether or not to reference @odata.nextLink and @odata.count in responses
RequireDerivedTypesConstraintForBoundOperations	Gets/Sets a value indicating whether or not to require the Validation.DerivedTypeConstraint to be applied to NavigationSources to bind operations of derived types to them.
RequireDerivedTypesConstraintForODataTypeCastSegments	Gets/sets a value indicating whether or not to require a derived types constraint to include the OData type cast segments.
RequireRestrictionAnnotationsToGenerateComplexPropertyPaths	Gets/Sets a value indicating whether or not to use restrictions annotations to generate paths for complex properties.
RoutePathPrefixProvider	Gets/sets a route path prefix provider.
SemVerVersion	Get/set the metadata version.
ServiceRoot	Gets/sets the service root.
ShowExternalDocs	Gets/sets links to external documentation for operations
ShowLinks	Gets/Sets a value indicating whether or not to show the OpenAPI links in the responses.
ShowMsDosGroupPath	Gets/sets a value indicating whether or not to show the group path extension.
ShowRootPath	Gets/sets a value indicating whether or not to show the root path of the described API.
ShowSchemaExamples	Gets/Sets a value indicating whether or not to show schema examples.
TagDepth	Gets/set a value indicating the tags name depth.
TopExample	Gets or sets $Top example value.
UseSuccessStatusCodeRange	Gets/Sets a value indicating whether or not to use the HTTP success status code range 2XX to represent all response codes between 200 - 299.
VerifyEdmModel	Gets/sets a value indicating whether to verify the edm model before converter.
Version	Obsolete. Get/set the metadata version.