Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix ExampleId parameter type #20750

Closed
wants to merge 1 commit into from
Closed

Conversation

PwnzorBot4000
Copy link

This change attempts to fix some error cases related to issue 18041 Azure/azure-sdk-for-net#18041

Data Plane API - Pull Request

This is a followup to PR 12896 #12896 which partially attempted to change the type of ExampleId to long. Noticing that other LUIS methods fail in preview 4 with same error (PublishAsync) it was suspected there were more spots where ExampleId is defined as an int32.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your engagement record.

  • Link to engagement record issue:

Is this review for (select one):

  • a private preview
  • [*] a public preview
  • GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.

  • Design Document:
  • Previous Open API Doc:
  • Updated paths:

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

This change attempts to fix some error cases related to issue 18041 Azure/azure-sdk-for-net#18041
@openapi-workflow-bot
Copy link

Hi, @PwnzorBot4000 Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 16, 2022

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.9.7)] new version base version
    LUIS-Authoring.json v3.0(2647d60) v3.0(main)
    Rule Message
    1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: Authoring/preview/v3.0/LUIS-Authoring.json#L457:11
    Old: Authoring/preview/v3.0/LUIS-Authoring.json#L457:11
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v1.13.0) new version base version
    authoring_3_0_preview authoring_3_0_preview(2647d60) authoring_3_0_preview(main)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ R2007 - LongRunningOperationsWithLongRunningExtension The operation 'Train_TrainVersion' returns 202 status code, which indicates a long running operation, please enable 'x-ms-long-running-operation.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L3111
    ⚠️ R3017 - GuidUsage Guid used in model definition 'GuidResponse' for property 'GuidResponse'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9005
    ⚠️ R3017 - GuidUsage Guid used in model definition 'EntityLabel' for property 'roleId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9168
    ⚠️ R3017 - GuidUsage Guid used in model definition 'ModelInfo' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9283
    ⚠️ R3017 - GuidUsage Guid used in model definition 'ModelInfoResponse' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9316
    ⚠️ R3017 - GuidUsage Guid used in model definition 'ChildEntity' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9506
    ⚠️ R3017 - GuidUsage Guid used in model definition 'ApplicationInfoResponse' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9793
    ⚠️ R3017 - GuidUsage Guid used in model definition 'ApplicationSettings' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9939
    ⚠️ R3017 - GuidUsage Guid used in model definition 'PublishSettings' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L9960
    ⚠️ R3017 - GuidUsage Guid used in model definition 'ModelTrainingInfo' for property 'modelId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L10044
    ⚠️ R3017 - GuidUsage Guid used in model definition 'PatternRuleUpdateObject' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L10349
    ⚠️ R3017 - GuidUsage Guid used in model definition 'EntityRole' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L10419
    ⚠️ R3017 - GuidUsage Guid used in model definition 'PatternRuleInfo' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Authoring/preview/v3.0/LUIS-Authoring.json#L10468
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️~[Staging] TrafficValidation succeeded [Detail] [Expand]
    ️❌ModelValidation: 16 Errors, 0 Warnings failed [Detail]
    Rule Message
    INVALID_FORMAT Object didn't pass validation for format uuid: {appId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10663:20
    ExampleUrl: v3.0/examples/model/SuccessfulGetApplicationVersionHierarchicalEntityInfosRequest.json#L5:14
    INVALID_FORMAT Object didn't pass validation for format uuid: {appId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10663:20
    ExampleUrl: v3.0/examples/model/SuccessfulGetApplicationVersionCompositeEntityInfosRequest.json#L5:14
    INVALID_FORMAT Object didn't pass validation for format uuid: {appId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10663:20
    ExampleUrl: v3.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json#L5:14
    INVALID_FORMAT Object didn't pass validation for format uuid: {hEntityId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10689:24
    ExampleUrl: v3.0/examples/model/SuccessfulGetHierarchicalEntityInfoRequest.json#L7:18
    INVALID_FORMAT Object didn't pass validation for format uuid: {appId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10663:20
    ExampleUrl: v3.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json#L5:14
    INVALID_FORMAT Object didn't pass validation for format uuid: {hEntityId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10689:24
    ExampleUrl: v3.0/examples/model/SuccessfulDeleteHierarchicalEntityModelRequest.json#L7:18
    INVALID_FORMAT Object didn't pass validation for format uuid: {appId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10663:20
    ExampleUrl: v3.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json#L5:14
    INVALID_FORMAT Object didn't pass validation for format uuid: {cEntityId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10680:24
    ExampleUrl: v3.0/examples/model/SuccessfulGetCompositeEntityInfoRequest.json#L7:18
    INVALID_FORMAT Object didn't pass validation for format uuid: {appId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10663:20
    ExampleUrl: v3.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json#L5:14
    INVALID_FORMAT Object didn't pass validation for format uuid: {cEntityId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10680:24
    ExampleUrl: v3.0/examples/model/SuccessfulUpdateCompositeEntityModelRequest.json#L7:18
    INVALID_FORMAT Object didn't pass validation for format uuid: {appId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10663:20
    ExampleUrl: v3.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json#L5:14
    INVALID_FORMAT Object didn't pass validation for format uuid: {cEntityId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10680:24
    ExampleUrl: v3.0/examples/model/SuccessfulDeleteCompositeEntityModelRequest.json#L7:18
    INVALID_FORMAT Object didn't pass validation for format uuid: {appId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10663:20
    ExampleUrl: v3.0/examples/apps/SuccessfulDownloadApplicationQueryLogsRequest.json#L5:14
    INVALID_FORMAT Object didn't pass validation for format uuid: {appId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10663:20
    ExampleUrl: v3.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json#L5:14
    INVALID_FORMAT Object didn't pass validation for format uuid: {hEntityId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L10689:24
    ExampleUrl: v3.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json#L7:18
    INVALID_FORMAT Object didn't pass validation for format uuid: {hChildId}
    Url: Authoring/preview/v3.0/LUIS-Authoring.json#L3998:11
    ExampleUrl: v3.0/examples/model/SuccessfulGetHierarchicalChildEntityInfoRequest.json#L8:17
    ️❌SemanticValidation: 9 Errors, 0 Warnings failed [Detail]
    Rule Message
    DISCRIMINATOR_PROPERTY_NOT_FOUND Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Intent Classifier
    JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9577:25
    DISCRIMINATOR_PROPERTY_NOT_FOUND Missing discriminator in base model. This derived model has x-ms-dicriminator-value: N-Depth Entity Extractor
    JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9620:30
    DISCRIMINATOR_PROPERTY_NOT_FOUND Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Hierarchical Entity Extractor
    JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9395:36
    DISCRIMINATOR_PROPERTY_NOT_FOUND Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Composite Entity Extractor
    JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9424:33
    DISCRIMINATOR_PROPERTY_NOT_FOUND Missing discriminator in base model. This derived model has x-ms-dicriminator-value: List Entity Extractor
    JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9453:34
    DISCRIMINATOR_PROPERTY_NOT_FOUND Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Prebuilt Entity Extractor
    JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9482:32
    DISCRIMINATOR_PROPERTY_NOT_FOUND Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Entity Extractor
    JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L9597:24
    DISCRIMINATOR_PROPERTY_NOT_FOUND Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Regex Entity Extractor
    JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L10364:29
    DISCRIMINATOR_PROPERTY_NOT_FOUND Missing discriminator in base model. This derived model has x-ms-dicriminator-value: Pattern.Any Entity Extractor
    JsonUrl: Authoring/preview/v3.0/LUIS-Authoring.json#L10390:34
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 0 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/2647d60476ee7ce5aa87885b1eb880073196635f/specification/cognitiveservices/data-plane/LUIS/Authoring/readme.md#tag-authoring_3_0_preview">cognitiveservices/data-plane/LUIS/Authoring/readme.md#authoring_3_0_preview
    The following errors/warnings exist before current PR submission:
    Rule Message
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'HierarchicalEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'CompositeEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'ClosedListEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'PrebuiltEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'CustomPrebuiltModel' inherits 'IntentClassifier' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'CustomPrebuiltModel' inherits 'EntityExtractor' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'CustomPrebuiltModel' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'EntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'NDepthEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'RegexEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    PreCheck/DuplicateInheritance "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'PatternAnyEntityExtractor' inherits 'EntityModelInfo' via an allOf that is already coming from parent 'ModelInfo'"
    "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Error: 11 errors occured -- cannot continue."
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'ModelInfoResponse' has a property 'id' that is already declared the parent schema 'ModelInfo' but isn't significantly different. The property has been removed from ModelInfoResponse"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'ModelInfoResponse' has a property 'name' that is already declared the parent schema 'ModelInfo' but isn't significantly different. The property has been removed from ModelInfoResponse"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'ModelInfoResponse' has a property 'typeId' that is already declared the parent schema 'ModelInfo' but isn't significantly different. The property has been removed from ModelInfoResponse"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'ModelInfoResponse' has a property 'readableType' that is already declared the parent schema 'ModelInfo' but isn't significantly different. The property has been removed from ModelInfoResponse"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'HierarchicalChildEntity' has a property 'typeId' that is already declared the parent schema 'ChildEntity' but isn't significantly different. The property has been removed from HierarchicalChildEntity"
    ⚠️ PreCheck/PropertyRedeclarationWarning "readme":"cognitiveservices/data-plane/LUIS/Authoring/readme.md",
    "tag":"authoring_3_0_preview",
    "details":"Schema 'HierarchicalChildEntity' has a property 'readableType' that is already declared the parent schema 'ChildEntity' but isn't significantly different. The property has been removed from HierarchicalChildEntity"
    ️️✔️PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    ️️✔️CadlValidation succeeded [Detail] [Expand]
    Validation passes for CadlValidation.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Sep 16, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

    @ghost ghost added the customer-reported Issues that are reported by GitHub users external to the Azure organization. label Sep 16, 2022
    @ghost
    Copy link

    ghost commented Sep 16, 2022

    Thank you for your contribution PwnzorBot4000! We will review the pull request and get back to you soon.

    @openapi-workflow-bot
    Copy link

    Hi @PwnzorBot4000, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    @PwnzorBot4000
    Copy link
    Author

    Rationale: PublishAsync was unable to complete because we had an intent with no examples. The example had an ID larger than int32 so the app was unable to delete it due to the bug. Once I deleted that intent from the LUIS UI we were able to train and publish again.

    @ghost
    Copy link

    ghost commented Oct 2, 2022

    Hi, @PwnzorBot4000. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost ghost added the no-recent-activity label Oct 2, 2022
    @ghost ghost closed this Oct 17, 2022
    @ghost
    Copy link

    ghost commented Oct 17, 2022

    Hi, @PwnzorBot4000. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    This pull request was closed.
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    CI-FixRequiredOnFailure Cognitive Services customer-reported Issues that are reported by GitHub users external to the Azure organization. data-plane
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants