Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Feb 4, 2026

The API rejects POST requests to /api/v3/configure/processing_engine_trigger without the disabled field, but the OpenAPI spec did not mark it as required.

Changes

  • Added disabled to required fields array in ProcessingEngineTriggerRequest schema
    • api-docs/influxdb3/core/v3/ref.yml
    • api-docs/influxdb3/enterprise/v3/ref.yml
  • Updated all 18 examples (9 per spec) to include disabled: false

Schema diff

 required:
   - db
   - plugin_filename
   - trigger_name
   - trigger_settings
   - trigger_specification
+  - disabled

Example diff

 value:
   db: mydb
   plugin_filename: schedule.py
   trigger_name: schedule_cron_trigger
   trigger_specification: cron:0 0 6 * * 1-5
+  disabled: false
   trigger_settings:
     run_async: false
     error_behavior: Log
Original prompt

This section details on the original issue you should resolve

<issue_title>Required field disabled not marked required for POST /api/v3/configure/processing_engine_trigger</issue_title>
<issue_description>Steps to reproduce:

  1. Make request to POST /api/v3/configure/processing_engine_trigger without disabled per v3 api docs fails
curl -i -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -X POST "http://localhost:8283/api/v3/configure/processing_engine_trigger" \
    --data \
        '{
            "db": "test",
            "plugin_filename": "test.py",
            "trigger_name": "test",
            "trigger_specification": "table:test",
            "trigger_settings": 
                {
                     "run_async": true,
                     "error_behavior": "log"
                 }
        }'

HTTP/1.1 400 Bad Request serde json error: missing field disabled at line 10 column 1

  1. Make request to POST /api/v3/configure/processing_engine_trigger with disabled runs successfully
    curl -i -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -X POST "http://localhost:8283/api/v3/configure/processing_engine_trigger"
    --data
    '{
    "db": "test",
    "plugin_filename": "test.py",
    "trigger_name": "test",
    "trigger_specification": "table:test",
    "disabled": false,
    "trigger_settings":
    {
    "run_async": true,
    "error_behavior": "log"
    }
    }'
`HTTP/1.1 200 OK`

__Expected behaviour:__
Required parameters are marked `required`

__Actual behaviour:__
`HTTP/1.1 400 Bad Request serde json error: missing field `disabled` at line 10 column 1`

__Environment info:__

influxdb3 -V
influxdb3 3.8.0-nightly, revision 091601acd330dbd524485e4bae5012c2d2fe96cb


## Comments on the Issue (you are @copilot in this section)

<comments>
</comments>


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI changed the title [WIP] Fix required field disabled for processing engine trigger Mark disabled field as required in processing engine trigger API specs Feb 4, 2026
Copilot AI requested a review from jstirnaman February 4, 2026 13:26
@jstirnaman jstirnaman requested a review from caterryan February 4, 2026 22:45
@jstirnaman jstirnaman marked this pull request as ready for review February 4, 2026 22:46
@jstirnaman jstirnaman requested review from sanderson and removed request for a team, garylfowler and peterbarnett03 February 4, 2026 22:46
@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

PR Preview Action v1.4.8
🚀 Deployed preview to https://influxdata.github.io/docs-v2/pr-preview/pr-6790/
on branch gh-pages at 2026-02-09 20:58 UTC

@jstirnaman jstirnaman requested a review from a team as a code owner February 4, 2026 23:58
Copilot AI and others added 2 commits February 5, 2026 13:37
…trigger API specs

Co-authored-by: jstirnaman <212227+jstirnaman@users.noreply.github.com>
- Add disabled field and api-ref to API examples per review feedback
- Add api-ref to upload plugin endpoint and remove duplicate link sentence
- Convert {{% code-placeholders %}} shortcode to placeholders code block
  attribute for cleaner syntax
- Add second argument to token-link shortcodes for admin tokens to
  ensure consistent linking to /admin/tokens/admin/ path
- Follows PR 6789 review feedback for processing engine documentation

fix(influxdb3): update placeholder and token-link syntax in get-started

- Convert code-placeholders wrapper shortcodes to code block attributes
@jstirnaman jstirnaman force-pushed the copilot/fix-disabled-field-requirement branch from 07f49f5 to c5c2ad7 Compare February 5, 2026 19:43
Rename "Set up a trigger" heading to "Create a trigger" and update
all internal anchor references to match.
@jstirnaman jstirnaman removed the request for review from a team February 5, 2026 22:19
@jstirnaman jstirnaman merged commit 57ad83b into master Feb 9, 2026
6 checks passed
@jstirnaman jstirnaman deleted the copilot/fix-disabled-field-requirement branch February 9, 2026 21:46
github-actions bot added a commit that referenced this pull request Feb 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Required field disabled not marked required for POST /api/v3/configure/processing_engine_trigger

2 participants