Skip to main content

API Change Log - INTERNAL Module

🧩 Service: Scheduler​

🔧 Operation: createJob​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createJob.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.job_data.properties

🔹 Change 2​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateJob
  • Schema Action: ADDITIONAL_PROPERTIES_ADDED
  • Path: paths.createJob.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.job_data.additionalProperties
  • New Schema:
true

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateJob
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createJob.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.job_repeat_every
  • New Schema:
{
  "type": "string",
  "description": "Frequency of job repetition (if applicable)"
}

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createJob.methodTypePlaceHolder.requestBody.required
  • New Schema:
true

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.properties

🔹 Change 6​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateJob200 --> CreateJob200Data
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.createJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.required

🔹 Change 7​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.next_run_at.format
  • New Schema:
"date-time"

🔹 Change 8​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateJobSuccess
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.failed_at
  • New Schema:
{
  "type": "string",
  "format": "date-time",
  "description": "Timestamp of job failure, if applicable"
}

🔹 Change 9​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateJobSuccess
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.fail_reason
  • New Schema:
{
  "type": "string",
  "description": "Reason for job failure, if applicable"
}

🔹 Change 10​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateJobSuccess
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.last_finished_at
  • New Schema:
{
  "type": "string",
  "format": "date-time",
  "description": "Timestamp of last successful job execution"
}

🔹 Change 11​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateJobSuccess
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.repeat_at
  • New Schema:
{
  "type": "string",
  "format": "date-time",
  "description": "Next scheduled repetition time for the job"
}

🔹 Change 12​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateJobSuccess
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.repeat_interval
  • New Schema:
{
  "type": "string",
  "description": "Time interval for job repetition"
}

🔹 Change 13​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: CreateJobSuccess
  • Schema Action: PROPERTY_ADDED
  • Path: paths.createJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.repeat_timezone
  • New Schema:
{
  "type": "string",
  "description": "Timezone used for scheduling the job"
}

🔹 Change 14​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: CreateJob200
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.createJob.methodTypePlaceHolder.responses.200.content.application/json.schema.required.5

🔹 Change 15​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createJob.methodTypePlaceHolder.responses.500

🔹 Change 16​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.createJob.methodTypePlaceHolder.path
  • New Schema:
"/service/internal/triggerhappy/v1.0/jobs"

🔧 Operation: getJob​

🔹 Change 1​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.data.properties

🔹 Change 2​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: getJob200 --> getJob200DataItems --> getJob200Data
  • Schema Action: REQUIRED_REMOVED
  • Path: paths.getJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.data.required

🔹 Change 3​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getJob.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.data.items.properties.next_run_at.format
  • New Schema:
"date-time"

🔹 Change 4​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getJob.methodTypePlaceHolder.path
  • New Schema:
"/service/internal/triggerhappy/v1.0/jobs"

🔹 Change 5​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.getJob.methodTypePlaceHolder.requestBody
  • New Schema:
{
  "description": "Optional query parameters to filter job results by ID, name, or data.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/jobQuery"
      },
      "examples": {
        "success": {
          "value": {
            "_id": "000000000000000000000001"
          }
        },
        "failure": {
          "value": {
            "_id": "00000000000000001"
          }
        }
      }
    }
  }
}

🔧 Operation: deleteJob​

🔹 Change 1​

  • Action: remove
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: deleteJob
  • Schema Action: OPERATION_ID_REMOVED
  • Path: paths.deleteJob.methodTypePlaceHolder.requestBody.content.application/json.schema.required

🔹 Change 2​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: jobQuery
  • Schema Action: PROPERTY_ADDED
  • Path: paths.deleteJob.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.name
  • New Schema:
{
  "type": "string",
  "description": "Name of the job"
}

🔹 Change 3​

  • Action: add
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: jobQuery
  • Schema Action: PROPERTY_ADDED
  • Path: paths.deleteJob.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.data
  • New Schema:
{
  "type": "object",
  "additionalProperties": true,
  "description": "Execution-related data for filtering jobs"
}

🔹 Change 4​

  • Action: add
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.deleteJob.methodTypePlaceHolder.requestBody.required
  • New Schema:
true

🔹 Change 5​

  • Action: remove
  • Type: breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.deleteJob.methodTypePlaceHolder.responses.500

🔹 Change 6​

  • Action: replace
  • Type: non-breaking
  • xGroup: N/A
  • Schema Ref: N/A
  • Schema Action: N/A
  • Path: paths.deleteJob.methodTypePlaceHolder.path
  • New Schema:
"/service/internal/triggerhappy/v1.0/jobs"

Was this section helpful?