Skip to content
GitmoapAPIBeta
Schema

SetListingRequest

Changes a provider's marketplace listing. A field left out is not changed; null clears readme, homepage_url or repository_url.

Shape

  • categoriesarray of Category: one of source-control | build | test | quality | security | release | deploy | infrastructure | notify | other or nulloptionalThe categories to list the provider under, one to three. Replaces the current ones.
  • examplesarray of ProviderExample or nulloptionalUsage examples, up to 10. Replaces the current ones; [] removes them all.
    • The ProviderExample schema
    • capability_idsarray of CapabilityId (string)The capabilities this example exercises; each must exist in some published version of the provider (validated at write time).
    • descriptionstringOne- or two-sentence summary (<= 500 chars).
    • snippetstringA pipeline YAML/JSON fragment (<= 8 KB).
    • titlestringShort heading (<= 120 chars).
  • homepage_urlHttpsUrl (string) or nulloptional
  • keywordsarray of Keyword (string) or nulloptionalSearch keywords, up to 10. Replaces the current ones; [] removes them all.
  • readmeMarkdownDoc (string) or nulloptionalThe listing's README, in Markdown. null removes it.
  • repository_urlHttpsUrl (string) or nulloptional

Example

Synthesized example
{
"categories": [
"source-control",
"source-control"
],
"examples": [
{
"capability_ids": [],
"description": "Renders each region as density contours of its operations.",
"snippet": "snippet-4f60",
"title": "Label every synthesized example"
}
],
"homepage_url": "https://gitmoap.example/acme/f9fcb848",
"keywords": [
"keywords-069a"
],
"readme": "readme-ec13",
"repository_url": "https://gitmoap.example/acme/624ea12f"
}

Graph

Used inside

No schema contains this one.

Contains

Used by

Sent by 1 operation
Returned by 0 operations

No operation returns it directly.