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

8749 invalid openapi schema #9156

Merged
merged 2 commits into from
Dec 20, 2024
Merged

8749 invalid openapi schema #9156

merged 2 commits into from
Dec 20, 2024

Conversation

martmull
Copy link
Contributor

@martmull martmull commented Dec 19, 2024

Fixes #8749
Switch openApi schema version from 3.0.1 to 3.1.1
Tested on https://editor-next.swagger.io/ as https://editor.swagger.io/ does not support 3.1
No error
image

@martmull martmull linked an issue Dec 19, 2024 that may be closed by this pull request
@martmull martmull marked this pull request as ready for review December 19, 2024 17:26
@martmull
Copy link
Contributor Author

@cabe56 is it ok for you?

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR Summary

Updates OpenAPI schema version from 3.0.3 to 3.1.1 in Twenty's REST API documentation to support webhooks functionality and ensure compliance with OpenAPI specification validators.

  • Updated schema version to 3.1.1 in packages/twenty-server/src/engine/core-modules/open-api/utils/base-schema.utils.ts
  • Added proper documentation links for Terms of Service and License in base schema
  • Updated API description to explicitly reference OpenAPI 3.1 specification
  • Added contact information with email address in schema metadata
  • Improved bearer token description with example format

1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile

@martmull martmull merged commit 94136d9 into main Dec 20, 2024
22 checks passed
@martmull martmull deleted the 8749-invalid-openapi-schema branch December 20, 2024 08:56
mdrazak2001 pushed a commit to mdrazak2001/twenty that referenced this pull request Dec 20, 2024
samyakpiya pushed a commit to samyakpiya/twenty that referenced this pull request Dec 28, 2024
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

Successfully merging this pull request may close these issues.

Invalid OpenAPI schema
2 participants