Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Bug]: Console logged "error" when DBtype is Cosmos and OpenAPI service fails to generate doc #2045

Closed
1 task done
seantleonard opened this issue Feb 16, 2024 · 0 comments · Fixed by #2072
Closed
1 task done

[Bug]: Console logged "error" when DBtype is Cosmos and OpenAPI service fails to generate doc #2045

seantleonard opened this issue Feb 16, 2024 · 0 comments · Fixed by #2072
Assignees
@seantleonard
Labels
bug Something isn't working
Milestone
0.12rc

Comments

@seantleonard
Copy link
Contributor

What happened?

A bug happened!

Cosmos doesn't support openapi/rest so there should be no reference to openapi in dab logs when using cosmos.

Version

main

What database are you using?

CosmosDB NoSQL

What hosting model are you using?

Local (including CLI)

Which API approach are you accessing DAB through?

GraphQL

Relevant log output

No response

Code of Conduct

  • I agree to follow this project's Code of Conduct
@seantleonard seantleonard added bug Something isn't working triage issues to be triaged labels Feb 16, 2024
@seantleonard seantleonard self-assigned this Feb 16, 2024
@seantleonard seantleonard added cosmos and removed triage issues to be triaged labels Feb 16, 2024
@seantleonard seantleonard added this to the 0.12rc milestone Feb 16, 2024
@seantleonard seantleonard mentioned this issue Mar 2, 2024
Merged
1 task
seantleonard added a commit that referenced this issue Mar 10, 2024
@seantleonard
Condition OpenAPI document creation to non-CosmosDB database types. (#…
08f4d45 
…2072)

## Why make this change?

- Closes #2045. Any time that CosmosDB is the configured database, the
codepath that attempts to init the OpenAPI documentor service is run and
will always fail for CosmosDB. As a result, a "Fail" message always
appears on the console which can be misinterpreted as a user fixable
error and is a false positive notification of an issue.

## What is this change?

- OpenAPI documentor service init only occurs for non-CosmosDB database
types because db types like MSSQL , PG, MySQL are the only db types that
support the REST endpoint in DAB.

## How was this tested?

- [x] Run DAB with CosmosDB set as db type and ensure OpenAPI init
failure is not logged to console.

![image](https://github.com/Azure/data-api-builder/assets/6414189/39e2f41a-6f8d-44d9-8ae8-ee649f20ffa4)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@seantleonard seantleonard

Labels
bug Something isn't working
Projects
None yet
Milestone
0.12rc
Development

Successfully merging a pull request may close this issue.

Condition OpenAPI document creation to non-CosmosDB database types. Azure/data-api-builder
1 participant
@seantleonard