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

Moving files from azure-rest-spec-pr to azure-rest-spec repo after api review #19878

Merged

Conversation

bexxx
Copy link
Member

@bexxx bexxx commented Jul 21, 2022

Changelog

Add a changelog entry for this PR by answering the following questions:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
    July 2022
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    July 2022
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

  • Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
  • Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

Please follow the link to find more details on PR review process.

@bexxx bexxx requested a review from a team as a code owner July 21, 2022 12:55
@bexxx bexxx requested review from scgbear and johanste and removed request for a team July 21, 2022 12:55
@openapi-workflow-bot
Copy link

Hi, @bexxx 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 Jul 21, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    compared tags (via openapi-validator v1.13.0) new version base version
    release_2022_03_01_preview release_2022_03_01_preview(8d32283) default(main)
    release_2022_06_01_preview release_2022_06_01_preview(8d32283) default(main)
    ️❌Avocado: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: AzureOpenAI/inference/preview/2022-03-01-preview
    MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: AzureOpenAI/inference/preview/2022-06-01-preview
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌ModelValidation: 3 Errors, 0 Warnings failed [Detail]
    Rule Message
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in completions_create.
    Url: inference/preview/2022-03-01-preview/inference.json#L30:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in completions_create.
    Url: inference/preview/2022-06-01-preview/inference.json#L30:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in embeddings_create.
    Url: inference/preview/2022-06-01-preview/inference.json#L352:15
    ️❌SemanticValidation: 18 Errors, 0 Warnings failed [Detail]
    Rule Message
    MULTIPLE_BODY_PARAMETERS Operation cannot have multiple body parameters
    JsonUrl: authoring/preview/2022-03-01-preview/azureopenai.json#L271:15
    MULTIPLE_BODY_PARAMETERS Operation cannot have multiple body parameters
    JsonUrl: authoring/preview/2022-06-01-preview/azureopenai.json#L271:15
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
    JsonUrl: inference/preview/2022-03-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: openapi
    JsonUrl: inference/preview/2022-03-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: servers
    JsonUrl: inference/preview/2022-03-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: components
    JsonUrl: inference/preview/2022-03-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: requestBody
    JsonUrl: inference/preview/2022-03-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: schema
    JsonUrl: inference/preview/2022-03-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: content
    JsonUrl: inference/preview/2022-03-01-preview/inference.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: type
    JsonUrl: inference/preview/2022-03-01-preview/inference.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
    JsonUrl: inference/preview/2022-06-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: openapi
    JsonUrl: inference/preview/2022-06-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: servers
    JsonUrl: inference/preview/2022-06-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: components
    JsonUrl: inference/preview/2022-06-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: requestBody
    JsonUrl: inference/preview/2022-06-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: schema
    JsonUrl: inference/preview/2022-06-01-preview/inference.json
    OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: content
    JsonUrl: inference/preview/2022-06-01-preview/inference.json
    OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: type
    JsonUrl: inference/preview/2022-06-01-preview/inference.json
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 2 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/8d322835ba86bd8d63431f35863319589d75fbda/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md#tag-release_2022_03_01_preview">cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md#release_2022_03_01_preview
      • "https://github.com/Azure/azure-rest-api-specs/blob/8d322835ba86bd8d63431f35863319589d75fbda/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md#tag-release_2022_06_01_preview">cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md#release_2022_06_01_preview
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md",
    "tag":"release_2022_03_01_preview",
    "details":"Security scheme api-key is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ⚠️ UnkownSecurityScheme "readme":"cognitiveservices/data-plane/AzureOpenAI/authoring/readme.md",
    "tag":"release_2022_06_01_preview",
    "details":"Security scheme api-key is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️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 Jul 21, 2022

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    @openapi-workflow-bot
    Copy link

    Hi @bexxx, 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.

    @bexxx
    Copy link
    Member Author

    bexxx commented Jul 22, 2022

    The following failures are expected because this API is an external API hosted on Azure now:

    • Avocado (missing readmes, we do not want to generate SDKs for those)
    • ModelValidation (missing exampes in inferece.json files, external API)
    • SemanticValidation (2 expected issues because of tooling issues with POST & form data (exception on -pr repo), the others are on the external API files)

    @weidongxu-microsoft weidongxu-microsoft merged commit 405811c into main Jul 22, 2022
    @weidongxu-microsoft weidongxu-microsoft deleted the rbeckers/addCognitiveServicesOpenAIPreviewVersions2 branch July 22, 2022 06:00
    akning-ms pushed a commit that referenced this pull request Aug 1, 2022
    * update folder structure
    
    * small errors and CI check
    
    * [Language Text] Update swagger titles (#19835)
    
    * [Language Text] Update swagger titles
    
    * edits
    
    * address feedback
    
    * Review request for Microsoft.ContainerService to add version 2022-06-01 (#19848)
    
    * Adds base for updating Microsoft.ContainerService from version stable/2022-04-01 to version 2022-06-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * update readmes (#19421)
    
    * Add key management service profile of a managed cluster for version 2022-06-01 (#19529)
    
    * Add NetworkPlugin none option to 2022-06-01 (#19510)
    
    * Add NetworkPlugin none option to 2022-06-01
    
    * improve description for none value
    
    * Fix violated rule R4041 for 2022-06-01 managedCluster swagger (#19581)
    
    * remove useless directive
    
    * fix R4041
    
    * GA AKS support for Dedicated Host Group (#19547)
    
    * GA AKS support for Dedicated Host Group
    
    * fit some format minor issue
    
    * add newline in end of files
    
    * Defender updates (#19665)
    
    * Defender updates
    
    * sample
    
    * remove old description
    
    Co-authored-by: Bin Xia <binxi@microsoft.com>
    Co-authored-by: Matt Stam <mattstam@live.com>
    Co-authored-by: Jianping Zeng <zjpjack@users.noreply.github.com>
    Co-authored-by: Or Parnes <orparnes@microsoft.com>
    
    * Update resources.json (#19861)
    
    * Pattts/predictive autoscale 20221001 (#19765)
    
    * Rev Autoscale API from 2021-05-01-preview to 2022-10-01.
    
    * Fix minor swagger issue. Default should be 'false'
    
    * Fix swagger validation error
    
    * Defining a new package 2022-10
    
    * AutoscaleSettingResource now reference allOf 'resource' which is the actual autoscaleSetting resource definition
    
    * Fix require property issue
    
    * Run prettier against autoscale_API.json
    
    * [Maps - Render & Spatial Services] add v2022-08-01 (#19520)
    
    * copy old swagger to new folders
    
    * set api version to 2022-08-01
    
    * apply api changes
    
    Co-authored-by: Gigi Grajo <gigigrajo@microsoft.com>
    
    * update appconfiguration (#19330)
    
    * update appconfiguration
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * Update readme.python.md
    
    * [Hub Generated] Publish private branch 'main' (#19852)
    
    * Add StorageMover specification for PubliC Preview
    
    * SpellCheck fix
    
    * Update custom-words
    
    * Update specification/storagemover/resource-manager/readme.md
    
    Co-authored-by: Abhishek Krishna <abkrish@microsoft.com>
    Co-authored-by: Dapeng Zhang <dapzhang@microsoft.com>
    
    * Merging Dynatrace swagger in stable folder (#19862)
    
    * Committing base swagger version
    
    * Removing preview tag from stable folder api version
    
    * Changing version name in all the files
    
    * Updating readme.go and readme.md files
    
    * [CDN] Fix customDomains property type in Endpoint (#19788)
    
    * [CDN] Fix customDomains property type in Endpoint
    
    * Fix linter error
    
    Co-authored-by: Bo Zhang <bzhan@microsoft.com>
    
    * Adding Microsoft.Sql AdvancedThreatProtectionSettings APIs for MI on v5 tag for 2022-02-01-preview (#19866)
    
    * update folders
    
    * [Hub Generated] Review request for Microsoft.KeyVault to add version stable/7.3 (#19844)
    
    * Update description of exportable attribute and release_policy.data
    
    * Remove submodule azure-reset-api-specs
    
    * Fix description for exportable
    
    Co-authored-by: Sunny Solanki <Sunny.Solanki@microsoft.com>
    
    * Add latest StorageMover updates (#19876)
    
    * Add StorageMover specification for PubliC Preview
    
    * SpellCheck fix
    
    * Update custom-words
    
    * Update specification/storagemover/resource-manager/readme.md
    
    * Add latest StorageMover updates
    
    Co-authored-by: Abhishek Krishna <abkrish@microsoft.com>
    Co-authored-by: Dapeng Zhang <dapzhang@microsoft.com>
    
    * Update readme.python.md (#19899)
    
    * Update readme.python.md
    
    * Update readme.md
    
    * Moving files from azure-rest-spec-pr to azure-rest-spec repo after api review (#19878)
    
    * Moving files from azure-rest-spec-pr to azure-rest-spec repo after api review
    
    * Add known words
    
    * Removed static IP allocation only from examples (#19858)
    
    * Removed static IP allocation
    
    * Removed static only from examples
    
    Co-authored-by: Arpit Gagneja <argagnej@microsoft.com>
    
    * Update securityinsights readme.python (#19903)
    
    * update securityinsights readme.python
    
    * Update readme.python.md
    
    Co-authored-by: Zhenbiao Wei (WICRESOFT NORTH AMERICA LTD) <v-zhenbwei@microsoft.com>
    
    * fix lint errors in Synapse trigger.json (#19660)
    
    * put json files into RP folders
    
    * update readme
    
    * Add CONTRIBUTING.md (#19257)
    
    * Add CONTRIBUTING.md
    
    * Apply suggestions from PR review
    
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    
    * Apply suggestions from PR review
    
    Co-authored-by: Weidong Xu <weidxu@microsoft.com>
    
    * Regen toc for CONTRIBUTING.md
    
    * Address PR review comments
    
    * Address PR review comments
    
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    Co-authored-by: Weidong Xu <weidxu@microsoft.com>
    
    * fix devcenter readme.go.md config (#19906)
    
    * fix readme.go.md config
    
    * rename to SkuInfo
    
    * add annotation for labservices (#19884)
    
    * add to description of OS state (#19764)
    
    * [Hub Generated] Review request for Microsoft.KeyVault to add version preview/2021-06-01-preview (#19767)
    
    * Updated the managed hsm resource manager spec to include two additional properties for private endpoint connection item
    
    * Update managed hsm private endpoint connection item in mhsm spec for latest api version
    
    * Address LRO_RESPONSE_HEADER violation for managed hsm
    
    Long running operations that are annotated with x-ms-long-running-operation:true
    must return location header or azure-AsyncOperation in response.
    Added the missing location header for managed hsm update command as well as to the corresponding
    examples.
    
    * [Microsoft.DeviceUpdate] Adding first stable API version (#19846)
    
    * Copied the most recent preview version into the first stable version
    
    * Updated api version in new stable version, added the tag to readme.md
    
    * Fixed typo
    
    * Fixed the wrong path in readme.md
    
    * Reverted VS Code automatic breaking change
    
    * Fix broken link (#19688)
    
    * add aadObjectId property to kustoPool (#19856)
    
    Co-authored-by: Amit Elran <amelran@microsoft.com>
    
    * Updata securityinsights readme.python (#19917)
    
    * update securityinsights readme.python
    
    * update readme.python
    
    Co-authored-by: Zhenbiao Wei (WICRESOFT NORTH AMERICA LTD) <v-zhenbwei@microsoft.com>
    
    * modify readme.typescripy.md for compute package (#19607)
    
    Co-authored-by: ZiWei Chen (WICRESOFT NORTH AMERICA LTD) <v-ziweichen@microsoft.com>
    
    * Dev gubalasu frontdoor microsoft.network 2021 06 01 (#19578)
    
    * Adds base for updating Microsoft.Network from version stable/2020-05-01 to version 2021-06-01
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * update waf configs and examples from 2020-11-01
    
    * Update api version in new specs and examples
    
    * Migration api update
    
    * Update readme
    
    * Fix readme
    
    * update readme
    
    * Fix readme again
    
    * Fix readme
    
    * Fix readme
    
    * update waf policy provisioning state
    
    * Update securityinsights readme.python (#19923)
    
    * update securityinsights readme.python
    
    * update readme.python
    
    * last modify
    
    * Update readme.python.md
    
    Co-authored-by: Zhenbiao Wei (WICRESOFT NORTH AMERICA LTD) <v-zhenbwei@microsoft.com>
    
    * sync with changes made to master
    
    * update folder structure
    
    * small errors and CI check
    
    * update folders
    
    * put json files into RP folders
    
    * update readme
    
    * resolve capitalization and number misplacement accident
    
    Co-authored-by: Theodore Chang <theodore.l.chang@gmail.com>
    Co-authored-by: Deyaaeldeen Almahallawi <dealmaha@microsoft.com>
    Co-authored-by: FumingZhang <81607949+FumingZhang@users.noreply.github.com>
    Co-authored-by: Bin Xia <binxi@microsoft.com>
    Co-authored-by: Matt Stam <mattstam@live.com>
    Co-authored-by: Jianping Zeng <zjpjack@users.noreply.github.com>
    Co-authored-by: Or Parnes <orparnes@microsoft.com>
    Co-authored-by: Alexander Batishchev <abatishchev@gmail.com>
    Co-authored-by: PatrickTseng <pattts@microsoft.com>
    Co-authored-by: gigi <52640944+gigigoo0@users.noreply.github.com>
    Co-authored-by: Gigi Grajo <gigigrajo@microsoft.com>
    Co-authored-by: zhenbiao wei <424401670@qq.com>
    Co-authored-by: Abhishek Krishna <AbhishekKrishna123@users.noreply.github.com>
    Co-authored-by: Abhishek Krishna <abkrish@microsoft.com>
    Co-authored-by: Dapeng Zhang <dapzhang@microsoft.com>
    Co-authored-by: Divyansh Agarwal <83802474+divyansh3131@users.noreply.github.com>
    Co-authored-by: t-bzhan <61817681+t-bzhan@users.noreply.github.com>
    Co-authored-by: Bo Zhang <bzhan@microsoft.com>
    Co-authored-by: Uriel Cohen <urielc@microsoft.com>
    Co-authored-by: susolank <73919400+susolank@users.noreply.github.com>
    Co-authored-by: Sunny Solanki <Sunny.Solanki@microsoft.com>
    Co-authored-by: Ralf Beckers <bexxx@users.noreply.github.com>
    Co-authored-by: arpit-gagneja <gagneja.arpit@gmail.com>
    Co-authored-by: Arpit Gagneja <argagnej@microsoft.com>
    Co-authored-by: Zhenbiao Wei (WICRESOFT NORTH AMERICA LTD) <v-zhenbwei@microsoft.com>
    Co-authored-by: YanjunGao <85206987+yanjungao718@users.noreply.github.com>
    Co-authored-by: Mike Kistler <mikekistler@microsoft.com>
    Co-authored-by: Heath Stewart <heaths@outlook.com>
    Co-authored-by: Weidong Xu <weidxu@microsoft.com>
    Co-authored-by: Jiahui Peng <46921893+Alancere@users.noreply.github.com>
    Co-authored-by: j-zhong-ms <107880703+j-zhong-ms@users.noreply.github.com>
    Co-authored-by: Tom FitzMacken <tomfitz@microsoft.com>
    Co-authored-by: neeerajaakula <81248992+neeerajaakula@users.noreply.github.com>
    Co-authored-by: darkoa-msft <61987922+darkoa-msft@users.noreply.github.com>
    Co-authored-by: Roy Wellington <53838718+roy-work@users.noreply.github.com>
    Co-authored-by: Amit Elran <amitelran2110@gmail.com>
    Co-authored-by: Amit Elran <amelran@microsoft.com>
    Co-authored-by: kazrael2119 <98569699+kazrael2119@users.noreply.github.com>
    Co-authored-by: ZiWei Chen (WICRESOFT NORTH AMERICA LTD) <v-ziweichen@microsoft.com>
    Co-authored-by: gubalasu <59630928+gubalasu@users.noreply.github.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants