Creator Features 2022-09-01-preview

[ismael-ms]

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

Changelog

Add a changelog entry for 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
   • [x] Other, please clarify - This is technically a new service onboarding. However, I wanted to clarify that this service is the successor of an existing service, WFS. We opted to create a whole new service instead of version as we wanted to rename the service to Features (as WFS is now a legacy service per Open Geospatial Consortium standards), as well as make a number of small changes to existing APIs that would sum up to breaking changes. Features keeps the same functionality as the read APIs in WFS while also adding a set of new APIs for write operations.
2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
   • February 2023
3. When do you expect to publish the swagger?
   • February 2023
4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
   • [ ] SDK of .NET (need service team to ensure code readiness)
   • [ ] SDK of Python
   • [ ] SDK of Java
   • [ ] SDK of Js
   • [ ] SDK of Go
   • [ ] PowerShell
   • [ ] CLI
   • [ ] Terraform
   • [x] No refresh required for updates in this PR

Contribution checklist:

• [x] I commit to follow the Breaking Change Policy of "no breaking changes"
• [x] I have reviewed the documentation for the workflow.
• [x] Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: :warning:

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

• Change to data plane APIs
• Adding new properties
• All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

• [ ] Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.

  • Adding a new service
  • Adding new API(s)
  • Adding a new API version -[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.

• [ ] 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.

• [ ] 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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.

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

fix https://github.com/Azure/azure-rest-api-specs/issues/22058

[openapi-workflow-bot[bot]]

Hi, @ismael-ms 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. [email protected]

[openapi-pipeline-app[bot]]

Swagger Validation Report

️❌BreakingChange: 8 Errors, 0 Warnings failed [Detail]

compared swaggers (via Oad v0.10.4)]	new version	base version
features.json	2023-03-01-preview(1bfc918)	2023-03-01-preview(main)

Rule	Message
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2023-03-01-preview/features.json#L137:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2023-03-01-preview/features.json#L170:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2023-03-01-preview/features.json#L203:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2023-03-01-preview/features.json#L236:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2023-03-01-preview/features.json#L269:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2023-03-01-preview/features.json#L305:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2023-03-01-preview/features.json#L341:5
❌ 1038 - AddedPath	The new version is adding a path that was not found in the old version. New: Creator/preview/2023-03-01-preview/features.json#L423:5

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️⚠️LintDiff: 88 Warnings warning [Detail]

compared tags (via openapi-validator v2.0.0)	new version	base version
package-preview-2023-03	package-preview-2023-03(1bfc918)	package-preview-2023-03(release-maps-Creator-2023-03-01-preview-feature-branch)

[must fix]The following errors/warnings are introduced by current PR:

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

Rule	Message	Related RPC [For API reviewers]
:warning: PageableOperation	Based on the response model schema, operation 'Features_GetLandingPage' might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2023-03-01-preview/features.json#L138
:warning: PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2023-03-01-preview/features.json#L138
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2023-03-01-preview/features.json#L153
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Creator/preview/2023-03-01-preview/features.json#L164
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Creator/preview/2023-03-01-preview/features.json#L164
:warning: ErrorResponse	Error schema should define code and message properties as required. Location: Creator/preview/2023-03-01-preview/features.json#L164
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2023-03-01-preview/features.json#L186
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Creator/preview/2023-03-01-preview/features.json#L197
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Creator/preview/2023-03-01-preview/features.json#L197
:warning: ErrorResponse	Error schema should define code and message properties as required. Location: Creator/preview/2023-03-01-preview/features.json#L197
:warning: PageableOperation	Based on the response model schema, operation 'Features_ListConformance' might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2023-03-01-preview/features.json#L204
:warning: PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2023-03-01-preview/features.json#L204
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2023-03-01-preview/features.json#L219
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Creator/preview/2023-03-01-preview/features.json#L230
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Creator/preview/2023-03-01-preview/features.json#L230
:warning: ErrorResponse	Error schema should define code and message properties as required. Location: Creator/preview/2023-03-01-preview/features.json#L230
:warning: PageableOperation	Based on the response model schema, operation 'Features_GetCollections' might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2023-03-01-preview/features.json#L237
:warning: PaginationResponse	Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2023-03-01-preview/features.json#L237
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2023-03-01-preview/features.json#L252
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Creator/preview/2023-03-01-preview/features.json#L263
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Creator/preview/2023-03-01-preview/features.json#L263
:warning: ErrorResponse	Error schema should define code and message properties as required. Location: Creator/preview/2023-03-01-preview/features.json#L263
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2023-03-01-preview/features.json#L285
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2023-03-01-preview/features.json#L288
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Creator/preview/2023-03-01-preview/features.json#L299
:warning: ErrorResponse	The error property in the error response schema should be required. Location: Creator/preview/2023-03-01-preview/features.json#L299
:warning: ErrorResponse	Error schema should define code and message properties as required. Location: Creator/preview/2023-03-01-preview/features.json#L299
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2023-03-01-preview/features.json#L321
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Creator/preview/2023-03-01-preview/features.json#L324
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: Creator/preview/2023-03-01-preview/features.json#L335

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-pipeline-app[bot]]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account. 

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

_{Posted by Swagger Pipeline | How to fix these errors?}

[openapi-workflow-bot[bot]]

Hi @ismael-ms, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

Task	How to fix	Priority
Avocado	Fix-Avocado	High
Semantic validation	Fix-SemanticValidation-Error	High
Model validation	Fix-ModelValidation-Error	High
LintDiff	Fix-LintDiff	high

If you need further help, please feedback via swagger feedback.

[openapi-pipeline-app[bot]]

Generated ApiView

Language	Package Name	ApiView Link
swagger	maps-data-plane-Creator	https://apiview.dev/Assemblies/Review/72173a66542c4d65add4fb6f9ac4e9bb

[openapi-workflow-bot[bot]]

Hi, @ismael-ms, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

[openapi-workflow-bot[bot]]

NewApiVersionRequired reason: A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support. EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

[ruowan]

/azp run

[azure-pipelines[bot]]

Azure Pipelines successfully started running 1 pipeline(s).

[heaths]

@ismael-ms if possible, can you please avoid rebasing and force-pushing. It makes it very difficult to simply view the changes since last we reviewed, thus having to review the entire PR again and taking longer.

[ismael-ms]

@ismael-ms if possible, can you please avoid rebasing and force-pushing. It makes it very difficult to simply view the changes since last we reviewed, thus having to review the entire PR again and taking longer.

@heaths Understood. Just wanted to fix a mistake in the previous commit, but I'll refrain from cleaning up history. Apologies for the trouble.

[ghost]

Hi, @ismael-ms. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

[ismael-ms]

@mikekistler, @JeffreyRichter, @heaths Thank you all for your assistance and guidance in developing a new API version. I have addressed the versioning concerns in this PR now and it is ready for review again.

For reference, here's a quick summary of things that have been changed since the last review:

• I merged release-maps-Creator-2023-03-01-preview-feature-branch into this branch to have the latest 2023-03-01-preview changes. (https://github.com/Azure/azure-rest-api-specs/pull/19539/commits/66ffa06dd5040e4907d438d4e4229c076d2b4f9a)
• I updated the API version for Features to 2023-03-01-preview (https://github.com/Azure/azure-rest-api-specs/pull/19539/commits/41693437b3ef5e1e64a2d4e2550f1795bfcc1609 and https://github.com/Azure/azure-rest-api-specs/pull/19539/commits/ec3fb5434a4f8e0c73e34aa3c80cfd6e2c2dbb89)
• I removed the "id" field in the POST (create feature) and PUT (update feature) request body. This is still conforming with the Open Geospatial Consortium specification, and it is not a breaking change since it is a new API. (https://github.com/Azure/azure-rest-api-specs/pull/19539/commits/ec3fb5434a4f8e0c73e34aa3c80cfd6e2c2dbb89)
• Removed the default api-version since it is a required field. (https://github.com/Azure/azure-rest-api-specs/pull/19539/commits/284d62c7a6e19ca10ed41e9c8ae4327bdf78cc58)

Please let me know if there are any questions. I'll be happy to answer 😃

[mikekistler]

@jhendrixMSFT This PR is ready to merge.