Fix sapi docs - #1123
Open
buixor wants to merge 6 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
🟡 Not ready to approve
The new allowlists documentation contains multiple copy/paste issues (wrong variable, wrong placeholder URL, inconsistent Redoc host, and an unused variable) and one troubleshooting reference link has a syntax error that can break rendering.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
This PR updates the Service API documentation structure by flattening former quickstart/<resource> pages into dedicated service_api/<resource> docs, updating internal references accordingly, and extending the Service API docs with additional endpoints coverage.
Changes:
- Flatten Service API docs (remove
quickstart/*pages, update sidebars, add redirects). - Update many docs pages to point to the new Service API doc URLs/anchors.
- Add/expand Service API docs pages (authentication, blocklists, allowlists, decisions) and enhance metrics/integrations docs.
File summaries
| File | Description |
|---|---|
| crowdsec-docs/unversioned/troubleshooting/usecases.mdx | Updates Service API links in references (now pointing to flattened pages). |
| crowdsec-docs/unversioned/integrations/sophos.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/integrations/rawiplist.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/integrations/pfsense.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/integrations/paloalto.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/integrations/opnsense.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/integrations/mikrotik.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/integrations/juniper.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/integrations/intro.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/integrations/fortinet.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/integrations/f5.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/integrations/cisco.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/integrations/checkpoint.mdx | Updates pagination doc link to new Service API integrations page. |
| crowdsec-docs/unversioned/console/service_api/quickstart/integrations.mdx | Removes legacy quickstart integrations page (flattening). |
| crowdsec-docs/unversioned/console/service_api/quickstart/blocklists.mdx | Removes legacy quickstart blocklists page (flattening). |
| crowdsec-docs/unversioned/console/service_api/metrics.mdx | Adds a new section describing server-side scoping filters for metrics. |
| crowdsec-docs/unversioned/console/service_api/integrations.mdx | Expands/modernizes integrations doc (creation, fetching content, pagination, supported formats). |
| crowdsec-docs/unversioned/console/service_api/decisions.mdx | Adds new Service API decisions documentation page. |
| crowdsec-docs/unversioned/console/service_api/blocklists.mdx | Adds new flattened blocklists documentation page (replacing older content). |
| crowdsec-docs/unversioned/console/service_api/blocklists.md | Removes older blocklists doc in favor of the new MDX page. |
| crowdsec-docs/unversioned/console/service_api/authentication.mdx | Adds new flattened authentication documentation page. |
| crowdsec-docs/unversioned/console/service_api/allowlists.mdx | Adds new flattened allowlists documentation page. |
| crowdsec-docs/sidebarsUnversioned.ts | Updates sidebar to reference flattened Service API pages and adds decisions entry. |
| crowdsec-docs/docusaurus.config.ts | Adds redirects from old quickstart Service API URLs to the new flattened URLs. |
Review details
- Files reviewed: 22/24 changed files
- Comments generated: 0
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
|
This pull request is automatically being deployed by Amplify Hosting (learn more). |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.