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(api-hub): adjust ms build to generate swagger file #1030

Merged
merged 13 commits into from
Sep 27, 2024
Merged

feat(api-hub): adjust ms build to generate swagger file #1030

merged 13 commits into from
Sep 27, 2024

Conversation

Phil91
Copy link
Member

@Phil91 Phil91 commented Sep 23, 2024 •
edited
Loading

Description

  • update the swagger nuget package to be able to create the swagger documentation while building the project
  • adjust ms build processes to generate an openApi file and copy it to the docs/api folder

Why

To align with TRG 1.08

Issue

Refs: #1021

Checklist

  • I have followed the contributing guidelines
  • I have performed IP checks for added or updated 3rd party libraries
  • I have created and linked IP issues or requested their creation by a committer
  • I have performed a self-review of my own code
  • I have successfully tested my changes locally
  • I have added tests that prove my changes work
  • I have checked that new and existing tests pass locally with my changes
  • I have commented my code, particularly in hard-to-understand areas

@Phil91 Phil91 marked this pull request as draft September 23, 2024 12:16
@Phil91 Phil91 changed the title build: update swagger package feat(openApi): adjust ms build to generate swagger file Sep 23, 2024
@Phil91 Phil91 marked this pull request as ready for review September 23, 2024 13:14
@Phil91 Phil91 requested a review from evegufy September 23, 2024 13:14
@Phil91 Phil91 marked this pull request as draft September 23, 2024 13:15
@Phil91 Phil91 requested a review from evegufy September 23, 2024 16:10
@Phil91 Phil91 marked this pull request as ready for review September 23, 2024 16:10
@evegufy evegufy mentioned this pull request Sep 24, 2024
Merged
2 tasks
evegufy
evegufy requested changes Sep 24, 2024
View reviewed changes
Copy link
Contributor

@evegufy evegufy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Build is failing, maybe due to the implementation of the skip config validation

.tractusx Outdated Show resolved Hide resolved
evegufy
evegufy requested changes Sep 25, 2024
View reviewed changes
.tractusx Outdated Show resolved Hide resolved
@Phil91 Phil91 requested a review from evegufy September 25, 2024 07:55
This was referenced Sep 25, 2024
Closed
Merged
evegufy
evegufy requested changes Sep 25, 2024
View reviewed changes
.tractusx Outdated Show resolved Hide resolved
@Phil91 Phil91 requested a review from evegufy September 25, 2024 13:28
evegufy
evegufy previously approved these changes Sep 25, 2024
View reviewed changes
This was referenced Sep 26, 2024
Merged
Merged
@evegufy evegufy changed the title feat(openApi): adjust ms build to generate swagger file feat(api-hub): adjust ms build to generate swagger file Sep 26, 2024
ntruchsess
ntruchsess previously approved these changes Sep 26, 2024
View reviewed changes
Phil91 and others added 13 commits September 26, 2024 20:42
@Phil91 @ntruchsess
feat: adjust ms build to generate swagger file
1b7eb5b 
adjust ms build processes to generate open api file for web service projects

Refs: #1021
@Phil91 @ntruchsess
feat: add prefix to api version
4dc8575 
Refs: #1021
@Phil91 @ntruchsess
feat: skip validation for specific environments
c907184 
Refs: #1021
@Phil91 @ntruchsess
feat: add documentation for open api generation
20ce894 
Refs: #1021
@Phil91 @ntruchsess
feat: adjust environment variable to skip validation
886faf3 
Refs: #1021
@Phil91 @ntruchsess
docs: adjust documentation
2bad4dc 
Refs: #1021
@Phil91 @ntruchsess
tests: fix unit tests
9fdcdbe 
Refs: #1021
@Phil91 @ntruchsess
chore: adjust version for openApiSpecs
1560011 
Refs: #1021
@Phil91 @ntruchsess
feat: adjust open api file naming
915582e 
Refs: #1021
@ntruchsess
cleanup
be9e7a7
@Phil91 @ntruchsess
fix: adjust jwtbearer option validation
1f3d5d0 
Refs: #1021
@ntruchsess
fix startup-validation not terminating at circular nested type depend…
d3b51a7 
…encies
@ntruchsess
update framework version
d61d8ea
@sonarcloud SonarCloud
Copy link

sonarcloud bot commented Sep 26, 2024

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

@Phil91 Phil91 merged commit 67cc761 into main Sep 27, 2024
11 checks passed
@Phil91 Phil91 deleted the feature/1021-api-hub branch September 27, 2024 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ntruchsess ntruchsess ntruchsess approved these changes

@evegufy evegufy evegufy approved these changes

Assignees
No one assigned
Labels
None yet
Projects
Portal
Status: USER READY
Milestone
Release 24.12
Development

Successfully merging this pull request may close these issues.
3 participants
@Phil91 @ntruchsess @evegufy