[snippets] Add README snippets for all projects #32416
Assignees
Labels
Client
This issue points to a problem in the data-plane of the library.
Comments
3 tasks
mpodwysocki
added a commit
that referenced
this issue
Jan 3, 2025
### Packages impacted by this PR - @azure/arm-advisor ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Adds snippets for the README which are type checked. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
This was referenced Jan 7, 2025
mpodwysocki
added a commit
that referenced
this issue
Jan 8, 2025
### Packages impacted by this PR - @azure-rest/agrifood-farming - @azure/arm-agrifood ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates the agrifood projects to use snippet extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
This was referenced Jan 8, 2025
mpodwysocki
added a commit
that referenced
this issue
Jan 9, 2025
### Packages impacted by this PR - @azure-rest/ai-anomaly-detector ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates snippets for all projects under the `anomalydetector` folder. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
3 tasks
mpodwysocki
added a commit
that referenced
this issue
Jan 9, 2025
### Packages impacted by this PR - @azure/arm-apicenter ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `apicenter` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
mpodwysocki
added a commit
that referenced
this issue
Jan 9, 2025
### Packages impacted by this PR - @azure/arm-apimanagement - @azure/api-management-custom-widgets-scaffolder - @azure/api-management-custom-widgets-tools ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all `apimanagement` packages to use snippets. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
mpodwysocki
added a commit
that referenced
this issue
Jan 9, 2025
### Packages impacted by this PR - @azure/arm-appcomplianceautomation ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all `appcomplianceautomation` projects to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
3 tasks
mpodwysocki
added a commit
that referenced
this issue
Jan 9, 2025
### Packages impacted by this PR - @azure/app-configuration - @azure/arm-appconfiguration ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `appconfiguration` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
3 tasks
mpodwysocki
added a commit
that referenced
this issue
Jan 10, 2025
### Packages impacted by this PR - @azure/arm-analysisservices ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Adds snippets for all analysis services SDKs ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
This was referenced Jan 10, 2025
mpodwysocki
added a commit
that referenced
this issue
Jan 10, 2025
…32501) ### Packages impacted by this PR - @azure/arm-appplatform ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all `appplatform` projects to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
mpodwysocki
added a commit
that referenced
this issue
Jan 10, 2025
### Packages impacted by this PR - @azure-rest/arm-appservice - @azure/arm-appservice - @azure/arm-appservice-profile-2020-09-01-hybrid ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `appservice` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
mpodwysocki
added a commit
that referenced
this issue
Jan 10, 2025
### Packages impacted by this PR - @azure/arm-astro ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `astro` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
mpodwysocki
added a commit
that referenced
this issue
Jan 10, 2025
) ### Packages impacted by this PR - @azure/arm-applicationinsights ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under the `applicationinsights` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
This was referenced Feb 20, 2025
mpodwysocki
added a commit
that referenced
this issue
Feb 24, 2025
…action (#33164) ### Packages impacted by this PR - @azure-rest/health-insights-cancerprofiling - @azure-rest/health-insights-clinicalmatching - @azure-rest/health-insights-radiologyinsights ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `healthinsights` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
3 tasks
mpodwysocki
added a commit
that referenced
this issue
Feb 24, 2025
…33174) ### Packages impacted by this PR - @azure-rest/purview-administration - @azure-rest/purview-catalog - @azure-rest/purview-datamap - @azure-rest/purview-scanning - @azure-rest/purview-sharing - @azure-rest/purview-workflow ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all REST projects under `purview` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
3 tasks
mpodwysocki
added a commit
that referenced
this issue
Feb 24, 2025
…33177) ### Packages impacted by this PR - @azure-rest/synapse-access-control - @azure/synapse-access-control - @azure/synapse-artifacts - @azure/synapse-managed-private-endpoints - @azure/synapse-monitoring - @azure/synapse-spark ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all client projects under `synapse` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
This was referenced Feb 25, 2025
mpodwysocki
added a commit
that referenced
this issue
Feb 25, 2025
### Packages impacted by this PR - @azure/data-tables ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `tables` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary) --------- Co-authored-by: Jeremy Meng <jeremy.ymeng@gmail.com>
3 tasks
mpodwysocki
added a commit
that referenced
this issue
Feb 25, 2025
### Packages impacted by this PR - @azure/template - @azure/template-dpg ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `template` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
3 tasks
mpodwysocki
added a commit
that referenced
this issue
Feb 26, 2025
…33188) ### Packages impacted by this PR - @azure/web-pubsub - @azure/web-pubsub-client - @azure/web-pubsub-client-protobuf - @azure/web-pubsub-express ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `web-pubsub` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
This was referenced Feb 26, 2025
mpodwysocki
added a commit
that referenced
this issue
Feb 26, 2025
### Packages impacted by this PR - @azure/functions-authentication-events ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `entra` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
mpodwysocki
added a commit
that referenced
this issue
Feb 26, 2025
### Packages impacted by this PR - @azure/quantum-jobs ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `quantum` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
mpodwysocki
added a commit
that referenced
this issue
Feb 26, 2025
…action (#33193) ### Packages impacted by this PR - @azure/schema-registry - @azure/schema-registry-avro - @azure/schema-registry-json ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `schemaregistry` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
mpodwysocki
added a commit
that referenced
this issue
Feb 26, 2025
…tion (#33212) ### Packages impacted by this PR - @azure/ai-text-analytics ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `databoxedge` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary) --------- Co-authored-by: Deyaaeldeen Almahallawi <dealmaha@microsoft.com>
This was referenced Feb 26, 2025
mpodwysocki
added a commit
that referenced
this issue
Feb 27, 2025
### Packages impacted by this PR - @azure-rest/ai-vision-image-analysis ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `vision` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
mpodwysocki
added a commit
that referenced
this issue
Feb 27, 2025
…#33220) ### Packages impacted by this PR - @azure-rest/ai-translation-document - @azure-rest/ai-translation-text ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `translation` to use snippets extraction. Note this disables non-functioning tests that need to be recorded under the `documentTranslationTest.spec.ts` and `translationFilterTest.spec.ts`. Noted in the issue #31948 that the tests need to be re-recorded. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
mpodwysocki
added a commit
that referenced
this issue
Feb 28, 2025
…ction (#32885) ### Packages impacted by this PR - @azure/ai-form-recognizer ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `formrecognizer` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
This was referenced Feb 28, 2025
mpodwysocki
added a commit
that referenced
this issue
Feb 28, 2025
… extraction (#33243) ### Packages impacted by this PR - @azure/microsoft-playwright-testing ### Issues associated with this PR - #32416 ### Describe the problem that is addressed by this PR Updates all projects under `playwrighttesting` to use snippets extraction. ### What are the possible designs available to address the problem? If there are more than one possible design, why was the one in this PR chosen? ### Are there test cases added in this PR? _(If not, why?)_ ### Provide a list of related PRs _(if any)_ ### Command used to generate this PR:**_(Applicable only to SDK release request PRs)_ ### Checklists - [ ] Added impacted package name to the issue description - [ ] Does this PR needs any fixes in the SDK Generator?** _(If so, create an Issue in the [Autorest/typescript](https://github.com/Azure/autorest.typescript) repository and link it here)_ - [ ] Added a changelog (if necessary)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
This is to track the progress of README snippets migration to use
dev-tool run update-snippetsto extract and type check snippets.Steps include:
test/snippets.spec.tsin each projectdev-tool run update-snippetsfrom the script taskupdate-snippetsMigration report
Category: core
Category: management
Category: client
Category: utility
Category: test
The text was updated successfully, but these errors were encountered: