Skip to content

fixed openapi specification #20392

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

Closed
wants to merge 1 commit into from
Closed

Conversation

pk8189
Copy link

@pk8189 pk8189 commented Mar 26, 2025

What does this PR do?

Fix the errors in the OpenAPI specification

OpenAPI linting before:
"errors": 52,
"infos": 4,
"warns": 1538

After:
"errors": 0,
"infos": 4,
"warns": 1538

Visual Demo (For contributors especially)

Functional Python and Typescript SDKs created using the fixed specification:
https://github.com/Sideko-Inc/calcom_py
https://github.com/Sideko-Inc/calcom_ts

Mandatory Tasks (DO NOT REMOVE)

  • [x ] I have self-reviewed the code (A decent size PR without self-review might be rejected).

  • I have updated the developer docs in /docs if this PR makes changes that would require a documentation change. If N/A, write N/A here and check the checkbox.
    I'm assuming this new spec needs to be fed into your documentation provider.

  • [ N/A] I confirm automated tests are in place that prove my fix is effective or that my feature works.

Copy link

vercel bot commented Mar 26, 2025

@pk8189 is attempting to deploy a commit to the cal Team on Vercel.

A member of the Team first needs to authorize it.

@graphite-app graphite-app bot added the community Created by Linear-GitHub Sync label Mar 26, 2025
@graphite-app graphite-app bot requested a review from a team March 26, 2025 21:18
@CLAassistant
Copy link

CLAassistant commented Mar 26, 2025

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added api area: API, enterprise API, access token, OAuth docs area: docs, documentation, cal.com/docs Low priority Created by Linear-GitHub Sync 🐛 bug Something isn't working labels Mar 26, 2025
Copy link
Contributor

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.

Details:

No release type found in pull request title "fixed openapi specification". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

Copy link

graphite-app bot commented Mar 26, 2025

Graphite Automations

"Add consumer team as reviewer" took an action on this PR • (03/26/25)

1 reviewer was added to this PR based on Keith Williams's automation.

"Add community label" took an action on this PR • (03/26/25)

1 label was added to this PR based on Keith Williams's automation.

Copy link
Contributor

@TusharBhatt1 TusharBhatt1 left a comment

Choose a reason for hiding this comment

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

The issue states issue with docs/api-reference/v1/openapi.json while the PR has changes to docs/api-reference/v2/openapi.json

@pk8189
Copy link
Author

pk8189 commented Mar 27, 2025

The issue states issue with docs/api-reference/v1/openapi.json while the PR has changes to docs/api-reference/v2/openapi.json

Hi Tushar, should I create a new issue? As you can see in the description, there were 51 issues with the v2 OpenAPI specification, which is also mentioned in the issue.

@keithwillcode
Copy link
Contributor

@pk8189 Thanks for the fixes. I'm curious - do you know the root cause? We currently auto-generate this doc so even with these fixes, more errors will pop up if we don't fix root cause.

@TusharBhatt1
Copy link
Contributor

The issue states issue with docs/api-reference/v1/openapi.json while the PR has changes to docs/api-reference/v2/openapi.json

Hi Tushar, should I create a new issue? As you can see in the description, there were 51 issues with the v2 OpenAPI specification, which is also mentioned in the issue.

Hey , you can create a new issue - the point is the issue and the PR doesn't really match.
Plus as Keith mentioned these files are auto generated - I guess you have done manual changes , so investigating and fixing the root cause is the ideal fix

Copy link
Contributor

@TusharBhatt1 TusharBhatt1 left a comment

Choose a reason for hiding this comment

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

@pk8189 still working on it ?

@TusharBhatt1
Copy link
Contributor

Thanks for the PR , closing it due to staleness (let me know if you wish to continue)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api area: API, enterprise API, access token, OAuth 🐛 bug Something isn't working community Created by Linear-GitHub Sync docs area: docs, documentation, cal.com/docs Low priority Created by Linear-GitHub Sync
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Multiple or incomplete openAPI specs
4 participants