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

idea: OpenAPI.json file for QA #1753

Open
gabrielle-ong opened this issue Nov 29, 2024 · 0 comments
Open

idea: OpenAPI.json file for QA #1753

gabrielle-ong opened this issue Nov 29, 2024 · 0 comments
Assignees
Labels
type: docs Improvements or additions to documentation

Comments

@gabrielle-ong
Copy link
Contributor

gabrielle-ong commented Nov 29, 2024

Problem Statement

  • Currently I use the OpenAPI .json file in https://cortex.so/api-reference/
  • to import into Postman for API testing
  • Pro: helps ensure our docs are accurate
  • Con: Folder structure is messy
image

Feature Idea

@namchuai has a postman collection that looks much cleaner -
could you share your postman collection please for reference :)

Possibly separate OpenAPI json for QA
but I dont think its a good idea to manage 2 different .jsons (for QA, for docs)

@github-project-automation github-project-automation bot moved this to Investigating in Menlo Nov 29, 2024
@louis-jan louis-jan added the type: docs Improvements or additions to documentation label Dec 4, 2024
@dan-menlo dan-menlo assigned TC117 and unassigned gabrielle-ong Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvements or additions to documentation
Projects
Status: Investigating
Development

No branches or pull requests

4 participants