Pm/swagger UI lib #151

PatrikMatiasko · 2024-04-11T09:02:24Z

Summary by CodeRabbit

Documentation
- Updated metadata for categories and keywords across various API documents to improve clarity and searchability.
- Introduced swaggerUrl fields in multiple API documents for direct access to Swagger definitions.
- Adjusted iframe shortcode syntax and formatting in several documents for better presentation.
- Removed iframe elements where necessary to streamline content.

coderabbitai · 2024-04-11T09:02:35Z

Walkthrough

The recent updates involve refining metadata and formatting across various API documentation files. Changes include adjusting spacing in categories and keywords, introducing swaggerUrl for direct API references, and updating iframe syntax. A theme subproject update also contributes to enhancing overall documentation consistency and accessibility.

Changes

Files	Change Summary
`.../control-plane/grpc-api.md` `.../services/certificate-authority/grpc-api.md` `.../services/grpc-gateway/grpc-api.md`	Adjusted spacing in categories and keywords; updated iframe syntax.
`.../control-plane/http-api.md` `.../services/coap-gateway/coap-api.md` `.../services/http-gateway/http-api.md`	Updated metadata fields and added `swaggerUrl`; removed iframe content.
`.../services/certificate-authority/http-api.md`	Removed iframe; added `swaggerUrl`.
`themes/plgd`	Updated the subproject commit reference.

🐇✨
A hop of code, a leap of text,
Changes made, what comes next?
Metadata tweaked, with URLs neat,
In docs we trust, updates complete!
🌟📄

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 930e573 and f4928ae.

Files selected for processing (3)

content/en/docs/features/control-plane/grpc-api.md (1 hunks)
content/en/docs/services/certificate-authority/grpc-api.md (1 hunks)
content/en/docs/services/grpc-gateway/grpc-api.md (1 hunks)

Additional comments not posted (6)

content/en/docs/features/control-plane/grpc-api.md (2)

5-6: Metadata formatting looks good and improves readability.

Line range hint 10-10: Ensure there is a space after the URL before the closing tag for proper syntax. Also, verify that the iframe syntax is split across lines as intended.

content/en/docs/services/grpc-gateway/grpc-api.md (2)

5-6: Metadata formatting looks good and improves readability.

Line range hint 10-10: Ensure there is a space after the URL before the closing tag for proper syntax. Also, verify that the iframe syntax is split across lines as intended.

content/en/docs/services/certificate-authority/grpc-api.md (2)

5-6: Metadata formatting looks good and improves readability.

Line range hint 10-10: Ensure there is a space after the URL before the closing tag for proper syntax. Also, verify that the iframe syntax is split across lines as intended.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

netlify · 2024-04-11T09:02:40Z

✅ Deploy Preview for docsplgd ready!

Name	Link
🔨 Latest commit	`f4928ae`
🔍 Latest deploy log	https://app.netlify.com/sites/docsplgd/deploys/66184e0753468900081546cf
😎 Deploy Preview	https://deploy-preview-151--docsplgd.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

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

coderabbitai

Actionable comments posted: 1

coderabbitai · 2024-04-11T09:05:41Z

content/en/docs/features/control-plane/grpc-api.md

+{{<
+iframe "<https://htmlpreview.github.io/?https://github.com/plgd-dev/hub/blob/main/grpc-gateway/pb/doc.html#grpcgateway.pb.GrpcGateway>" >}}


The updated iframe syntax improves readability and maintainability of the document. However, ensure there is a space after the URL before the closing tag for proper syntax.

- {{< iframe "<https://htmlpreview.github.io/?https://github.com/plgd-dev/hub/blob/main/grpc-gateway/pb/doc.html#grpcgateway.pb.GrpcGateway>" >}} + {{< iframe "<https://htmlpreview.github.io/?https://github.com/plgd-dev/hub/blob/main/grpc-gateway/pb/doc.html#grpcgateway.pb.GrpcGateway> " }}

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

{{<

iframe "<https://htmlpreview.github.io/?https://github.com/plgd-dev/hub/blob/main/grpc-gateway/pb/doc.html#grpcgateway.pb.GrpcGateway>" >}}

{{< iframe "<https://htmlpreview.github.io/?https://github.com/plgd-dev/hub/blob/main/grpc-gateway/pb/doc.html#grpcgateway.pb.GrpcGateway> " }}

jkralik

Just fix the linter :)

sonarqubecloud · 2024-04-11T20:59:07Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

PatrikMatiasko added 4 commits April 10, 2024 22:30

Swagger ui

5c10052

Swagger ui

c229ad1

Swagger ui

2b43c78

iframe fix url

7130a70

PatrikMatiasko requested a review from jkralik April 11, 2024 09:02

coderabbitai bot reviewed Apr 11, 2024

View reviewed changes

jkralik approved these changes Apr 11, 2024

View reviewed changes

PatrikMatiasko added 5 commits April 11, 2024 22:07

Eslint fix

909da4d

Switch to main branch

bdbdc55

Eslint fix

930e573

md format fix

b15a4fd

md format fix

f4928ae

PatrikMatiasko merged commit 89dae91 into main Apr 11, 2024
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Pm/swagger UI lib #151

Pm/swagger UI lib #151

PatrikMatiasko commented Apr 11, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 11, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

netlify bot commented Apr 11, 2024 •

edited

Loading

coderabbitai bot left a comment

coderabbitai bot Apr 11, 2024

jkralik left a comment

sonarqubecloud bot commented Apr 11, 2024

		{{<
		iframe "<https://htmlpreview.github.io/?https://github.com/plgd-dev/hub/blob/main/grpc-gateway/pb/doc.html#grpcgateway.pb.GrpcGateway>" >}}

	{{<
	iframe "<https://htmlpreview.github.io/?https://github.com/plgd-dev/hub/blob/main/grpc-gateway/pb/doc.html#grpcgateway.pb.GrpcGateway>" >}}
	{{< iframe "<https://htmlpreview.github.io/?https://github.com/plgd-dev/hub/blob/main/grpc-gateway/pb/doc.html#grpcgateway.pb.GrpcGateway> " }}

Pm/swagger UI lib #151

Pm/swagger UI lib #151

Conversation

PatrikMatiasko commented Apr 11, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Apr 11, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

netlify bot commented Apr 11, 2024 • edited Loading

✅ Deploy Preview for docsplgd ready!

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot Apr 11, 2024

Choose a reason for hiding this comment

jkralik left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Apr 11, 2024

Quality Gate passed

PatrikMatiasko commented Apr 11, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 11, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

netlify bot commented Apr 11, 2024 •

edited

Loading