Update the swagger to reconcile SDK generation #24669
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This response is not used, and included in Swagger by mistake. Co-authored-by: shono <>
* Adding typespec definitions for DALL-E * feedback * Updating api version. * size enum * update * adding missing error * Adding open api. * fixing CI * fixing 'created' type. * generated files * updating examples * fixes * proper target * adding missing examples * fixes * fixing examples * more example updates * more fixes * regenerating files * more fixes * adding temporary fix * Link suppress of "union-unsupported" to tracking issue * tsp format * feedback * enum values * fixing example * renaming ImageResult to ImageLocation * rename * Adding readme * Adding extra files * feedback + linter fixes * generated files * cleanup * fixes * fix * Update specification/cognitiveservices/OpenAI.Inference/routes.tsp Co-authored-by: Johan Stenberg (MSFT) <[email protected]> * feedback * fixes * fixing param name * adding deps * package dir * disabling failing emitters * reenabling csharp * indenting * testing java & ts * disabling back --------- Co-authored-by: Mike Harder <[email protected]> Co-authored-by: Johan Stenberg (MSFT) <[email protected]>
Applied latest schema of emitter options and parameters.
…version preview/2023-05-01-privatepreview (Azure#23601) * Adds base for updating Microsoft.AlertsManagement from version stable/2021-08-08 to version 2023-05-01-privatepreview * Updates readme * Updates API version in new specs and examples * added correlation example * Updated the example according to the discussion. * Continue after discussion * Removed targe region * Removed the target region * Modified correlationInterval * Fixed after a review. * Fixed file path * removed 'private' from apiversion * cont * fixed model validation * cont * Cont. * run prettier * Added "x-ms-identifiers" * Fixed avocade * fixed readme * fixed avocado * Continue * updated readmy * Modified "SuppressAll" to "SuppressAlways"
* Add view parameter, remove adminDistrict type * Remove adminDistrict type in examples --------- Co-authored-by: Gigi Grajo <[email protected]>
…lify workflow bot rules `comment.yml` (Azure#24227) Simplify PR GH ARM comment template `control_plane_template.md`; simplify workflow bot rules `comment.yml` (Azure#24227)
* Adds base for updating Microsoft.Consumption from version stable/2023-03-01 to version 2023-05-01 Updates readme Updates API version in new specs and examples New version 2023-05-01 for Consumption Avoid breaking change by accepting only subId via filter Changes from https://github.com/Azure/azure-rest-api-specs/pull/23914/files#diff-b9c73fdca8365cb39a74112db329608946bd326cfc04d63b201cec6a83c2250f Code style issues * Correct versions
* Add inital swagger files for DFSv2 * add descriptions and fix alignment * fixes and remove comments * Code style and description updates * fix missing x-ms-enum check. * fix MISSING_APIS_IN_DEFAULT_TAG * remove id, type and name from pu examples body * fix missing responses in Put example. * "resource" -> "storage account" in descriptions * descriptions
…sion preview/2022-05-01-preview (Azure#23941) * Adds base for updating Microsoft.Authorization from version stable/2022-04-01 to version 2022-05-01-preview * Updates readme * Updates API version in new specs and examples * Update swagger Docs for Roledefintiion condition in payload * delete unwanted example files * fix errors * typo * more fixes * scope fix * roledef fix * fixing warnings * Revert "fixing warnings" This reverts commit 2f81f5d. * revert scope base * supress warnings with reason * remove x-ms path * supresess * fixing get by id as there nothing called get by name * fix * Scope * v2 to v4 * scope param * scope param * typo * api version * Revert "api version" This reverts commit 7d8e791. * update correct package version * fix warnings * added missing access review file * removing 200 response code * pretty fix * fix errors * update azure-sdk-for-go readme * fix errors * u4 * u5 * u5 * u6 * u7 * u8 * u9 * u10 * u11 --------- Co-authored-by: Ryan Ren <[email protected]>
…ure#24115) * adding new resource type 'CloudHsm' with new API version * added systemData in responses and fixed few warnings * renamings * added stateMessage * removed PrivateEndpointConnectionProxy APIs and examples * API version folder renamed * updated ReadMe.md * renamings, fixing validation errors * fixed avocado errors * fixed prettier errors * fixed prettier errors * fixed validation errors * fixed prettier errors * fixed prettier errors * fixed linfdiff errors * fixed LintDiff errors * fixed linfdiff errors * fixed staging LintDiff errors * fixed LintDiff errors * fixed lintdiff errors * removed pageable extention from CloudHsmPrivateLinkResource_ListByCloudHsm * renamings * used referecing for private endpoint connection and private link resource under common types * fixed review comments * fixed resourceType in exmaple * renamed CloudHsm to CloudHsmCluster * renamed hsmId to fqdn * fixed description * modified default tag in Readme.md * changed tag value to package-2022-08-preview * Update specification/hardwaresecuritymodules/resource-manager/readme.md Co-authored-by: Chenjie Shi <[email protected]> * Update readme.md * Update readme.md * fixing lintdiff errors, also fixing old DHSM errors * fixing syntax errors * removed operations examples from cloudhsm * added ResourceNameRestriction for peConnectionName * added ResourceNameRestriction for peConnectionName * added pattern for peConnectionName * fixing prettier check * Using Common-types definitions for TrackedResource * created separate folders for different sub services * reverting to common folder structure * To resolve duplicate definition errors * fixing Swagger Staging lintDiff error * Update Cloud Hsm swagger specifications * update api-versions to resolve Model Validation issues * update api version in example file * added chsmOperation to custom-words.txt * Removed chsmOperation, replaced CHsmTrackedResource with TrackedResource and AzureResource with ProxyResource. Removed unused definitions/ * Set final-state-via to CreateOperationAsyncResponseValidation and added x-ms-pageable to resolve LintDiff validation issue * fix lintdiff issue * update final-state-via for put operation to Original-Uri * Replaced ProxyResource with TrackedResource in PrivateEndPointConnection because location and tags are also needed. * Reverted previouse commit to resolve LintDiff issue and included location and etags to PrivateEndpointConnetion. * removed white space to resolve Prettier check issue * updated etag description * Updated skiptoken type from integer to string based on code update. * Fix required value for skiptoken * make update for LintDiff issue - PutResponseSchemaDescription * make update for LintDiff issue - PutResponseSchemaDescription * Removed location and added groupIds from PrivateEndpointConnection definition in line with NRP Documentation * update swagger to reflect ARM feedback * Added Canceled state to PrivateEndpointConnectionProvisioningState enum as per ARM review request * Renamed "Resource" Definition in Dedicated hsm swagger file to resolve azure-sdk-for-go error caused by duplicate schema. "CloudHsmClusterResource" indirectly references the common-type"Resource" and this conflicts with "Resource" definition in dedicatedhsm swagger. * Remove duplicate type tag from DedicatedHsmResource * updated readme file to fix ~[Staging] Service API Readiness Test failed error * updated readme file to fix ~[Staging] Service API Readiness Test fail * update readme file to resolve ~[Staging] Service API Readiness Test failure --------- Co-authored-by: GoradeAarti <[email protected]> Co-authored-by: GoradeAarti <[email protected]> Co-authored-by: Chenjie Shi <[email protected]>
* Removing the Anonymous types in private-preview version * Prettier check fix and spell check fix * resolving prettier check * Added the type-script readme file.
* update typescript.md * update file
* update putdeployment example * remove ScaleSettings from example
…rsion preview/2023-06-01-preview (Azure#24113) * Adds base for updating Microsoft.AgFoodPlatform from version preview/2021-09-01-preview to version 2023-06-01-preview * Updates readme * Updates API version in new specs and examples * Rename changes + Control Plane BYOL changes * added examples * added examples for data Connector Apis * fixing lint issues * reorder and updated description * node description updated. * updated like Solution Apis * beautify json examples * prettier fix * custom words + spelling fix * system data lower case * removed dataConnectorName from example + lint fix * fixed lint issue in example * prettier fix * Default Error response + 201 code * Description updated * request model made same as response in patch * added status code 201 in PUT API * updated solution example * updated changes for OAuth renaming * updated Data Connector examples * example update * corrected typo * syncing to latest DI Agri branch * added MADMA in custom-words file * data connector delete example updated * solution example updated * xms error fix * added xms-identifier * fixing examples * updated create or update example * prettier fix * solution fix * updated examples * prettier fix --------- Co-authored-by: Abhishek Khatri <[email protected]>
* changing readme to include 2023-01-01 search + remove redundant line * copying 2022-09-25 folder as an initial skeleton to 2023-01-01 seacrh documentation * rename copied folder to 2023-01-01 * add 2023 to search readme * initial attempt of docs * change decimal to number * remove popularity mention in searchFieldName * fixed samples * cahnged the samples * remove x-nullable * remove more x-nullable * add x-ms-enum to solve errors related * add missing desciptions * fixed publically and bussiness typo * remove x-nullable (warning) * publicly is the forrect form * adjust planSummary (and productSummary) to products.json (\specification\marketplacecatalog\data-plane\Products\preview\2023-01-01-preview\products.json) * changed suggestions searchQuery to not required temporary - as it is a breaking change * make searchQuery required. since it didnt solve the breaking change issue * fixed SemanticValidation of PublisherType by removing $ref * use prettier to fix PrettierCheck * fixed Dynamycs typo by taking the description of products.json (specification\marketplacecatalog\data-plane\Products\preview\2023-01-01-preview\products.json) * fixed number format error * missed comma * attempt to fix SemanticValidation "OBJECT_ADDITIONAL_PROPERTIES" issue - remove $ref of items * fixed another semantic validation 7th param with $ref * added desc + fixed more semantic issues * more semantic fixes * remove descprition inside items param to solve more sematic validation error * one more * another missed additional description * another description * more extra description * another one * fix NOT_LATEST_API_VERSION_IN_DEFAULT_TAG by setting 2023-01-01 as defualt (attempt) * fix tagging * remove default api-version (A required parameter should not specify a default value. ) * x-api-key header in Kebab case * rearange order alhabetically * remove x-original-name tag * remove x-original-name * remove x-originalName * reverting accidenty changed file * added allOf as generated in swagger * add 401 description to error in case of invalid api key + remove x-ms-app header from docs * make x-api-key reuired and change its description to be the same as products api * remove x-ms-app from examples * reordering * mild change in error description * remove popularity from productSummary * publihsingStage default is Public not preview * hidekeys only works on preview offers * attempt to make productTypes with link * revert last commit * remove None from request productType description and added 2 new peoductTypes * small modification in description * changed comma * changed description to contain X-API-KEY description * removed security definitions - public APIs * mild refactoring in api-key decription * added default dor skip & top * remove applocableProducts&categoryIds&IndustryIds from documentation at once (including productSummary). added orderBy asc description and operatingSystems filter possibilities. aligned all the description * added centos and windowsserver to ignored custom words * solved conflict * changed errorRespnse description * removed select=Market, select=IndustryCloud,select=Language,select=VmImageGenerations from docs (all are not returning....) * remove references to LinkedAddInTypes (wrong- need to be with an 's') * changed the example to contain more fields * fix case mismatch - change to caps * changed response to match * attempt to add CSPSTATE description to enum values + prettier Search_Get.json * added productType enum * add AzurBenefiet enym description * fixed typos * added PublisherType enum description * prettier * add PublishingStage enum decription * new description for 4 types: CoreVirtualMachine.AzureServices,AppService,LogAnalytics * prettier +VmArchitectureType enum * fixed vaue * fixed typo to publicly * added ` * added enum description to IndustryCloud * remove VmSecurityTypes from select as it is not returning * remove VmArchitectureTypes from select since it is not returning * changed VmSecurityType Standard to None * preetier * make suggestionTypes required and added description to select of suggestions * added required field * remove \n\r - it doesnt look good * make facets in facets api required
…evCM' (Azure#24160)" (Azure#24355)" (Azure#24551) This reverts commit 6c157d4.
* Update readme.python.md * Update readme.python.md
* Adds base for updating Microsoft.ApiManagement from version preview/2022-09-01-preview to version 2023-03-01-preview * Updates readme * Updates API version in new specs and examples * feat(apim): Provide capability to use custom hostname for Configuration API v2 (Azure#23785) Signed-off-by: Tom Kerkhove <[email protected]> * feat(rp): Added flags to enable/disable portals (Azure#23799) * feat(rp): Added flags to enable/disable portals * update default * feat(apim): Provide capability to disable legacy configuration API (Azure#23786) * feat(apim): Provide capability to disable legacy configuration API Signed-off-by: Tom Kerkhove <[email protected]> * Update sample Signed-off-by: Tom Kerkhove <[email protected]> * Fix type definition Signed-off-by: Tom Kerkhove <[email protected]> * Switch to enum Signed-off-by: Tom Kerkhove <[email protected]> * Update samples Signed-off-by: Tom Kerkhove <[email protected]> --------- Signed-off-by: Tom Kerkhove <[email protected]> * feat(apim): Add new tracing API (Azure#23800) * Add new tracing api * Remove TODOs descriptions * Improve descriptions * Fix dot * Add missing examples * prettier fixes * Fix model and semantic problems * Remove get prefix in post operations * Use list prefix * Fix PR comments * feat(apim): Add ability to create and update new OData api (Azure#23849) * Add odata api definitions * add api usage example * fix file reference * address comments --------- Co-authored-by: rkolesnikov <[email protected]> * migration contract (Azure#23983) * 2023 03 cred scan fix - Examples Only (Azure#24357) * remove-sas-signature * update example * 2023-03-01-preview arm review feedback (Azure#24404) * move to v5 subscription contract * move to v5 for rg and api-version * cred scan * default is true * uuid in examples * change from boolean to enums * fix default value --------- Signed-off-by: Tom Kerkhove <[email protected]> Co-authored-by: Tom Kerkhove <[email protected]> Co-authored-by: Harun Reşit <[email protected]> Co-authored-by: Rafał Mielowski <[email protected]> Co-authored-by: Roman Kolesnikov <[email protected]> Co-authored-by: rkolesnikov <[email protected]>
…id readonly (Azure#24530) * Update readme.java.md to make Resource.resourcegroup readonly * Update readme.java.md * Update readme.java.md to make subscriptionid readonly
ericasp16
requested review from
madewithsmiles,
MS-syh2qs,
grizzlytheodore,
hyonholee,
yangyuan,
stankovski,
solankisamir,
ofirmanor and
orieldar
as code owners
Swagger Validation Report
|
Swagger Generation Artifacts
|
ericasp16
requested review from
DominikMe and
MushMal
and removed request for
a team
|
Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment. |
ghost
added
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
The PhoneNumbers SDKs were generated on a swagger that is slightly different to the one that is checked into this repository. This is causing an issue when trying to make incremental changes for new features. This change aims to bring them into alignment and reach parity to unblock further SDK development
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your API Spec engagement record.
Communication/PhoneNumbers - Add Number Lookup API #23053
[Communication - Phone Number Service] Proposed countries offerings API for the ACS Phone Number Service. #18869
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links