starred/hoppscotch
1
0
Fork 0
mirror of https://github.com/hoppscotch/hoppscotch.git synced 2026-04-26 01:06:00 +03:00
Code Issues 711 Projects Releases 5 Packages Wiki Activity

[PR #2243] [MERGED] Open API support for post/put body schemas #3690

New issue
Closed
opened 2026-03-17 01:16:51 +03:00 by kerem · 0 comments
kerem commented 2026-03-17 01:16:51 +03:00
Owner
Copy link

📋 Pull Request Information

Original PR: https://github.com/hoppscotch/hoppscotch/pull/2243
Author: @RishabhAgarwal-2001
Created: 4/8/2022
Status: ✅ Merged
Merged: 6/29/2022
Merged by: @AndrewBastin

Base: orphan-pr/2243 ← Head: 2087-openapi

📝 Commits (10+)

  • 2244d38 feat: oasv2 example generation complete
  • a04b634 refactor: removed unecessary const
  • 14e9d19 feat: v3 requests example working
  • 2aef9c5 refactor: examplev2 created and lintfix
  • 2fd9eb0 refactor: address comments
  • 3a41d79 feat: handle oneof and anyof
  • b0071e6 feat: oasv2 example generation complete
  • 721a201 refactor: removed unecessary const
  • bc2f81f feat: v3 requests example working
  • ed49c0b refactor: examplev2 created and lintfix

📊 Changes

5 files changed (+464 additions, -7 deletions)

View changed files

📝 packages/hoppscotch-app/helpers/functional/json.ts (+8 -0)
➕ packages/hoppscotch-app/helpers/import-export/import/openapi/exampleV2.ts (+185 -0)
➕ packages/hoppscotch-app/helpers/import-export/import/openapi/exampleV3.ts (+109 -0)
➕ packages/hoppscotch-app/helpers/import-export/import/openapi/exampleV31.ts (+129 -0)
📝 packages/hoppscotch-app/helpers/import-export/import/openapi/index.ts (+33 -7)

📄 Description

Closes #2087

Description

PR introduces the feature of generating body examples from a schema definition. PR is a WIP and thus created as a draft PR.

  • Add Open API V2 support for primitive types
  • Add Open API V2 support for the array type
  • Add Open API V2 support for the object type
  • Add Open API V3 support for primitive types
  • Add Open API V3 support for the array type
  • Add Open API V3 support for the object type
  • Transform example based on content-type

Checks

  • My pull request adheres to the code style of this project
  • My code requires changes to the documentation
  • I have updated the documentation as required
  • All the tests have passed

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/hoppscotch/hoppscotch/pull/2243 **Author:** [@RishabhAgarwal-2001](https://github.com/RishabhAgarwal-2001) **Created:** 4/8/2022 **Status:** ✅ Merged **Merged:** 6/29/2022 **Merged by:** [@AndrewBastin](https://github.com/AndrewBastin) **Base:** `orphan-pr/2243` ← **Head:** `2087-openapi` --- ### 📝 Commits (10+) - [`2244d38`](https://github.com/hoppscotch/hoppscotch/commit/2244d38439e813faacb5b4f8ada80852e32c7ecc) feat: oasv2 example generation complete - [`a04b634`](https://github.com/hoppscotch/hoppscotch/commit/a04b634089d0e3f3cb0dff3f78e078b06201ed23) refactor: removed unecessary const - [`14e9d19`](https://github.com/hoppscotch/hoppscotch/commit/14e9d19ae69d01f6bac3f92999734e5f02ac7732) feat: v3 requests example working - [`2aef9c5`](https://github.com/hoppscotch/hoppscotch/commit/2aef9c56910cb323a8f19146cf985a12ce16a404) refactor: examplev2 created and lintfix - [`2fd9eb0`](https://github.com/hoppscotch/hoppscotch/commit/2fd9eb0767f22d358b5cdcc24960bc54ab3fb943) refactor: address comments - [`3a41d79`](https://github.com/hoppscotch/hoppscotch/commit/3a41d79c2f9c286dffb1df4a00d587974bae1c46) feat: handle oneof and anyof - [`b0071e6`](https://github.com/hoppscotch/hoppscotch/commit/b0071e6859ccea32cd6882d91ea777e905d30b45) feat: oasv2 example generation complete - [`721a201`](https://github.com/hoppscotch/hoppscotch/commit/721a201e7adfdb08d96d55c3fbf51dfb311c7a58) refactor: removed unecessary const - [`bc2f81f`](https://github.com/hoppscotch/hoppscotch/commit/bc2f81ff2587eac9123fe6029d8618fbdb02ca8a) feat: v3 requests example working - [`ed49c0b`](https://github.com/hoppscotch/hoppscotch/commit/ed49c0b72c20b2a7050b7b39b7b9d68c9df15636) refactor: examplev2 created and lintfix ### 📊 Changes **5 files changed** (+464 additions, -7 deletions) <details> <summary>View changed files</summary> 📝 `packages/hoppscotch-app/helpers/functional/json.ts` (+8 -0) ➕ `packages/hoppscotch-app/helpers/import-export/import/openapi/exampleV2.ts` (+185 -0) ➕ `packages/hoppscotch-app/helpers/import-export/import/openapi/exampleV3.ts` (+109 -0) ➕ `packages/hoppscotch-app/helpers/import-export/import/openapi/exampleV31.ts` (+129 -0) 📝 `packages/hoppscotch-app/helpers/import-export/import/openapi/index.ts` (+33 -7) </details> ### 📄 Description <!-- Thanks for creating this pull request 🤗 Please make sure that the pull request is limited to one type (docs, feature, etc.) and keep it as small as possible. You can open multiple prs instead of opening a huge one. --> <!-- If this pull request closes an issue, please mention the issue number below --> Closes #2087 ### Description PR introduces the feature of generating body examples from a schema definition. PR is a WIP and thus created as a draft PR. - [x] Add Open API V2 support for primitive types - [x] Add Open API V2 support for the array type - [x] Add Open API V2 support for the object type - [x] Add Open API V3 support for primitive types - [x] Add Open API V3 support for the array type - [x] Add Open API V3 support for the object type - [ ] Transform example based on content-type ### Checks <!-- Make sure your pull request passes the CI checks and do check the following fields as needed - --> - [ ] My pull request adheres to the code style of this project - [ ] My code requires changes to the documentation - [ ] I have updated the documentation as required - [ ] All the tests have passed --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-03-17 01:16:51 +03:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
chore/security-fix-2026-4-0
next
fix/mockserver-env-set-url-priority
feat/rest-gql-merge
refactor/workspaces
fix/onboarding-mass-assignment
desktop-settings-phase-0-schema-bridge-shell
patch
test-webhook
pr/johnan319/5745
tembo/optimize-performance-db-queries
add-claude-github-actions-1772782423108
fix/code-scanning-103
fix/mock-server-example-endpoint-match-v2
fix/rate-limit-on-health-route
hotfix/api-doc-collection-deletetion
cd-test
fix/mock-server-backend-followup
chore/code-scanning-52
chore/verion-addition-check
nested-migrations
scripting-system-updates-worker-setup
scripting-system-updates
pr/shipko/4367
ci-test
feat/user-delete-condition
feat/user-workspace-stats-api
chore/collection-export-addition
fix/import-file-size-limit-flow
feat/dashboard-common
feat/sort-environment-alphabetically
feat/infra-config-encryption
refactor/team
feat/collection-duplicationn
feat/secure-cookies-toggle
pr/pavog/4195
pr/pavog/4196
test/patch-demo
feat/native-interceptor-updates
pr/AndrewBastin/4111
feat/user-last-active-on
fix/codemirror-large-text-scroll-bug
fix/precision-lost-beautify
fix/env-diff-test-schema-error
fix/email-case-sensitive
release/2024.3.3
refactor/workspace-login-conversion
feat/node-apline-version-upgrade
feat/seed
release/2024.3.2
fix/sh-email-handlebar-issue
feat/app-experiment-animation
release/2024.3.1
release/2024.3.0
pr/jamesgeorge007/3937
experiment/deploychan
feat/github-enterprise-auth
refactor/collection-search-query
hotfix/infra-config-reset-bug
fix/secret-var-bug
hotfix/full-text-search
hotfix/request-variable-version-syncing
feat/request-variable
feat/server-config-additional-properties
pr/JoelJacobStephen/3845
release/2023.12.6
fix/safari-codemirror-perf-bug
release/2023.12.5
release/2023.12.4
fix/secret-env-bugs-tooltip
release/2023.12.3
fix/shared-request-bug
fix/disable-context-menu-option
release/2023.12.2
release/2023.12.1
fix/shared-request-bugs
release/2023.12.0
fix/gql-history-schema
fix/actions-not-working-without-sidebar
pr/jamesgeorge007/3665
chore/desktop-app-corrections
fix/auth-headers-in-coll
fix/embed-url
improve/placeholder
add-realtime-logos
feat/shared-request-embeds
feat/collection-headers
revamp/header
release/2023.8.4
refactor/interceptor-error-display
feat/subpath-based-access
release/2023.8.3
feat/shared-requests
feat/desktop
fix/nodemailer-templates-issue
feature/upgrade-graphql-ws
fix/graphql-crashing
fix/set-environments-when-no-env-selected
refactor/pre-prisma-bump-setup
release/2023.8.2
pr/danitherex/3216
perf/raw-db-query
release/2023.8.1
revert-3348-perf/reduce-backend-calls
fix/incorrect-tab-count-close-all-tab
fix/duplicate-tab-bug
release/2023.8.0
hotfix/fetch-shortcode
fix/tab-right-click-rename-bug
chore/docker-fixes
pr/JoelJacobStephen/3178
feat/fe-accessible-auth-provider-env
feat-cherry-pick/conditional-auth-select
feat/conditional-auth-select
release/2023.4.8
fix/generate-sitemap-issue
test/backend-test-case
refactor/team-invitation
pr/AndrewBastin/3171
release/2023.4.7
fix/duplicate-team-invite
fix/unified-bg-color-coll-tree
fix/shortcode-screen-stuck
release/2023.4.6
revert-3117-patch-3
fix/env-selector-bg
fix/db-url
release/2023.4.4
fix/sync-popup-bug
fix/team-env-set-test
chore/wss-to-ws-on-env
fix/prettify-xml-response
feat/db-volume-addition
feat/env-selector-tabs-ui
bug/broken-env
release/2023.4.2
fix/switch-workspace-env-bug
fix/magic-link
fix/cookie-handler
HPS-OSS-1
staging
revert/auth-issue
feat/export-env
refactor/commons
reference/path-variables
orphan-pr/2243
feat/realtime-search
fix/save-override
refactor/strategies
feat/embeds
bug/withDefaults
feat/show-keys
refactor/toast
2026.3.1
2026.3.0
2026.2.1
2026.2.0
2026.1.1
2026.1.0
2025.12.1
2025.12.0
2025.11.2
2025.11.1
2025.11.0
2025.10.1
2025.10.0
2025.9.2
2025.9.1
2025.9.0
2025.8.1
2025.8.0
2025.7.1
2025.7.0
2025.6.1
2025.6.0
2025.5.4
2025.5.3
2025.5.2
2025.5.1
2025.5.0
2025.4.2
2025.4.1
2025.4.0
2025.3.2
2025.3.1
2025.3.0
2025.2.3
2025.2.2
2025.2.1
2025.2.0
2025.1.1
2025.1.0
2024.12.2
2024.12.1
2024.12.0
2024.11.0
2024.10.2
2024.10.1
2024.10.0
2024.9.3
2024.9.2
2024.9.1
2024.9.0
2024.8.3
2024.8.2
2024.8.1
2024.8.0
2024.7.2
2024.7.1
2024.7.0
2024.6.1
2024.6.0
2024.3.4
2024.3.3
2024.3.2
2024.3.1
2024.3.0
2023.12.6
2023.12.5
2023.12.4
2023.12.3
2023.12.2
2023.12.1
2023.12.0
2023.8.4
2023.8.3
2023.8.2
2023.8.1
2023.8.0
2023.4.8
2023.4.7
2023.4.6
2023.4.5
2023.4.4
2023.4.3
2023.4.2
2023.4.1
2023.4.0
v3.0.1
v3.0.0
v2.2.1
v2.2.0
v2.1.0
v2.0.0
v1.12.0
v1.10.0
v1.9.9
v1.9.7
v1.9.5
v1.9.0
v1.8.0
v1.5.0
v1.0.0
v0.1.0
Labels
Clear labels   
CodeDay

   
a11y

   
browser limited

   
bug

   
bug fix

   
cli

   
core

   
critical

   
design

   
desktop

   
discussion

   
docker

   
documentation

   
duplicate

   
enterprise

   
feature

   
feature

   
fosshack

   
future

   
good first issue

   
hacktoberfest

   
help wanted

   
i18n

   
invalid

   
major

   
minor

   
need information

   
need testing

   
not applicable to hoppscotch

   
not reproducible

   
pull-request

Mirrored from GitHub Pull Request

  
question

   
refactor

   
resolved

   
sandbox

   
self-host

   
spam

   
stale

   
testmu

   
wip

   
wont fix
No labels
CodeDay
a11y
browser limited
bug
bug fix
cli
core
critical
design
desktop
discussion
docker
documentation
duplicate
enterprise
feature
feature
fosshack
future
good first issue
hacktoberfest
help wanted
i18n
invalid
major
minor
need information
need testing
not applicable to hoppscotch
not reproducible
pull-request
question
refactor
resolved
sandbox
self-host
spam
stale
testmu
wip
wont fix
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/hoppscotch#3690
No description provided.