Uploaded image for project: 'Red Hat OpenBridge'
  1. Red Hat OpenBridge
  2. MGDOBR-974

smart_events.yaml produces SDK with deficiencies

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Done
    • Icon: Critical Critical
    • None
    • None
    • None
    • None
    • False
    • None
    • False
    • MGDX - Sprint 222

      Issue Description:
      app-services-sdk-js contains a module for RHOSE (smart-events) product. This smart-events module is quite fresh and contanis some deficiencies preventing our team from using it.

      Spotted deficiencies are:

      1. (critical) APIErrorCodes unable to use them. If I follow usage [2], I get an attached error. If I import them from "service-accounts-sdk" then APIErrorCodes are found, but they do not contain members like ERROR_1 MGDOBR-1011
      2. (minor) official SDK operations are prefixed in some 'duplicity' way, which makes reading code harder. We used `remove-operation-id-prefix` for generation [3]
      3. (minor) some fields are optional in official SDK [4], while they are not in openapi [5]

      [1] https://github.com/5733d9e2be6485d52ffa08870cabdee0/sandbox-ui/pull/111
      [2] https://www.npmjs.com/package/@rhoas/smart-events-management-sdk/v/0.40.0
      [3] https://github.com/5733d9e2be6485d52ffa08870cabdee0/sandbox-ui/blob/main/scripts/openapi-sdk/generate_openapi_client.sh
      [4] https://github.com/redhat-developer/app-services-sdk-js/blob/main/packages/smart-events-management-sdk/src/generated/model/bridge-response.ts#L66
      [5] https://github.com/5733d9e2be6485d52ffa08870cabdee0/sandbox/blob/main/openapi/smartevents_mgmt.yaml#L905

      Acceptance Criteria: At least the (critical) point form the description is fixed.

      Out of Scope: <Here you need to fill in what is out of scope for this issue and then create new issues if necessary in the backlog for the work>

      Additional Information:

              wtrocki@redhat.com Wojciech Trocki
              rh-ee-jomarko Jozef Marko (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: