{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/ibm-api-connect/json-schema/ibm-api-connect-catalog-setting-schema.json",
  "title": "CatalogSetting",
  "x-generated": "2026-10-29",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/ibm-api-connect-catalog-settings-api-openapi.yml#/components/schemas/CatalogSetting",
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "catalog_setting"
      ]
    },
    "api_version": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "2.0.0"
      ]
    },
    "name": {
      "type": "string",
      "maxLength": 255
    },
    "title": {
      "type": "string",
      "maxLength": 1023
    },
    "summary": {
      "type": "string",
      "maxLength": 65535
    },
    "user_registry_default_url": {
      "type": "string",
      "format": "uri"
    },
    "production_mode": {
      "type": "boolean"
    },
    "portal": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "none",
            "drupal"
          ]
        },
        "endpoint": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "portal_service_url": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        },
        "webhook_url": {
          "type": "string",
          "format": "uri"
        },
        "webhook_state": {
          "type": "string"
        },
        "service_version": {
          "type": [
            "string",
            "null"
          ]
        },
        "state": {
          "type": "string",
          "enum": [
            "pending",
            "ready"
          ]
        },
        "service_supported_features": {
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "product_lifecycle_approvals": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "staged",
          "published",
          "deprecated",
          "retired",
          "archived",
          "replace",
          "supersede"
        ]
      }
    },
    "task_self_approval": {
      "type": "boolean"
    },
    "allowed_product_visibility": {
      "$ref": "#/$defs/ProductVisibility"
    },
    "application_lifecycle": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      }
    },
    "consumer_self_service_onboarding": {
      "type": "boolean"
    },
    "consumer_self_service_onboarding_approval": {
      "type": "boolean"
    },
    "consumer_org_invitations_enabled": {
      "type": "boolean"
    },
    "consumer_org_invitation_roles": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "administrator",
          "developer",
          "viewer"
        ]
      }
    },
    "invitation_ttl": {
      "type": "integer",
      "minimum": 0,
      "maximum": 2147483647
    },
    "legacy_endpoint_behavior": {
      "type": "string",
      "enum": [
        "enabled",
        "disabled"
      ]
    },
    "v5_endpoint_substitution_behavior": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": false,
      "properties": {
        "base_endpoints": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "endpoint": {
                "type": "string",
                "format": "uri"
              },
              "gateway_service_url": {
                "type": "string",
                "format": "uri"
              },
              "description": {
                "type": "string"
              }
            }
          }
        },
        "unenforced_api_base_endpoint": {
          "type": [
            "string",
            "null"
          ],
          "format": "uri"
        }
      }
    },
    "vanity_api_endpoint": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "endpoint_preference": {
          "type": [
            "string",
            "null"
          ],
          "enum": [
            "catalog",
            "api"
          ]
        },
        "vanity_api_base_endpoints": {
          "type": "array",
          "items": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "endpoint",
              "type"
            ],
            "properties": {
              "endpoint": {
                "type": "string",
                "format": "uri"
              },
              "description": {
                "type": "string"
              },
              "type": {
                "type": "array",
                "items": {
                  "type": "string",
                  "enum": [
                    "development",
                    "production"
                  ]
                }
              }
            }
          }
        }
      }
    },
    "spaces_enabled": {
      "type": "boolean"
    },
    "config_sync_target_catalog": {
      "type": "boolean"
    },
    "custom_notification_templates_enabled": {
      "type": "boolean"
    },
    "email_sender": {
      "$ref": "#/$defs/EmailSender"
    },
    "hash_client_secret": {
      "type": "boolean"
    },
    "subscription_task_approval_retention": {
      "type": "integer"
    },
    "space_download_logs_enabled": {
      "type": "boolean"
    },
    "org_url": {
      "type": "string",
      "format": "uri"
    },
    "catalog_url": {
      "type": "string",
      "format": "uri"
    },
    "default_catalog": {
      "type": "boolean"
    },
    "product_publish_validations": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "app_approvals": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "create_app_approval",
              "register_app_approval",
              "update_app_approval"
            ]
          },
          "self_approval": {
            "type": "boolean",
            "default": false
          }
        }
      }
    },
    "subscription_approvals": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "create_subscription_approval",
              "delete_subscription_approval"
            ]
          },
          "self_approval": {
            "type": "boolean",
            "default": false
          }
        }
      }
    },
    "override_invitation_ttl_for_all_consumer_orgs": {
      "type": "boolean"
    },
    "gateway_supported_protocols": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string",
        "enum": [
          "wss",
          "https",
          "ws",
          "http"
        ]
      }
    },
    "consumer_self_service_onboarding_ttl": {
      "type": [
        "integer",
        "null"
      ],
      "minimum": 60,
      "maximum": 31536000
    },
    "consumer_catalog_enabled": {
      "type": "boolean"
    },
    "protected_properties": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "corg_member_invitation_regenerate_delay": {
      "description": "Minimal interval, in minutes, after which a consumer org member invitation can be regenerated. max === 1 week",
      "type": "integer",
      "minimum": 0,
      "maximum": 10080
    },
    "max_corg_members": {
      "type": "integer",
      "minimum": 1,
      "maximum": 2147483647
    },
    "postman_setting": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        }
      }
    },
    "api_agent_enabled": {
      "type": [
        "boolean",
        "null"
      ]
    },
    "apiset_setting": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "allow_override": {
          "type": "boolean"
        }
      }
    },
    "rate_limit_notification_settings": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean"
        },
        "thresholds": {
          "type": "object",
          "properties": {
            "70": {
              "type": "boolean"
            },
            "80": {
              "type": "boolean"
            },
            "95": {
              "type": "boolean"
            }
          }
        }
      }
    },
    "metadata": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "url": {
      "type": "string",
      "readOnly": true,
      "format": "uri"
    }
  },
  "$defs": {
    "EmailSender": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "custom": {
          "type": "boolean"
        },
        "name": {
          "type": "string"
        },
        "address": {
          "type": "string"
        }
      }
    },
    "ProductVisibility": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "view",
        "subscribe"
      ],
      "properties": {
        "view": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "public",
                "authenticated",
                "custom"
              ]
            },
            "enabled": {
              "type": "boolean"
            },
            "group_urls": {
              "type": [
                "array",
                "null"
              ],
              "items": {
                "type": "string",
                "format": "uri"
              }
            },
            "org_urls": {
              "type": [
                "array",
                "null"
              ],
              "items": {
                "type": "string",
                "format": "uri"
              }
            }
          }
        },
        "subscribe": {
          "type": "object",
          "additionalProperties": false,
          "required": [
            "type"
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "authenticated",
                "custom"
              ]
            },
            "enabled": {
              "type": "boolean"
            },
            "group_urls": {
              "type": [
                "array",
                "null"
              ],
              "items": {
                "type": "string",
                "format": "uri"
              }
            },
            "org_urls": {
              "type": [
                "array",
                "null"
              ],
              "items": {
                "type": "string",
                "format": "uri"
              }
            }
          }
        }
      }
    }
  }
}