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

refactor: v2 docs #14446

Merged
merged 35 commits into from Apr 10, 2024
Merged

refactor: v2 docs #14446

merged 35 commits into from Apr 10, 2024

Conversation

supalarry
Copy link
Contributor

@supalarry supalarry commented Apr 7, 2024

Docs

  1. Groups endpoints e.g. all event types endpoints are under Event Types tags - in files changed search by @DocsTags in commit refactor: group endpoints by tags
  2. Removes default swagger header in commit refactor: remove swagger header
  3. Except slots and timezones, all endpoints have inputs and outputs and except some bookings endpoints.
    3.1 feat: managed users docs and feat: managed users docs
    3.2 feat: gcal docs
    3.3 feat: provider docs
    3.4 schedules docs in feat: schedules docs and feat: schedules docs
    3.5 me docs in feat: me docs
    3.6 calendars docs in feat: calendar busy times docs and feat: calendar connected and destination calendars docs

Refactors

  1. schedules - refactored tests to reflect data returned to atoms (aka don't have the "@foratom" logic anymore) in commit refactor: schedules remove forAtom logic - return just for atoms
  2. refactor UpdateScheduleInput - do not require scheduleId as part of UpdateScheduleInput because we already pass scheduleId in request parameter.
  3. merge schedules response service into schedule service to prevent circular deps

Fixes

  1. FIX: when updating schedule if schedule property was not passed it would erase availabilities - fetch the schedule prop as it is currently if its not passed in update body see code.
  2. isDefault for schedule - make it required field in fix: schedule create isDefault required because it was true by default meaning each last created schedule without it becomes default which is an unexpected behaviour - its better users are aware of it.
  3. Add OAuth id to email when updating user email + disallow updating username in commit fix: add OAuth id when updating user email + disallow updating username
  4. FIX: when creating managed user with e-mai "bob@example.com" it works, and if we submit it again server errors with 500 because we were attempting to create user with same e-mail, so check it before creating new user in fix: creating user with same e-mail results in 500

To see docs checkout http://localhost:5555/docs
v2 tests, e2e tests run green and examples app and web app work.

@graphite-app graphite-app bot requested review from a team April 7, 2024 16:20
@dosubot dosubot bot added api area: API, enterprise API, access token, OAuth core area: core, team members only docs area: docs, documentation, cal.com/docs platform Anything related to our platform plan 💻 refactor labels Apr 7, 2024
Copy link
Contributor

github-actions bot commented Apr 7, 2024

Thank you for following the naming conventions! 🙏 Feel free to join our discord and post your PR link.

Copy link

vercel bot commented Apr 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

4 Ignored Deployments
Name Status Preview Comments Updated (UTC)
ai ⬜️ Ignored (Inspect) Visit Preview Apr 10, 2024 8:02am
cal ⬜️ Ignored (Inspect) Visit Preview Apr 10, 2024 8:02am
calcom-web-canary ⬜️ Ignored (Inspect) Visit Preview Apr 10, 2024 8:02am
qa ⬜️ Ignored (Inspect) Visit Preview Apr 10, 2024 8:02am

Copy link

graphite-app bot commented Apr 7, 2024

Graphite Automations

"Add foundation team as reviewer" took an action on this PR • (04/07/24)

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

"Add consumer team as reviewer" took an action on this PR • (04/07/24)

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

"Add platform team as reviewer" took an action on this PR • (04/07/24)

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

@supalarry supalarry merged commit 8382ebc into main Apr 10, 2024
40 checks passed
@supalarry supalarry deleted the v2-docs-improvements branch April 10, 2024 09:08
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 automated-tests area: unit tests, e2e tests, playwright core area: core, team members only docs area: docs, documentation, cal.com/docs platform Anything related to our platform plan 💻 refactor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants