- 
        Couldn't load subscription status. 
- Fork 317
Create documentation for backward compatibility supported scenarios #8809
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
          
     Open
      
        
      
            Copilot
  wants to merge
  6
  commits into
  main
  
    
      
        
          
  
    
      Choose a base branch
      
     
    
      
        
      
      
        
          
          
        
        
          
            
              
              
              
  
           
        
        
          
            
              
              
           
        
       
     
  
        
          
            
          
            
          
        
       
    
      
from
copilot/create-back-compat-documentation
  
      
      
   
  
    
  
  
  
 
  
      
    base: main
Could not load branches
            
              
  
    Branch not found: {{ refName }}
  
            
                
      Loading
              
            Could not load tags
            
            
              Nothing to show
            
              
  
            
                
      Loading
              
            Are you sure you want to change the base?
            Some commits from the old base branch may be removed from the timeline,
            and old review comments may become outdated.
          
          
      
        
          +225
        
        
          −0
        
        
          
        
      
    
  
Conversation
  
    
      This file contains hidden or 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
    
  
  
    
    Co-authored-by: jorgerangel-msft <[email protected]>
Co-authored-by: jorgerangel-msft <[email protected]>
      
          
Copilot
AI
        changed the title
[WIP] Create document on all back compatibility supported scenarios
Create documentation for backward compatibility supported scenarios
      Oct 23, 2025 
    
      
          Copilot finished work on behalf of 
  jorgerangel-msft 
    October 23, 2025 16:12     
    
        
          
                packages/http-client-csharp/generator/docs/backward-compatibility.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
              
          
                packages/http-client-csharp/generator/docs/backward-compatibility.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
              
          
                packages/http-client-csharp/generator/docs/backward-compatibility.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
              
          
                packages/http-client-csharp/generator/docs/backward-compatibility.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
              
          
                packages/http-client-csharp/generator/docs/backward-compatibility.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
      Co-authored-by: jorgerangel-msft <[email protected]>
    
          Copilot finished work on behalf of 
  jorgerangel-msft 
    October 23, 2025 16:24     
    
        
          
                packages/http-client-csharp/generator/docs/backward-compatibility.md
              
                Outdated
          
            Show resolved
            Hide resolved
        
      Co-authored-by: jorgerangel-msft <[email protected]>
    
          Copilot finished work on behalf of 
  jorgerangel-msft 
    October 23, 2025 16:30     
    
              
                    jorgerangel-msft
  
              
              approved these changes
              
                  
                    Oct 23, 2025 
                  
              
              
            
            
Co-authored-by: jorgerangel-msft <[email protected]>
    
          Copilot finished work on behalf of 
  jorgerangel-msft 
    October 24, 2025 15:35     
    
              
                    jorgerangel-msft
  
              
              approved these changes
              
                  
                    Oct 24, 2025 
                  
              
              
            
            
|  | ||
| **Result:** The generator keeps the previous parameter ordering to maintain compatibility. | ||
|  | ||
| #### Scenario 3: Model Factory Method Renamed | 
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would say this isn't really supported because we don't generate the backcompat model. I don't think this is a scenario that we need to support.
  
    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.
  
    
  
    
LastContractViewin the generator codebasepackages/http-client-csharp/generator/docs/backward-compatibility.mdSummary
Created documentation for backward compatibility support in the TypeSpec C# generator. The document covers:
Supported Back-Compat Scenarios:
Model Factory Methods
Model Properties
API Version Enum
Recent Changes:
The documentation is located at
/packages/http-client-csharp/generator/docs/backward-compatibility.md.Original prompt
Fixes #8808
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.