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: Generate basic code snippets #2387

Merged
merged 32 commits into from
May 30, 2022
Merged

feat: Generate basic code snippets #2387

merged 32 commits into from
May 30, 2022

Conversation

taban03
Copy link
Contributor

@taban03 taban03 commented May 25, 2022

Description

  1. Upgrade of the swagger-ui-react library to major version
  2. Introduce new npm package openapi-snippet
  3. Enable the filter functionality to search APIs via tag (can be extended to filter by other criteria by customising plugin as part of the As a modern programmer I want to easily find the APIs relevant to my work #2253 )
  4. Add basic code snippets generator and embed it into the Swagger UI

Linked to #2377

Type of change

Please delete options that are not relevant.

  • (feat) New feature (non-breaking change which adds functionality)
  • (docs) Change in a documentation

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas. In JS I did provide JSDoc
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • The java tests in the area I was working on leverage @nested annotations
  • Any dependent changes have been merged and published in downstream modules

For more details about how should the code look like read the Contributing guideline

taban03 added 12 commits May 13, 2022 15:45
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
taban03 and others added 17 commits May 25, 2022 12:08
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
Signed-off-by: at670475 <[email protected]>
@sonarcloud
Copy link

sonarcloud bot commented May 30, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

82.4% 82.4% Coverage
0.0% 0.0% Duplication

@taban03 taban03 merged commit 79c67d0 into v2.x.x May 30, 2022
@delete-merged-branch delete-merged-branch bot deleted the apiml/GH2273/snippet_gen branch May 30, 2022 10:08
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.

2 participants