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

EDC API Wrapper: SwaggerUI in dev #186

Open
7 tasks
Tracked by #181
richardtreier opened this issue Mar 15, 2023 · 0 comments
Open
7 tasks
Tracked by #181

EDC API Wrapper: SwaggerUI in dev #186

richardtreier opened this issue Mar 15, 2023 · 0 comments
Labels
component/api-wrapper Impacts the API-wrapper API. component/edc-ce affected software component kind/enhancement New feature or request

Comments

@richardtreier
Copy link
Collaborator

richardtreier commented Mar 15, 2023

Feature

Description

We'd like to serve a bit more than just the technical openapi.yaml in our EDC so customers may explore the API in an interactive way.

While the SwaggerUI might be the simplest, a good Postman Collection might replace it.

Potential Solutions

  • Serve OpenApi Yaml as endpoint
  • Swagger UI might be easier:
    • Serve a Swagger UI in DEV that simply shows our OpenAPI YAML.
  • Postman might be better, but would have to be manually kept:
    • Our customers like to use Postman collections instead of the Swagger UI
    • Check if it is possible to serve a postman collection instead of an OpenAPI YAML file.
    • Postman collections might be better built by humans. Check if we need one.
@richardtreier richardtreier changed the title EDC API Wrapper SwaggerUI in dev EDC API Wrapper: SwaggerUI in dev Mar 15, 2023
@tmberthold tmberthold added the component/api-wrapper Impacts the API-wrapper API. label Mar 27, 2023
@SebastianOpriel SebastianOpriel added kind/enhancement New feature or request area/api-wrapper and removed enhancement component/api-wrapper Impacts the API-wrapper API. labels Apr 18, 2023
@richardtreier richardtreier added the status/blocked/needs-product requires input from product owner label Aug 31, 2023
@AbdullahMuk AbdullahMuk added the clean-backlog requires backlog cleaning label May 2, 2024
@tmberthold tmberthold removed their assignment May 2, 2024
@tmberthold tmberthold removed the clean-backlog requires backlog cleaning label May 2, 2024
@SebastianOpriel SebastianOpriel added component/edc-ce affected software component component/api-wrapper Impacts the API-wrapper API. and removed status/blocked/needs-product requires input from product owner labels Nov 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/api-wrapper Impacts the API-wrapper API. component/edc-ce affected software component kind/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

5 participants