Uploaded image for project: 'camunda BPM'
  1. camunda BPM
  2. CAM-10894

OpenAPI documentation for Camunda Rest API

XMLWordPrintable

    • Icon: Feature Request Feature Request
    • Resolution: Fixed
    • Icon: L3 - Default L3 - Default
    • 7.13.0
    • None
    • engine
    • None

      AT:

      • a jar artifact containing a single JSON file containing the OpenAPI documentation of the Rest API

      Scope:

      The following resources are covered:

      • Condition
      • Deployment
      • Engine
      • External Task
      • Message
      • Metrics
      • Process Instance
      • Process Definition
      • Signal
      • Schema Log
      • Task
      • Version

        This is the controller panel for Smart Panels app

            [CAM-10894] OpenAPI documentation for Camunda Rest API

            Daniel Meyer added a comment -

            Hi thorben.lindhauer, I just tried out to use our openapi file with the swagger online ui but I get the following error:

            Unable to render this definition
The provided definition does not specify a valid version field.
Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2.0" and those that match openapi: 3.0.n (for example, openapi: 3.0.0).

            Daniel Meyer added a comment - Hi thorben.lindhauer , I just tried out to use our openapi file with the swagger online ui but I get the following error: Unable to render this definition The provided definition does not specify a valid version field. Please indicate a valid Swagger or OpenAPI version field. Supported version fields are swagger: "2.0" and those that match openapi: 3.0.n (for example, openapi: 3.0.0).

            Yana Vasileva added a comment - - edited

            Hi meyer,

            Unfortunately, this is not the correct OpenAPI file (this is the schema.json that against this schema we are validating our documentation), the SNAPSHOT version of OpenAPI documentation can be found here:
            https://app.camunda.com/nexus/service/rest/repository/browse/camunda-bpm-snapshots/org/camunda/bpm/camunda-engine-rest-openapi/7.13.0-SNAPSHOT/
            So far our openapi.json is not deployed anywhere but we ship it packaged in jar file, inside you can find openapi.json file.

            You can try it with https://editor.swagger.io/ or importing it in Postman for example.

            Yana Vasileva added a comment - - edited Hi meyer , Unfortunately, this is not the correct OpenAPI file (this is the schema.json that against this schema we are validating our documentation), the SNAPSHOT version of OpenAPI documentation can be found here: https://app.camunda.com/nexus/service/rest/repository/browse/camunda-bpm-snapshots/org/camunda/bpm/camunda-engine-rest-openapi/7.13.0-SNAPSHOT/ So far our openapi.json is not deployed anywhere but we ship it packaged in jar file, inside you can find openapi.json file. You can try it with https://editor.swagger.io/ or importing it in Postman for example.

              yana.vasileva Yana Vasileva
              meyer Daniel Meyer
              Votes:
              1 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: