docs: apply reviewed wiki editorial corrections
docs: improve Web SDK documentation style
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 macros
Replace bold field names with backticks across the activemacrosdetails
Response fields list, normalize period punctuation across five Notes
and Available fields bullet lists, sentence-case the Entity Operations
See also link, and add trailing periods to all three See also items.
docs: Web SDK refinements on events/alarms, macros, and reports
Three Web SDK pages refined with related improvements: privilege
documentation, streaming diagnostics, and recipient-check disambiguation.
web-sdk-events-and-alarms.md:
- Beefed up subscription-resolution NOTE with concrete polling guidance:
events delivered only after the matching entity appears in
/events/subscribed; events that occur before that resolution are not
replayed. Poll until expected entities are listed.
- New "Reconnecting after a stream closes" H3 covering session-scoped
subscription persistence and the resubscribe-then-reopen pattern.
- New Mermaid sequence diagram showing the streaming connection flow
(subscribe, redirect to streaming port, multipart event delivery,
closeconnection).
- Refactored IsRecipient vs Recipients.Contains explanation from prose
to a clear behavior table covering direct user, group-member user,
and recipient-group-itself cases.
- Added character-escaping pointer in the DynamicAlarmContent IMPORTANT
alert for context strings containing commas or parentheses.
- Tightened EventType reference one-liner to highlight the Can Raise
column in the Web SDK Reference.
- Added Content-Type guidance and clarified filename optionality on
the multipart payload example.
web-sdk-macros.md:
- New "Required privileges" section with operation-by-privilege table
(View macro properties, Execute macros, Administrator).
- Clarified StopMacro vs AbortInstance: StopMacro from /action when you
only have the execution ID; AbortInstance from /entity when you have
the macro entity and the execution ID together.
web-sdk-reports.md:
- New "Report privileges" H3 with 36-row table mapping each report type
to its required Security Center privilege. Documented the
InsufficientPrivileges failure shape.
- Added least-privilege integration recommendation.
- Clarified AlarmActivity JSON response omissions (no dynamic attached
entities, dynamic URLs, forwards, or forward recipients) and pointed
to /activealarms for richer live-state details.
docs: clean implementation-framing from wiki pages
docs: remove HR dividers and normalize See-also format across wiki
Remove 141 standalone horizontal-rule dividers used for visual section
separation (PUNCT-04) from 9 pages: web-sdk-reports (56), gwp-developer-
guide (39), web-sdk-reference (19), web-sdk-actions (8), web-sdk-
troubleshooting (7), web-sdk-under-the-hood (7), web-sdk-system-endpoints
(2), platform-sdk-report-manager-query-reference (2), platform-sdk-
report-manager (1). Proper heading hierarchy already separates the
sections in every case.
Normalize 103 See-also entries to the LINK-09 colon format across 27
pages. The page audit at the start of the session showed entries mixed
three formats: bold+dash ("- **[X](y)** - desc"), plain-dash
("- [X](y) - desc"), and colon ("- [X](y): desc"). This commit rewrites
all three to the colon form; bare links with no description are left
alone.
Some files in this commit carry bundled pre-existing working-tree
changes from an earlier cleanup pass (**Label:** bold-pseudo-header
flattening, Title Case to sentence case, etc.) that were already
uncommitted when this session started.
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: commit previously applied audit fixes for 4 web sdk guides
- web-sdk-custom-card-formats: add unique name note, correct error messages, remove speculative export guidance
- web-sdk-macros: fix draft compilation timing description
- web-sdk-referencing-entities: fix custom field case sensitivity, correct credential format parameter names
- web-sdk-system-endpoints: narrow ignoreremoteexception scope, clarify suppression behavior
docs: audit and expand web sdk macros and custom entity types guides
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