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

removed apprentice mode metrics from swagger #15052

Merged
merged 5 commits into from
Jul 7, 2021

Conversation

orenmichaely
Copy link
Contributor

small change to personalizer swagger. Removed unused apprentice mode metrics.

@openapi-workflow-bot
Copy link

Hi, @orenmichaely 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. [email protected]

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 1, 2021

    Swagger Validation Report

    ️❌BreakingChange: 4 Errors, 2 Warnings failed [Detail]
    Rule Message
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ApprenticeLearningMetrics' removed or renamed?
    New: Personalizer/preview/v1.1-preview.1/Personalizer.json#L771:3
    Old: Personalizer/preview/v1.1-preview.1/Personalizer.json#L771:3
    1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ApprenticeModeMetrics' removed or renamed?
    New: Personalizer/preview/v1.1-preview.1/Personalizer.json#L771:3
    Old: Personalizer/preview/v1.1-preview.1/Personalizer.json#L771:3
    1008 - ModifiedOperationId The operation id has been changed from 'Evaluation_Apply' to 'ServiceConfiguration_ApplyFromEvaluation'. This will impact generated code.
    New: Personalizer/preview/v1.1-preview.1/Personalizer.json#L178:7
    Old: Personalizer/preview/v1.1-preview.1/Personalizer.json#L178:7
    1033 - RemovedProperty The new version is missing a property found in the old version. Was 'latestApprenticeModeMetrics' renamed or removed?
    New: Personalizer/preview/v1.1-preview.1/Personalizer.json#L783:7
    Old: Personalizer/preview/v1.1-preview.1/Personalizer.json#L850:7
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Personalizer/preview/v1.1-preview.1/Personalizer.json#L1239:9
    Old: Personalizer/preview/v1.1-preview.1/Personalizer.json#L1309:9
    ⚠️ 1026 - TypeChanged The new version has a different type 'object' than the previous one ''.
    New: Personalizer/preview/v1.1-preview.1/Personalizer.json#L1416:9
    Old: Personalizer/preview/v1.1-preview.1/Personalizer.json#L1480:9
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ServiceConfigurationModel'. Consider using the plural form of 'ServiceConfiguration' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Personalizer/preview/v1.1-preview.1/Personalizer.json#L183


    The following errors/warnings exist before current PR submission:

    Rule Message
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ServiceConfigurationModel'. Consider using the plural form of 'ServiceConfiguration' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Personalizer/preview/v1.1-preview.1/Personalizer.json#L20
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ServiceConfigurationModel'. Consider using the plural form of 'ServiceConfiguration' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Personalizer/preview/v1.1-preview.1/Personalizer.json#L64
    ⚠️ R4000 - ParameterDescriptionRequired 'body' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation.
    Location: Personalizer/preview/v1.1-preview.1/Personalizer.json#L191
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Personalizer/readme.md",
    "tag":"release_1_1_preview.1",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Personalizer/readme.md",
    "tag":"release_1_1_preview.1",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"cognitiveservices/data-plane/Personalizer/readme.md",
    "tag":"release_1_1_preview.1",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jul 1, 2021

    Swagger Generation Artifacts

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

    Breaking Changes Tracking

    ️✔️azure-sdk-for-go - personalizer/v1.0/personalizer - v55.5.0
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 3d08fb3. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.3.0 requires azure-core<2.0.0,>=1.15.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️azure-cognitiveservices-personalizer [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Added operation group ServiceConfigurationOperations
      info	[Changelog]   - Added operation group MultiSlotOperations
      info	[Changelog]   - Added operation group ModelOperations
      info	[Changelog]   - Added operation group PersonalizerBaseOperationsMixin
      info	[Changelog]   - Added operation group MultiSlotEventsOperations
      info	[Changelog]   - Added operation group LogOperations
      info	[Changelog]   - Added operation group PolicyOperations
      info	[Changelog]   - Added operation group EvaluationsOperations
    ️⚠️ azure-sdk-for-go warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 3d08fb3. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
      cmderr	[generator automation] [WARNING] line in batch '' does not starts with 'tags', ignore
    • ️✔️personalizer/v1.0/personalizer [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️❌ azure-sdk-for-js failed [Detail]
    • Failed [Logs]Release - Generate from 3d08fb3. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/cognitiveservices/data-plane/Personalizer/readme.md
    • @azure/cognitiveservices-personalizer [View full logs]  [Release SDK Changes]
      error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-js/azure-sdk-for-js/sdk/cognitiveservices/cognitiveservices-personalizer]: npm pack --silent
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @orenmichaely, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    Action: To initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @anuchandy
    Copy link
    Member

    Hi @JeffreyRichter, could you please provide breaking change approval?

    Context: The PR removes a model exposed by mistake and updates the client-side operation names, there are no SDKs released yet, the crew is actively working on it.

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jul 7, 2021
    @anuchandy anuchandy merged commit 3d08fb3 into Azure:master Jul 7, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * removed apprentice mode metrics from swagger
    
    * changed evalution_apply operation name
    
    * fixed typo
    
    * chnaged name of example
    
    * removed csharp formats
    
    Co-authored-by: orenmichaely <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    5 participants