Skip to content

chore: Automated API v2 OpenAPI spec generation#17046

Merged
ThyMinimalDev merged 5 commits intomainfrom
chore/improve-docs
Nov 13, 2024
Merged

chore: Automated API v2 OpenAPI spec generation#17046
ThyMinimalDev merged 5 commits intomainfrom
chore/improve-docs

Conversation

@keithwillcode
Copy link
Copy Markdown
Contributor

@keithwillcode keithwillcode commented Oct 10, 2024

What does this PR do?

These should never be out of sync now.

Mandatory Tasks (DO NOT REMOVE)

  • 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.
  • N/A - I confirm automated tests are in place that prove my fix is effective or that my feature works.

How should this be tested?

  • Run API v2 locally and ensure the openapi.json file in /docs/api-reference/v2 is updated properly based on any api docs tags

@keithwillcode keithwillcode requested a review from a team October 10, 2024 12:34
@keithwillcode keithwillcode self-assigned this Oct 10, 2024
@graphite-app graphite-app Bot requested a review from a team October 10, 2024 12:34
@dosubot dosubot Bot added api area: API, enterprise API, access token, OAuth docs area: docs, documentation, cal.com/docs labels Oct 10, 2024
@keithwillcode keithwillcode added core area: core, team members only foundation labels Oct 10, 2024
@graphite-app
Copy link
Copy Markdown

graphite-app Bot commented Oct 10, 2024

Graphite Automations

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

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

keithwillcode
keithwillcode commented Oct 10, 2024
View reviewed changes
Comment thread apps/api/v2/src/modules/oauth-clients/controllers/oauth-flow/oauth-flow.controller.ts
@Post("/authorize")
@HttpCode(HttpStatus.OK)
@UseGuards(NextAuthGuard)
@DocsOperation({
Copy link
Copy Markdown
Contributor Author

@keithwillcode keithwillcode Oct 10, 2024

Choose a reason for hiding this comment

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

After talking to @ThyMinimalDev, we agreed to not add development-only docs.

Copy link
Copy Markdown
Contributor

@supalarry supalarry Oct 14, 2024

Choose a reason for hiding this comment

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

What was the reason for the decision? IMO the @DocsOperation docs are useful in the future for the team itself to understand how these endpoints are intended to be used.

Copy link
Copy Markdown
Contributor

@ThyMinimalDev ThyMinimalDev Oct 14, 2024

Choose a reason for hiding this comment

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

I think these are not useful for developers as they can simply check the input types, hiding these properties in prod was requiring more work than the actual benefits, we can always just have comments or tsdocs on the input types for dev endpoints

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 10, 2024 •
edited
Loading

E2E results are ready!

@keithwillcode keithwillcode enabled auto-merge (squash) October 10, 2024 14:45
supalarry
supalarry previously approved these changes Oct 14, 2024
View reviewed changes
Comment thread apps/api/v2/src/modules/oauth-clients/controllers/oauth-flow/oauth-flow.controller.ts
@Post("/authorize")
@HttpCode(HttpStatus.OK)
@UseGuards(NextAuthGuard)
@DocsOperation({
Copy link
Copy Markdown
Contributor

@supalarry supalarry Oct 14, 2024

Choose a reason for hiding this comment

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

What was the reason for the decision? IMO the @DocsOperation docs are useful in the future for the team itself to understand how these endpoints are intended to be used.

@vercel
Copy link
Copy Markdown

vercel Bot commented Oct 14, 2024 •
edited
Loading

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

2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
cal ⬜️ Ignored (Inspect) Visit Preview Nov 13, 2024 0:31am
calcom-web-canary ⬜️ Ignored (Inspect) Visit Preview Nov 13, 2024 0:31am

@keithwillcode keithwillcode marked this pull request as draft October 14, 2024 21:54
auto-merge was automatically disabled October 14, 2024 21:54

Pull request was converted to draft

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Oct 30, 2024

This PR is being marked as stale due to inactivity.

@github-actions github-actions Bot added the Stale label Oct 30, 2024
@ThyMinimalDev ThyMinimalDev marked this pull request as ready for review November 13, 2024 12:31
@ThyMinimalDev ThyMinimalDev self-requested a review November 13, 2024 12:31
@ThyMinimalDev ThyMinimalDev enabled auto-merge (squash) November 13, 2024 12:32
@ThyMinimalDev ThyMinimalDev merged commit 74b4d7a into main Nov 13, 2024
@ThyMinimalDev ThyMinimalDev deleted the chore/improve-docs branch November 13, 2024 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ThyMinimalDev ThyMinimalDev ThyMinimalDev approved these changes

@supalarry supalarry supalarry left review comments

Assignees

@keithwillcode keithwillcode

Labels

api area: API, enterprise API, access token, OAuth core area: core, team members only docs area: docs, documentation, cal.com/docs foundation ready-for-e2e Stale

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@keithwillcode @ThyMinimalDev @supalarry