Theme: Streamline API Experience

[pepopowitz]

This represents a collection of issues related to the theme of streamlining the API experience within our docs.

Tasks

Preview Give feedback

1. API documentation is lacking key information #3649
   2 of 3
   component:docs epic:api-interactivity theme:api-streamline +3
   
2. Clearly describe URL schema for both self-managed and SaaS environments, across all REST APIs. #3715
   1 of 4
   component:docs theme:api-streamline +2
   
3. Camunda Saas: Mention Zeebe REST API endpoint schema #3698
   component:zeebe +1
   
4. https://github.com/camunda/developer-experience/issues/38
5. Camunda 8 REST API (& Zeebe REST API) explorers are missing authentication requirement #4074
   component:docs dx theme:api-streamline +3
   
6. Generated OpenAPI introduction pages lack information #3721
   0 of 4
   component:docs dx theme:api-streamline +3
   
7. ---- waterline of urgency (things above this are immediately important; below are not.) ----
8. Merge intro pages of new API explorers with existing ones and clean them up #3585
   dx +1
   
9. custom DocCardList items are required to hardcode a specific URL #3078
   component:docs dx theme:api-streamline +3
   
10. API Explorer generator incorrectly describes allOf schemas #3568
    epic:api-interactivity kind/bug +2
    
11. Feature request: Extend API explorer to incorporate SDK example code #3049
    dx kind/enhancement +2
12. BLOCKED: Improve API Explorer code samples #3422
    component:docs dx epic:api-interactivity hold +4