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.

Sign up for GitHub

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

Jump to bottom

feat: OpenApi Parser multiple success responses, error response descriptions, better examples #1924

Merged
merged 31 commits into from
Dec 20, 2024
Merged

feat: OpenApi Parser multiple success responses, error response descriptions, better examples #1924

merged 31 commits into from
Dec 20, 2024

Conversation

RohinBhargava
Copy link
Member

Short description of the changes made

  • Focuses heavily on examples, with multiple success/failure responses
  • Changes FDR EndpointDefinition to accept multiple requests and responses, now
  • Prefers first request and response in UI for now
  • Plumbs redoc examples
  • Ensures enums are plumbed to errors

What's not included:

  • Updated UI
  • Formats and Regexes
  • Allowing for curl snippet to be processed

What was the motivation & context behind this PR?

  • Customer Go-Live

How has this PR been tested?

Screen.Recording.2024-12-19.at.4.32.56.AM.mov

fern-support and others added 27 commits December 10, 2024 18:12
@fern-support
add tag conversion
3c40232
@RohinBhargava
server name and tags, tests needed
5913f3b
@RohinBhargava
checkpoint
dcc756b
@RohinBhargava
pnpm lock
ceac2c1
@RohinBhargava
Merge remote-tracking branch 'origin/main' into uploadcare-experiment
53274dc
@RohinBhargava
added example parsers, need to add tests and merge examples in a mean…
a79a06a 
…ingful way
@RohinBhargava
add tests and fix compile errors
81daa61
@RohinBhargava
merge from main
def2f73
@RohinBhargava
remove type_: from type alias
662ed6e
@RohinBhargava
feat: redoc example parsing (#1906)
b95ff56
@RohinBhargava
code compiles, testing
23d96f0
@RohinBhargava
update tests
cd5b548
@RohinBhargava
many examples working, multiple request responses, error defaults sho…
8fad42e 
…wing, enums plumbed to errors, type safety on docs-search-server
@RohinBhargava
empty snippets & removed redundancy
91bff16
@RohinBhargava
remove test file
0d77cab
@RohinBhargava
update snapshot
e7cee2c
@RohinBhargava
pnpm lock
cec5db2
@RohinBhargava
merge from main
73ba050
@RohinBhargava
bump version and fix some tests
d06d9c5
@RohinBhargava
update and add tests
1c6f33a
@RohinBhargava
example object tests
223a89f
@RohinBhargava
Merge branch 'uploadcare-experiment' into rohin/multiple-success-resp…
2c70167 
…onses
@RohinBhargava
merge from main
0551cae
@RohinBhargava
try removing cross product from converter
e730db8
@RohinBhargava
return statement
ece2427
@RohinBhargava
snippet old logic for curl
767c824
@RohinBhargava
merge from main
0618a87
@RohinBhargava RohinBhargava had a problem deploying to Preview - app-dev.buildwithfern.com December 20, 2024 17:44 — with GitHub Actions Failure
@RohinBhargava RohinBhargava had a problem deploying to Preview - app.buildwithfern.com December 20, 2024 17:44 — with GitHub Actions Failure
@github-actions GitHub Actions
Copy link

🌿 Preview your docs: https://fern-preview-51a83e71-77d7-4d21-b867-513811e9431b.docs.buildwithfern.com

@fern-support fern-support had a problem deploying to Preview - app.buildwithfern.com December 20, 2024 18:10 — with GitHub Actions Failure
@fern-support fern-support had a problem deploying to Preview - app-dev.buildwithfern.com December 20, 2024 18:10 — with GitHub Actions Failure
@github-actions GitHub Actions
Copy link

🌿 Preview your docs: https://fern-preview-9a4de990-edee-4866-ba8c-d04f74eb8e90.docs.buildwithfern.com

@RohinBhargava RohinBhargava marked this pull request as ready for review December 20, 2024 18:11
@fern-support fern-support had a problem deploying to Preview - app-dev.buildwithfern.com December 20, 2024 18:27 — with GitHub Actions Failure
@fern-support fern-support had a problem deploying to Preview - app.buildwithfern.com December 20, 2024 18:27 — with GitHub Actions Failure
@github-actions GitHub Actions
Copy link

🌿 Preview your docs: https://fern-preview-81017e9b-baa9-4ce3-ab1c-b03ae8488325.docs.buildwithfern.com

@RohinBhargava RohinBhargava enabled auto-merge (squash) December 20, 2024 18:31
@fern-support fern-support had a problem deploying to Preview - app.buildwithfern.com December 20, 2024 19:18 — with GitHub Actions Error
@fern-support fern-support had a problem deploying to Preview - app-dev.buildwithfern.com December 20, 2024 19:18 — with GitHub Actions Error
@github-actions GitHub Actions
Copy link

🌿 Preview your docs: https://fern-preview-1b0c7bd7-c6ce-482e-999c-3075258f00bc.docs.buildwithfern.com

@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 20, 2024 •
edited
Loading

📦 Next.js Bundle Analysis for fern-platform-monorepo

This analysis was generated by the Next.js Bundle Analysis action. 🤖

This PR introduced no changes to the JavaScript bundle! 🙌

@github-actions GitHub Actions
Copy link

🌿 Preview your docs: https://fern-preview-64b166cb-5a36-4d81-9e33-f24740252caa.docs.buildwithfern.com

@github-actions GitHub Actions
Copy link

PR Preview

@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 20, 2024 •
edited
Loading

Playwright test results

failed  1 failed
passed  97 passed
flaky  1 flaky
skipped  4 skipped

Details

stats  103 tests across 10 suites
duration  1 minute, 36 seconds
commit  3da43f1

Failed tests

chromium › skew-protection/index.test.ts › should contain ?dpl= or x-deployment-id header on all scripts and prefetch requests

Flaky tests

chromium › smoke/favicon.spec.ts › Check if favicon exists and URL does not return 404 for dev.documentation.sayari.com

Skipped tests

chromium › posthog.spec.ts › Posthog loads successfully
chromium › proxy.spec.ts › multipart-form upload
chromium › proxy.spec.ts › json request
chromium › websockets/websocket.spec.ts › websocket test

@RohinBhargava RohinBhargava merged commit 3b7a74a into main Dec 20, 2024
16 of 19 checks passed
@RohinBhargava RohinBhargava deleted the rohin/multiple-success-responses-rebase branch December 20, 2024 19:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abvthecity abvthecity abvthecity approved these changes

@dsinghvi dsinghvi Awaiting requested review from dsinghvi dsinghvi is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@RohinBhargava @abvthecity @fern-support