datahub icon indicating copy to clipboard operation
datahub copied to clipboard

GlobalTags Aspect API returns HTTP Code 204 instead of 200

Open kzgrzendek opened this issue 11 months ago • 1 comments

Hello,

First of all, I'd like to thank you for your amazing work! This issue is rather minor, but I thought I'd raise it anyway for you to have it in the backlog.

PS : I haven's see this behavior describe in other issues, sorry if it was already discussed elsewhere.

Describe the bug On the 0.13.0 version of Datahub, when browsing the OpenAPI page to the HEAD [/v2/entity/dataproduct/{urn}/globaltags] operation of the GlobalTags Aspect, the API returns a HTTP 204 Code if GlobalTags for the corresponding DataProduct urn exists, but the documentation states that an HTTP 200 Code should be returned in that case.

Would it be possible to align the OpenAPI specification with the actual API behavior?

To Reproduce Steps to reproduce the behavior:

  1. Open the OpenAPI - Swagger UI of the 0.13.0 version of DataHub
  2. Browse to the HEAD [/v2/entity/dataproduct/{urn}/globaltags] operation of the GlobalTags Aspect of the API.
  3. Search GlogalTags for a valid DataProduct urn containing at least one GlobalTag
  4. The API answers with a 204 HTTP return code, whereas the Swagger specifies that a 200 return code should be returned instead

Expected behavior The API should return an HTTP 200 OK code in that scenario, or the Swagger should be updated to state that an HTTP 204 return code is the behavior to expect.

Screenshots image

Desktop (please complete the following information):

  • OS: Ubuntu 22.04 LTS
  • Browser: Firefox 122.0.1 (64 bits)
  • Version: 0.13.0

Additional context None

kzgrzendek avatar Mar 18 '24 13:03 kzgrzendek

This issue is stale because it has been open for 30 days with no activity. If you believe this is still an issue on the latest DataHub release please leave a comment with the version that you tested it with. If this is a question/discussion please head to https://slack.datahubproject.io. For feature requests please use https://feature-requests.datahubproject.io

github-actions[bot] avatar Apr 18 '24 01:04 github-actions[bot]

This issue was closed because it has been inactive for 30 days since being marked as stale.

github-actions[bot] avatar May 18 '24 01:05 github-actions[bot]