[WAAP] API tabs#2191
Open
kostichs wants to merge 69 commits into
Open
Conversation
Adds MethodSwitch with Portal and REST API tabs to waf-and-owasp-top-threats.mdx. API tab covers view policy states and toggle individual policies with Python SDK, Go SDK, and curl examples based on live-tested responses. Policy reference accordion includes Purpose, ID, and default state columns. Updates api-use-case skill with standalone tab test in Phase 7 review.
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…nse-pages
Article 13 (configure-api-base-path.mdx):
- Add REST API tab via MethodSwitch/MethodSection
- Cover GET/PATCH /waap/v1/domains/{id}/settings (api.is_api + api_urls)
- Sections: View current configuration, Configure API paths, Set domain as API
- Warning block for api_urls full-list replacement behavior
- Explain is_api storage/priority behavior
- Replace screenshots with updated portal UI images
- Python SDK, Go SDK, curl examples (live-tested)
Article 12 (manage-custom-response-pages.mdx):
- Remove domains= from List page sets print output
- Clarify Assign to domains: list replaces all existing assignments
- Simplify Update page content description
Replace "A permanent [API token]" with "An [API token]" in six articles: articles 7, 9, 10, 11, 12, 13 (advanced-api-protection, configure-waap, manage-domains, create-custom-response-pages, manage-custom-response-pages, configure-api-base-path). Also fix absolute URL to relative path in configure-api-base-path. Update style-guide.md to reflect correct phrasing.
Convert access-control.mdx to a conceptual overview linking to dedicated articles. Create ip-allowlist-and-blocklist.mdx with Portal and API tabs. Portal tab: Add/Edit/Delete procedures for Allowed IPs and Blocked IPs with screenshots. API tab: full CRUD via curl, Python SDK, Go SDK (List, Create, Update, Toggle, Delete). Update docs.json to include new article in Firewall navigation group.
Wrap existing portal content in MethodSwitch. Add REST API tab: list, create, update, enable/disable, delete (single + bulk). All operations verified against live API. Action/condition reference in Accordion for standalone tab compliance. Fix broken link: access-control -> ip-allowlist-and-blocklist. Update WAAP-API-TABS-STATUS.md.
Add Python SDK and Go SDK tabs to all existing curl examples. Add missing List, Update, Enable/disable, Delete sections. All operations verified against live API. No MethodSwitch (API-only feature, no portal create workflow). Update WAAP-API-TABS-STATUS.md.
Add Python SDK and Go SDK tabs to all 7 existing curl examples. All rate-limit CEL variants verified against live API: cookie exclusions, ip_list, additional conditions, complex URL regex, ip_in_range, cluster scope with method/status/content_type filters, tag filter. Add env vars block and link to parent article for CRUD operations. Update WAAP-API-TABS-STATUS.md.
Wrap existing Portal content in MethodSwitch/MethodSection Fix MDX: numbered steps, prose in p tags, curly brace in inline code Add REST API tab: List/Add/Update/Delete API paths, View/Update scan settings All six operations tested live: POST 201, PATCH 204, DELETE 204, GET 200 path_id is UUID string; correct endpoint is /api-paths (not /api-discovery/paths) PATCH settings returns partial response (only updated fields) trafficScanIntervalHours max 24; manually-added paths get CONFIRMED_API by default Python SDK + Go SDK + curl tabs for all operations Update status file: dashboard.mdx and ddos-protection.mdx marked no API tab needed
Wrap Portal content in MethodSwitch/MethodSection with p tags
Add REST API tab: Update insight status (ACKED/CLOSED/OPEN), Create silence rule
PUT /insights/{id} -> 200 + insight object
POST /insight-silences -> 201 + silence object; DELETE silence -> 204
insight_type uses slug format (allowed-high-risk-ip, attack-on-disabled-policy)
labels={} silences full type; labels={ip:...} targets specific entity
expire_at null = indefinite; ISO 8601 = time-limited
Go SDK: DomainInsightReplaceParamsStatus enum; gcore.Time() for expiry
Cross-linked manage-silence-rules for silence CRUD
Link 'IP details' in existing sentence to WAAP API reference (IP Spotlight section) No new sentences added - organic inline link only
Add MethodSwitch with Customer Portal and REST API sections. API section covers three operations (list, update, delete) for insight silence rules with Python SDK, Go SDK, and curl examples. All operations verified live against the API. Updates WAAP-API-TABS-STATUS.md: article #21 marked OK.
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
1 participant
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.
Adds MethodSwitch with Portal and REST API tabs to waf-and-owasp-top-threats.mdx. API tab covers view policy states and toggle individual policies with Python SDK, Go SDK, and curl examples based on live-tested responses. Policy reference accordion includes Purpose, ID, and default state columns. Updates api-use-case skill with standalone tab test in Phase 7 review.