influxdata / openapi

An OpenAPI specification for influx (cloud/oss) apis.
MIT License
17 stars 10 forks source link

paths/notificationRules - GET definition contains query param `checkID` which does not seem to be implemented #563

Open karel-rehor opened 1 year ago

karel-rehor commented 1 year ago

While writing tests for the endpoint notificationRules I've tried to filter using the checkID parameter defined in common/paths/notificationRules.yml but it seems to have no affect. Even illegal ID Values (e.g. ?checkID=12345678 should throw an error that ID must have a length of 16 bytes) are passed without issue.

Is this the remains of an idea that was later implemented differently and should be removed, or is this something awaiting implementation?

common/paths/notificationRules.yml

get:
  operationId: GetNotificationRules
  tags:
    - NotificationRules
  summary: List all notification rules
  parameters:
    - $ref: "../parameters/TraceSpan.yml"
    - $ref: "../parameters/Offset.yml"
    - $ref: "../parameters/Limit.yml"
    - in: query
      name: orgID
      required: true
      description: Only show notification rules that belong to a specific organization ID.
      schema:
        type: string
    - in: query
      name: checkID
      description: Only show notifications that belong to the specific check ID.
      schema:
        type: string
    - in: query
      name: tag
      description: Only return notification rules that "would match" statuses which contain the tag key value pairs provided.
      schema:
        type: string
        pattern: ^[a-zA-Z0-9_]+:[a-zA-Z0-9_]+$
        example: env:prod
  responses:
    "200":
      description: A list of notification rules
      content:
        application/json:
          schema:
            $ref: "../schemas/NotificationRules.yml"
    default:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: "../schemas/Error.yml"
post:
  operationId: CreateNotificationRule
  tags:
    - NotificationRules
...