APIRevision Management

[Chidozie Ononiwu]

This epic that tries to address various issue we have around managing APIRevisions (Creating, Updating, Tagging with Versions, release tags e.t.c.)

The main goal here is to clarify and document this process so we fully understand the workflow for managing API Revisions then translate it into code in such a way that each step in the process is properly logged such that one can easily track down problem in our DevOps pipelines.

Tasks

Beta Give feedback

1. Create a workflow document that covers existing behavior for all cases.
2. Collect feedback from architects and other users, then update the document to cover new requests.
3. Design APIs around the workflow.
4. Implement the APIs

By the end we should have addressed the following issues

Beta Give feedback

1. APIView - Retain a revision for each major minor package version #5186
   APIView Central-EngSys +2
   
2. Release pipeline for APIView should add a Release tag #4470
   APIView Central-EngSys +2
   
3. APIView should keep revisions for release packages #1770
   APIView APIView Priority 3 Central-EngSys feature-request +4
   
4. Update revision name for automatic packages to show published status when a package is released #1698
   APIView APIView Priority 3 Central-EngSys feature-request +4
   
5. Show release date in API view for automatic review #1696
   APIView APIView Priority 2 Central-EngSys feature-request +4
   
6. APIView - ability to rebase (reupload first revision) #841
   APIView APIView Priority 3 Central-EngSys enhancement feature-request +5
7. [API View] For a GA'd library, all new API views of that library should include a revision that points to the last released version #3781
   APIView Central-EngSys +2
8. APIView review comparison #2886
   APIView APIView Priority 3 Central-EngSys +3
   
9. Support More Granular Updating to Current API View #3286
   APIView Java +2
   
10. [APIView] Add release metadata to API #2278
    APIView APIView Priority 3 Central-EngSys enhancement feature-request +5
    
11. [APIView] Get clarity on the version showed in APIView #2277
    APIView APIView Priority 2 Python bug +4
    
12. Swagger APIView support diff with different version #5457
    APIView Central-EngSys Swagger +3
13. APIView - API review gen step in the pipeline fails for .NET meta package #5812
    APIView Central-EngSys +2
    
14. Evaluate if we should update API Spec revision when there is a new version of the swagger/typespec parser #5817
    APIView Central-EngSys +2
    
15. [APIView] Make GA baseline available for diff in PR and manual reviews #6102
    APIView Central-EngSys feature-request +3
16. APIView - Update version label on the automatic review #6111
    APIView Central-EngSys +2
17. Update the PR apiview diff to compare current and target branch #6212
    APIView Central-EngSys +2
18. [APIView] Ability to compare with latest stable version #6676
    APIView Central-EngSys +2
19. APIView "approved" status is tied to rev number #6793
    APIView Central-EngSys bug +3
    
20. Tidy Up APIView Approval Requirements #6740
    APIView +1
    
21. APIView did not generate base revision #7225
    APIView Central-EngSys Swagger +3
22. [APIView] APIRevison MetaData #7744
    1 of 7
    APIView Central-EngSys +2