core icon indicating copy to clipboard operation
core copied to clipboard

Workflow Import endpoint: schema & error messages incorrect

Open jdcmsd opened this issue 6 months ago • 0 comments

Parent Issue

No response

Problem Statement

While working on the API Playground, I noticed the Workflow Import endpoint has a couple of small errors that run a bit deeper than just pure Swagger UI annotations. I figured I'd address these separately from the doc PR itself.

Firstly, the schema includes a duplicated object: Both workflowObject (the proper one) and workflowImportObject (a bogus one)

image

Furthermore, if the workflowObject is not supplied, even if workflowImportObject is supplied, its error message indicates the wrong object is absent:

image

Steps to Reproduce

  • Open API Playground
  • Open POST /v1/workflow/schemes/import endpoint
  • Click "Schema" to observe the former.
    • Alternately, the default body content will include both redundant objects
  • Attempt to submit without the workflowObject property to see the mistaken error message.

Acceptance Criteria

The schema and default body should both not contain duplicate/redundant/unnecessary properties, and errors should point toward the correct concerns.

I'll be pushing a fix shortly.

dotCMS Version

24.08.20

Proposed Objective

Technical User Experience

Proposed Priority

Priority 4 - Trivial

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response

jdcmsd avatar Aug 23 '24 13:08 jdcmsd