docs: apply reviewed wiki editorial corrections
docs: clarify Web SDK wording and custom event reporting
docs: clarify Web SDK custom formats and field limits
docs: refine Web SDK requests and behavior guidance
docs: correct Web SDK reference and usage guidance
docs: standardize See also descriptions across remaining families
Adopt the canonical-summary pattern across the GWP, Macro SDK, Media
Gateway, and Web SDK pages whose See also sections were touched in
earlier commits this session. Same change previously applied to
Plugin SDK (af4ddd7), Platform SDK (a32f681), and Media SDK (28361b5).
Canonical descriptions used for cross-referenced targets:
- gwp-developer-guide: Embedding the Genetec Web Player in browser-based applications.
- gwp-api-reference: Genetec Web Player API reference (TypeScript definitions and methods).
- gwp-sample-application: Single-player GWP sample with playback, PTZ, and dewarping controls.
- gwp-multiplexing-sample: Multi-camera GWP grid sharing one WebSocket connection.
- media-gateway-developer-guide: RTSP and HTTP video streaming through the Media Gateway role.
- macro-sdk-developer-guide: Writing macro C# code with the Macro SDK.
- web-sdk-overview: Web SDK conceptual model, architecture, and session lifecycle.
- web-sdk-getting-started: Authentication, your first API call, and Web SDK role setup.
- web-sdk-reference: Well-known GUIDs, card format identifiers, and enumerations.
- web-sdk-entity-operations: The /entity endpoint and shared q= query syntax.
- web-sdk-referencing-entities: Entity discovery, search, and parameter formats.
- web-sdk-reports: The /report endpoint and report query filters.
- web-sdk-actions: The /action endpoint and operational commands.
- web-sdk-events-and-alarms: Event subscriptions, real-time streaming, and alarm operations.
- web-sdk-custom-fields: Custom entity properties.
- web-sdk-performance-guide: Optimizing Web SDK performance.
- web-sdk-troubleshooting: Diagnosing common Web SDK issues.
- web-sdk-under-the-hood: How q= requests are interpreted and route limitations.
- Postman Collection: Ready-to-use example requests for Web SDK endpoints.
docs(web-sdk): style sweep on custom entity types
Replace bold JSON field names with backticks across the Response
fields list (25 occurrences), add periods to full-sentence top-level
bullets, replace e.g. with for example in three nested bullets, drop
the solo Successful response H3 in favor of a prose intro, and add a
See also section linking to entity operations and referencing entities.
Document customCardFormats privilege and expand Capabilities flag list
- web-sdk-custom-card-formats.md: add an IMPORTANT alert noting that all
/customCardFormats routes require the General settings privilege in the
Access control task.
- web-sdk-custom-entity-types.md: expand the Capabilities field
documentation from a single inline sentence to a bulleted list with a
one-line description per flag (None, CreateDelete, MapSupport,
CanBeFederated, IsVisible, MaintenanceMode, HasRunningState). Also
clarify that these descriptor flags describe product behavior and UI
support, not Web SDK privilege checks.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
docs: systemic style cleanup across Web SDK pages
Batch 3 of 5. Same mechanical style fixes. No content rewrites.
Files: web-sdk-custom-entity-types, web-sdk-events-and-alarms,
web-sdk-getting-started, web-sdk-tasks, web-sdk-users.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
docs: apply web sdk audit correction pass
Addresses findings across all 20 reader-facing web-sdk-*.md guides:
- Correct factual claims confirmed wrong through runtime testing
- Tighten incomplete sections where source and runtime evidence
support a more accurate or complete statement
- Fix response envelope, endpoint scope, and privilege-related prose
- Add concrete runtime-verified examples where the existing text
left the reader to infer the request shape
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
docs: normalize unordered list markers to dashes
docs: fix custom entity types - negative event IDs, admin prerequisite
- Note that SupportedCustomEvents returns negative integers
- Add administrator requirement for deleting custom entity type descriptors
docs: audit and expand web sdk macros and custom entity types guides
docs: add custom entity configuration coverage
docs: add Web SDK endpoint pages for tasks, macros, custom entity types, and system endpoints
New pages documenting previously undocumented Web SDK endpoints:
- web-sdk-tasks.md: saved task listing and execution
- web-sdk-macros.md: running macro monitoring
- web-sdk-custom-entity-types.md: custom entity type CRUD
- web-sdk-system-endpoints.md: license usage, web tokens, exception handling