修正 Swagger 驗證程式錯誤

本文重點介紹連接器可能出現的 Power Platform 常見 swagger 驗證錯誤以及如何修復它們。

作業

Error 問題 方案
ApiAnnotationExtensionReplacementInfo
ForNonDeprecatedOperations
The 'x-ms-api-annotation' extension for operation '{0}' is invalid. The replacement property should be specified for deprecated operations only. 作業 {0} 未標記為已取代。 若要使用此屬性,該作業應將「已取代」屬性設定為 True。 如果不是這種情況,請移除「x-ms-api-annotation」屬性。
ApiAnnotationExtensionReplacementInfo
MissingApiProperty
The 'x-ms-api-annotation' extension for operation '{0}' is invalid. The replacement property must specify 'api' property. 「x-ms-api-annotation」指定了「replacement」屬性,但缺少「api」屬性。 為使用「replacement」屬性,必須設定「api」和「operationId」屬性。
ApiAnnotationExtensionReplacementInfo
MissingOperationIdProperty
The 'x-ms-api-annotation' extension for operation '{0}' is invalid. The replacement property must specify 'operationId' property. 「x-ms-api-annotation」指定了「replacement」屬性,但缺少「operationId」屬性。 為使用「replacement」屬性,必須設定「api」和「operationId」屬性。
ArrayDuplicateValue The array contains duplicate values, values must be unique. 陣列必須具有唯一值,但您的 Swagger 包含重複資料。 移除重複資料。
BodyOrFormDataParameterInFetch
OperationNotAllowed
Body or form data parameters are not supported in a fetch operation. 使用「GET」HTTP 方法的作業不能有主體或表單資料。
ConnectionIdParameterNotAllowed A parameter cannot be named as 'connectionId'. 將參數重新命名為不是「connectionId」的值。
ConsumesMissing At least one supported MIME type must be provided in 'consumes' for operation '{0}'. 您的 Swagger 應在取用作業中指定一個支援的 MIME 類型。
DuplicateEnumValuesInExtension The 'x-ms-enum-values' extension has duplicate values. You can only have one display name mapped to a value. Enum 值必須是唯一且不重複。
DuplicateOperationPath The operations '{0}' and '{1}' have the path templates '{2}' and '{3}' which are duplicate and indistinguishable. They need to have a difference in static path segments for a deterministic routing. {0} 為作業識別碼,{1} 為重複作業識別碼,{2} 為作業路徑,{3} 為重複作業路徑。 從重複的作業路徑中移除重複的作業識別碼。
DynamicExtensionDefinitionNotAllowed
InParameter
Dynamic extensions are not allowed to be defined on the body parameter. It should be in the schema. 動態擴充功能是在主體參數上定義,必須移除。 它只能在架構中定義。
DynamicListExtensionRequiredFor
AmbiguousReferences
The 'x-ms-dynamic-values' extension references ambiguous parameter references. You need to define the 'x-ms-dynamic-list' extension. 必須定義「x-ms-dynamic-list」。 其他資訊:如何使用動態值
DynamicListExtensionRequiredFor
NonParameterReferences
The 'x-ms-dynamic-values' extension references properties within parameters. You need to define the 'x-ms-dynamic-list' extension. 必須定義「x-ms-dynamic-list」。 其他資訊:如何使用動態值
DynamicPropertiesExtensionRequiredFor
AmbiguousReferences
The 'x-ms-dynamic-schema' extension references ambiguous parameter references. You need to define the 'x-ms-dynamic-properties' extension. 必須定義「x-ms-dynamic- properties」。 其他資訊:如何使用動態值
DynamicPropertiesExtensionRequiredFor
NonParameterReferences
The 'x-ms-dynamic-schema' extension references properties within parameters. You need to define the 'x-ms-dynamic-properties' extension. 必須定義「x-ms-dynamic- properties」。 其他資訊:如何使用動態值
DynamicPropertiesExtensionRequiredFor
PropertiesValuePath
The 'x-ms-dynamic-schema' extension property 'value-path' points to schema properties. You need to define the 'x-ms-dynamic-properties' extension, which points to schema object. 您的 Swagger 檔案缺少「x-ms-dynamic-properties」,這是必要的,因為它定義了「x-ms-dynamic-schema」。
DynamicPropertiesItemValue
PathMismatch
The 'x-ms-dynamic-properties' extension should have the same item value path as 'x-ms-dynamic-schema' extension without 'properties' ending. The expected path is '{0}'. 動態屬性擴展項值路徑與基於架構的預期路徑不匹配。
DynamicTreeExtensionMissing The 'x-ms-dynamic-tree' extension must be defined to enable file picker support. 缺少屬性「x-ms-dynamic-tree」,必須定義它以支援檔案選取器。
InvalidEnumValue The type of the enum value is '{0}' but it should be '{1}' as specified in the schema. 必須以指定的類型取代該值。
InvalidEnumValuesExtensionValue The 'value' field must match one of the enums as defined in the 'enum' property of the schema. 選定的列舉尚未在枚舉清單中定義。 在列舉屬性中定義值,或使用在列舉屬性中定義的值。
InvalidFormDataParameterName The form data parameter name '{0}' is invalid. All characters must be part of the US-ASCII character set. 將表單資料參數名稱重新命名為僅包含 US-ASCII 字元。
InvalidNextLinkNameValue The nextLinkName value for operation '{0}' is invalid. Supported values are 'nextLink' or '@odata.nextLink'. 修復屬性“nextLinkName”的值,使其為“nextLink”或“@odata.nextLink”。 不允許使用任何其他值。
InvokedOperationShouldProduceArray The dynamic operation expects an array on the specified path '{0}' which should be defined in the successful response of the invoked operation '{1}'. {0} 為回應屬性路徑,{1} 為作業識別碼。在作業回應中定義類型陣列的傳回。
InvokedOperationShouldProduceProperty The dynamic operation expects a property on the specified path '{0}' which should be defined in the successful response of the invoked operation '{1}'. {0} 為回應屬性路徑,{1} 為作業識別碼。在作業回應中定義特定屬性
MimeTypeNotCompatibleWithRequest
ContentSchemaType
The MIME type(s) are not compatible with the request content type '{0}' for operation '{1}'. 您嘗試使用 MIME 類型與指定操作中的請求內容不相容。
NotificationExtensionNotSupportedIn
WebhookOperation
The 'x-ms-notification' extension must not be defined in a webhook operation. 在 Webhook 作業中不允許使用「x-ms-notification」。
NotificationExtensionSupportedFor
TriggerOnly
The 'x-ms-notification' is supported for trigger operations only. 「x-ms-notification」擴充只能用於觸發作業。
NotificationOperationMustBeWebhook The 'operationId' property in 'x-ms-notification' extension must be for a webhook operation. 使用“x-ms-notification”時,操作 ID 必須引用 webhook 操作。
OperationFamilyHasDuplicateRevisions The operation family '{0}' has operations with duplicate revision. 您的 swagger 會定義具有相同版本/修訂編號的作業系列。 作業系列中的每個作業都應具有唯一的版本號碼。
OperationFamilyHasManyActive
作業
The operation family '{0}' has more than two active operations. Extra operations must be deprecated. 操作系列限制為兩個未棄用的操作。 所有其他作業都應標記為已取代,以減少連接器使用者的混淆。
OperationFamilyHasManyActive
ProductionOperations
The operation family '{0}' has several active operations in Production status. Previous revisions should be deprecated. 作業系列在生產中有多個作業。 若要減少混淆,請限制系列中的生產作業數目,並取代其餘的部分。
OperationFamilyHasManyEmptyRevisions The operation family '{0}' has several operations with empty revision. Only one operation can have empty revision. 作業系列只能有一個沒有修訂的作業。 系列中的所有其他作業都應具有修訂。
OperationHasManyResponsesWithSchema The operation '{0}' has more than one response with specified schema, only one schema will be used in the designer. 設計工具的限制會阻止多個回應結構描述。 您的作業指定多個回應結構描述,但應該只指定一個。
OperationIdNotFound The 'operationId' could not be found in this swagger document. 在您的 Swagger 中找不到 operationId。
OperationIdNotUnique The operationId '{0}' is used multiple times. Operation identifiers must be unique. 相同的 operationId 出現不止一次。 請移除其中一個執行個體,或將其中一個執行個體修正為不同的執行個體。
OperationIdRequired The operation 'operationId' property is required. 缺少「operationId」屬性,包括您作業的「operationId」屬性。
OperationIdSanitized The 'operationId' property value is different from its sanitized value '{0}'. Please avoid the useage of non-alphanumeric characters to have matching values. 提供的操作 ID 與清理的版本不匹配。 請更新作業識別碼以讓其相符。
OperationIdShouldEndWithRevision The operation Id '{0}' should end with revision suffix '{1}'. 具有修訂的作業識別碼應具有含修訂尾碼的名稱。
OperationIdTooLong The operationId length must be less than '{0}'. 請減少「operationId」屬性的值,讓字元長度小於 {0}。
OperationMissingPathParameter The operation '{0}' does not define the '{1}' parameter which is required by the path. 您的 swagger 有一個操作,該操作未定義其路徑範本似乎需要的參數。
OperationMissingRequiredProperty The target operation requires parameter '{0}'. 該操作已根據需要定義了參數”{0} 新增此參數以解決問題。
OperationMustHaveNotification
ContentExtension
The operation '{0}' is missing notification content extension as it has '{1}' properties marked as notification URL. 您的 Swagger 包含沒有通知內容擴充的作業。 (需要更多內容)
OperationMustHaveResponse The operation is not valid, it must contain at least one response definition. 您的 Swagger 有一個作業不具備至少一個回應定義。
OperationParameterNameIsAmbiguous The parameter name is ambiguous as it matches both a parameter name and a path to a body property. 參數的名稱會做為參數名稱和參數主體路徑名稱。 重新命名其中一個執行個體以修正此問題。
OperationParameterNameNotFound The parameter could not be found in operation '{0}' in the swagger document. 在您的 Swagger 中找不到作業參數名稱。
OperationParameterRequiredMismatch The parameter is required, but an optional value is provided by operation '{0}'. The request cannot be made until a value for this parameter is provided. 該參數是必需的,但操作的值聲明它是可選的,從而導致此不匹配。
OperationParametersAreNotUnique The parameters in the operation '{0}' are not unique. 作業參數中似乎存在重復資料。 您的 Swagger 必須移除作業參數重複資料。
OperationParametersContain
DuplicateParameter
The operation '{0}' contains duplicate parameters with name '{1}', location '{2}'. 有一個操作參數被列出兩次。 {0} 為作業名稱,{1} 是重複參數名稱,{2} 是重複參數位置 (Swagger 中的「in」屬性)。 移除重複出現的屬性。
OperationParametersContain
MultipleBodyParameters
The operation '{0}' contains multiple parameters in the location 'body', at most one is allowed. 操作參數包含重複的主體參數。 移除其中一個主體參數。
OperationParameterStaticTypeMismatch The parameter has type '{0}', but a static value is provided of type '{1}'. 不需要此作業參數時,該參數提供為靜態類型。
OperationParameterTypeMismatch The parameter has type '{0}', but operation '{1}' is providing a parameter of type '{2}'. 參數和作業具有不同的類型。 讓您的參數類型和您的作業相符。
OperationPathContainsUnsupportedCharacters The operation path cannot contain wildcard character '*'. 您的某個操作指定了包含不受支援的字元(如通配符)的 URL 路徑。
OperationPathMayNotContainQueryOrFragment The path is not valid, it must not contain a query part or fragment identifier. To include '?' or '#' characters in the path, they must be URL encoded. 作業路徑不能包含「?」 和 '#',除非它們是 URL 編碼的(轉換為它們的 %xx 等效項)。
OperationPathMustStartWithSlash The path is not valid, it must start with a '/' character. 如果使用嘗試實現的操作路徑,則要求它以“/”字元開頭。 若要解決此問題,請在路徑的開頭包含“/”字元。
OperationPathTemplateNotValid The path is not valid, each path template variable enclosed by '{{' and '}}' characters must be contained within a single URL segment. Individual '{{' or '}}' characters which are not enclosing a path template variable must be URL encoded. 您的 Swagger 包含具有未封閉「{」或「}」字元的作業路徑。 這些字元是用來參考路徑中的變數,因此在未封閉時不能存在於路徑中。
OperationPathVariablesContainDefaults The operation path template variables cannot set default values with character '='. 其中一項操作是為包含“=”的參數指定預設值。 也會將該參數指定於 URL 路徑中。 不允許此組合。
OperationRevisionEmpty The operation '{0}' does not specify a revision in api annotation. 該操作被標記為系列的一部分,但沒有修訂版。
OperationSchemaCountExceedsMaxAllowed The total number of schemas in the operation has exceeded the maximum allowed value of '{0}'. Please remove any unnecessary property or item definitions. 作業中包含過多結構描述。 移除部分結構描述,使總數小於限制。
OperationShouldHaveSuccessfulResponse The operation '{0}' should have at least one successful response definition. 您的 swagger 有一個操作沒有至少一個成功的回覆定義。
OperationStatusAheadOfConnector The operation '{0}' cannot be in a Production status ahead of the connector. 當整個連接器仍處於「預覽版」狀態時,不能將操作標記為“生產”。
OperationSummaryTooLong The operation 'summary' should be fewer than {0} characters for improved readablity. 請將作業「摘要」屬性減少到 120 個字元以內。
PartialDuplicateOperationPath The operation '{0}' has the path template '{1}' which is similar to other operation path templates, this can lead to an unexpected routing to a different operation in case an input path parameter value matches to a static value segment. It is better to have unconditional routing in all cases. Partially duplicated paths are: {2} {0} 為作業識別碼,{1} 是作業路徑,{2} 是部分重複的作業路徑組。 變更作業路徑以在共用相似性的作業路徑之間創造更大的差異。
PathParameterMustBeRequired The parameter must be marked as required as it is used in the operation path. Include the 'required' property, with the value 'true'. 參數的位置設定為「路徑」,因此必須將「必要」屬性設為「True」。
PathParameterNotDefinedInTemplate The 'path' parameter '{0}' is not defined in the URI path template. To include the parameter as a variable in the path, use '{{' and '}}' characters to enclose the name of the parameter in the path. 其中一個操作中有一個參數被標記為位於操作路徑中,但在路徑範本中不存在。
PathParametersContain
DuplicateParameter
The path '{0}' contains duplicate parameters with name '{1}', location '{2}'. {0} 是作業路徑。 {1} 是重複的參數名稱。 {2} 是重複參數的位置 (「in」屬性)。 移除重複的路徑參數。
PathParametersContainMultiple
BodyParameters
The path '{0}' contains multiple parameters in the location 'body', at most one is allowed. 一個作業不能有多個參數同時存在於主體中。 若要修復此錯誤,請刪除其中一個參數。
PathRedefined The path '{0}' is defined multiple times with different capitalization. Paths must be unique when compared case-insensitively. 相同的路徑定義了一次以上。 刪除或重命名實例,使其具有唯一性。
RestrictedCharactersInSummary Summary string contains any of the restricted characters [{0}] 其中一個作業的摘要包含受限字元。 若要修復此錯誤,請刪除字元或改寫摘要。
SelectedItemValuePathNotAllowedIn
ThisPosition
The 'selectedItemValuePath' property is not allowed in this position. It is allowed only in 'browse' operation of 'x-ms-dynamic-tree' extension. 不允許在任何地方放置「selectedItemValuePath」。 移除它,或將其置於有效位置。
StringBinaryNotSupportedFor
FormUrlEncoded
String/binary parameters are not supported for operation '{0}' with 'application/x-www-form-urlencoded' consumes type. 該作業具有在「取用」屬性中定義的「application/x-www-form-urlencoded」值。 此操作的參數不能是「string」或「binary」類型。
TotalOperationsCountExceedsMaxAllowed The total number of operations in the swagger exceeds the maximum allowed value of '{0}'. 在 Swagger 中包含過多作業。
UnrecognizedTypeFormat The type/format '{0}' is not recognized. 指定的類型/格式 {0} 未知。 請檢查是否有錯字,或檢查文件以確認支援的類型格式。
WebhookOperationsMissingNotification
UrlProperty
The webhook operation '{0}' is missing notification URL property. 您的 swagger 包含一個 webhook 操作,該操作沒有缺少通知 URL 屬性。 在 Webhook 作業中新增此屬性可修正此作業。

陣列

錯誤 問題 應用程式執行個體
ArrayHasNoItems The array should have items specified. 陣列是空白的,但不允許使用空白陣列。
RequiredPropertyArrayEmpty The 'required' array requires at least one value. If no properties are required in the schema, remove the 'required' property. 你的 swagger 有一個名為“required”的屬性的空陣列。 如果沒有必要參數,則應將其移除。
SchemesArrayEmpty The 'schemes' array requires at least one value. 結構描述不能是空白的,且必須至少有一個值。

不支援

錯誤 問題 應用程式執行個體
CollectionFormatValueNotSupported The 'collectionFormat' keyword value '{0}' is not supported. 僅支援特定的集合格式。 您的 Swagger 包含不支援的格式。
MimeTypeNotSupported The MIME type '{0}' is not supported. The supported mime types are: '{1}'. 不支援您嘗試在 Swagger 中使用的 MIME 類型。
PathItemRefNotSuppored The '$ref' property in a path is not supported. 路徑不能定義「$ref」屬性。 移除此屬性。
SwaggerKeywordNotSupported The '{0}' keyword is not supported. {0} 是 swagger 關鍵字,例如“uniqueItems”,在使用它的上下文中不允許使用。

參數

Error 問題 方案
FileParameterMustBeInFormData Parameters of type 'file' are not valid in locations other than 'formData'. 你的 swagger 有一個“file”類型的參數,它只能是“in”,即“formData”。
ParameterListContainsFormDataAndBody The 'parameters' list defines both a 'body' parameter, and a 'formData' parameter. Only one of these location types can be used in an operation. 你的大搖大擺既定義了 body 參數又定義了 formData,這是不允許的。 移除這些參數類型之一。
ParameterReferenceNotFound The parameter reference '{0}' could not be found in the swagger document. 您的 Swagger 具有在 Swagger 文件中找不到的參數參考。 移除此參數的參考。
ParameterReferenceNotValid The parameter reference '{0}' is not valid. Parameter references must start with '#/parameters/' and be valid JSON Pointers. 您的 swagger 有一個參數引用(“#/parameters/”),根據 JSON 指標 RFC 規範,該引用是無效的。
ParameterRefLoopNotAllowed The parameter definition may not use a '$ref' to point to another definition. 您的 Swagger 有一個參數定義,其錯誤地使用「$ref」來指向另一個定義。
ParamtersWithSameNameMustHave
SameTypeAndVisibility
Parameters of the same name in fetch and subscribe operations must be of the same type and visibility. 如果您的 Swagger 在擷取和訂閱作業中具有相同名稱的參數,則它們應具有相同的類型與可見度。
PathParameterMissingEncoding Encoding for path parameter '{0}' is missing, which might lead to invalid requests. Use "x-ms-url-encoding": "single" to ensure the value is URL encoded. {0} 是缺少編碼的參數名稱。
QueryParameterEncodingNotSupported Encoding for query parameter '{0}' is not supported. All query parameters are single encoded by default. {0} 是具有不支援編碼的參數名稱。 修正此編碼。
ReservedParameterIsUsed The parameter '{0}' is reserved and cannot be used in '{1}'. 正在使用此錯誤中所述的參數,但這是無法使用的,因其是為該區段或一般情況保留的。
ResponseRefLoopNotAllowed The response definition may not use a '$ref' to point to another definition. 您的 Swagger 有一個回應定義,其錯誤地使用「$ref」來指向另一個定義。
SourcePropertyInternal The parameter reference '{0}' in the source operation '{1}' is internal or one of its parent(s) are internal. Either make the property visible or update the parameter reference to a static value. 參數參考會標記為內部,但使用參數參考的作業不是內部。 若要解決此問題,請更新參數或操作。

內容

Error 問題 方案
AdditionalPropertyNotAllowed The property '{0}' is not allowed and must be removed. 你的大搖大擺中有一個額外的屬性必須被移除。
AdditionalPropertyNotAllowedAdjacent
ToRef
When '$ref' is defined, no other properties may be specified. 在 swagger 中使用“$ref”時,該 JSON 物件中不應包含任何其他屬性。
BasePathNotValid The 'basePath' property, if present, must start with a '/' character. 如果您使用的是基礎路徑,則其必須以「/」開頭。 無效的基本路徑類似於“abc/def/ghi”或“microsoft.com/abc”。
BodyParameterPropertyNotValid The 'body' parameter cannot use property '{0}', instead, the 'schema' property should be used to define the type used by the parameter. Swagger 中的其中一個主體參數使用了不能在主體參數中使用的無效屬性。
ConnectorMetadataPropertiesMissing The connector metadata property '{0}' is required. 連接器需要某些中繼資料。
ContactEmailNotValid The contact 'email' property, if present, must be a valid email address. 提供的電子郵件地址格式不正確或包含非 ASCII 字元。
DefaultValueMustMatchType The 'default' value is of type '{0}', but should match the given type '{1}'. 預設值的值與指定類型的類型不同。 將預設值的值變更為指定類型的值以修正此問題。
EnumMustContainAtLeastOneElement The 'enum' array requires at least one value. 如果您的屬性類型是列舉,則其應指定一個至少包含一個列舉值的陣列。
ExtensionNameNotValid The property '{0}' is not valid. If this property is an extension, its name must begin with "x-". 做為擴充的屬性必須以「x-」首碼開頭。
FilterFunctionsPropertyEmpty The 'filterFunctions' property must have at least one element. 如果指定,則「filterFunctions」屬性不能為空白。
FilterFunctionsPropertyHasDuplicates The 'filterFunctions' property cannot contain duplicates. 「FilterFunctions」屬性不能包含重複資料。
FilterFunctionsPropertyInInputSchema The 'filterFunctions' property has to be in the response schema. 「FilterFunctions」屬性只能位於回應結構描述中。
FilterFunctionsPropertyInvalidValue The 'filterFunctions' property supports only these values: {0}". 「FilterFunctions」屬性無法指定不支援的值。
HostNameNotValid The 'host' property, if present, must be a valid URI host without a scheme or path. 沒有方案或路徑的主機 URI 類似於“www.microsoft.com”。 主機的無效 URI 類似於“https://www.microsoft.com/”或“www.microsoft.com/hello”
InternalPropertyWithDefaultOptional The internal property has a default value but is optional. Only required properties are guaranteed to be included in requests. 屬性標記為內部且指定了預設值,這不是必要的。 如果要確保此內容包含在請求中,請將其標記為必填項;否則,如果這是有意的,它可以保持原樣。
InvalidConnectorCategory The connector category is invalid. Available categories are: [{0}]. 類別只能來自允許的類別值清單。
InvalidStringBinaryProperty A schema with type/format 'string/binary' can only be at the top level of a body or formData parameter. 「字串」和「二進位」的「類型」和「格式」屬性值在此結構描述位置是不允許的。
JsonTypeIncorrect The type of the property is incorrect. Expected type '{0}', but value is of type '{1}'. Swagger 中的屬性是一種類型,但實際值為不同類型。 變更值類型以符合預期的類型。
JsonValueNotInEnum The property value must be one of the following: {0}. 中的列舉的屬性值與當前可用選項不匹配。 將該值變更為以下錯誤訊息中所述的值之一。
MimeTypeNotValid The MIME type '{0}' is not valid. 您所選取的使用者提供的 MIME「內容類型」無效。 有效的 MIME 類型為:“application/json”“text/plain”“multipart/form-data”“application/x-www-form-urlencoded”
MissingEnumValuesDisplayName The 'x-ms-enum-values' extension is invalid. Please specify the property 'displayName'. x-ms-enum-values 未指定“displayName”屬性。
MultipleOfMustBeGreaterThanZero The 'multipleOf' value must be greater than zero. 「multipleOf」屬性的值應該是一個大於零的值。
OneOfPropertiesRequired At least one of the properties is required: [{0}]. {0} 是一組屬性。 此錯誤會顯示 Swagger 中必須存在的所有屬性。
ProductionStatusOnBetaService The connector cannot be in Production status on a beta service. 當後端服務處於 Beta 版時,連接器不能標記為「生產」。 它必須設置為“預覽版”。
PropertyMustBeRequired The property is internal and has a default value, it must be required. Optional internal fields are ignored. 儘管屬性是必需的,但未設置屬性。
RequiredPropertyDefinitionMissing The required property '{0}' is not defined in the object schema. 結構描述屬性列在「必要」下,因此必須在「屬性」中定義
RequiredPropertyMissing The '{0}' property is required. 需要您 Swagger 中的屬性,但其目前不在您的 Swagger 中。 若要修復此錯誤,請包含此屬性。
RequiredPropertyNotOnObject The property 'required' is applicable to schemas with 'object' type only and should be removed. 「必要」屬性僅支援「物件」類型。 移除所有其他類型的屬性。
RequiredReadOnlyPropertyNotAllowed
AsInput
An input property cannot be 'readonly' and required. 您的 swagger 包含一個標記為唯讀和必需的屬性。 唯讀屬性代表使用者不能修改該值。 必要屬性需要一個值進行修改。
SchemeNotValid The 'schemes' property must only contain transfer protocols from the list: {0}. Scheme 屬性應為“HTTP”或“https”之一。
SecuritySchemePropertyNotValid The security definition property '{0}' is not valid for definitions of type '{1}'. 包含在 securityDefinitions 字典中的屬性名稱和值無效。 若要解決此問題,請將此屬性更改為有效的屬性名稱。
SecuritySchemePropertyRequired The security definition property '{0}' is required for definitions of type '{1}'. 有一個屬性名稱和值是必需的,但未包含在 securityDefinitions 字典中。 新增此屬性與值以修正此問題。
SpecificationVersionIncorrect The 'swagger' property must have the string value "2.0". 僅支援「2.0」版本,因此將 Swagger 版本屬性修正為「2.0」。
TagRedefined The 'tags' property defines tag '{0}' multiple times. 在「標籤」屬性中定義的標籤必須是唯一的。 移除或取代任何多次發生次數。
TooManyConnectorCategories The maximum allowed number of categories for the connector is '{0}'. 可以為連接器設置的類別數是有限制的。
UrlNotValid The 'url' property must be a valid absolute URL. 您的 Swagger 具有無效 URL。 這可能是因為從某處錯誤地複製了 URL。

回應

錯誤 問題 應用程式執行個體
BodyParameterSchemaRequired The 'body' parameter must define a 'schema' property. 在主體參數中必須定義結構描述屬性。 定義結構描述屬性以修正此問題。
BodySchemaCountExceedsMaxAllowed The total number of schemas in the object exceeds the max schema count allowed value of '{0}'. Please remove any unnecessary property or item definitions. 主體物件中包含過多結構描述。 移除部分結構描述,使總數小於限制。
DefaultResponseHasSchema The 'default' response should not have schema definition. Schemas should be defined on expected responses only. 您的 Swagger 包含預設回應的結構描述定義。 移除預設回應的此結構描述定義可修正此錯誤。
InvalidCustomEditorExtension
DictionaryValue
The 'x-ms-editor' extension can be specified as 'dictionary' only for schema with type object and additional properties allowed. 檢查 x-ms-editor 是否僅在結構描述類型為物件並設為允許的其他屬性時設為字典。
JsonPointerNotValid The JSON Pointer path is not valid. 在您的 Swagger 中使用的參考 (#ref) 無效。
NonBodyParameterSchemaNotValid The parameter cannot define a schema as it is not in the 'body'. 您的 Swagger 具有使用「結構描述」的參數,但只有主體參數可以使用「結構描述」。
RequiredLoopInSchemaNotAllowed Loops of required schema properties are not allowed. 必要屬性的規範不能使用參考迴圈。
ResponseExampleMustBeProduced
ByOperation
The response example '{0}' is not produced by the operation '{1}'. 您的 swagger 有一個帶有回覆示例的操作,但該操作不會生成具有指示 MIME 類型的回覆。
ResponseHeadersAreNotUnique The response headers are not unique. 回覆標頭存在重複。 回應標頭應該是唯一的。
ResponseMustBeDefaultOrHttpStatusCode The response is not valid, the response must be a valid HTTP status code, or the string 'default'. 您的 swagger 沒有預設的 HTTP 狀態代碼或有效的 HTTP 狀態代碼。 將狀態碼新增至回應。
ResponseReferenceNotFound The response reference '{0}' could not be found in the swagger document. 您的 Swagger 具有在 Swagger 文件中找不到的回應參考。 移除此回應的參考。
ResponseReferenceNotValid The response reference '{0}' is not valid. Response references must start with '#/responses/' and be valid JSON Pointers. 您的 Swagger 具有回應參考 (「#/responses/」),根據 JSON 指標 RFC 規範是無效的。
SchemaDefinitionSetIncorrectly The operation '{0}' should define an output schema on the 200 or 201 response code or in 'x-ms-notification-content' extension for a webhook to be visible in the designer. 您的作業缺少 200 或 201 回應碼的回應結構描述。 如果是 Webhooks,則回應結構描述指定為通知內容擴充的一部分。
SchemaReferenceNotFound The schema reference '{0}' could not be found in the swagger document. 您的 swagger 具有在 swagger 文件中找不到的架構引用。
SchemaReferenceNotValid The schema reference '{0}' is not valid. Schema references must start with '#/definitions/' and be valid JSON Pointers. 您的 Swagger 具有結構描述參考 (「#/definitions/」),根據 JSON 指標 RFC 規範是無效的。
SchemaRefLoopNotAllowed The schema definition may not use a '$ref' to point to another definition. 架構中有一個引用迴圈(A 指向 B,B 指向 A)。
SchemaTooDeep The schema exceeds the maximum allowed depth. Schemas must not exceed a depth of '{0}', including referenced ('$ref') schemas. 結構描述僅限於特定的 JSON 深度。 使用更淺的結構描述。
SchemaTypeFileNotValid The schema type 'file' is not valid. Only parameters in 'formData' and the root response schema may be of type 'file'. 僅在表單資料中支援使用結構描述類型「檔案」,且必須位於回應定義的回應結構描述根目錄中。
SchemeNotSupported The WebSocket transfer protocol schemes are not supported. 不支援此結構描述。 支援的結構描述為 Https 和 Http。
TotalSchemaCountExceedsMaxAllowed The maximum allowed number of schemas in the swagger is '{0}'. Please remove any unnecessary property or item definitions. Swagger 中包含過多結構描述。

安全性

錯誤 問題 應用程式執行個體
OAuthSecurityRequirementValueMustBe
ScopeName
The OAuth security requirement '{0}' refers to scope name '{1}', but this is not defined in the 'securityDefinitions' object. 安全性要求名稱必須是在安全性定義物件中定義的範圍名稱。
SecurityRequirementMustBeDefined The security requirement '{0}' is not defined in the 'securityDefinitions' object. 已使用安全性需求,但未在安全性定義字典中定義。
SecurityRequirementMustHaveEmptyValue The security requirement '{0}' cannot specify any scopes, an empty array should be provided. 根據目前的設定,名稱為「{0}」的安全性要求必須是空白陣列。
SecurityRequirementMustHaveValue The security requirement '{0}' must have have a value. Provide an empty array if no OAuth scopes are required. 安全性要求遺失或為 Null。 如果不需要 OAuth 範圍,請指定空白陣列。

Webhooks

錯誤 問題 應用程式執行個體
NotificationUrlNotAllowedInThisPosition The notification URL property is not allowed in this position. It is allowed only in input body. 「x-ms-notification-url」屬性應該只在輸入中定義。
NotificationUrlNotInternal The notification URL property itself or at least one of its parents must be internal. 應該是您的 Swagger 目前並未將通知 URL 屬性設為內部。
NotificationUrlNotRequired The notification URL property must be required all the way through the schema chain. 您的 Swagger 目前沒有要求通知 URL 屬性,而這應該是必要的。
NotificationUrlNotString The notification URL property must be of type string. 通知 URL 屬性的值不是字串類型。

中繼資料

錯誤 問題 應用程式執行個體
AllowEmptyValueOnlyValidForQuery
FormData
The parameter cannot use the 'allowEmptyValue' keyword as it is not in the 'query' or 'formData' location. 「allowEmptyValue」屬性只能在「位置」屬性為「query」或「formData」的參數中設為「True」。 「位置」屬性的值不屬於這兩種。
DiscriminatorMustBeARequiredStringProperty The 'discriminator' value must be the name of a required string property. 「discriminator」值應該是您的 Swagger 中所需字串屬性的名稱。
ExclusiveMaximumRequiresMaximum The 'exclusiveMaximum' keyword can only be specified if the 'maximum' keyword is also specified. 您不能在不指定「最大值」的情況下指定「exclusiveMaximum」。
ExclusiveMinimumRequiresMinimum The 'exclusiveMinimum' keyword can only be specified if the 'minimum' keyword is also specified. 您不能在不指定「最小值」的情況下指定「exclusiveMinimum」。
FieldLengthExceeded The '{0}' value goes over the character limit '{1}' {0} 中指定名稱的欄位超出了 {1} 中指定的字元限制。
FieldLengthNotInRange The '{0}' value must be between '{1}' and '{2}' characters. {0} 為欄位名稱,{1} 為最小長度,{2} 為限制。 減少此欄位中字元的長度。
MaxItemsMustBeGreaterThanOrEqual
ToZero
The 'maxItems' value must be greater than or equal to zero. “maxItems”值當前低於零。 將此值更改為大於或等於零。
MaxLengthMustBeGreaterThanOrEqual
ToZero
The 'maxLength' value must be greater than or equal to zero. 「maxLength」屬性的值應該是非負數值。
MaxPropertiesMustBeGreaterThanOrEqual
ToZero
The 'maxProperties' value must be greater than or equal to zero. “maxProperties”值當前小於零。 將此值更改為大於或等於零。
MinimumShouldBeLessThanOrEqual
ToMaximum
The 'minimum' value should be less than or equal to the 'maximum' value. 指定最小值時,該值應小於或等於最大值。
MinItemsMustBeGreaterThanOrEqual
ToZero
The 'minItems' value must be greater than or equal to zero. “minItems”值當前小於零。 將此值更改為大於或等於零。
MinItemsShouldBeLessThanOrEqual
ToMaxItems
The 'minItems' value should be less than or equal to the 'maxItems' value. 指定最小專案時,該值應小於或等於最大專案。
MinLengthMustBeGreaterThanOrEqual
ToZero
The 'minLength' value must be greater than or equal to zero. 「minLength」屬性的值應該是非負數值。
MinLengthShouldBeLessThanOrEqual
ToMaxLength
The 'minLength' value should be less than or equal to the 'maxLength' value. 指定最小長度時,該值應小於或等於最大長度。
MinPropertiesMustBeGreaterThanOrEqual
ToZero
The 'minProperties' value must be greater than or equal to zero. “minProperties”值當前小於零。 將此值更改為大於或等於零。
PatternShouldBeValidRegularExpression The 'pattern' value should be a valid regular expression. “pattern”值不是有效的正則表達式,修復正則表達式可以修復此錯誤。
RequiredValueEmpty The '{0}' property must have not empty value. 您的 Swagger 包含所需屬性的空白值。 設定這個必要屬性的值可修正此問題。
ValueContainsRestrictedWords The value '{0}' contains at least one of the restricted words: '{1}'. Swagger 中的其中一個欄位使用了受限詞。
ValueMustBeInEnglish The '{0}' value must be written in English. 將該值取代為僅包含英數字元的值。
ValueMustEndWithAlphanumeric The '{0}' value must end with alphanumeric character. 以英數字元取代最後一個字元