-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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
Adding swagger for new api-version consumption 2018-05-31, introducing new Forecast api swagger #3114
Conversation
Automation for azure-libraries-for-javaNothing to generate for azure-libraries-for-java |
Automation for azure-sdk-for-pythonThe initial PR has been merged into your service PR: |
Automation for azure-sdk-for-nodeThe initial PR has been merged into your service PR: |
Automation for azure-sdk-for-goThe initial PR has been merged into your service PR: |
Thanks @ncalagar .. this looks good to me. |
} | ||
} | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
even though this is not a pagable operation, adding following annotation
"x-ms-pageable": {
"nextLinkName": null
}
will ensure the generator flatten the value
field, thus generated method will have List as return type instead of a model type that composes list.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, applied the change
} | ||
} | ||
}, | ||
"paths": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why we don't have other operations described in this api version such as usageDetails (those are supported in the previous api version)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@anuchandy We are not releasing new version for usageDetails and other APIs yet... A new version for those APIs will come in later.
Simply put the call to new api-version for other APIs will fail as they do not exist. So there is no need to have them in new version of swagger, unless we actually have a new version for those APIs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ms-premp - you can add new APis to existing api-version also. I am not sure if i understand spinning up a new api-version for this api unless you are thinking this is in preview (in which case the api-version should be marked preview)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @ravbhatnagar ... We decided to use the new version for this API since, we do have some additional changes coming to few existing APIs and therefore we will need a new version anyway.
By first week of June, we will hopefully have changes to this swagger with updates to existing APIs.
Automation for azure-sdk-for-rubyThe initial PR has been merged into your service PR: |
@ravbhatnagar we need ARM review for this API. This is a new resource being added to Consumption RP. |
"type": "string", | ||
"readOnly": true | ||
}, | ||
"grain": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we please make this as an enum. would be easier to write code against
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done, thanks for suggestion
"type": "string", | ||
"readOnly": true | ||
}, | ||
"chargeType": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Enum
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sure, done
"format": "decimal", | ||
"readOnly": true | ||
}, | ||
"bound": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
enum
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
done. Thanks
} | ||
} | ||
}, | ||
"paths": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ms-premp - you can add new APis to existing api-version also. I am not sure if i understand spinning up a new api-version for this api unless you are thinking this is in preview (in which case the api-version should be marked preview)
Thanks @ravbhatnagar ... We decided to use the new version for this API since, we do have some additional changes coming to few existing APIs and therefore we will need a new version anyway. |
Looks good! |
Thanks @ravbhatnagar .. |
@ms-premp merging this, thanks! |
…g new Forecast api swagger (#3114) * Forecast Api swagger * consumption readme file update for the new swagger version * addressing review comment on adding nextLink * fixing build error * Addressed feedback on enum and fixed a typo
* One file for server and db apis Make one file which is blobAuditing.json that contains both server & db apis + update readme.md and add operations.json * Add extended server auditing settings API * Fixed operation id. * Enable Database Auditing Filtiring With a Predicate Expression New API which enables database auditing filtering by a where clause. * Enable Database Auditing Filtiring With a Predicate Expression New API which enables database auditing filtering by a where clause. In addition, existing related APIs swaggers were unified under same Public API name. * Enable Database Auditing Filtiring With a Predicate Expression New API which enables database auditing filtering by a where clause. In addition, existing related APIs swaggers were unified under same Public API name. * Fixing examples of existing APIs and modifying blobAuditing Swagger file storageAccountAccessKey was removed from requests response, and examples were modified accordingly. * Remove description of predicateExpression related exceptions from old APIs description. Fixing a small issue for client readability. AuditingSettings and ExtendedAuditingSettings APIs have a mutual exceptions description. Description which mentions predicateExpression parameter in all APIs. After this fix, predicateExpression related exceptions will not be mentioned on old APIs. * Moving files to preview/stable as appropriate. * Modifying swagger and examples of 2017 BlobAuditing APIs (#421) * 2017 Blob Auditing APIs - Swagger and examples. Modifying swagger and examples of 2017 blob auditing APIs. * Resetting examples of DatabaseBlobAuditing API to 2017 Resetting examples of DatabaseBlobAuditing API to 2017 * Fixing follwing comments Fixing follwing comments * Fixing build errors Fixing build errors * Fix build errors Fix build errors * Fixing comments fixing comments * Removed 2017 database API Removed 2017 database API * Revert "Fixing comments" This reverts commit c09f9f6. * Modifying description of APIs Modifying description of APIs after generating new swagger. * Modifying readme.md. Modifying readme.md. * Updating blobAuditing Json files. Updating blobAuditing Json files. * Temp change Temp change * Final commit Final commit * Fix Duplicated model name with non-identical definitions build error Fix Duplicated model name with non-identical definitions * Fix Duplicated model name with non-identical definitions build error This reverts commit 616851d and commits fixes. * Fix Automation Duplicated model name with non-identical definitions Fix Automation Duplicated model name with non-identical definitions * One file for server and db apis Make one file which is blobAuditing.json that contains both server & db apis + update readme.md and add operations.json * Add extended server auditing settings API * Fixed operation id. * Enable Database Auditing Filtiring With a Predicate Expression New API which enables database auditing filtering by a where clause. * Enable Database Auditing Filtiring With a Predicate Expression New API which enables database auditing filtering by a where clause. In addition, existing related APIs swaggers were unified under same Public API name. * Enable Database Auditing Filtiring With a Predicate Expression New API which enables database auditing filtering by a where clause. In addition, existing related APIs swaggers were unified under same Public API name. * Fixing examples of existing APIs and modifying blobAuditing Swagger file storageAccountAccessKey was removed from requests response, and examples were modified accordingly. * Remove description of predicateExpression related exceptions from old APIs description. Fixing a small issue for client readability. AuditingSettings and ExtendedAuditingSettings APIs have a mutual exceptions description. Description which mentions predicateExpression parameter in all APIs. After this fix, predicateExpression related exceptions will not be mentioned on old APIs. * Moving files to preview/stable as appropriate. * Modifying swagger and examples of 2017 BlobAuditing APIs (#421) * 2017 Blob Auditing APIs - Swagger and examples. Modifying swagger and examples of 2017 blob auditing APIs. * Resetting examples of DatabaseBlobAuditing API to 2017 Resetting examples of DatabaseBlobAuditing API to 2017 * Fixing follwing comments Fixing follwing comments * Fixing build errors Fixing build errors * Fixing comments fixing comments * Removed 2017 database API Removed 2017 database API * Revert "Fixing comments" This reverts commit c09f9f6. * Modifying description of APIs Modifying description of APIs after generating new swagger. * Modifying readme.md. Modifying readme.md. * Updating blobAuditing Json files. Updating blobAuditing Json files. * Temp change Temp change * Final commit Final commit * Fix Python conf of servermanager (#3140) * Fix ServerManager Py Conf (#3141) * Plug SwaggerToSdk to LogAnalyticsMgmt (#3142) * [Storage] Support Management policy on new api version 2018-03-01-preview (#3137) * [Storage] Add new API version 2018-03-01-preview * [Storage] Update rest version 2018-03-01-preview * [Storage] Support Management Policy * [Storage] Update since code review comments * Add Python conf * [Storage] Add managment policy doc link to policy description. * [Storage] modify as review comments * RSA key size examples, ECC descriptions (#3136) * RSA key size examples, ECC descriptions * remove preview changes for now * Added GroupType property in HybridWorkerGroup (#3132) * Watcher resource swagger specs. For more details on the Usage of the resource: https://docs.microsoft.com/en-us/azure/automation/automation-watchers-tutorial (#3102) * Watcher specs * using the same model for get/put input and output. * Fix storage Python conf (#3148) * Fix for Azure Networking swagger 2018-04-01 version (#3146) * Adding swagger for new api-version consumption 2018-05-31, introducing new Forecast api swagger (#3114) * Forecast Api swagger * consumption readme file update for the new swagger version * addressing review comment on adding nextLink * fixing build error * Addressed feedback on enum and fixed a typo * Stop using unobscured credentials * Fix Duplicated model name with non-identical definitions build error Fix Duplicated model name with non-identical definitions * Fix go tag for storage management plane 2018-03-02 api version (#3156) * Refactoring Job Definitions (#3116) * MySQL/PostgreSQL VNET with API Version 2017-12-01 for Public Preview. (#3138) * Fix Python conf * Adding the VNET Rest APIs to 2017-12-01 version. Adding the VNET Rest APIs to 2017-12-01 version. * Add specs for machine learning services provider (#3135) * Add specs for machine learning services provider * Added python config to readme * Added repo generation for Python * Addressed feedback * Address more comments * Adding Security RP API swagger (#3144) * Reverted methods in vpn gateways. (#3163) * Fix Duplicated model name with non-identical definitions build error This reverts commit 616851d and commits fixes. * Fix Automation Duplicated model name with non-identical definitions Fix Automation Duplicated model name with non-identical definitions * Revert "Fix Duplicated model name with non-identical definitions build error" This reverts commit d1c40f7. * Revert "Fix Duplicated model name with non-identical definitions build error" This reverts commit 2c1261e. * Update readme.md file Update readme.md file
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
api-version
in the path should match theapi-version
in the spec).Quality of Swagger