Skip to content

OpsWeave — OpenAPI Spec Gaps

AUDIT-FIX: L-10 — Endpoints present in the codebase but missing or outdated in docs/api/openapi.yaml.

Spec version: 0.3.2 (Tags updated, individual endpoint definitions still pending)


Missing Endpoints

Tickets

MethodPathNotes
GET/api/v1/tickets/stats/timelineAdded post-spec
GET/api/v1/tickets/stats/by-customerAdded post-spec
GET/api/v1/tickets/categoriesCategory CRUD
POST/api/v1/tickets/categoriesCategory CRUD
PUT/api/v1/tickets/categories/{id}Category CRUD
DELETE/api/v1/tickets/categories/{id}Category CRUD
PATCH/api/v1/tickets/{id}/archiveArchive endpoint
GET/api/v1/tickets/{id}/childrenParent/child tickets

Assets

MethodPathNotes
GET/api/v1/assets/graphFull CMDB graph

Workflows

MethodPathNotes
POST/api/v1/workflows/templates/{id}/stepsStep management
DELETE/api/v1/workflows/templates/{id}/steps/{sid}Step management
PUT/api/v1/workflows/templates/{id}/steps/reorderStep reordering
GET/api/v1/workflows/templates/{id}/instancesTemplate instances
GET/api/v1/workflows/ticket/{ticketId}Get workflow for ticket

Compliance

MethodPathNotes
PUT/api/v1/compliance/requirements/{rid}Requirement update
DELETE/api/v1/compliance/requirements/{rid}Requirement delete
POST/api/v1/compliance/requirements/{rid}/mappings/{sid}Mapping CRUD
DELETE/api/v1/compliance/requirements/{rid}/mappings/{sid}Mapping CRUD
GET/api/v1/compliance/frameworks/{id}/assetsAsset flags
POST/api/v1/compliance/frameworks/{id}/assetsAsset flags
DELETE/api/v1/compliance/frameworks/{id}/assets/{aid}Asset flags

Service Catalog

MethodPathNotes
DELETE/api/v1/services/catalogs/vertical/{id}Vertical catalog delete
POST/api/v1/services/catalogs/vertical/{id}/overridesOverride management
DELETE/api/v1/services/catalogs/vertical/{id}/overrides/{oid}Override management

SLA (entire module missing from spec)

MethodPathNotes
GET/api/v1/sla/definitionsSLA definition CRUD
GET/api/v1/sla/definitions/{id}
POST/api/v1/sla/definitions
PUT/api/v1/sla/definitions/{id}
DELETE/api/v1/sla/definitions/{id}
GET/api/v1/sla/assignmentsSLA assignment CRUD
POST/api/v1/sla/assignments
DELETE/api/v1/sla/assignments/{id}
GET/api/v1/sla/resolveSLA resolution helper

Settings

MethodPathNotes
GET/api/v1/settings/runtimeRuntime config
DELETE/api/v1/settings/{key}Setting deletion

License

MethodPathNotes
DELETE/api/v1/licenseLicense deactivation

Customers

MethodPathNotes
GET/api/v1/customers/{id}/overviewCustomer overview

Endpoints in Spec but Not Implemented

MethodPathNotes
POST/api/v1/auth/refreshToken refresh not implemented (stateless JWT)
GET/api/v1/auth/oidc/loginOIDC not yet implemented (Phase 6)
GET/api/v1/auth/oidc/callbackOIDC not yet implemented (Phase 6)
GET/api/v1/assets/searchMerged into GET /assets with q param
GET/api/v1/assets/typesNot implemented as separate endpoint
POST/api/v1/workflows/instances/{id}/steps/{sid}/routeNot implemented
GET/api/v1/compliance/frameworks/{id}/gapsNot implemented
GET/PUT/api/v1/settings/brandingNot implemented as separate endpoint
GET/api/v1/kb/articles/searchMerged into GET /kb/articles with q param
GET/api/v1/kb/categoriesNot implemented as separate endpoint
GET/POST/api/v1/monitoring/sourcesMonitoring module not implemented
PUT/api/v1/monitoring/sources/{id}Monitoring module not implemented
POST/GET/api/v1/monitoring/eventsMonitoring module not implemented

Recommendation

  1. Bump spec version to 0.2.0 to match codebase
  2. Add all missing endpoints listed above
  3. Remove or mark as x-not-implemented the endpoints not yet built
  4. Run npm run generate-api-docs after updating (if script is functional)

Released under the AGPL-3.0 License.