Uploaded image for project: 'Kogito'
  1. Kogito
  2. KOGITO-3083

Kogito REST APIs consistency analyse and guideline

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Obsolete
    • Icon: Major Major
    • 1.8.0.Final
    • 0.13.0
    • Core Engine
    • None
    • 2020 Week 34-36 (from Aug 17), 2020 Week 37-39 (from Sep 7), 2020 Week 40-42 (from Sep 28), 2020 Week 43-45 (from Okt 19), 2020 Week 46-48 (from Nov 9), 2020 Week 49-51 (from Nov 30), 2020 Week 52-03 (from Dec 21)

      Analyse the endpoins for processes, decisions, rules and other services and check the consistency like, naming convention, attributes on queries, paths, headers, used HTTP methods, response codes...

      Based on the analyse result, propose a guideline that could be used to keep consistency on all the exposed APIs. This may be extended even to messaging APIs, topics, and Events.

       

      It is important that APIs are consistent before the 1.0 once the public APIs are published and being used it is difficult to change them because it breaks all clients using them.

       

      One idea it regarding metada related to resources, how can we use it where the client may associate any kind of metadata ( corellation ids, labels, etc).

            tdolphin-1 Tiago Dolphine
            tdolphin-1 Tiago Dolphine
            Marian Macik Marian Macik
            Marian Macik Marian Macik
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: