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: swaggerhub integration #8038

Merged
merged 4 commits into from
Oct 18, 2024
Merged

Conversation

lena-larionova
Copy link
Contributor

@lena-larionova lena-larionova commented Oct 9, 2024

Description

Service Catalog SwaggerHub integration doc.

I added a section on how to add/find the API specs tab to link specs to services, because it took me some poking around to find it. It's not standard for these integration pages yet, but I think it makes sense to add it here.

https://konghq.atlassian.net/browse/DOCU-4092

Testing instructions

Preview link:
https://deploy-preview-8038--kongdocs.netlify.app/konnect/service-catalog/integrations/
https://deploy-preview-8038--kongdocs.netlify.app/konnect/service-catalog/integrations/swaggerhub/

Checklist

@lena-larionova lena-larionova added do not merge Issues/ PRs whose changes should not be merged at this time review:copyedit Request for writer review. labels Oct 9, 2024
@lena-larionova lena-larionova requested a review from a team as a code owner October 9, 2024 22:50
Copy link

netlify bot commented Oct 9, 2024

Deploy Preview for kongdocs ready!

Name Link
🔨 Latest commit 56dde22
🔍 Latest deploy log https://app.netlify.com/sites/kongdocs/deploys/6712ac28dbc6e800081ef4d8
😎 Deploy Preview https://deploy-preview-8038--kongdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
9 paths audited
Performance: 93 (🟢 up 3 from production)
Accessibility: 92 (no change from production)
Best Practices: 98 (🟢 up 8 from production)
SEO: 91 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@cloudjumpercat cloudjumpercat self-assigned this Oct 10, 2024
Copy link
Contributor

@cloudjumpercat cloudjumpercat left a comment

Choose a reason for hiding this comment

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

Left a couple of comments! Let me know if you'd like another review.

Oh, I think it made sense where you put the instructions to map the SwaggerHub spec to the service, it is in a different spot than the other resources, so I think the instructions are helpful.

app/konnect/service-catalog/integrations/swaggerhub.md Outdated Show resolved Hide resolved
2. Select **Add API Spec**.
3. Choose SwaggerHub as the **Source**, then pick your spec and name it.

Once uploaded, you can view the rendered spec on the API Specs tab in structured, YAML, or JSON format, and download it in that format.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Once uploaded, you can view the rendered spec on the API Specs tab in structured, YAML, or JSON format, and download it in that format.
Once it's uploaded, you can view the rendered spec on the API Specs tab in structured YAML or JSON format, and download it in that format.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

"Structured" is a separate option from YAML and JSON. It's the default - it's basically the rendered UI.

Copy link
Contributor

@cloudjumpercat cloudjumpercat left a comment

Choose a reason for hiding this comment

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

Changes look good to me!

@miko-bautista miko-bautista merged commit 9cbaa17 into main Oct 18, 2024
15 checks passed
@miko-bautista miko-bautista deleted the feat/swaggerhub-integration branch October 18, 2024 18:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do not merge Issues/ PRs whose changes should not be merged at this time review:copyedit Request for writer review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants