Azure / Azure/typespec-azure

Add documentation for converting old ARM operation patterns

Open
#454 1 comment 0 reactions 0 assignees View on GitHub
docs
Dominant language
TypeScript
Stars
27
Forks
90
Avg merge
1d 21h
Merged PRs (30d)
164

Description

There are still older ARM specs that use interface templates, which can result in confusing deprecation messages, and inexact usage of suppressions to get rid of the warnings (because suppressions cna only happen at the interface definition).
- Add a section to troubleshooting describing the deprecation messages and options for how to deal with them
- Talk to breaking change folks about promoting breaking changes that do not represent API changes, such as removing 200 responses for asynchronous APIs.

Contributor guide

Open the contributing guide

Research direction

No file or test is named. Start by locating the troubleshooting documentation and existing guidance for older ARM specs using interface templates; document the deprecation messages and suppression options, then confirm the breaking-change guidance covers non-API changes such as removing 200 responses from asynchronous APIs.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.