Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-2704

API section has aa confusing organization

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Unresolved
    • Neutral
    • None
    • None
    • None
    • None

    Description

      ON the side navigation, for a develooper it is confusing to have REST API's mixed with Java apis. They are used very differently and used in different contexts. Most of our competitors only have REST API's - so many evaluators are likely confused when they encourter Java APIs in there.

      Not sure best approach - but I think a safe and usefull improvement would be to split into two.
      REST API
      Java API

      REST API would include, in this order:
      Delivery API
      GraphQL API
      Content Management API (Renamed from "Nodes and properties API")
      Connector pack APIs
      Commands API
      Cache API
      Health check API
      SPA templating API
      API error handling

      Java API Contains 
      Java Server APIs
      i18n API
      UI Context API
      Javadoc

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              mdrapela Martin Drápela
              czimmermann Christopher Zimmermann
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated: