APapicurio
GitOps
Admin

Create a dry-run validation task

Changed on

Experimental. Creates a dry-run validation task that fetches a git ref and validates the data without affecting the live registry. The sidecar fetches the ref, and the registry loads and validates the data in the inactive storage (no swap).

Returns a task object with a taskId that can be used to poll for results.

This endpoint is only available when GitOps storage is enabled.

This operation can fail for the following reasons:

  • GitOps storage is not enabled (HTTP error 409)
  • Dry-run validation is disabled (HTTP error 503)
  • A server error occurred (HTTP error 500)
post/admin/gitops/validate

Request

  • The document declares no server URL.
  • Auth
    none declared

Request body

type'pull'

Validation type. Currently only pull is supported.

repoIdstring required

Repository ID to validate against. Must match a configured repository.

refstring required

Git ref to validate (branch name, tag, or PR ref like refs/pull/42/head).

Response

Validation task created. Poll the task status to get the result.

taskIdstring required

Unique identifier for the validation task.

typestring

Validation type (pull or push).

repoIdstring

Repository ID being validated.

refstring

Git ref being validated.

state'pending' | 'submitted' | 'fetching' | 'validating' | 'completed' | 'failed' required

Current task state: pending (queued, waiting for capacity), submitted (request sent to sidecar), fetching (sidecar is cloning), validating (registry is loading and validating), completed (finished with results), failed (an error occurred).

result'success' | 'failure'

Validation result: success (all checks passed) or failure (validation errors found). Only present when state is completed.

createdAtstring date-time

ISO 8601 timestamp of when the task was created.

completedAtstring date-time

ISO 8601 timestamp of when the task completed. Only present when state is completed or failed.

groupCountinteger

Number of groups loaded during validation. Only present when state is completed.

artifactCountinteger

Number of artifacts loaded during validation. Only present when state is completed.

versionCountinteger

Number of artifact versions loaded during validation. Only present when state is completed.

Changes

  • ff9684af2aadRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f17f5df4e79cRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status