Skip to content

Phase 4, Task 3: API Documentation #32

@Sam-Bolling

Description

@Sam-Bolling

Phase 4, Task 3: API Documentation\n\nCompleted in commit ccd646a.\n\n### Changes\n- endpoint.ts: Enhanced JSDoc for csapiCollections, hasConnectedSystems, and csapi() factory with @example blocks, descriptive paragraphs, and @see cross-references\n- url_builder.ts: Enriched class-level JSDoc with migration guide (before/after), error handling patterns, and a complete workflow @example\n- model.ts: Added 24 section-specific OGC spec @see links to all query option interfaces, resource interfaces, collection types, and constants\n- swecommon/types.ts: Added OGC SWE Common 3.0 spec section references (§7.2, §7.4, §7.5, §8)\n- src/index.ts: Exported ~80+ CSAPI types for full TypeDoc coverage (SensorML processes, SWE Common scalars/ranges/encodings, parser functions)\n- navigation.spec.ts: Fixed TS2352 type assertion for TypeDoc build compatibility\n\n### Verification\n- TypeDoc build succeeds with all CSAPI types appearing in api.json\n- All CSAPI test suites pass (0 regressions)\n- No lint errors in any modified file"

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions