APIView: Cross-Language API reviews

[mikekistler]

For DPG generated libraries we need a way to review all the languages together with the Cadl/OpenAPI source used for generation in one ApiView review.

The Cadl/OpenAPI and each language should be shown in separate tabs and switching tabs should maintain context -- meaning that if the user is viewing a particular operation in Python and switches to the Cadl/OpenAPI tab, the content in that tab will be scrolled to the same operation as the Python tab.

We may also want special handling of comments, such as showing comments from all tabs in the OpenAPI/Cadl view (since presumably that's where the changes would be needed).

Tasks

Preview Give feedback

1. [TypeSpec APIView] Support CrossLanguageDefinitionId #6889
   APIView APIView Priority 1 TypeSpec +3
   
2. Add a link to open full APIView from the cross language view context
3. In Cross language View context keep the selected language sticky so user does not have to change it often.

[joshfree]

@JonathanGiles

[JonathanGiles]

I think a way that would work is something like this: you start in the CADL view, you click on some definition, and a right-blade appears with a tabbed interface for each language. In each tab is a fully-fledged APIView, with the selected language-specific code highlighted. This will resolve issues with flicking between tabs, because we never leave the CADL review, and it also means we can see all associated code with the highlighting, even if it is in different parts of the review for each language.

[maririos]

Small step in this direction: #4677

[maririos]

Recent APIView deployment includes a step in this direction. See Fro example this review that got created from an APISpec:

[MrJustinB]

Phase 1 is complete. Phase 2 is planned for 1H Gallium

[maririos]

This work has stopped until #8174 and #5897 are stable