Skip to content

LM swagger missing standard query params on multiple endpoints #47

@rdmarsh

Description

@rdmarsh

The LM Swagger spec is missing standard query parameters on many endpoints. The API accepts these parameters and returns correct results — they are just not declared in the spec.

elm works around these gaps via swagger.undocumented.json so the generated CLI flags are correct. This issue tracks the upstream gaps for reference and to inform future make init cleanup if LM ever fixes the spec.

Universal gaps

These parameters are accepted by every GET endpoint but declared on none of them in the swagger:

Parameter Type Notes
fields string Comma-separated field selection
sort string [+,-]FIELD,... sort order

List endpoints missing size, offset, filter

These list endpoints accept pagination and filtering but do not declare the params:

elm command API path Missing params
PortalInfo GET /setting/companySetting fields
IntegrationList GET /setting/integrations fields, size, offset, filter
DeviceEventsourceList GET /device/devices/{deviceId}/deviceeventsources size, offset, filter
DiagnosticSourcesList GET /setting/diagnosticsources size, offset, filter
JobMonitorList GET /setting/batchjobs size, offset, filter
LogAlertGroupsList GET /logpipelines size, offset, filter
LogQueryGroupList GET /log/logquerygroups size, offset, filter
LogSourceList GET /setting/logsources size, offset, filter
OIDList GET /setting/oids size, offset, filter
RemediationSourcesList GET /setting/remediationsources size, offset, filter
RetentionList GET /log/partitions/retentions size, offset, filter
TopologySourceList GET /setting/topologysources size, offset, filter
TrackedQueryGroupList GET /trackedquerygroups size, offset, filter

Workaround

swagger.undocumented.json in this repo adds the missing declarations. These override the official swagger during make init so the generated CLI flags are complete.

Should be raised with LogicMonitor support to fix the official swagger spec.

Metadata

Metadata

Assignees

No one assigned

    Labels

    upstream-bugBug in an upstream dependency (LM API, etc.) — should be raised with vendor

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions