search

apigitlabs / apigit-support

APIGIT is a native Git based collaboration platform for API design, document, mock and share.
https://apigit.com
1 stars 0 forks source link

UX issue when using $ref in Request definition #20

Closed nad-au closed 6 months ago

nad-au commented 1 year ago

Is there an existing issue for this?

Describe the Issue

In the edit form when you define a Request you can edit Path Param, Query Param, Headers, Cookie and Body. When you create any of these items and select $ref as the type, it expands all sections and creates a placeholder $ref entry in each.

To be fair it does hide the other sections after creating an entry so not too much of a problem.

Steps To Reproduce

  1. Edit a spec
  2. Edit a path
  3. Go to Request section
  4. Change type to $ref
  5. Observe a placeholder row gets created for each Request type

Screenshots or Videos

No response

Browser

Brave

Additional Context?

No response

apigitlabs commented 1 year ago

Thanks, @neildobson-au. This is a known issue that occurs when a new $ref is added without specifying a target for it. As a result, it becomes unclear which target(query, path, header,cookie) the new parameters should belong to. We acknowledge this problem and plan to address it by implementing an improvement.

apigitlabs commented 6 months ago

problem was fixed