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

Added swagger for private link resource API #8655

Merged
merged 19 commits into from
Apr 6, 2020
Merged

Added swagger for private link resource API #8655

merged 19 commits into from
Apr 6, 2020

Conversation

deymadhumanti
Copy link
Contributor

@deymadhumanti deymadhumanti commented Mar 10, 2020

…ults

Latest improvements:

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

Contribution checklist:

  • I have reviewed the documentation for the workflow.
  • Validation tools were run on swagger spec(s) and have all been fixed in this PR.
  • The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

  • Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
  • adding/removing APIs.
  • adding/removing properties.
  • adding/removing API-version.
  • adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

  • If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
    Please follow the link to find more details on API review process.

@azuresdkci
Copy link
Contributor

Can one of the admins verify this patch?

@sumitmal2711 sumitmal2711 added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Mar 10, 2020
@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Mar 12, 2020

azure-sdk-for-js - Release

️✔️ succeeded [Logs] [Expand Details]
  • ️✔️ Generate from 165b7fc with merge commit aa5da1f. SDK Automation 13.0.17.20200326.3
  • ️✔️@azure/arm-recoveryservices [Logs]  [Release SDK Changes]
    [npmPack] npm WARN lifecycle @azure/arm-recoveryservices@3.0.0~prepack: cannot run in wd @azure/arm-recoveryservices@3.0.0 npm install && npm run build (wd=/z/work/azure-sdk-for-js/sdk/recoveryservices/arm-recoveryservices)

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Mar 12, 2020

azure-sdk-for-net - Release

️✔️ succeeded [Logs] [Expand Details]

@openapi-sdkautomation
Copy link

openapi-sdkautomation bot commented Mar 12, 2020

azure-sdk-for-java - Release

⚠️ warning [Logs] [Expand Details]
  • ⚠️ Generate from 165b7fc with merge commit aa5da1f. SDK Automation 13.0.17.20200326.3
  • ⚠️sdk/recoveryservices/mgmt-v2016_06_01 [Logs]  [Release SDK Changes]
      [mvn] [ERROR] COMPILATION ERROR : 
      [mvn] [ERROR] /z/work/azure-sdk-for-java/sdk/recoveryservices/mgmt-v2016_06_01/src/main/java/com/microsoft/azure/management/recoveryservices/v2016_06_01/implementation/RegisteredIdentitiesImpl.java:[15,1] com.microsoft.azure.management.recoveryservices.v2016_06_01.implementation.RegisteredIdentitiesImpl is not abstract and does not override abstract method deleteAsync(java.lang.String,java.lang.String,java.lang.String) in com.microsoft.azure.management.recoveryservices.v2016_06_01.RegisteredIdentities
      [mvn] [ERROR] Failed to execute goal org.apache.maven.plugins:maven-compiler-plugin:3.1:compile (default-compile) on project azure-mgmt-recoveryservices: Compilation failure
      [mvn] [ERROR] /z/work/azure-sdk-for-java/sdk/recoveryservices/mgmt-v2016_06_01/src/main/java/com/microsoft/azure/management/recoveryservices/v2016_06_01/implementation/RegisteredIdentitiesImpl.java:[15,1] com.microsoft.azure.management.recoveryservices.v2016_06_01.implementation.RegisteredIdentitiesImpl is not abstract and does not override abstract method deleteAsync(java.lang.String,java.lang.String,java.lang.String) in com.microsoft.azure.management.recoveryservices.v2016_06_01.RegisteredIdentities
      [mvn] [ERROR] -> [Help 1]
      [mvn] [ERROR] 
      [mvn] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
      [mvn] [ERROR] Re-run Maven using the -X switch to enable full debug logging.
      [mvn] [ERROR] 
      [mvn] [ERROR] For more information about the errors and possible solutions, please read the following articles:
      [mvn] [ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoFailureException

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Mar 12, 2020

    azure-sdk-for-go - Release

    ️✔️ succeeded [Logs] [Expand Details]

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Mar 12, 2020

    azure-sdk-for-python - Release

    ️✔️ succeeded [Logs] [Expand Details]
    • ️✔️ Generate from 165b7fc with merge commit aa5da1f. SDK Automation 13.0.17.20200326.3
    • ️✔️azure-mgmt-recoveryservices [Logs]  [Release SDK Changes]
      [build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
      [build_package]   warnings.warn(msg)
      [build_package] /usr/lib/python3.6/distutils/dist.py:261: UserWarning: Unknown distribution option: 'long_description_content_type'
      [build_package]   warnings.warn(msg)
      [breaking_change_setup] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
      [breaking_change_setup] Cannot uninstall requirement azure-nspkg, not installed
      [breaking_change_setup] Command '['/usr/local/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' returned non-zero exit status 1.
      [ChangeLog] Size of delta 18.598% size of original (original: 26481 chars, delta: 4925 chars)
      [ChangeLog] **Features**
      [ChangeLog] 
      [ChangeLog]   - Model VaultProperties has a new parameter private_endpoint_connections
      [ChangeLog]   - Model VaultProperties has a new parameter private_endpoint_state_for_backup
      [ChangeLog]   - Model VaultProperties has a new parameter private_endpoint_state_for_site_recovery
      [ChangeLog]   - Model Vault has a new parameter identity
      [ChangeLog]   - Added operation group PrivateLinkResourcesOperations

    @anthony-c-martin anthony-c-martin added ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Mar 17, 2020
    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @openapi-sdkautomation
    Copy link

    openapi-sdkautomation bot commented Mar 17, 2020

    azure-cli-extensions - Release

    No readme.md specification configuration files were found that are associated with the files modified in this pull request, or swagger_to_sdk section in readme.md is not configured

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    Copy link
    Contributor

    @pilor pilor left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    :shipit:

    @pilor pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review labels Mar 30, 2020
    @ArcturusZhang
    Copy link
    Member

    Hi @deymadhumanti please resolve the CI failures (Spell check and prettier). And as for the breaking changes check, could you provide a justification of this? Or it is only a false alarm?

    Hi @ChenTanyi would you please take a look at the Java generation failure?

    @ChenTanyi
    Copy link
    Contributor

    The generation error is due to privateLinkResources, the java will make auto collections for every resource with conflict with https://github.com/Azure/azure-rest-api-specs/pull/8655/files#diff-02ce4ce9148599d2d4ec2600b9c4626cR1165. @weidongxu-microsoft Is it possible for us to generate without collections if there is already a collections.

    @weidongxu-microsoft
    Copy link
    Member

    @ChenTanyi No idea, you know as much as I know about v2 generator.

    My suggestion is to try another name for "PrivateLinkResources" definition, like "PrivateLinkResourceListResult". E.g. https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json#L117

    @ChenTanyi
    Copy link
    Contributor

    @ChenTanyi No idea, you know as much as I know about v2 generator.

    My suggestion is to try another name for "PrivateLinkResources" definition, like "PrivateLinkResourceListResult". E.g. https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json#L117

    @deymadhumanti Could you change for this name, if you want to update Java sdk. Thanks!

    @deymadhumanti
    Copy link
    Contributor Author

    @ChenTanyi No idea, you know as much as I know about v2 generator.
    My suggestion is to try another name for "PrivateLinkResources" definition, like "PrivateLinkResourceListResult". E.g. https://github.com/Azure/azure-rest-api-specs/blob/master/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json#L117

    @deymadhumanti Could you change for this name, if you want to update Java sdk. Thanks!

    Hi @ChenTanyi , Can we use "PrivateLinkResourceList" for PrivateLinkResources. Please confirm. I will make the json change accordingly,

    @ChenTanyi
    Copy link
    Contributor

    @deymadhumanti Yes, it could be PrivateLinkResourceList.

    It could be anything you like which could be separated from other resources and their plurality.
    For example, the java sdk will automatically collect all privateLinkResource into privateLinkResources. And so as others.

    @deymadhumanti
    Copy link
    Contributor Author

    Hi @deymadhumanti please resolve the CI failures (Spell check and prettier). And as for the breaking changes check, could you provide a justification of this? Or it is only a false alarm?

    Hi @ChenTanyi would you please take a look at the Java generation failure?

    Hi @ArcturusZhang , Prettier Check is successful here. I am looking at SpellCheck failure and update it .

    @deymadhumanti
    Copy link
    Contributor Author

    Hi @deymadhumanti please resolve the CI failures (Spell check and prettier). And as for the breaking changes check, could you provide a justification of this? Or it is only a false alarm?

    Hi @ChenTanyi would you please take a look at the Java generation failure?

    Hi @ArcturusZhang , Regarding breaking change failure:

    The earlier schema for CheckNameAvailability response was erronous. It was added as part of Added Swagger details for CheckNameAvailability API #5496 and OAV example validation wasn’t performed as a part of validation for the same. SDK has not been generated for the same since the swagger changes were made.

    With the current PR we are fixing the response to CheckNameAvailability API and we have also validated the same using OAV spec and example validation tool. It is in accordance with format mentioned at - https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/proxy-api-reference.md#check-name-availability-requests

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @deymadhumanti
    Copy link
    Contributor Author

    Hi @deymadhumanti please resolve the CI failures (Spell check and prettier). And as for the breaking changes check, could you provide a justification of this? Or it is only a false alarm?
    Hi @ChenTanyi would you please take a look at the Java generation failure?

    Hi @ArcturusZhang , Prettier Check and Spell Check are successful now. For Breaking changes, I have already explained. Can you please check this

    @deymadhumanti
    Copy link
    Contributor Author

    @deymadhumanti Yes, it could be PrivateLinkResourceList.

    It could be anything you like which could be separated from other resources and their plurality.
    For example, the java sdk will automatically collect all privateLinkResource into privateLinkResources. And so as others.

    Hi @ChenTanyi , I have changed PrivateLinkResources to PrivateLinkResourceList. But still Java SDK generation is failing with same error. Can you please take a look

    @ArcturusZhang
    Copy link
    Member

    Hi @deymadhumanti please resolve the CI failures (Spell check and prettier). And as for the breaking changes check, could you provide a justification of this? Or it is only a false alarm?
    Hi @ChenTanyi would you please take a look at the Java generation failure?

    Hi @ArcturusZhang , Prettier Check and Spell Check are successful now. For Breaking changes, I have already explained. Can you please check this

    I think the breaking changes are reasonable based on what you said. But since the breaking changes CI is a required check, this PR must wait for @akning-ms 's approval and eventually merge.
    Hi @akning-ms could you please have a look at this?

    @ChenTanyi
    Copy link
    Contributor

    @deymadhumanti After my test, it is not the error caused by items, the privateLinkResourceList can be changed back if you like.

    The problem is in operations, java always use operations in plural format.
    PrivateLinkResources_List and PrivateLinkResource_Get in operationId are conflict. You can change it into same prefix, or use directive in readme like https://github.com/azure/azure-rest-api-specs/blob/89c0f6e94d390cd4c3bfe992bac632db6058e9fd/specification/adhybridhealthservice/resource-manager/readme.java.md#L14

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @deymadhumanti
    Copy link
    Contributor Author

    Hi @deymadhumanti please resolve the CI failures (Spell check and prettier). And as for the breaking changes check, could you provide a justification of this? Or it is only a false alarm?
    Hi @ChenTanyi would you please take a look at the Java generation failure?

    Hi @ArcturusZhang , Prettier Check and Spell Check are successful now. For Breaking changes, I have already explained. Can you please check this

    I think the breaking changes are reasonable based on what you said. But since the breaking changes CI is a required check, this PR must wait for @akning-ms 's approval and eventually merge.
    Hi @akning-ms could you please have a look at this?

    Hi @akning-ms, Can you please take a look at this PR.

    @akning-ms akning-ms merged commit aa5da1f into Azure:master Apr 6, 2020
    00Kai0 pushed a commit to 00Kai0/azure-rest-api-specs that referenced this pull request Oct 12, 2020
    * Added GEt-privateLinkResources API and managedIdentity changes for Vaults
    
    * Fixed PrettierCheck failure
    
    * Update vaults.json
    
    * Update vaults.json
    
    * Resolved PR commens related to PrivateLinkResources
    
    * Resolved PR comments
    
    * resolved PR comments
    
    * Using x-ms-client-flatten for PrivateLinkResourceProperties
    
    * Fixing examples for PrivateLinkResources
    
    * Revert "Fixing examples for PrivateLinkResources"
    
    This reverts commit b0d62a2.
    
    * Revert "Using x-ms-client-flatten for PrivateLinkResourceProperties"
    
    This reverts commit 31ba2d0.
    
    * Using x-ms-client-flatten for PrivateLinkResourceProperties
    
    * Fixing examples for PrivateLinkResources
    
    * Adding description for privateLinkResourceProperties
    
    * Resolved PR comments. Fixed SpellCheck and PrettierCheck and Java SDK failures
    
    * Changing operationId for PrivateLinkResource to PrivateLinkResources
    
    * Renaming PrivateLinkResourceList to PrivateLinkResources
    
    Co-authored-by: deymadhumanti <deymadhumanti@users.noreply.github.com>
    Co-authored-by: asmaskar <asmaskar@microsoft.com>
    Co-authored-by: asmaskar <58723769+asmaskar@users.noreply.github.com>
    Co-authored-by: Aman Chandna <amchandn@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.