datahub-project / datahub

The Metadata Platform for your Data Stack
https://datahubproject.io
Apache License 2.0
9.73k stars 2.87k forks source link

OpenAPI specification is missing info property #7844

Closed janfrederickk closed 1 year ago

janfrederickk commented 1 year ago

Describe the bug The generated Swagger OpenAPI specification is missing the required info attribute.

To Reproduce Steps to reproduce the behavior:

  1. Go to datahub
  2. Append /openapi/v3/api-docs to URL

Expected behavior OpenAPI specification requires the info property. see here

The info property is described here

Additional context If the info property is not available in the json file. The specifcation cannot be imported to Azure API Management

vishesh10 commented 1 year ago

Hi @jan-wacker, Can you please guide what needs to be added in the "title" and "version" tags of the info property. Additionally, can you also please provide the values of any tags of the info property which are required to be added.

Thanks

janfrederickk commented 1 year ago

As described in the OpenAPI Requirements here the following tags are required:

"title": "DataHub OpenAPI",
"version": "1.0.1"

Version tag needs to be generated.

vishesh10 commented 1 year ago

Hi @jan-wacker, I have created a PR for this issue. Thanks

github-actions[bot] commented 1 year ago

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] commented 1 year ago

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