Phase 2.2: Deployments Methods

[Sam-Bolling]

Task

Implement all 8 Deployments methods in url_builder.ts and add Deployments method tests to url_builder.spec.ts. Deployments is the second Phase 2 resource type and follows the pattern established by Systems (Issue #5).

ROADMAP Reference: Phase 2, Task 2 — Deployments Methods (~1.5–2 hours implementation + ~0.5 hour testing, Medium complexity)

---

Files to Create or Modify

File	Action	Est. Lines	Purpose
src/ogc-api/csapi/url_builder.ts	Modify	~50–80 added	Add 8 Deployments methods with resource validation
src/ogc-api/csapi/url_builder.spec.ts	Modify	~30–40 added	Add Deployments method tests

Blueprint Reference

Follow the Systems methods pattern established in Issue #5 (same file). Also reference the EDR pattern in src/ogc-api/edr/url_builder.ts (562 lines) for resource validation, URL construction, and query parameter appending.

Scope — What to Implement

8 Deployments Methods

Each method validates resource availability (~2 lines), builds a URL using buildResourceUrl(), appends query parameters using buildQueryString(), and returns the constructed URL string.

Collection query:

• getDeployments(options?: DeploymentQueryOptions): string — GET /deployments with pagination, filtering, bbox, datetime, sorting

Single resource:

• getDeployment(id: string, options?): string — GET /deployments/{id}

CRUD operations:

• createDeployment(body: object): string — POST /deployments
• updateDeployment(id: string, body: object): string — PUT /deployments/{id}
• deleteDeployment(id: string): string — DELETE /deployments/{id}

Hierarchical navigation:

• getDeploymentSubdeployments(id: string, options?): string — GET /deployments/{id}/subdeployments (supports recursive parameter)

Association links:

• getDeploymentSystems(id: string, options?): string — GET /deployments/{id}/systems

History:

• getDeploymentHistory(id: string, options?): string — GET /deployments/{id}/history

Deployments Query Parameters

Deployments support: bbox, datetime, recursive, system, parent, id, uid, q, property filters, limit, offset, f, sortBy, sortOrder.

All parameters are serialised by the shared buildQueryString() helper (Issue #3). Temporal support: datetime only (no phenomenonTime, resultTime, executionTime, or issueTime — see Guide §6 temporal applicability matrix).

JSDoc Requirements

• Document each method with @param for all parameters, @returns description, and usage example
• Add @see links to OGC CSAPI Part 1 specification sections for Deployments endpoints
• Follow the JSDoc style in src/ogc-api/edr/url_builder.ts and the Systems methods from Issue Phase 2.1: Systems Methods #5

Testing Requirements

• Extend src/ogc-api/csapi/url_builder.spec.ts (~30–40 lines)
• Test getDeployments with collection query and individual retrieval
• Test CRUD operations (createDeployment, updateDeployment, deleteDeployment) produce correct URLs
• Test getDeploymentSubdeployments with hierarchical navigation and recursive=true
• Test temporal validity filtering (datetime parameter)
• Test resource validation — calling any Deployments method when deployments is not in availableResources throws an error
• Follow test patterns from Systems tests (Issue Phase 2.1: Systems Methods #5) and src/ogc-api/edr/url_builder.spec.ts

Scope — What NOT to Touch

• ❌ Do NOT implement Systems, Procedures, Sampling Features, Properties, DataStreams, Observations, Control Streams, or Commands methods — Systems belongs to Issue Phase 2.1: Systems Methods #5, the rest to Issues Phase 2.3: Procedures Methods #7–Phase 2.9: Commands Methods #13
• ❌ Do NOT modify model.ts — type definitions belong to Issue Phase 1.1: Create Type System (csapi/model.ts) #1
• ❌ Do NOT modify helpers.ts — helper utilities belong to Issue Phase 1.2: Create Helper Utilities (csapi/helpers.ts) #2
• ❌ Do NOT modify the constructor, buildResourceUrl(), buildQueryString(), extractAvailableResources(), or availableResources — those belong to Issue Phase 1.3: Create Stub QueryBuilder (csapi/url_builder.ts) #3
• ❌ Do NOT modify endpoint.ts, info.ts, or src/index.ts — integration belongs to Issue Phase 1.4: Integrate with OgcApiEndpoint #4
• ❌ Do NOT modify Systems methods — those belong to Issue Phase 2.1: Systems Methods #5
• ❌ Do NOT modify files outside the "Files to Create or Modify" table above
• ❌ Do NOT refactor existing code unless required to complete this task

Acceptance Criteria

• url_builder.ts contains all 8 Deployments methods listed above
• Each method validates resource availability before constructing a URL
• Each method uses buildResourceUrl() and buildQueryString() helpers
• All new methods have complete JSDoc documentation with @param, @returns, @see
• url_builder.spec.ts contains Deployments tests covering collection/individual retrieval, CRUD, subdeployments navigation, temporal filtering, and resource validation (~30–40 lines)
• Existing tests still pass (npm test)
• No lint errors

Dependencies

Blocked by: Issue #1 (Type System — provides DeploymentQueryOptions and resource types), Issue #2 (Helper Utilities — provides encoding helpers), Issue #3 (Stub QueryBuilder — provides constructor, buildResourceUrl, buildQueryString, availableResources), Issue #5 (Systems Methods — establishes the pattern this task follows)
Blocks: Issues #7–#13 (subsequent resource type methods)

---

Operational Constraints

⚠️ MANDATORY: Before starting work on this issue, review docs/governance/AI_OPERATIONAL_CONSTRAINTS.md.

Key constraints for this task:

• Precedence: OGC specifications → AI Collaboration Agreement → This issue description → Existing code → Conversational context
• No scope expansion: Do not infer unstated requirements or add unrequested features
• No refactoring: Do not rename, restructure, or "improve" code outside this issue's scope
• Minimal diffs: Prefer the smallest change that satisfies the acceptance criteria
• Ask when unclear: If intent is ambiguous, stop and ask for clarification

---

References

Read these documents before starting implementation. They are ordered by priority.

Primary References (must read)

#	Document	Section/Lines	What It Provides
1	docs/planning/csapi-implementation-guide.md	§6 Deployments Resource Methods (lines 1413–1444)	Full CRUD operations, query parameters, relationship management for Deployments
2	docs/planning/csapi-implementation-guide.md	§6 Complete Query Parameter Support (lines 1921–2000)	All query parameters with types, applicability, encoding rules
3	docs/planning/csapi-implementation-guide.md	§6 Query Parameters and Code Reuse (lines 720–900)	Parameter distribution analysis, temporal applicability matrix, buildQueryString code example
4	src/ogc-api/edr/url_builder.ts	Full file (562 lines)	Blueprint: method structure, resource validation, URL construction pattern
5	src/ogc-api/edr/url_builder.spec.ts	Full file	Blueprint: test patterns for URL builder methods
6	docs/planning/ROADMAP.md	Phase 2, Task 2 (lines 171–186)	Authoritative task definition, method list, test requirements

Upstream Type/Import References (files this task imports from)

#	Document	What to Import
7	src/ogc-api/csapi/model.ts	DeploymentQueryOptions, CSAPIResourceType (created by Issue #1)
8	src/ogc-api/csapi/helpers.ts	Encoding helpers: encodeBBox, encodeDateTime, encodeArray (created by Issue #2)

Research References (context, not required reading)

#	Document	What It Provides
9	docs/research/requirements/csapi-part1-requirements.md	Detailed client implementation requirements for Deployments including spatial/temporal queries
10	docs/research/requirements/csapi-query-parameters.md	Complete catalog of all CSAPI query parameters
11	docs/research/requirements/csapi-subresource-navigation.md	Query parameters on nested endpoints (/deployments/{id}/subdeployments?recursive=true)

Specification References (for @see links and field accuracy)

#	Document	Use
12	OGC API - Connected Systems Part 1 (23-001)	Deployments resource definitions, CRUD endpoints, query parameters
13	OGC API - Connected Systems Part 1: OpenAPI Spec	Deployments endpoint definitions — normative URL paths
14	RFC 7946 (GeoJSON)	Format for encoding Deployments with spatial extents
15	OGC API - Connected Systems Part 2 (23-002)	Context for system-deployment associations crossing Part 1/Part 2 boundary

Convention Quick Reference

Rule	Example
Use .js extension for relative imports	import { X } from './file.js'
Use import type for interfaces/types	import type { Y } from './model.js'
Three-tier hierarchy: import from lower tiers only	shared → ogc-api → csapi
Named exports for types and utilities	export interface Z { ... }
as const arrays for enum-like values	export const XTypes = [...] as const
HTTP mocking: globalThis.fetch = jest.fn()	Never use nock, msw, or other libraries
Meaningful tests only	Verify behavior, not that code runs without throwing