Skip to content

Latest commit

 

History

History
628 lines (571 loc) · 14.8 KB

Microsoft.OpenApi.Models.md

File metadata and controls

628 lines (571 loc) · 14.8 KB
Raw

Microsoft.OpenApi.Models


NameConstants

public static class NameConstants

Static Fields

List

string List

Pagination

string Pagination

OpenApiDataTypeConstants

public static class OpenApiDataTypeConstants

Static Fields

Array

string Array

Boolean

string Boolean

Integer

string Integer

Number

string Number

Object

string Object

String

string String

OpenApiDocumentExtensions

public static class OpenApiDocumentExtensions

Static Methods

GetPathsByBasePathSegmentName

List<KeyValuePair<string, OpenApiPathItem>> GetPathsByBasePathSegmentName(this OpenApiDocument document, string basePathSegmentName)

OpenApiFormatTypeConstants

public static class OpenApiFormatTypeConstants

Static Fields

Binary

string Binary

Byte

string Byte

Date

string Date

DateTime

string DateTime

Double

string Double

Email

string Email

Float

string Float

Int32

string Int32

Int64

string Int64

Time

string Time

Timestamp

string Timestamp

Uri

string Uri

Uuid

string Uuid

OpenApiMediaTypeExtensions

public static class OpenApiMediaTypeExtensions

Static Methods

GetSchema

OpenApiSchema GetSchema(this IDictionary<string, OpenApiMediaType> content, string contentType = application/json)

GetSchemaByFirstMediaType

OpenApiSchema GetSchemaByFirstMediaType(this IDictionary<string, OpenApiMediaType> content)

OpenApiOperationExtensions

public static class OpenApiOperationExtensions

Static Methods

GetModelSchemaFromRequest

OpenApiSchema GetModelSchemaFromRequest(this OpenApiOperation openApiOperation)

GetModelSchemaFromResponse

OpenApiSchema GetModelSchemaFromResponse(this OpenApiOperation openApiOperation)

GetOperationName

string GetOperationName(this OpenApiOperation openApiOperation)

HasDataTypeFromSystemCollectionGenericNamespace

bool HasDataTypeFromSystemCollectionGenericNamespace(this List<OpenApiOperation> apiOperations)

HasParametersOrRequestBody

bool HasParametersOrRequestBody(this OpenApiOperation openApiOperation)

HasRequestBodyWithAnythingAsFormatTypeBinary

bool HasRequestBodyWithAnythingAsFormatTypeBinary(this OpenApiOperation openApiOperation)

IsOperationIdPluralized

bool IsOperationIdPluralized(this OpenApiOperation openApiOperation, OperationType operationType)

IsOperationNamePluralized

bool IsOperationNamePluralized(this OpenApiOperation openApiOperation, OperationType operationType)

IsOperationReferencingSchema

bool IsOperationReferencingSchema(this OpenApiOperation openApiOperation, string schemaKey)

OpenApiParameterExtensions

public static class OpenApiParameterExtensions

Static Methods

GetAllFromHeader

List<OpenApiParameter> GetAllFromHeader(this IList<OpenApiParameter> parameters)

GetAllFromQuery

List<OpenApiParameter> GetAllFromQuery(this IList<OpenApiParameter> parameters)

GetAllFromRoute

List<OpenApiParameter> GetAllFromRoute(this IList<OpenApiParameter> parameters)

HasFormatTypeByte

bool HasFormatTypeByte(this IList<OpenApiParameter> parameters)

HasFormatTypeDate

bool HasFormatTypeDate(this IList<OpenApiParameter> parameters)

HasFormatTypeDateTime

bool HasFormatTypeDateTime(this IList<OpenApiParameter> parameters)

HasFormatTypeEmail

bool HasFormatTypeEmail(this IList<OpenApiParameter> parameters)

HasFormatTypeFromDataAnnotationsNamespace

bool HasFormatTypeFromDataAnnotationsNamespace(this IList<OpenApiParameter> parameters)

HasFormatTypeFromSystemNamespace

bool HasFormatTypeFromSystemNamespace(this IList<OpenApiParameter> parameters)

HasFormatTypeInt32

bool HasFormatTypeInt32(this IList<OpenApiParameter> parameters)

HasFormatTypeInt64

bool HasFormatTypeInt64(this IList<OpenApiParameter> parameters)

HasFormatTypeTime

bool HasFormatTypeTime(this IList<OpenApiParameter> parameters)

HasFormatTypeTimestamp

bool HasFormatTypeTimestamp(this IList<OpenApiParameter> parameters)

HasFormatTypeUri

bool HasFormatTypeUri(this IList<OpenApiParameter> parameters)

HasFormatTypeUuid

bool HasFormatTypeUuid(this IList<OpenApiParameter> parameters)

OpenApiPathItemExtensions

public static class OpenApiPathItemExtensions

Static Methods

HasParameters

bool HasParameters(this OpenApiPathItem openApiPathItem)

IsPathStartingSegmentName

bool IsPathStartingSegmentName(this KeyValuePair<string, OpenApiPathItem> urlPath, string segmentName)

OpenApiPathsExtensions

public static class OpenApiPathsExtensions

Static Methods

GetPathsStartingWithSegmentName

List<KeyValuePair<string, OpenApiPathItem>> GetPathsStartingWithSegmentName(this OpenApiPaths urlPaths, string segmentName)

OpenApiResponsesExtensions

public static class OpenApiResponsesExtensions

Static Methods

GetDataTypeForStatusCode

string GetDataTypeForStatusCode(this OpenApiResponses responses, HttpStatusCode httpStatusCode)

GetHttpStatusCodes

List<HttpStatusCode> GetHttpStatusCodes(this OpenApiResponses responses)

GetModelNameForStatusCode

string GetModelNameForStatusCode(this OpenApiResponses responses, HttpStatusCode httpStatusCode)

GetSchemaForStatusCode

OpenApiSchema GetSchemaForStatusCode(this OpenApiResponses responses, HttpStatusCode httpStatusCode, string contentType = application/json)

HasSchemaHttpStatusCodeUsingAspNetCoreHttp

bool HasSchemaHttpStatusCodeUsingAspNetCoreHttp(this OpenApiResponses responses)

HasSchemaHttpStatusCodeUsingSystemNet

bool HasSchemaHttpStatusCodeUsingSystemNet(this OpenApiResponses responses)

HasSchemaTypeArray

bool HasSchemaTypeArray(this OpenApiResponses responses)

IsSchemaTypeArrayForStatusCode

bool IsSchemaTypeArrayForStatusCode(this OpenApiResponses responses, HttpStatusCode httpStatusCode)

IsSchemaTypePaginationForStatusCode

bool IsSchemaTypePaginationForStatusCode(this OpenApiResponses responses, HttpStatusCode httpStatusCode)

IsSchemaTypeProblemDetailsForStatusCode

bool IsSchemaTypeProblemDetailsForStatusCode(this OpenApiResponses responses, HttpStatusCode httpStatusCode)

IsSchemaUsingBinaryFormatForOkResponse

bool IsSchemaUsingBinaryFormatForOkResponse(this OpenApiResponses responses)

OpenApiSchemaExtensions

public static class OpenApiSchemaExtensions

Static Methods

ExtractPropertyNameWhenHasAnyPropertiesOfArrayWithFormatTypeBinary

string ExtractPropertyNameWhenHasAnyPropertiesOfArrayWithFormatTypeBinary(this OpenApiSchema apiSchema)

GetDataType

string GetDataType(this OpenApiSchema schema)

GetEnumSchema

Tuple<string, OpenApiSchema> GetEnumSchema(this OpenApiSchema schema)

GetModelName

string GetModelName(this OpenApiSchema schema, bool ensureFirstCharacterToUpper = True)

GetModelType

string GetModelType(this OpenApiSchema schema)

GetSchemaByModelName

OpenApiSchema GetSchemaByModelName(this IDictionary<string, OpenApiSchema> componentSchemas, string modelName)

GetSimpleDataTypeFromArray

string GetSimpleDataTypeFromArray(this OpenApiSchema schema)

GetSimpleDataTypeFromPagination

string GetSimpleDataTypeFromPagination(this OpenApiSchema schema)

GetTitleFromPropertyByPropertyKey

string GetTitleFromPropertyByPropertyKey(this OpenApiSchema schema, string propertyKey)

HasAnyProperties

bool HasAnyProperties(this OpenApiSchema schema)

HasAnyPropertiesAsArrayWithFormatTypeBinary

bool HasAnyPropertiesAsArrayWithFormatTypeBinary(this OpenApiSchema schema)

HasAnyPropertiesFormatTypeFromSystemCollectionGenericNamespace

bool HasAnyPropertiesFormatTypeFromSystemCollectionGenericNamespace(this OpenApiSchema schema, IDictionary<string, OpenApiSchema> componentSchemas)

HasAnyPropertiesFormatTypeFromSystemNamespace

bool HasAnyPropertiesFormatTypeFromSystemNamespace(this OpenApiSchema schema)

HasAnyPropertiesFormatTypeFromSystemNamespace

bool HasAnyPropertiesFormatTypeFromSystemNamespace(this OpenApiSchema schema, IDictionary<string, OpenApiSchema> componentSchemas)

HasAnyPropertiesWithFormatTypeBinary

bool HasAnyPropertiesWithFormatTypeBinary(this OpenApiSchema schema)

HasAnythingAsFormatTypeBinary

bool HasAnythingAsFormatTypeBinary(this OpenApiSchema schema)

HasArrayItemsWithSimpleDataType

bool HasArrayItemsWithSimpleDataType(this OpenApiSchema schema)

HasDataTypeFromSystemCollectionGenericNamespace

bool HasDataTypeFromSystemCollectionGenericNamespace(this OpenApiSchema schema, IDictionary<string, OpenApiSchema> componentSchemas)

HasDataTypeFromSystemCollectionGenericNamespace

bool HasDataTypeFromSystemCollectionGenericNamespace(this IList<OpenApiSchema> schemas, IDictionary<string, OpenApiSchema> componentSchemas)

HasDataTypeList

bool HasDataTypeList(this IList<OpenApiSchema> schemas)

HasFormatType

bool HasFormatType(this OpenApiSchema schema)

HasFormatTypeByte

bool HasFormatTypeByte(this IList<OpenApiSchema> schemas)

HasFormatTypeDate

bool HasFormatTypeDate(this IList<OpenApiSchema> schemas)

HasFormatTypeDateTime

bool HasFormatTypeDateTime(this IList<OpenApiSchema> schemas)

HasFormatTypeEmail

bool HasFormatTypeEmail(this IList<OpenApiSchema> schemas)

HasFormatTypeFromAspNetCoreHttpNamespace

bool HasFormatTypeFromAspNetCoreHttpNamespace(this OpenApiSchema schema)

HasFormatTypeFromAspNetCoreHttpNamespace

bool HasFormatTypeFromAspNetCoreHttpNamespace(this IList<OpenApiSchema> schemas)

HasFormatTypeFromDataAnnotationsNamespace

bool HasFormatTypeFromDataAnnotationsNamespace(this OpenApiSchema schema)

HasFormatTypeFromDataAnnotationsNamespace

bool HasFormatTypeFromDataAnnotationsNamespace(this IList<OpenApiSchema> schemas)

HasFormatTypeFromSystemNamespace

bool HasFormatTypeFromSystemNamespace(this OpenApiSchema schema)

HasFormatTypeFromSystemNamespace

bool HasFormatTypeFromSystemNamespace(this IList<OpenApiSchema> schemas)

HasFormatTypeInt32

bool HasFormatTypeInt32(this IList<OpenApiSchema> schemas)

HasFormatTypeInt64

bool HasFormatTypeInt64(this IList<OpenApiSchema> schemas)

HasFormatTypeTime

bool HasFormatTypeTime(this IList<OpenApiSchema> schemas)

HasFormatTypeTimestamp

bool HasFormatTypeTimestamp(this IList<OpenApiSchema> schemas)

HasFormatTypeUri

bool HasFormatTypeUri(this IList<OpenApiSchema> schemas)

HasFormatTypeUuid

bool HasFormatTypeUuid(this IList<OpenApiSchema> schemas)

HasItemsWithFormatTypeBinary

bool HasItemsWithFormatTypeBinary(this OpenApiSchema schema)

HasItemsWithSimpleDataType

bool HasItemsWithSimpleDataType(this OpenApiSchema schema)

HasModelNameOrAnyPropertiesWithModelName

bool HasModelNameOrAnyPropertiesWithModelName(this OpenApiSchema schema, string modelName)

HasPaginationItemsWithSimpleDataType

bool HasPaginationItemsWithSimpleDataType(this OpenApiSchema schema)

IsArrayReferenceTypeDeclared

bool IsArrayReferenceTypeDeclared(this OpenApiSchema schema)

IsFormatTypeBinary

bool IsFormatTypeBinary(this OpenApiSchema schema)

IsFormatTypeByte

bool IsFormatTypeByte(this OpenApiSchema schema)

IsFormatTypeDate

bool IsFormatTypeDate(this OpenApiSchema schema)

IsFormatTypeDateTime

bool IsFormatTypeDateTime(this OpenApiSchema schema)

IsFormatTypeEmail

bool IsFormatTypeEmail(this OpenApiSchema schema)

IsFormatTypeInt32

bool IsFormatTypeInt32(this OpenApiSchema schema)

IsFormatTypeInt64

bool IsFormatTypeInt64(this OpenApiSchema schema)

IsFormatTypeTime

bool IsFormatTypeTime(this OpenApiSchema schema)

IsFormatTypeTimestamp

bool IsFormatTypeTimestamp(this OpenApiSchema schema)

IsFormatTypeUri

bool IsFormatTypeUri(this OpenApiSchema schema)

IsFormatTypeUuid

bool IsFormatTypeUuid(this OpenApiSchema schema)

IsObjectReferenceTypeDeclared

bool IsObjectReferenceTypeDeclared(this OpenApiSchema schema)

IsRuleValidationNumber

bool IsRuleValidationNumber(this OpenApiSchema schema)

IsRuleValidationString

bool IsRuleValidationString(this OpenApiSchema schema)

IsSchemaEnum

bool IsSchemaEnum(this OpenApiSchema schema)

IsSchemaEnumOrPropertyEnum

bool IsSchemaEnumOrPropertyEnum(this OpenApiSchema schema)

IsSharedContract

bool IsSharedContract(this OpenApiSchema schema, OpenApiComponents openApiComponents)

IsSimpleDataType

bool IsSimpleDataType(this OpenApiSchema schema)

IsTypeArray

bool IsTypeArray(this OpenApiSchema schema)

IsTypeArrayOrPagination

bool IsTypeArrayOrPagination(this OpenApiSchema schema)

IsTypePagination

bool IsTypePagination(this OpenApiSchema schema)
Generated by MarkdownCodeDoc version 1.2