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

feat: Add generating OpenApi yamls for the admin api (DEV-1812) #2983

Merged
merged 6 commits into from Jan 9, 2024

Conversation

seakayone
Copy link
Collaborator

@seakayone seakayone commented Jan 9, 2024

Pull Request Checklist

Task Description/Number

For now the open api documentation is only generated on demand by calling just dog.

This should enable @BalduinLandolt and @mpro7 to integrate their newly migrated endpoints, so that in future we are able to:

  1. Integrate all endpoints in the api
  2. Create a new /docs endpoint in the dsp-api akin to the dsp-ingest

PR Type

  • build/chore: maintenance tasks (no production code change)
  • docs: documentation changes (no production code change)
  • feat: represents new features
  • fix: represents bug fixes
  • perf: performance improvements
  • refactor: represents production code refactoring
  • test: adding or refactoring tests (no production code change)

Basic requirements for bug fixes and features

  • Tests for the changes have been added
  • Docs have been added / updated

Does this PR introduce a breaking change?

  • Yes

Does this PR change client-test-data?

  • Yes

@seakayone seakayone self-assigned this Jan 9, 2024
@seakayone seakayone requested review from mpro7 and BalduinLandolt and removed request for mpro7 January 9, 2024 12:34
@seakayone seakayone marked this pull request as ready for review January 9, 2024 12:35
Copy link

codecov bot commented Jan 9, 2024

Codecov Report

Attention: 5 lines in your changes are missing coverage. Please review.

Comparison is base (eac5751) 11.74% compared to head (06302ff) 88.45%.
Report is 11 commits behind head on main.

Files Patch % Lines
webapi/src/main/scala/dsp/valueobjects/User.scala 64.28% 5 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main    #2983       +/-   ##
===========================================
+ Coverage   11.74%   88.45%   +76.71%     
===========================================
  Files         246      253        +7     
  Lines       22907    23015      +108     
===========================================
+ Hits         2690    20359    +17669     
+ Misses      20217     2656    -17561     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@seakayone seakayone merged commit 503b742 into main Jan 9, 2024
12 of 13 checks passed
@seakayone seakayone deleted the feat/add-openapi-yml-generation branch January 9, 2024 15:00
@seakayone seakayone changed the title feat: Add generating OpenApi yamls for the admin api feat: Add generating OpenApi yamls for the admin api (DEV-1812) Jan 9, 2024
Copy link

linear bot commented Jan 9, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants