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.

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

[Schema Inaccuracy] GitHub App (integration) is Nullable #4127

Open
aayachnes opened this issue Nov 1, 2024 · 0 comments
Open

[Schema Inaccuracy] GitHub App (integration) is Nullable #4127

aayachnes opened this issue Nov 1, 2024 · 0 comments

Comments

@aayachnes
Copy link

aayachnes commented Nov 1, 2024

Schema Inaccuracy

The integration type in the OpenAPI document is marked nullable, even though there is a nullable-integration type which is equivalent. This means that, according to the OpenAPI document, the GET /apps/{app_slug} API returns null or an integration, which I do not believe is accurate. If this is accurate, please do let me know what the case is where the API returns null, and I would recommend documenting this case in the OpenAPI document.

Expected

The integration type should not have nullable: true set. Because this type is nullable, the TypeScript type (from openapi-types.ts) for the GET /apps/{app_slug} API response is inaccurate, and I have to manually override the type to be non-null.

Reproduction Steps

N/A

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant