feat(api-reference): add callbacks #5716
Conversation
🦋 Changeset detectedLatest commit: 24d8797 The changes in this PR will be included in the next version bump. This PR includes changesets to release 17 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
packages/api-reference/index.html
Outdated
| ], | ||
| persistAuth: true, | ||
| // Avoid CORS issues | ||
| title: 'Scalar Galaxy', // optional, would fallback to 'API #1' |
There was a problem hiding this comment.
remove this before merging
#10014 Bundle Size — 2.43MiB (+0.14%).24d8797(current) vs edb5490 main#10009(baseline) Warning Bundle contains 3 duplicate packages – View duplicate packages Bundle metrics
Bundle analysis report Branch amrit/webhooks-callbacks Project dashboard Generated by RelativeCI Documentation Report issue |
| @@ -102,6 +102,8 @@ export const oasRequestSchema = z.object({ | |||
| 'deprecated': z.boolean().optional(), | |||
| /** Response formats */ | |||
| 'responses': z.record(z.string(), z.any()).optional(), | |||
| /** Callbacks */ | |||
There was a problem hiding this comment.
Haha u know this one is temp for real
There was a problem hiding this comment.
GREAT WORK
just design-wise @cameronrohani: isn’t that too big of a wall of information? it might not be super clear which example response is for the callback and which for the operation. shouldn’t we make callbacks kind of a new block inside but below the operation somehow?
5813337 to
4d263d5
Compare
4d263d5 to
9a25213
Compare
Problem
Currently, we don't support callbacks
Solution
With this PR we show callbacks! I didn't want to go too deep with this one since its going to change with the new store, will clean up the code and types then.
Checklist
I’ve gone through the following:
pnpm changeset).