Add swagger for operations APIs by zjpjack · Pull Request #2682 · Azure/azure-rest-api-specs

zjpjack · 2018-03-16T19:34:03Z

Add swagger for Microsoft.Resources, Microsoft.Solutions and Microsoft.Features operations APIs.

This checklist is used to make sure that common issues in a pull request are addressed. This will expedite the process of getting your pull request merged and avoid extra work on your part to fix issues discovered during the review process.

PR information

The title of the PR is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For information on cleaning up the commits in your pull request, see this page.
Except for special cases involving multiple contributors, the PR is started from a fork of the main repository, not a branch.
If applicable, the PR references the bug/issue that it fixes.
Swagger files are correctly named (e.g. the api-version in the path should match the api-version in the spec).

Quality of Swagger

I have read the contribution guidelines.
My spec meets the review criteria:
- The spec conforms to the Swagger 2.0 specification.
- The spec follows the guidelines described in the Swagger checklist document.
- Validation tools were run on swagger spec(s) and have all been fixed in this PR.

….features/register/action

AutorestCI · 2018-03-16T19:35:29Z

Automation for azure-sdk-for-node

Encountered a Subprocess error: (azure-sdk-for-node)

Command: ['/usr/local/bin/autorest', '/tmp/tmpto3v75a4/rest/specification/resources/resource-manager/readme.md', '--license-header=MICROSOFT_MIT_NO_VERSION', '--node-sdks-folder=/tmp/tmpto3v75a4/sdk', '--nodejs', '--use=@microsoft.azure/autorest.nodejs@^2.1.43']
Finished with return code 1
and output:

AutoRest code generation utility [version: 2.0.4262; node: v7.10.1]
(C) 2018 Microsoft Corporation.
https://aka.ms/autorest
   Loading AutoRest core      '/root/.autorest/@microsoft.azure_autorest-core@2.0.4278/node_modules/@microsoft.azure/autorest-core/dist' (2.0.4278)
   Loading AutoRest extension '@microsoft.azure/autorest.nodejs' (^2.1.43->2.1.59)
   Loading AutoRest extension '@microsoft.azure/autorest.modeler' (2.3.44->2.3.44)
[Exception] No input files provided.

Use --help to get help information.

AutorestCI · 2018-03-16T19:39:17Z

Automation for azure-libraries-for-java

A PR has been created for you based on this PR content.

Once this PR will be merged, content will be added to your service PR:
AutorestCI/azure-libraries-for-java#154

AutorestCI · 2018-03-16T19:45:32Z

Automation for azure-sdk-for-python

A PR has been created for you based on this PR content.

Once this PR will be merged, content will be added to your service PR:
Azure/azure-sdk-for-python#2570

AutorestCI · 2018-03-16T20:14:39Z

Automation for azure-sdk-for-go

A PR has been created for you:
Azure/azure-sdk-for-go#2019

…into msft-jizen/features

anuchandy · 2018-03-19T16:50:26Z

...on/resources/resource-manager/Microsoft.Solutions/stable/2017-09-01/managedapplications.json

+          "type": "string",
+          "description": "Operation description."
+        }
+      }


Please mark all properties are readonly given user cannot update any of these

"readOnly": true,

anuchandy · 2018-03-19T16:54:11Z

...on/resources/resource-manager/Microsoft.Solutions/stable/2017-09-01/managedapplications.json

+              "$ref": "#/definitions/OperationsList"
+            }
+          }
+        }


though this API is not page-able, it's recommended to add the extension

"x-ms-pageable": { "nextLinkName": "nextLink" }

this will instruct code-gen to avoid emitting a wrapper model for the array

refer this

Gets all the solution operations

anuchandy · 2018-03-19T16:55:59Z

...on/resources/resource-manager/Microsoft.Solutions/stable/2017-09-01/managedapplications.json

+            "$ref": "#/definitions/OperationDefinition"
+          },
+          "description": "The array of solution operations."
+        }


Add property since we recommended to apply x-ms-pageable in the API

"nextLink": { "readOnly": true, "type": "string", "description": "URL to get the next set of operation list results if there are any." }

see this

anuchandy · 2018-03-19T16:56:26Z

...on/resources/resource-manager/Microsoft.Solutions/stable/2017-09-01/managedapplications.json

+    "OperationsList": {
+      "properties": {
+        "operations": {
+          "type": "array",


"readOnly": true,

anuchandy · 2018-03-19T17:00:04Z

specification/resources/resource-manager/Microsoft.Resources/stable/2015-01-01/resources.json

+              "$ref": "#/definitions/OperationsList"
+            }
+          }
+        }


though this API is not page-able, it's recommended to add the extension

"x-ms-pageable": { "nextLinkName": "nextLink" }

this will instruct code-gen to avoid emitting a wrapper model for the array

refer this

anuchandy · 2018-03-19T17:01:09Z

specification/resources/resource-manager/Microsoft.Resources/stable/2015-01-01/resources.json

+        "description": {
+          "type": "string",
+          "description": "Operation description."
+        }


Mark all properties are readonly, ref this

anuchandy · 2018-03-19T17:01:31Z

specification/resources/resource-manager/Microsoft.Resources/stable/2015-01-01/resources.json

+    "OperationsList": {
+      "properties": {
+        "operations": {
+          "type": "array",


"readOnly": true

anuchandy · 2018-03-19T17:02:35Z

specification/resources/resource-manager/Microsoft.Features/stable/2015-12-01/features.json

+          "description": "The array of feature operations."
+        }
+      }
    }


please see comments below related to marking properties as readonly, applying x-ms-pagable extension and adding nextLink property. Please apply same here for Features operation apis.

anuchandy · 2018-03-19T17:03:15Z

specification/resources/resource-manager/Microsoft.Resources/stable/2015-01-01/resources.json

+          "description": "The array of resource operations."
+        }
+      }
+    }


Add property since we recommended to apply x-ms-pageable in the API

"nextLink": { "readOnly": true, "type": "string", "description": "URL to get the next set of operation list results if there are any." }

see this

vivsriaus · 2018-03-19T17:53:07Z

...on/resources/resource-manager/Microsoft.Solutions/stable/2017-09-01/managedapplications.json

+              "$ref": "#/definitions/OperationsList"
+            }
+          }
+        }


Gets all the solution operations

anuchandy · 2018-04-11T22:37:02Z

@zjpjack is this PR still valid? if so please address the comments. If you are planning to send different PR at later point please close this.

lmazuel · 2018-04-20T18:22:25Z

@AutorestCI regenerate azure-sdk-for-python

anuchandy · 2018-05-07T18:37:28Z

@zjpjack any update? if this PR is still valid please address the comments, If you are planning to send a different PR then we can close this.

anuchandy · 2018-06-12T06:09:37Z

@zjpjack closing this due to lack of response (~3 months). Feel free to open a new PR when you are ready to update the spec. thanks!

AutorestCI · 2018-06-12T06:11:27Z

Automation for azure-sdk-for-ruby

Nothing to generate for azure-sdk-for-ruby

github-actions · 2025-11-11T18:30:05Z

Next Steps to Merge

Important checks have failed. As of today they are not blocking this PR, but in near future they may.
Addressing the following failures is highly recommended:

⚠️ The check named SDK Validation Status has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

Comment generated by summarize-checks workflow run.

github-actions · 2025-11-11T18:30:05Z

Next Steps to Merge

Important checks have failed. As of today they are not blocking this PR, but in near future they may.
Addressing the following failures is highly recommended:

⚠️ The check named SDK Validation Status has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it and consult the aka.ms/ci-fix guide

Comment generated by summarize-checks workflow run.

Jianping Zeng added 3 commits February 14, 2018 09:58

Add swagger spec for Microsoft.features/operations/read and Microsoft…

07d5b6f

….features/register/action

Merge branch 'master' into msft-jizen/features

42fedf5

Swagger for opeartions APIs.

cec659e

zjpjack requested a review from a user March 16, 2018 19:34

zjpjack requested review from tbombach and vladbarosan as code owners March 16, 2018 19:34

azuresdkci assigned anuchandy Mar 16, 2018

Correct typo caused CI problems

cd1fa61

Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs …

9daeae5

…into msft-jizen/features

anuchandy requested changes Mar 19, 2018

View reviewed changes

vivsriaus approved these changes Mar 19, 2018

View reviewed changes

AutorestCI mentioned this pull request Apr 20, 2018

[AutoPR resources/resource-manager] Add swagger for operations APIs Azure/azure-sdk-for-python#2442

Closed

anuchandy closed this Jun 12, 2018

Comments

Conversation

zjpjack commented Mar 16, 2018 • edited by azuresdkci Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR information

Quality of Swagger

Uh oh!

AutorestCI commented Mar 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-node

Uh oh!

AutorestCI commented Mar 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-libraries-for-java

Uh oh!

AutorestCI commented Mar 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-python

Uh oh!

AutorestCI commented Mar 16, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-go

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

anuchandy commented Apr 11, 2018

Uh oh!

lmazuel commented Apr 20, 2018

Uh oh!

anuchandy commented May 7, 2018

Uh oh!

anuchandy commented Jun 12, 2018

Uh oh!

AutorestCI commented Jun 12, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Automation for azure-sdk-for-ruby

Uh oh!

github-actions bot commented Nov 11, 2025

Next Steps to Merge

Uh oh!

github-actions bot commented Nov 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

zjpjack commented Mar 16, 2018 •

edited by azuresdkci

Loading

AutorestCI commented Mar 16, 2018 •

edited

Loading

AutorestCI commented Mar 16, 2018 •

edited

Loading

AutorestCI commented Mar 16, 2018 •

edited

Loading

AutorestCI commented Mar 16, 2018 •

edited

Loading

AutorestCI commented Jun 12, 2018 •

edited

Loading

github-actions bot commented Nov 11, 2025 •

edited

Loading