Skip to content
GitmoapAPIBeta
Schema

ProviderSubmission

A submitted provider version awaiting review + publication.

Shape

  • auth_schemaobject
  • manifestProviderVersionManifestThe provider version as submitted. Image locations and digests, signing and lifecycle are filled in by the platform when the version is published.
    • The ProviderVersionManifest schema
    • capabilitiesarray of CapabilityDescriptor
      • The CapabilityDescriptor schema
      • cache_enabledboolean
      • capability_idCapabilityId (string)
      • config_schemaobjectThe JSON Schema a step's config must satisfy to use this capability.
      • default_timeout_secondsinteger · int320–∞
      • descriptionstring
      • image_uristringThe container image that runs the capability, with an immutable version tag.
      • inputsarray of PortDescriptor
        • The PortDescriptor schema
        • namePortName (string)
        • port_typePortTypegit_refartifactcontainer_imagetest_reportdeployment_refcredentialsevidencevaluecustomSemantic type of the data this port carries. Drives edge type-compatibility in the pipeline builder and validation/routing in the engine.
        • requiredboolean
        • cardinalityPortCardinalityonemanyoptionalHow many sources this input accepts. one by default; many takes several at once.
        • descriptionstring or nulloptionalWhat this port is for, in the provider's own words. Absent on a few older providers.
        • schema_idPortSchemaId (string) or nulloptionalFor a custom port, the id of the schema it carries (e.g. aws.ecs.task-definition/v1). Two custom ports connect only when their schema ids agree, or when either leaves this unset.
      • namestring
      • outputsarray of PortDescriptor
        • The PortDescriptor schema
        • namePortName (string)
        • port_typePortTypegit_refartifactcontainer_imagetest_reportdeployment_refcredentialsevidencevaluecustomSemantic type of the data this port carries. Drives edge type-compatibility in the pipeline builder and validation/routing in the engine.
        • requiredboolean
        • cardinalityPortCardinalityonemanyoptionalHow many sources this input accepts. one by default; many takes several at once.
        • descriptionstring or nulloptionalWhat this port is for, in the provider's own words. Absent on a few older providers.
        • schema_idPortSchemaId (string) or nulloptionalFor a custom port, the id of the schema it carries (e.g. aws.ecs.task-definition/v1). Two custom ports connect only when their schema ids agree, or when either leaves this unset.
      • requires_dockerboolean
      • stage_typeStageTypesourcebuildtestpublishdeploynotifycustomThe pipeline stage a capability belongs to. Maps verbatim to the stage_type field of a capability in gitmoap-provider.yaml.
      • bindablearray of PortName (string)optionalConfig keys that can take their value from an earlier step. Each has an optional value input port of the same name: connect it and read it with {"$from": "<key>"}, or leave it unconnected and write the value yourself.
      • image_digeststring or nulloptionalThe exact build of the capability's container image, when the catalog records one. Pinned so a run cannot pick up a different build behind the same tag.
      • input_groupsarray of PortGroupoptionalRules about which inputs are alternatives to each other. Empty for most capabilities.
        • The PortGroup schema
        • kindPortGroupKindexactly_one_ofat_most_one_ofat_least_one_ofHow many of a group's ports may be connected.
        • portsarray of PortName (string)The member input ports, in the order the author should read them.
        • descriptionstring or nulloptionalWhy these ports constrain each other, in the provider's own words. Rendered beside the group, and repeated in the validation error when the group is unsatisfied — which is the point: the sentence explaining the rule reaches the person who broke it.
      • source_image_refstring or nulloptionalFor a verified provider, the image's location in its publisher's registry before gitmoap copied it. Absent for providers gitmoap builds itself.
    • contract_versioninteger · int320–∞
    • manifest_digeststringThe SHA-256 digest of the version's gitmoap-provider.yaml. May be empty.
    • provider_idProviderId (string)
    • published_atstring
    • published_bystring"platform" for platform-authored providers; a publisher id otherwise.
    • versionProviderVersion (string)
    • changelogMarkdownDoc (string) or nulloptionalThe version's release notes, in Markdown, up to 64 KB. They cannot be changed once published. Absent when the version has none.
    • cosign_signature_refstring or nulloptionalWhere the cosign signature is stored in the registry, when the images are signed.
    • lifecycle_stateVersionLifecycleactivedeprecatedsunsetoptionalWhere the version is in its life: active, deprecated or sunset. Checked whenever a run starts.
    • signedbooleanoptionalWhether the version's images are signed with gitmoap's cosign key, as verified and platform providers' are.
    • sunset_atstring or nulloptionalWhen the version was sunset. Set only for a sunset version.
    • sunset_enforced_atstring or nulloptionalWhen the sunset's grace period ends. After it, a run that uses the version fails to start.
  • manifest_digeststring
  • provider_descriptionstring
  • provider_idProviderId (string)
  • provider_namestringThe provider's name, as the catalog shows it.
  • publisher_idPublisherId (string · uuid)
  • source_image_refsobjectEach capability's image in your registry, by capability id.
  • stateSubmissionStatesubmittedin_reviewchanges_requestedapprovedmirroringsigningpublishedrejectedmirror_failedwithdrawnverifyingverification_failedWhere a provider submission stands, from review through to publication or refusal.
  • submission_idProviderSubmissionId (string · uuid)
  • submitted_atstring
  • submitted_byActorSummaryWho submitted the version.
  • target_tierProviderTierplatformverifiedcommunityprivateThe tier the version was submitted for: verified goes to review by gitmoap; community and private are checked automatically, without review.
  • versionProviderVersion (string)
  • attest_resultAttestResult or nulloptionalThe result of checking a community or private provider's images.
  • mirror_resultMirrorResult or nulloptional
  • owning_group_idGroupId (string · uuid) or nulloptionalThe organization the provider is private to. Set only when target_tier is private.
  • published_atstring or nulloptional
  • registry_pull_secret_refSsmParameterPath (string) or nulloptionalA reference to the stored credential for pulling images from a private registry, for a private provider that uses one. Never the credential itself.
  • review_notesstring or nulloptional
  • reviewed_atstring or nulloptional
  • reviewerActorSummary or nulloptionalThe gitmoap administrator who reviewed the submission, once reviewed.

Example

Synthesized example
{
"auth_schema": {},
"manifest": {
"capabilities": [
{
"cache_enabled": false,
"capability_id": "bb245d6f-9bfc-4ad6-9d1b-b66bbeaa1f56",
"config_schema": {},
"default_timeout_seconds": 18,
"description": "Renders each region as density contours of its operations.",
"image_uri": "https://gitmoap.example/acme/1c76d108",
"inputs": [],
"name": "payments-api",
"outputs": [],
"requires_docker": false,
"stage_type": "source"
},
{
"cache_enabled": false,
"capability_id": "b63c35f8-9216-49c3-8ca7-288b1a528235",
"config_schema": {},
"default_timeout_seconds": 35,
"description": "Renders each region as density contours of its operations.",
"image_uri": "https://gitmoap.example/acme/1736dfe1",
"inputs": [],
"name": "payments-api",
"outputs": [],
"requires_docker": false,
"stage_type": "source"
}
],
"contract_version": 4,
"manifest_digest": "manifest-digest-7dd7",
"provider_id": "49f46cf5-3997-468a-8844-6c83de596a97",
"published_at": "2026-10-08T20:39:04Z",
"published_by": "b7e2d1c0-9f8e-4d7c-a6b5-c4d3e2f1a0b9",
"version": "version-c8e9",
"changelog": "changelog-6d3a",
"cosign_signature_ref": "cosign-signature-ref-516d",
"lifecycle_state": "active",
"signed": false,
"sunset_at": "2026-10-12T22:17:24Z",
"sunset_enforced_at": "2026-10-14T17:40:54Z"
},
"manifest_digest": "manifest-digest-126c",
"provider_description": "provider-description-5fe9",
"provider_id": "f4c1651f-6bde-40f4-9701-42d6e68ee785",
"provider_name": "payments-api",
"publisher_id": "5066f0d2-dcde-4165-8074-e2bad68672d2",
"source_image_refs": {
"source_image_refs": {
"image_digest": "image-digest-a62d",
"image_ref": "image-ref-3327"
}
},
"state": "submitted",
"submission_id": "3ac0d8e5-9db9-47c1-a7cb-d1ec54853511",
"submitted_at": "2026-10-12T11:49:25Z",
"submitted_by": {
"email": "lin@acme.example",
"id": "id-b7d8",
"username": "tomas",
"avatar_url": "https://gitmoap.example/acme/e15042b2"
},
"target_tier": "platform",
"version": "version-a6f5",
"attest_result": {
"attested_at": "2026-10-14T14:45:52Z",
"capabilities": {
"capabilities": {
"image_digest": "image-digest-0088",
"image_uri": "https://gitmoap.example/acme/a8aa9106"
}
}
},
"mirror_result": {
"capabilities": {
"capabilities": {
"gitmoap_image_uri": "https://gitmoap.example/acme/b9ad45fe",
"image_digest": "image-digest-5614"
}
},
"mirrored_at": "2026-10-08T15:17:42Z",
"sbom_ref": "sbom-ref-31ff"
},
"owning_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"published_at": "2026-10-15T04:44:38Z",
"registry_pull_secret_ref": "registry-pull-secret-ref-6823",
"review_notes": "review-notes-0f11",
"reviewed_at": "2026-10-11T14:55:56Z",
"reviewer": {
"email": "lin@acme.example",
"id": "id-e336",
"username": "mara",
"avatar_url": "https://gitmoap.example/acme/44648dff"
}
}

Graph

Used inside

No schema contains this one.

Used by