We couldn't load all Actvitity tabs. Refresh the page to try again.
If the problem persists, contact your Jira admin.
Uploaded image for project: 'Camunda Optimize'
  1. Camunda Optimize
  2. OPT-5902

Spike: Research API Documentation tool for Optimize API

    • 2
    • S

      Now we have an increasing number of public APIs, we should revisit the topic of documentation for it. Our public documentation is not sufficient for users and our internal API documentation for FE usage is error-prone and quite probably not correct at the moment. 

      We should spike tooling to see if something can be used to remove the manual effort and reduce the chance of errors with this documentation.

      Assigning to Giuliano as he expressed an interest in doing this spike

      Justification:

      Our documentation could easily get out of date and we can unknowingly introduce breaking changes to our API, breaking the consuming APIs of clients. Using a tool such as swagger could reduce the possibility of this happening. Furthermore, this would make QA testing our public APIs considerably easier

        This is the controller panel for Smart Panels app

            Loading...
            Uploaded image for project: 'Camunda Optimize'
            1. Camunda Optimize
            2. OPT-5902

            Spike: Research API Documentation tool for Optimize API

              • 2
              • S

                Now we have an increasing number of public APIs, we should revisit the topic of documentation for it. Our public documentation is not sufficient for users and our internal API documentation for FE usage is error-prone and quite probably not correct at the moment. 

                We should spike tooling to see if something can be used to remove the manual effort and reduce the chance of errors with this documentation.

                Assigning to Giuliano as he expressed an interest in doing this spike

                Justification:

                Our documentation could easily get out of date and we can unknowingly introduce breaking changes to our API, breaking the consuming APIs of clients. Using a tool such as swagger could reduce the possibility of this happening. Furthermore, this would make QA testing our public APIs considerably easier

                  This is the controller panel for Smart Panels app

                        Unassigned Unassigned
                        joshua.windels Joshua Windels
                        Giuliano Rodrigues Lima Giuliano Rodrigues Lima
                        Votes:
                        0 Vote for this issue
                        Watchers:
                        1 Start watching this issue

                          Created:
                          Updated:
                          Resolved:

                              Unassigned Unassigned
                              joshua.windels Joshua Windels
                              Giuliano Rodrigues Lima Giuliano Rodrigues Lima
                              Votes:
                              0 Vote for this issue
                              Watchers:
                              1 Start watching this issue

                                Created:
                                Updated:
                                Resolved: