Adding Online Experimentation data plane API. by smichtch · Pull Request #33135 · Azure/azure-rest-api-specs

smichtch · 2025-03-11T20:31:41Z

Data Plane API Specification Update Pull Request

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

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.

Link to API Spec engagement record issue: https://github.com/Azure/azure-rest-api-specs-pr/issues/20970

Is this review for (select one):

a private preview
a public preview
GA release

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.}

Design Document: https://microsoft-my.sharepoint.com/:w:/p/risinh/EUe08KsA8AVAsk1DAAjnuOcBv9GDoBkUXL1huIp4iWOTCA?e=ns6H2Y
Previous API Spec Doc: N/A (new API)
Updated paths: /specification/onlineexperimentation/*

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

❔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.

💬 Teams Channel
💌 email

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting

Guidelines & Specifications

Helpful Links

Schedule a data plane REST API spec review

Getting help

First, please carefully read through this PR description, from top to bottom.
If you don't have permissions to remove or add labels to the PR, request write access per aka.ms/azsdk/access#request-access-to-rest-api-or-sdk-repositories
To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
and https://aka.ms/ci-fix.
If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

fix #33168

openapi-pipeline-app · 2025-03-11T20:31:45Z

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

openapi-pipeline-app · 2025-03-11T20:31:46Z

PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.

azure-sdk · 2025-03-11T20:38:22Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

Language	API Review for Package
TypeSpec	Azure.Analytics.OnlineExperimentation
Go	sdk/analytics/azonlineexperimentation
Swagger	Microsoft.OnlineExperimentation
Java	com.azure:azure-analytics-onlineexperimentation
JavaScript	@azure-rest/analytics-onlineexperimentation
Python	azure-onlineexperimentation

…OWN`

…ntil SDK repo is updated)

weidongxu-microsoft · 2025-04-17T01:21:36Z

+  - code: AvoidAnonymousTypes
+  - code: PatchInOperationName
+  - code: OperationIdNounVerb
+  - code: RequiredReadOnlyProperties
+  - code: SchemaNamesConvention
+  - code: SchemaDescriptionOrTitle


Is this suppression from some template in specs (andthere seems no PatchInOperationName in this PR)?

Thanks. Added Approved-Suppression label, as all these suppressions are from template readme

azure-rest-api-specs/specification/contosowidgetmanager/data-plane/readme.md

Lines 53 to 78 in 525c8c6

### Suppress non-TypeSpec SDK related linting rules

These set of linting rules aren't applicable to the new TypeSpec SDK code generators so suppressing them here. Eventually we will

opt-out these rules from running in the linting tools for TypeSpec generated swagger files.

```yaml

suppressions:

- code: AvoidAnonymousTypes

- code: PatchInOperationName

- code: OperationIdNounVerb

- code: RequiredReadOnlyProperties

- code: SchemaNamesConvention

- code: SchemaDescriptionOrTitle

```

### Suppress rules that might be fixed

These set of linting rules we expect to fixed in typespec-autorest emitter but for now suppressing.

Github issue filed at https://github.com/Azure/typespec-azure/issues/2762

```yaml

suppressions:

- code: LroExtension

- code: SchemaTypeAndFormat

- code: PathParameterSchema

```

mikekistler

Looks good! 👍

# Conflicts: # specification/onlineexperimentation/cspell.yaml

This reverts commit f29d05c.

…rimentation/tspconfig.yaml Remove "analytics" segment from python SDK package name. Co-authored-by: catalinaperalta <9859037+catalinaperalta@users.noreply.github.com>

smichtch requested a review from a team as a code owner March 11, 2025 20:31

smichtch requested review from JeffreyRichter and mikekistler and removed request for a team March 11, 2025 20:31

AzureRestAPISpecReview added data-plane new-api-version TypeSpec Authored with TypeSpec labels Mar 11, 2025

smichtch force-pushed the feature/online-experimentation branch 2 times, most recently from 3313ce6 to 1f6fc42 Compare March 11, 2025 21:36

azure-sdk mentioned this pull request Mar 11, 2025

[AutoPR Azure.Analytics.OnlineExperimentation] Adding Online Experimentation data plane API. azure-sdk/azure-sdk-for-net#10720

Closed

smichtch force-pushed the feature/online-experimentation branch from 1f6fc42 to 8e94f14 Compare March 11, 2025 21:38

smichtch force-pushed the feature/online-experimentation branch 5 times, most recently from 9939bf1 to 297e162 Compare March 12, 2025 15:44

smichtch added the offline-review-requested Service team has requested PR review be conducted offline. label Mar 12, 2025

openapi-pipeline-app Bot added PipelineBotTrigger and removed PipelineBotTrigger labels Mar 12, 2025

openapi-pipeline-app Bot added the PipelineBotTrigger label Apr 9, 2025

smichtch added 2 commits April 9, 2025 16:59

Revert https://aka.ms/autorest to bare URL to fix `NOT_AUTOREST_MARKD…

8bf69ce

…OWN`

Fix TypeScript package-dir.

e69ddd0

openapi-pipeline-app Bot removed the PipelineBotTrigger label Apr 10, 2025

Enable extensible enums feature in TypeScript SDK.

30eb35d

weidongxu-microsoft reviewed Apr 11, 2025

View reviewed changes

Comment thread specification/onlineexperimentation/Azure.Analytics.OnlineExperimentation/main.tsp

Change validateMetric to a ResourceCollectionAction

adbc526

smichtch mentioned this pull request Apr 11, 2025

Azure Online Experimentation data-plane SDK Azure/azure-sdk-for-js#33812

Merged

3 tasks

Java SDK set partial-update: true

94b4b75

smichtch mentioned this pull request Apr 15, 2025

Adding Online Experimentation data-plane SDK Azure/azure-sdk-for-java#44980

Merged

6 tasks

Cleanup.

152e731

azure-sdk mentioned this pull request Apr 15, 2025

[AutoPR default] Adding Online Experimentation data plane API. azure-sdk/azure-sdk-for-js#14979

Closed

Disable generate-samples and generate-test for python.

87cbd37

smichtch mentioned this pull request Apr 15, 2025

Adding Online Experimentation data-plane SDK Azure/azure-sdk-for-python#40532

Merged

6 tasks

smichtch added 3 commits April 16, 2025 08:37

Merge branch 'main' into feature/online-experimentation

b5d4817

Enable generate-metadata: true for @azure-tools/typespec-ts (needed u…

0f7c49f

…ntil SDK repo is updated)

Change percentile from int32 to float64.

5dd9df1

weidongxu-microsoft approved these changes Apr 17, 2025

View reviewed changes

weidongxu-microsoft reviewed Apr 17, 2025

View reviewed changes

mikekistler approved these changes Apr 17, 2025

View reviewed changes

smichtch added 6 commits April 17, 2025 09:58

Remove "analytics" grouping from python package name.

f29d05c

Merge branch 'main' into feature/online-experimentation

4641d78

# Conflicts: # specification/onlineexperimentation/cspell.yaml

Fix cspell.yaml syntax

cf7651f

Revert "Remove "analytics" grouping from python package name."

d9aa329

This reverts commit f29d05c.

Replace ValidationResult with boolean.

d1fdd0e

Merge branch 'main' into feature/online-experimentation

9cc22b4

catalinaperalta reviewed Apr 21, 2025

View reviewed changes

Comment thread specification/onlineexperimentation/Azure.Analytics.OnlineExperimentation/tspconfig.yaml Outdated

Update specification/onlineexperimentation/Azure.Analytics.OnlineExpe…

e1a7980

…rimentation/tspconfig.yaml Remove "analytics" segment from python SDK package name. Co-authored-by: catalinaperalta <9859037+catalinaperalta@users.noreply.github.com>

azure-sdk mentioned this pull request Apr 21, 2025

[AutoPR azure-onlineexperimentation] Adding Online Experimentation data plane API. azure-sdk/azure-sdk-for-python#11357

Closed

aprilk-ms approved these changes Apr 21, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding Online Experimentation data plane API.#33135

Adding Online Experimentation data plane API.#33135
smichtch merged 41 commits intomainfrom
feature/online-experimentation

smichtch commented Mar 11, 2025 •

edited by azure-sdk

Loading

Uh oh!

openapi-pipeline-app Bot commented Mar 11, 2025 •

edited

Loading

Uh oh!

openapi-pipeline-app Bot commented Mar 11, 2025 •

edited

Loading

Uh oh!

azure-sdk commented Mar 11, 2025 •

edited by github-actions Bot

Loading

Uh oh!

Uh oh!

weidongxu-microsoft Apr 17, 2025 •

edited

Loading

Uh oh!

weidongxu-microsoft Apr 17, 2025 •

edited

Loading

Uh oh!

mikekistler left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

	### Suppress non-TypeSpec SDK related linting rules

	These set of linting rules aren't applicable to the new TypeSpec SDK code generators so suppressing them here. Eventually we will
	opt-out these rules from running in the linting tools for TypeSpec generated swagger files.

	```yaml
	suppressions:
	- code: AvoidAnonymousTypes
	- code: PatchInOperationName
	- code: OperationIdNounVerb
	- code: RequiredReadOnlyProperties
	- code: SchemaNamesConvention
	- code: SchemaDescriptionOrTitle
	```

	### Suppress rules that might be fixed

	These set of linting rules we expect to fixed in typespec-autorest emitter but for now suppressing.
	Github issue filed at https://github.com/Azure/typespec-azure/issues/2762

	```yaml
	suppressions:
	- code: LroExtension
	- code: SchemaTypeAndFormat
	- code: PathParameterSchema
	```

Conversation

smichtch commented Mar 11, 2025 • edited by azure-sdk Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Data Plane API Specification Update Pull Request

PR review workflow diagram

API Info: The Basics

Change Scope

Viewing API changes

Suppressing failures

❔Got questions? Need additional info?? We are here to help!

Tooling

Guidelines & Specifications

Helpful Links

Getting help

Uh oh!

openapi-pipeline-app Bot commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Next Steps to Merge

Uh oh!

openapi-pipeline-app Bot commented Mar 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azure-sdk commented Mar 11, 2025 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Check

Uh oh!

Uh oh!

weidongxu-microsoft Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

weidongxu-microsoft Apr 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mikekistler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

smichtch commented Mar 11, 2025 •

edited by azure-sdk

Loading

openapi-pipeline-app Bot commented Mar 11, 2025 •

edited

Loading

openapi-pipeline-app Bot commented Mar 11, 2025 •

edited

Loading

azure-sdk commented Mar 11, 2025 •

edited by github-actions Bot

Loading

weidongxu-microsoft Apr 17, 2025 •

edited

Loading

weidongxu-microsoft Apr 17, 2025 •

edited

Loading