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

add stable version for hybrid network #15211

Merged
merged 4 commits into from
Jul 16, 2021
Merged

Conversation

marjanmr
Copy link
Contributor

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet. August 2021
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet. August 2021
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • [] SDK of .NET (need service team to ensure code readiness)
    • [x ] SDK of Python
    • [ x] SDK of Java
    • SDK of Js
    • SDK of Go
    • [ x] PowerShell
    • [ x] CLI
    • [ x] Terraform
    • No, no need to refresh 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

  • [x ] Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • [x ] Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • Adding a new service
  • [ x] Please 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.

  • [ x] 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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.

@openapi-workflow-bot
Copy link

Hi, @marjanmr 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. vsswagger@microsoft.com

    @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 15, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.HybridNetwork/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/operation.json#L37
    R4037 - MissingTypeObject The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L38
    R4037 - MissingTypeObject The schema 'TagsObject' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L82
    R4037 - MissingTypeObject The schema 'NetworkInterface' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L94
    R4037 - MissingTypeObject The schema 'NetworkInterfaceIPConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L128
    R4037 - MissingTypeObject The schema 'OsProfile' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L203
    R4037 - MissingTypeObject The schema 'LinuxConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L225
    R4037 - MissingTypeObject The schema 'SshConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L234
    R4037 - MissingTypeObject The schema 'SshPublicKey' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L246
    R4037 - MissingTypeObject The schema 'NetworkFunction' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/networkFunction.json#L333
    R4037 - MissingTypeObject The schema 'NetworkFunctionPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/networkFunction.json#L357
    R4037 - MissingTypeObject The schema 'NetworkFunctionListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/networkFunction.json#L414
    R4037 - MissingTypeObject The schema 'NetworkFunctionUserConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/networkFunction.json#L431
    R4037 - MissingTypeObject The schema 'osProfile' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/networkFunction.json#L448
    R4037 - MissingTypeObject The schema 'NetworkInterfaceIPConfiguration' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L128
    R4037 - MissingTypeObject The schema 'NetworkInterface' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L94
    R4037 - MissingTypeObject The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L38
    R4037 - MissingTypeObject The schema 'TagsObject' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L82
    R4037 - MissingTypeObject The schema 'Device' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/device.json#L379
    R4037 - MissingTypeObject The schema 'DevicePropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/device.json#L399
    R4037 - MissingTypeObject The schema 'DeviceRegistrationKey' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/device.json#L453
    R4037 - MissingTypeObject The schema 'DeviceListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/device.json#L463
    R4037 - MissingTypeObject The schema 'SubResource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L38
    R4037 - MissingTypeObject The schema 'TagsObject' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/common.json#L82
    R4037 - MissingTypeObject The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/operation.json#L82
    R4037 - MissingTypeObject The schema 'Vendor' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/vendor.json#L692
    R4037 - MissingTypeObject The schema 'VendorPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/vendor.json#L712
    R4037 - MissingTypeObject The schema 'VendorSku' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/vendor.json#L730
    R4037 - MissingTypeObject The schema 'VendorSkuPropertiesFormat' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/vendor.json#L750
    R4037 - MissingTypeObject The schema 'VendorSkuListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.HybridNetwork/stable/2021-05-01/vendor.json#L806
    ️️✔️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":"hybridnetwork/resource-manager/readme.md",
    "tag":"package-2021-05-01",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"hybridnetwork/resource-manager/readme.md",
    "tag":"package-2021-05-01",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"hybridnetwork/resource-manager/readme.md",
    "tag":"package-2021-05-01",
    "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 15, 2021

    Swagger Generation Artifacts

    ️❌[Staging] ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=231851&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"Run.ps1 failed with exit code 1 "
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-hybridnetwork - 1.0.0b1
    ️✔️azure-sdk-for-go - preview/hybridnetwork/mgmt/2020-01-01-preview/hybridnetwork - v55.7.0
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a2d4dc4. 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] 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
    • ️✔️track2_azure-mgmt-hybridnetwork [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model NetworkFunction has a new parameter system_data
      info	[Changelog]   - Model NetworkFunction has a new parameter network_function_container_configurations
      info	[Changelog]   - Model VendorSku has a new parameter network_function_type
      info	[Changelog]   - Model VendorSku has a new parameter system_data
      info	[Changelog]   - Model Vendor has a new parameter system_data
      info	[Changelog]   - Model PreviewSubscription has a new parameter system_data
      info	[Changelog]   - Model PreviewSubscription has a new parameter provisioning_state
      info	[Changelog]   - Model RoleInstance has a new parameter system_data
      info	[Changelog]   - Model RoleInstance has a new parameter provisioning_state
      info	[Changelog]   - Model VendorNetworkFunction has a new parameter system_data
      info	[Changelog]   - Model Device has a new parameter system_data
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a2d4dc4. SDK Automation 14.0.0
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
      command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
      cmderr	[generate.py] 2021-07-16 07:43:11 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-hybridnetwork"
      cmderr	[generate.py] 2021-07-16 07:43:11 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-07-16 07:43:11 INFO autorest --version=3.4.5 --use=@autorest/java@4.0.33 --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/hybridnetwork/azure-resourcemanager-hybridnetwork --java.namespace=com.azure.resourcemanager.hybridnetwork   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL  ../azure-rest-api-specs/specification/hybridnetwork/resource-manager/readme.md
      cmderr	[generate.py] 2021-07-16 07:43:42 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-07-16 07:43:42 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-07-16 07:43:42 INFO [POM][Skip] pom already has module azure-resourcemanager-hybridnetwork
      cmderr	[generate.py] 2021-07-16 07:43:42 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-07-16 07:43:42 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-07-16 07:43:42 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-hybridnetwork [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-07-16 07:45:40 DEBUG Got artifact_id: azure-resourcemanager-hybridnetwork
      cmderr	[Inst] 2021-07-16 07:45:40 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-07-16 07:45:40 DEBUG Got artifact: azure-resourcemanager-hybridnetwork-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-07-16 07:45:40 DEBUG Got artifact: azure-resourcemanager-hybridnetwork-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-07-16 07:45:40 DEBUG Match jar package: azure-resourcemanager-hybridnetwork-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-07-16 07:45:40 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/15211/azure-sdk-for-java/azure-resourcemanager-hybridnetwork/azure-resourcemanager-hybridnetwork-1.0.0-beta.1.jar\" -o azure-resourcemanager-hybridnetwork-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-hybridnetwork -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-hybridnetwork-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from a2d4dc4. 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
    • ️✔️preview/hybridnetwork/mgmt/2020-01-01-preview/hybridnetwork [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a2d4dc4. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/hybridnetwork/resource-manager/readme.md
      warn	No file changes detected after generation
      warn	No package detected after generation
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from a2d4dc4. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh]
      cmderr	[initScript.sh]  The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh]  so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh]
      cmderr	[initScript.sh]  This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh]
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      cmderr	[generateScript.sh] (node:2897) UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, unlink '/home/vsts/work/1/s/azure-resource-manager-schemas/schemas/2020-01-01-preview/Microsoft.HybridNetwork.json'
      cmderr	[generateScript.sh] (Use `node --trace-warnings ...` to show where the warning was created)
      cmderr	[generateScript.sh] (node:2897) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
      cmderr	[generateScript.sh] (node:2897) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
    • ️✔️hybridnetwork [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @zhenglaizhang
    Copy link
    Contributor

    Swagger already approved in private repo, https://github.com/Azure/azure-rest-api-specs-pr/pull/4002.
    Approve and merge the PR.

    @leni-msft
    Copy link
    Contributor

    leni-msft commented Aug 20, 2021

    Incorrect discriminator usage in this PR. We can consider add a lint rule for that. cc. @jianyexi @akning-ms

    "DevicePropertiesFormat": {
    "description": "Device properties.",
    "required": [
    "deviceType"
    ],
    "discriminator": "deviceType",
    "properties": {
    "status": {
    "type": "string",
    "readOnly": true,
    "description": "The current device status.",
    "enum": [
    "Unknown",
    "NotRegistered",
    "Registered",
    "Deleted"
    ],
    "x-ms-enum": {
    "name": "Status",
    "modelAsString": true
    }
    },
    "provisioningState": {
    "readOnly": true,
    "$ref": "./common.json#/definitions/ProvisioningState",
    "description": "The provisioning state of the device resource."
    },
    "deviceType": {
    "type": "string",
    "description": "The type of the device.",
    "enum": [
    "Unknown",
    "AzureStackEdge"
    ],
    "x-ms-enum": {
    "name": "DeviceType",
    "modelAsString": true
    }
    },
    "azureStackEdge": {
    "x-ms-discriminator-value": "AzureStackEdge",
    "$ref": "./common.json#/definitions/SubResource",
    "description": "The reference to the Azure stack edge device. Once set, it cannot be updated."
    },
    "networkFunctions": {
    "readOnly": true,
    "type": "array",
    "items": {
    "$ref": "./common.json#/definitions/SubResource"
    },
    "description": "The list of network functions deployed on the device."
    }
    }
    },

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    LintRuleCandidate Lint Rule Candidate
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    3 participants