SubmitProviderRequest
Submits a new provider, or a new version of an existing one.
Shape
capabilitiesarray of SubmissionCapabilityInput
- The SubmissionCapabilityInput schema
- capability_idCapabilityId (string)
- descriptionstring
- image_digeststring
- image_refstring
- namestring
- stage_typeStageTypesourcebuildtestpublishdeploynotifycustomThe pipeline stage a capability belongs to. Maps verbatim to the
stage_typefield of a capability ingitmoap-provider.yaml. - bindablearray of PortName (string)optionalConfig keys that can take their value from an earlier step. Each becomes an optional
valueinput port of the same name when the version is published. - cache_enabledbooleanoptional
- config_schemaobjectoptional
- default_timeout_secondsinteger · int32optional0–∞
input_groupsarray of PortGroupoptionalRules over which of the capability's optional inputs may be connected together.
- 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.
inputsarray of PortDescriptoroptional
- 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.
oneby default;manytakes 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
customport, the id of the schema it carries (e.g.aws.ecs.task-definition/v1). Twocustomports connect only when their schema ids agree, or when either leaves this unset.
outputsarray of PortDescriptoroptional
- 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.
oneby default;manytakes 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
customport, the id of the schema it carries (e.g.aws.ecs.task-definition/v1). Twocustomports connect only when their schema ids agree, or when either leaves this unset.
- requires_dockerbooleanoptional
- contract_versioninteger · int320–∞
providerSubmissionProviderInput
- The SubmissionProviderInput schema
- auth_schemaobject
- descriptionstring
- idProviderId (string)
- namestring
- versionProviderVersion (string)
- changelogMarkdownDoc (string) or nulloptionalOptional release notes for this version, in Markdown, up to 64 KB. They cannot be changed once the version is published.
- owning_group_idGroupId (string · uuid) or nulloptionalRequired when
target_tierisprivate: the organization (a top-level group) the provider is private to. You must be at least a Maintainer there. registry_pull_secretRegistryPullSecretInput or nulloptionalOptional registry pull credential (Private only); rejected for other tiers.
- The RegistryPullSecretInput schema
- registrystring
- secretstring · passwordThe password or access token for the registry. Never returned or logged.
- usernamestring
- target_tierProviderTierplatformverifiedcommunityprivateoptional
verified(default) /community/private.platformis rejected.
Example
Synthesized example{
"capabilities": [
{
"capability_id": "c145e17f-7a45-45f4-a2f7-9ec2ad80dcdb",
"description": "Renders each region as density contours of its operations.",
"image_digest": "image-digest-0256",
"image_ref": "image-ref-ab44",
"name": "payments-api",
"stage_type": "source"
},
{
"capability_id": "c2fd758c-711b-4428-bea8-0d970389787e",
"description": "Renders each region as density contours of its operations.",
"image_digest": "image-digest-d5ee",
"image_ref": "image-ref-e061",
"name": "payments-api",
"stage_type": "source"
}
],
"contract_version": 13,
"provider": {
"auth_schema": {},
"description": "Renders each region as density contours of its operations.",
"id": "id-b9f6",
"name": "payments-api"
},
"version": "version-ed9c",
"changelog": "changelog-53eb",
"owning_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"registry_pull_secret": {
"registry": "registry-073b",
"secret": "secret-166e",
"username": "tomas"
},
"target_tier": "platform"
}
Graph
Used inside
No schema contains this one.
Used by
Sent by 2 operations
Returned by 0 operations
No operation returns it directly.