{
  "openapi": "3.0.0",
  "info": {
    "title": "Catalog Management API",
    "x-alternate-name": "Catalog Management",
    "description": "## Introduction\n\nWith the catalog management service, you can define the way users in your account can interact with the IBM Cloud® catalog and the private catalogs that you've created. You can use private catalogs to centrally manage access to products. For more information, see [Customizing what's available in your private catalogs](https://cloud.ibm.com/docs/account?topic=account-restrict-by-user).\n\nAPI endpoint\n\n```\nhttps://cm.globalcatalog.cloud.ibm.com/api/v1-beta\n```\n\nThe code examples on this tab use the client library that is provided for Java.\n\nMaven\n\n```\n<dependency>\n\t<groupId>com.ibm.cloud</groupId>\n\t<artifactId>platform-services</artifactId>\n\t<version>0.8.0</version>\n</dependency>\n```\n\nGradle\n\n```bash\n'com.ibm.cloud:platform-services:0.8.0'\n```\n\nGitHub\n<p>\n   <code><a href=\"https://github.ibm.com/ibmcloud/platform-services-java-sdk\">https://github.ibm.com/ibmcloud/platform-services-java-sdk</a>\n</code>\n</p>\n\nAPI endpoint\n\n```curl\nhttps://cm.globalcatalog.cloud.ibm.com/api/v1-beta\n```\n\nCreating an instance of the Catalog Management service using the Java SDK is shown below.\n\nAuthentication can be specified via environment variables.\n\n```bash\nexport CATALOG_MANAGEMENT_AUTH_TYPE=iam\nexport CATALOG_MANAGEMENT_APIKEY={apikey}\n```\n\n```bash\nimport com.ibm.cloud.platform_services.catalog_management.v1.*;\nimport com.ibm.cloud.sdk.core.http.Response;\n```\n\n```bash\nCatalogManagement service = CatalogManagement.newInstance();\n```\n\nThe code examples on this tab use the client library that is provided for Node.js.\n\nInstallation\n\n```bash\nnpm i @ibm-cloud/platform-services\n```\n\nGitHub\n\n<p>\n   <code><a href=\"https://github.ibm.com/ibmcloud/platform-services-node-sdk\">https://github.ibm.com/ibmcloud/platform-services-node-sdk</a>\n</code>\n</p>\n\nAPI endpoint\n\n```curl\nhttps://cm.globalcatalog.cloud.ibm.com/api/v1-beta\n```\n\nCreating an instance of the Catalog Management service using the Node.js SDK is shown below.\n\nAuthentication can be specified via environment variables.\n\n```bash\nexport CATALOG_MANAGEMENT_AUTH_TYPE=iam\nexport CATALOG_MANAGEMENT_APIKEY={apikey}\n```\n\n```bash\nconst CatalogManagementV1 = require('@ibm-cloud/platform-services/catalog-management/v1');\n```\n\n```bash\nservice = CatalogManagementV1.newInstance({});\n```\n\nThe code examples on this tab use the client library that is provided for Python.\n\nInstallation\n\nTo install, use pip or easy_install:\n\n```bash\npip install --upgrade ibm-platform-services\n```\n\nor\n\n```bash\neasy_install --upgrade ibm-platform-services\n```\n\nGitHub\n\n<p>\n   <code><a href=\"https://github.com/IBM/platform-services-python-sdk\">https://github.com/IBM/platform-services-python-sdk</a>\n</code>\n</p>\n\nAPI endpoint\n\n```curl\nhttps://cm.globalcatalog.cloud.ibm.com/api/v1-beta\n```\n\nCreating an instance of the Catalog Management service using the Node.js SDK is shown below.\n\nAuthentication can be specified via environment variables.\n\n```bash\nexport CATALOG_MANAGEMENT_AUTH_TYPE=iam\nexport CATALOG_MANAGEMENT_APIKEY={apikey}\n```\n\n```bash\nfrom ibm_platform_services.catalog_management_v1 import *\n```\n\n```bash\nservice = CatalogManagementV1.new_instance()\n```\n\nThere are a few different ways to download and install the Platform Services Go SDK project for use by your Go application:\n\n1. Go get command\n\nUse this command to download and install the Platform Services Go SDK project to allow your Go application to use it:\n\n```\ngo get -u github.ibm.com/ibmcloud/platform-services-go-sdk\n```\n\n2. Go modules\n\nIf your application is using Go modules, you can add a suitable import to your Go application, like this:\n\n```\nimport (\n\t\"github.ibm.com/ibmcloud/platform-services-go-sdk/catalogmanagementv1\"\n)\n```\n\nNext, run go mod tidy to download and install the new dependency and update your Go application's go.mod file.\n\n3. Dep dependency manager\n\nIf your application is using the dep dependency management tool, you can add a dependency to your Gopkg.toml file. Here is an example:\n```\n[[constraint]]\n   name = \"github.ibm.com/ibmcloud/platform-services-go-sdk/catalogmanagementv1\"\n   version = \"0.7.0\"\n```\nthen run \n\n```\ndep ensure\n```\n\nGitHub\n\n<p>\n   <code><a href=\"https://github.com/IBM/platform-services-go-sdk\">https://github.com/IBM/platform-services-go-sdk</a>\n</code>\n</p>\n\nAPI endpoint\n```\nhttps://cm.globalcatalog.cloud.ibm.com/api/v1-beta\n```\n\nCreating an instance of the Catalog Management service using the Go SDK is shown below.\n\nAuthentication can be specified via environment variables.\n\n```bash\nexport CATALOG_MANAGEMENT_AUTH_TYPE=iam\nexport CATALOG_MANAGEMENT_APIKEY={apikey}\n```\n\n```bash\nimport (\n    \"github.com/IBM/go-sdk-core/v3/core\"\n    \"github.com/IBM/platform-services-go-sdk/catalogmanagementv1\"\n)\n```\n\n```\nservice, _ := catalogmanagementv1.NewCatalogManagementV1UsingExternalConfig(\n\t&catalogmanagementv1.CatalogManagementV1Options{},\n)\n```\n\n## Endpoint URLs\n\nThe Catalog Management API uses the following global endpoint URL for all regions. When you call the API, add the path for each method to form the complete API endpoint for your requests.\n\n```\nhttps://cm.globalcatalog.cloud.ibm.com\n```\n\nIf you enabled service endpoints in your account, you can send API requests over the IBM Cloud® private network at the following base endpoint URLs. For more information, see [Enabling VRF and service endpoints](https://cloud.ibm.com/docs/account?topic=account-vrf-service-endpoint).\n\n* Private endpoint URL for VPC infrastructure: `https://cm.private.globalcatalog.cloud.ibm.com`\n* Private endpoint URLs for classic infrastructure: \n   * Dallas: `https://cm.private.us-south.globalcatalog.cloud.ibm.com`\n   * Washington DC: `https://cm.private.us-east.globalcatalog.cloud.ibm.com`\n\nExample API request\n\n```\ncurl -X {request_method} \"https://cm.globalcatalog.cloud.ibm.com/{method_endpoint}\"\n```\n\nReplace `{request_method}` and `{method_endpoint}` in this example with the values for your particular API call. \n\n## Error handling\n\nThe Catalog Management API uses standard HTTP response codes to indicate whether a method completed successfully. A `200` type response always indicates success. A `400` type response is a failure, and a `500` type response is an internal system error.",
    "version": "1.0",
    "contact": {
      "email": "cdmauney@us.ibm.com"
    },
    "x-codegen-config": {
      "improvedNameFormattingV2": true,
      "go": {
        "apiPackage": "github.com/IBM/platform-services-go-sdk"
      },
      "java": {
        "apiPackage": "com.ibm.cloud.platform_services"
      },
      "python": {
        "apiPackage": "ibm_platform_services"
      }
    },
    "x-sdk-supported-languages": [
      "curl",
      "go",
      "java",
      "python",
      "node"
    ],
    "x-github": "https://github.ibm.com/cloud-api-docs/resource-catalog",
    "x-github-issues": "https://github.ibm.com/cloud-api-docs/resource-catalog/issues/new",
    "x-last-updated": "2021-10-14"
  },
  "servers": [
    {
      "url": "https://cm.globalcatalog.cloud.ibm.com/api/v1-beta"
    }
  ],
  "security": [
    {
      "IAM": []
    }
  ],
  "tags": [
    {
      "name": "Account"
    },
    {
      "name": "Catalogs"
    },
    {
      "name": "Enterprise"
    },
    {
      "name": "Offerings"
    },
    {
      "name": "Versions"
    },
    {
      "name": "Repo"
    },
    {
      "name": "Deploy"
    },
    {
      "name": "Licensing"
    },
    {
      "name": "Cross Account Search"
    },
    {
      "name": "Objects"
    },
    {
      "name": "Instances"
    },
    {
      "name": "Plans"
    },
    {
      "name": "Regions"
    }
  ],
  "paths": {
    "/enterprises/{enterprise_identifier}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/EnterpriseIdentifier"
        }
      ],
      "get": {
        "tags": [
          "Enterprise"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.enterprise-settings.read"
          ]
        },
        "operationId": "get_enterprise",
        "x-sdk-exclude": true,
        "summary": "Get enterprise settings",
        "description": "Get the enterprise settings for the specified enterprise ID",
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Enterprise"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id := \"{id}\"\n",
                      "getOptions := service.NewGetEnterpriseOptions(id)\n",
                      "_, response, _ := service.GetEnterprise(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String id = \"{id}\";\n",
                      "GetEnterpriseOptions getOptions = new GetEnterpriseOptions.Builder().enterpriseId(id).build();\n",
                      "Response<Enterprise> response = service.getEnterprise(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "response = await service.getEnterprise({ 'enterpriseId': id });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "response = self.service.get_enterprise(enterprise_id=id)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "put": {
        "tags": [
          "Enterprise"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.enterprise-settings.update"
          ]
        },
        "operationId": "update_enterprise",
        "x-sdk-exclude": true,
        "summary": "Update enterprise settings",
        "description": "Update the settings for an enterprise",
        "x-codegen-request-body-name": "enterprise",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Enterprise"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful update. Your permissions determine if can update or not."
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "revision = \"{revision}\"\n",
                      "accountFilters = \"{accountFilters}\"\n",
                      "accountGroups = \"{accountGroups}\"\n",
                      "response = self.service.replace_enterprise(enterprise_id=id, id=id, rev=revision, account_filters= accountFilters, account_groups=accountGroups)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id := \"{id}\"\n",
                      "revision := \"{revision}\"\n",
                      "accountFilters := {accountFilters}\n",
                      "replaceOptions := {replaceOptions}\n",
                      "replaceOptions := service.NewReplaceEnterpriseOptions(id)\n",
                      "replaceOptions.SetID(id)\n",
                      "replaceOptions.SetRev(revision)\n",
                      "replaceOptions.SetAccountFilters(accountFilters)\n",
                      "replaceOptions.SetAccountGroups(accountGroups)\n",
                      "response, _ := service.ReplaceEnterprise(replaceOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String id = \"{id}\";\n",
                      "String revision = \"{revision}\";\n",
                      "String accountFilters = {accountFilters};\n",
                      "String accountGroups = {accountGroups};\n",
                      "ReplaceCatalogOptions replaceOptions = new ReplaceEnterpriseOptions.Builder().enterpriseId(id).id(id).rev(revision).accountFilters(accountFilters).accountGroups(accountGroups).build();\n",
                      "Response<Catalog> response = service.replaceEnterprise(replaceOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "revision = \"{revision}\";\n",
                      "accountFilters = {accountFilters};\n",
                      "accountGroups = {accountGroups};\n",
                      "response = await service.replaceEnterprise({ 'enterpriseId': id, 'id': id, 'rev': revision, 'accountFilters': accountFilters, 'accountGroups': accountGroups });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/enterprises/{enterprise_identifier}/audits": {
      "get": {
        "tags": [
          "Enterprise"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "operationId": "list_enterprise_audits",
        "x-sdk-exclude": false,
        "summary": "Get enterprise audit logs",
        "description": "Get the audit logs associated with an enterprise.",
        "parameters": [
          {
            "$ref": "#/components/parameters/EnterpriseIdentifier"
          },
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLogs"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/enterprises/{enterprise_identifier}/audits/{auditlog_identifier}": {
      "get": {
        "tags": [
          "Enterprise"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "operationId": "get_enterprise_audit",
        "x-sdk-exclude": false,
        "summary": "Get an enterprise audit log entry",
        "description": "Get the full audit log entry associated with an enterprise.",
        "parameters": [
          {
            "$ref": "#/components/parameters/EnterpriseIdentifier"
          },
          {
            "$ref": "#/components/parameters/AuditLogIdentifier"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLog"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/enterprises/{enterprise_identifier}/audit": {
      "get": {
        "tags": [
          "Enterprise"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "deprecated": true,
        "operationId": "get_enterprise_audits",
        "x-sdk-exclude": true,
        "summary": "Get enterprise audit log",
        "description": "Get the audit log associated with an enterprise.",
        "parameters": [
          {
            "$ref": "#/components/parameters/EnterpriseIdentifier"
          },
          {
            "name": "id",
            "in": "query",
            "description": "Log identification.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLogOld"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogaccount": {
      "get": {
        "tags": [
          "Account"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "operationId": "get_catalog_account",
        "summary": "Get catalog account settings",
        "description": "Get the account level settings for the account for private catalog",
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                }
              }
            },
            "links": {
              "AccountRev": {
                "$ref": "#/components/links/AccountRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "getOptions := service.NewGetCatalogAccountOptions()\n",
                      "_, response, _ := service.GetCatalogAccount(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "Response<Account> response = service.getCatalogAccount().execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = self.service.get_catalog_account()\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = await service.getCatalogAccount();\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "put": {
        "tags": [
          "Account"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.update"
          ]
        },
        "operationId": "update_catalog_account",
        "summary": "Update account settings",
        "description": "Update the account level settings for the account for private catalog",
        "x-codegen-request-body-name": "account",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/Account"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful update. Your permissions determine if you an update or not",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Account"
                }
              }
            },
            "links": {
              "AccountRev": {
                "$ref": "#/components/links/AccountRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "curl": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "curl -X \"PUT\" \\\n",
                      "\"https://cm.globalcatalog.cloud.ibm.com/api/v1-beta/catalogaccount\" \\\n",
                      "-H \"accept: */*\" \\\n",
                      "-H \"Authorization: {iam-bearer-token}\" \\\n",
                      "-d '{\"id\":\"string\",\"hide_IBM_cloud_catalog\":true,\"account_filters\":{\"include_all\":true,\"category_filters\":{\"additionalProp1\":{\"include\":true,\"filter\":{\"filter_terms\":[\"string\"]}},\"additionalProp2\":{\"include\":true,\"filter\":{\"filter_terms\":[\"string\"]}},\"additionalProp3\":{\"include\":true,\"filter\":{\"filter_terms\":[\"string\"]}}},\"id_filters\":{\"include\":{\"filter_terms\":[\"string\"]},\"exclude\":{\"filter_terms\":[\"string\"]}}}}'"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogaccount/audits": {
      "get": {
        "tags": [
          "Account"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "operationId": "list_catalog_account_audits",
        "x-sdk-exclude": false,
        "summary": "Get catalog account audit logs",
        "description": "Get the audit logs associated with a catalog account.",
        "parameters": [
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLogs"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogaccount/audits/{auditlog_identifier}": {
      "get": {
        "tags": [
          "Account"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "operationId": "get_catalog_account_audit",
        "x-sdk-exclude": false,
        "summary": "Get a catalog account audit log entry",
        "description": "Get the full audit log entry associated with a catalog account.",
        "parameters": [
          {
            "$ref": "#/components/parameters/AuditLogIdentifier"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLog"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogaccount/filters": {
      "get": {
        "tags": [
          "Account"
        ],
        "operationId": "get_catalog_account_filters",
        "summary": "Get catalog account filters",
        "description": "Get the accumulated filters of the account and of the catalogs you have access to.",
        "parameters": [
          {
            "name": "catalog",
            "in": "query",
            "description": "catalog id. Narrow down filters to the account and just the one catalog.",
            "schema": {
              "type": "string"
            },
            "x-linkback": "#/components/links/CatalogID"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccumulatedFilters"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "getOptions := service.NewGetCatalogAccountFiltersOptions()\n",
                      "_, response, _ := service.GetCatalogAccountFilters(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "Response<AccumulatedFilters> response = service.getCatalogAccountFilters().execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = self.service.get_catalog_account_filters()\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = await service.getCatalogAccountFilters();\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogaccount/audit": {
      "get": {
        "tags": [
          "Account"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "deprecated": true,
        "operationId": "get_catalog_account_audit_old",
        "x-sdk-exclude": true,
        "summary": "Get catalog account audit log",
        "description": "Get the audit log associated with a catalog account.",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "Log identification.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLogOld"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "curl": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "curl -X \"GET\" \\ \n",
                      "\"https://cm.globalcatalog.cloud.ibm.com/api/v1-beta/catalogs/{catalog-id}/audit\" \\\n",
                      "-H \"accept: application/json\" \\\n",
                      "-H \"Authorization: {iam-bearer-token}\""
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/shareapproval/{object_type}/access": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ObjectType"
        }
      ],
      "get": {
        "tags": [
          "Account"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.share-approvals.read"
          ]
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "$ref": "#/components/parameters/Limit"
          }
        ],
        "operationId": "get_share_approval_list",
        "summary": "Get share approval access list",
        "description": "Get the share approval access list associated with the specified object type",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShareApprovalListAccessResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      },
      "delete": {
        "tags": [
          "Account"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.share-approvals.delete"
          ]
        },
        "operationId": "delete_share_approval_list",
        "summary": "Delete share approval access",
        "description": "Delete share approval accesses associated with the specified object type",
        "x-codegen-request-body-name": "accesses",
        "requestBody": {
          "description": "A list of accesses to delete.  An entry with star[\"*\"] will remove all accesses",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AccessIdentifier"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response, still need to look for errors for specific accesses",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessListBulkResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      },
      "post": {
        "tags": [
          "Account"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.share-approvals.create"
          ]
        },
        "operationId": "add_share_approval_list",
        "summary": "Add accesses to share approval access list",
        "description": "Add one or more accesses to the share approval access list for a specific object type.",
        "x-codegen-request-body-name": "accesses",
        "requestBody": {
          "description": "A list of accesses to add.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AccessIdentifier"
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful response, still need to look for errors for specific accesses",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessListBulkResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/shareapproval/{object_type}/access/source/{approval_state_identifier}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/ObjectType"
        },
        {
          "$ref": "#/components/parameters/ApprovalStateIdentifier"
        }
      ],
      "get": {
        "tags": [
          "Account"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.share-approvals.read"
          ]
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/EnterpriseOrAccountGroupIdentifier"
          }
        ],
        "operationId": "get_share_approval_list_as_source",
        "summary": "Get share approval access list for requesting accounts",
        "description": "Get the share approval access list associated with the specified object type in a certain approval state for requesting accounts",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShareApprovalListAccessResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      },
      "post": {
        "tags": [
          "Account"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.share-approvals.update"
          ]
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/EnterpriseOrAccountGroupIdentifier"
          }
        ],
        "operationId": "update_share_approval_list_as_source",
        "summary": "Update approval states for share approval access list for requesting accounts",
        "description": "Update one or more access approval states from the share approval access list for a specific object type for requesting accounts.",
        "x-codegen-request-body-name": "accesses",
        "requestBody": {
          "description": "A list of accesses to update to the specified approval state.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AccessIdentifier"
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful response, still need to look for errors for specific accesses",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessListBulkResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs": {
      "get": {
        "tags": [
          "Catalogs"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.instances.list"
          ]
        },
        "operationId": "list_catalogs",
        "summary": "Get list of catalogs",
        "description": "Retrieves the available catalogs for a given account. This can be used by an unauthenticated user to retrieve the public catalog.",
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogSearchResult"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "listOptions := service.NewListCatalogsOptions()\n",
                      "_, response, _ := service.ListCatalogs(listOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "Response<CatalogSearchResult> response = service.listCatalogs().execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = self.service.list_catalogs()\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = await service.listCatalogs();\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "post": {
        "tags": [
          "Catalogs"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.instances.create"
          ]
        },
        "operationId": "create_catalog",
        "summary": "Create a catalog",
        "description": "Create a catalog for a given account",
        "x-codegen-request-body-name": "catalog",
        "requestBody": {
          "$ref": "#/components/requestBodies/CatalogPrototype"
        },
        "responses": {
          "201": {
            "description": "New catalog created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Catalog"
                }
              }
            },
            "links": {
              "CatalogID": {
                "$ref": "#/components/links/CatalogID"
              },
              "CatalogRev": {
                "$ref": "#/components/links/CatalogRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "label := \"{label}\"\n",
                      "shortDesc := \"{shortDesc}\"\n",
                      "createOptions := service.NewCreateCatalogOptions()\n",
                      "createOptions.SetLabel(label)\n",
                      "createOptions.SetShortDescription(shortDesc)\n",
                      "_, response, _ := service.CreateCatalog(createOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String label = \"{label}\";\n",
                      "String shortDesc = \"{shortDesc}\";\n",
                      "CreateCatalogOptions createOptions = new CreateCatalogOptions.Builder().label(label).shortDescription(shortDesc).build();\n",
                      "Response<Catalog> response = service.createCatalog(createOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "label = \"{label}\"\n",
                      "shortDesc = \"{shortDesc}\"\n",
                      "response = self.service.create_catalog(label=label, short_description=shortDesc)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "label = \"{label}\";\n",
                      "shortDesc = \"{shortDesc}\";\n",
                      "response = await service.createCatalog({ 'label': label, 'shortDescription': shortDesc });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        }
      ],
      "get": {
        "tags": [
          "Catalogs"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.instance.read"
          ]
        },
        "operationId": "get_catalog",
        "summary": "Get catalog",
        "description": "Get a catalog. This can also be used by an unauthenticated user to get the public catalog.",
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Catalog"
                }
              }
            },
            "links": {
              "CatalogRev": {
                "$ref": "#/components/links/CatalogRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog id"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id := \"{id}\"\n",
                      "getOptions := service.NewGetCatalogOptions(id)\n",
                      "_, response, _ := service.GetCatalog(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String id = \"{id}\";\n",
                      "GetCatalogOptions getOptions = new GetCatalogOptions.Builder().catalogIdentifier(id).build();\n",
                      "Response<Catalog> response = service.getCatalog(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "response = self.service.get_catalog(catalog_identifier=id)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "response = await service.getCatalog({ 'catalogIdentifier': id });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "put": {
        "tags": [
          "Catalogs"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.instance.update"
          ]
        },
        "operationId": "replace_catalog",
        "summary": "Update catalog",
        "description": "Update a catalog",
        "x-codegen-request-body-name": "catalog",
        "requestBody": {
          "$ref": "#/components/requestBodies/Catalog"
        },
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Catalog"
                }
              }
            },
            "links": {
              "CatalogRev": {
                "$ref": "#/components/links/CatalogRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog id"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "curl": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "curl -X \"PUT\" \\\n",
                      "\"https://cm.globalcatalog.cloud.ibm.com/api/v1-beta/catalogs/{catalog-id}\" \\\n",
                      "-H \"accept: application/json\" \\\n",
                      "-H \"Authorization: {iam-bearer-token}\" \\\n",
                      "-d '{\"id\":\"string\",\"_rev\":\"string\",\"label\":\"string\",\"short_description\":\"string\",\"catalog_icon_url\":\"string\",\"tags\":[\"string\"],\"features\":[{\"title\":\"string\",\"description\":\"string\"}],\"resource_group_id\":\"string\",\"catalog_filters\":{\"include_all\":true,\"category_filters\":{\"additionalProp1\":{\"include\":true,\"filter\":{\"filter_terms\":[\"string\"]}},\"additionalProp2\":{\"include\":true,\"filter\":{\"filter_terms\":[\"string\"]}},\"additionalProp3\":{\"include\":true,\"filter\":{\"filter_terms\":[\"string\"]}}},\"id_filters\":{\"include\":{\"filter_terms\":[\"string\"]},\"exclude\":{\"filter_terms\":[\"string\"]}}},\"kind\":\"string\"}'"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "delete": {
        "tags": [
          "Catalogs"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.instance.delete"
          ]
        },
        "operationId": "delete_catalog",
        "summary": "Delete catalog",
        "description": "Delete a catalog",
        "responses": {
          "200": {
            "description": "Successful Result"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id := \"{id}\"\n",
                      "deleteOptions := service.NewDeleteCatalogOptions(id)\n",
                      "response, _ := service.DeleteCatalog(deleteOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String id = \"{id}\";\n",
                      "DeleteCatalogOptions deleteOptions = new DeleteCatalogOptions.Builder().catalogIdentifier(id).build();\n",
                      "Response<Void> response = service.deleteCatalog(deleteOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "response = self.service.delete_catalog(catalog_identifier=id, id=id)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "response = await service.deleteCatalog({ 'catalogIdentifier': id, 'id': id });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/audits": {
      "get": {
        "tags": [
          "Catalogs"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "operationId": "list_catalog_audits",
        "x-sdk-exclude": false,
        "summary": "Get catalog audit logs",
        "description": "Get the audit logs associated with a catalog.",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLogs"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/audits/{auditlog_identifier}": {
      "get": {
        "tags": [
          "Catalogs"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "operationId": "get_catalog_audit",
        "x-sdk-exclude": false,
        "summary": "Get a catalog audit log entry",
        "description": "Get the full audit log entry associated with a catalog.",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/AuditLogIdentifier"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLog"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/audit": {
      "get": {
        "tags": [
          "Catalogs"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "deprecated": true,
        "operationId": "get_catalog_audit_old",
        "x-sdk-exclude": true,
        "summary": "Get catalog audit log",
        "description": "Get the audit log associated with a catalog.",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "name": "id",
            "in": "query",
            "description": "Log identification.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLogOld"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/offerings": {
      "get": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offerings.list"
          ]
        },
        "operationId": "get_consumption_offerings",
        "summary": "Get consumption offerings",
        "description": "Retrieve the available offerings from both public and from the account that currently scoped for consumption. These copies cannot be used for updating. They are not complete and only return what is visible to the caller. This can be used by an unauthenticated user to retreive publicly available offerings.",
        "parameters": [
          {
            "name": "digest",
            "in": "query",
            "description": "true - Strip down the content of what is returned. For example don't return the readme. Makes the result much smaller. Defaults to false.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "catalog",
            "in": "query",
            "description": "catalog id. Narrow search down to just a particular catalog. It will apply the catalog's public filters to the public catalog offerings on the result.",
            "schema": {
              "type": "string"
            },
            "x-linkback": "#/components/links/CatalogID"
          },
          {
            "name": "select",
            "in": "query",
            "description": "What should be selected. Default is 'all' which will return both public and private offerings. 'public' returns only the public offerings and 'private' returns only the private offerings.",
            "schema": {
              "type": "string",
              "enum": [
                "all",
                "public",
                "private"
              ]
            }
          },
          {
            "name": "includeHidden",
            "in": "query",
            "description": "true - include offerings which have been marked as hidden. The default is false and hidden offerings are not returned.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "limit",
            "description": "number or results to return",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 100,
              "maximum": 1000
            }
          },
          {
            "name": "offset",
            "description": "number of results to skip before returning values",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OfferingSearchResult"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "options := service.NewGetConsumptionOfferingsOptions()\n",
                      "_, response, _ := service.GetConsumptionOfferings(options)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "Response<OfferingSearchResult> response = service.getConsumptionOfferings().execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = self.service.get_consumption_offerings()\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = await service.getConsumptionOfferings();\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        }
      ],
      "get": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offerings.list"
          ]
        },
        "operationId": "list_offerings",
        "summary": "Get list of offerings",
        "description": "Retrieve the available offerings in the specified catalog. This can also be used by an unauthenticated user to retreive publicly available offerings.",
        "parameters": [
          {
            "name": "digest",
            "in": "query",
            "description": "true - Strip down the content of what is returned. For example don't return the readme. Makes the result much smaller. Defaults to false.",
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "limit",
            "description": "The maximum number of results to return",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 100,
              "maximum": 1000
            }
          },
          {
            "name": "offset",
            "description": "The number of results to skip before returning values",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "name",
            "description": "Only return results that contain the specified string",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "description": "The field on which the output is sorted. Sorts by default by **label** property. Available fields are **name**, **label**, **created**, and **updated**. By adding **-** (i.e. **-label**) in front of the query string, you can specify descending order. Default is ascending order.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "includeHidden",
            "in": "query",
            "description": "true - include offerings which have been marked as hidden. The default is true. To not return hidden offerings false must be explicitly set",
            "schema": {
              "type": "boolean",
              "default": true
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OfferingSearchResult"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id := \"{id}\"\n",
                      "listOptions := service.NewListOfferingsOptions(id)\n",
                      "_, response, _ := service.ListOfferings(listOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String id = \"{id}\";\n",
                      "ListOfferingsOptions listOptions = new ListOfferingsOptions.Builder().catalogIdentifier(id).build();\n",
                      "Response<OfferingSearchResult> response = service.listOfferings(listOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "response = self.service.list_offerings(catalog_identifier=id)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "name = \"{name}\";\n",
                      "label = \"{label}\";\n",
                      "response = await service.listOfferings({ 'catalogIdentifier': id, 'id': id, 'name': name, 'label': label });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "post": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.create"
          ]
        },
        "operationId": "create_offering",
        "summary": "Create offering",
        "description": "Create an offering",
        "x-codegen-request-body-name": "offering",
        "requestBody": {
          "$ref": "#/components/requestBodies/OfferingPrototype"
        },
        "responses": {
          "201": {
            "description": "New offering created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offering"
                }
              }
            },
            "links": {
              "OfferingID": {
                "$ref": "#/components/links/OfferingID"
              },
              "OfferingRev": {
                "$ref": "#/components/links/OfferingRev"
              },
              "VersionLocator": {
                "$ref": "#/components/links/VersionLocator"
              },
              "VersionID": {
                "$ref": "#/components/links/VersionLocator"
              },
              "VersionRev": {
                "$ref": "#/components/links/VersionRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id := \"{id}\"\n",
                      "name := \"{name}\"\n",
                      "label := \"{label}\"\n",
                      "offeringOptions := service.NewCreateOfferingOptions(id)\n",
                      "offeringOptions.SetName(name)\n",
                      "offeringOptions.SetLabel(label)\n",
                      "_, response, _ := service.CreateOffering(offeringOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String id = \"{id}\";\n",
                      "String name = \"{name}\";\n",
                      "String label = \"{label}\";\n",
                      "CreateOfferingOptions offeringOptions = new CreateOfferingOptions.Builder().catalogIdentifier(id).name(name).label(label).build();\n",
                      "Response<Offering> response = service.createOffering(offeringOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "name = \"{name}\"\n",
                      "label = \"{label}\"\n",
                      "response = self.service.create_offering(catalog_identifier=id, name=name, label=label)\n",
                      "print(response)\n",
                      ""
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "name = \"{name}\";\n",
                      "label = \"{label}\";\n",
                      "response = await service.createOffering({ 'catalogIdentifier': id, 'id': id, 'name': name, 'label': label });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/version": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/OfferingId"
        }
      ],
      "post": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "import_offering_version",
        "summary": "Import offering version",
        "description": "Import new version to an offering",
        "parameters": [
          {
            "name": "zipurl",
            "in": "query",
            "description": "URL path to zip location.  If not specified, must provide content in the body of this call.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "targetVersion",
            "description": "The semver value for this new version, if not found in the zip url package content",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "includeConfig",
            "description": "Add all possible configuration values to this version when importing",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "isVSI",
            "description": "Indicates that the current terraform template is used to install a virtual server image",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "repotype",
            "description": "The type of repository containing this version.  Valid values are 'public_git' or 'enterprise_git'",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Auth-Token",
            "description": "Authentication token used to access the specified zip file",
            "in": "header",
            "required": false,
            "schema": {
              "type": "string",
              "description": "String literal or JSON encoded value of $ref:#/components/schemas/SecretInstance, prefixed with `cmsm_v1:`"
            }
          }
        ],
        "x-codegen-request-body-name": "offering_import",
        "requestBody": {
          "$ref": "#/components/requestBodies/ImportOfferingBody"
        },
        "responses": {
          "201": {
            "description": "New version created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offering"
                }
              }
            },
            "links": {
              "OfferingID": {
                "$ref": "#/components/links/OfferingID"
              },
              "OfferingRev": {
                "$ref": "#/components/links/OfferingRev"
              },
              "VersionLocator": {
                "$ref": "#/components/links/VersionLocator"
              },
              "VersionID": {
                "$ref": "#/components/links/VersionLocator"
              },
              "VersionRev": {
                "$ref": "#/components/links/VersionRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID := \"{catalogID}\"\n",
                      "offeringID := \"{offeringID}\"\n",
                      "offeringURL := \"{offeringURL}\"\n",
                      "importOptions := service.NewImportOfferingVersionOptions(catalogID, offeringID, offeringURL)\n",
                      "_, response, _ := service.ImportOfferingVersion(importOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String catalogID = \"{catalogID}\";\n",
                      "String offeringID = \"{offeringID}\";\n",
                      "String offeringURL = \"{offeringURL}\";\n",
                      "ImportOfferingVersionOptions newOfferingOptions = new ImportOfferingVersionOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).zipurl(offeringURL).build();\n",
                      "Response<Offering> response = service.importOfferingVersion(newOfferingOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\"\n",
                      "offeringID = \"{offeringID}\"\n",
                      "offeringURL = \"{offeringURL}\"\n",
                      "response = self.service.import_offering_version(catalog_identifier=catalogID, offering_id=offeringID, zipurl=offeringURL)\n",
                      "print(response)\n",
                      ""
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\";\n",
                      "offeringID = \"{offeringID}\";\n",
                      "offeringURL = \"{offeringURL}\";\n",
                      "response = await service.importOfferingVersion({ 'catalogIdentifier': catalogID, 'offeringId': offeringID, 'zipurl': offeringURL });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/import/offerings": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        }
      ],
      "post": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.create"
          ]
        },
        "operationId": "import_offering",
        "summary": "Import offering",
        "description": "Import a new offering",
        "parameters": [
          {
            "name": "zipurl",
            "in": "query",
            "description": "URL path to zip location.  If not specified, must provide content in this post body.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "offeringID",
            "description": "Re-use the specified offeringID during import",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "x-linkback": "#/components/links/OfferingID"
          },
          {
            "name": "targetVersion",
            "description": "The semver value for this new version",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "includeConfig",
            "description": "Add all possible configuration items when creating this version",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "isVSI",
            "description": "Indicates that the current terraform template is used to install a virtual server image",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "repotype",
            "description": "The type of repository containing this version.  Valid values are 'public_git' or 'enterprise_git'",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Auth-Token",
            "description": "Authentication token used to access the specified zip file",
            "in": "header",
            "required": false,
            "schema": {
              "type": "string",
              "description": "String literal or JSON encoded value of $ref:#/components/schemas/SecretInstance, prefixed with `cmsm_v1:`"
            }
          }
        ],
        "x-codegen-request-body-name": "offering_import",
        "requestBody": {
          "$ref": "#/components/requestBodies/ImportOfferingBody"
        },
        "responses": {
          "201": {
            "description": "New offering created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offering"
                }
              }
            },
            "links": {
              "OfferingRev": {
                "$ref": "#/components/links/OfferingRev"
              },
              "VersionLocator": {
                "$ref": "#/components/links/VersionLocator"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id := \"{id}\"\n",
                      "offeringURL := \"{offeringURL}\"\n",
                      "offeringOptions := service.NewImportOfferingOptions(id, offeringURL)\n",
                      "_, response, _ := service.ImportOffering(offeringOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "offeringURL = \"{offeringURL}\";\n",
                      "ImportOfferingOptions offeringOptions = new ImportOfferingOptions.Builder().catalogIdentifier(id).zipurl(offeringURL).build();\n",
                      "Response<Offering> response = service.importOffering(offeringOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "offeringURL = \"{offeringURL}\"\n",
                      "response = self.service.import_offering(catalog_identifier=id, zipurl=offeringURL)\n",
                      "print(response)\n",
                      ""
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "offeringURL = \"{offeringURL}\";\n",
                      "response = await service.importOffering({ 'catalogIdentifier': id, 'zipurl': offeringURL });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/reload": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/OfferingId"
        }
      ],
      "put": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "reload_offering",
        "summary": "Reload offering",
        "description": "Reload an existing version in offering from a tgz",
        "parameters": [
          {
            "name": "targetVersion",
            "description": "The semver value for this new version",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "zipurl",
            "in": "query",
            "description": "URL path to zip location.  If not specified, must provide content in this post body.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "repoType",
            "description": "The type of repository containing this version.  Valid values are 'public_git' or 'enterprise_git'",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "x-codegen-request-body-name": "offering_import",
        "requestBody": {
          "$ref": "#/components/requestBodies/ImportOfferingCopyReloadBody"
        },
        "responses": {
          "200": {
            "description": "New version created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offering"
                }
              }
            },
            "links": {
              "OfferingRev": {
                "$ref": "#/components/links/OfferingRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID := \"{catalogID}\"\n",
                      "offeringID := \"{offeringID}\"\n",
                      "offeringURL := \"{offeringURL}\"\n",
                      "offeringVersion := \"{offeringVersion}\"\n",
                      "reloadOptions := service.NewReloadOfferingOptions(catalogID, offeringID, offeringURL, offeringVersion)\n",
                      "_, response, _ := service.ReloadOffering(reloadOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String catalogID = \"{catalogID}\";\n",
                      "String offeringID = \"{offeringID}\";\n",
                      "String version = \"{version}\";\n",
                      "ReloadOfferingOptions reloadOfferingOptions = new ReloadOfferingOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).zipurl(offeringID).targetVersion(version).build();\n",
                      "Response<Offering> response = service.reloadOffering(reloadOfferingOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\"\n",
                      "offeringID = \"{offeringID}\"\n",
                      "offeringURL = \"{offeringURL}\"\n",
                      "version = \"{version}\"\n",
                      "response = self.service.reload_offering(catalog_identifier=catalogID, offering_id=offeringID, zipurl=offeringURL, target_version=version)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\";\n",
                      "offeringID = \"{offeringID}\";\n",
                      "offeringURL = \"{offeringURL}\";\n",
                      "version = \"{version}\";\n",
                      "response = await service.reloadOffering({'catalogIdentifier': catalogID, 'offeringId': offeringID, 'zipurl': offeringURL, 'targetVersion': version});\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/OfferingId"
        }
      ],
      "get": {
        "operationId": "get_offering",
        "summary": "Get offering",
        "description": "Get an offering. This can be used by an unauthenticated user for publicly available offerings.",
        "parameters": [
          {
            "name": "type",
            "in": "query",
            "description": "Offering Parameter Type.  Valid values are 'name' or 'id'.  Default is 'id'.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "digest",
            "in": "query",
            "description": "Return the digest format of the specified offering.  Default is false.",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offering"
                }
              }
            },
            "links": {
              "OfferingRev": {
                "$ref": "#/components/links/OfferingRev"
              },
              "VersionLocator": {
                "$ref": "#/components/links/VersionLocator"
              },
              "VersionID": {
                "$ref": "#/components/links/VersionLocator"
              },
              "VersionRev": {
                "$ref": "#/components/links/VersionRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID := \"{catalogID}\"\n",
                      "offeringID := \"{offeringID}\"\n",
                      "getOptions := service.NewGetOfferingOptions(catalogID, offeringID)\n",
                      "_, response, _ := service.GetOffering(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String catalogID = \"{catalogID}\";\n",
                      "String offeringID = \"{offeringID}\";\n",
                      "GetOfferingOptions getOptions = new GetOfferingOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).build();\n",
                      "Response<Offering> response = service.getOffering(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\"\n",
                      "offeringID = \"{offeringID}\"\n",
                      "response = self.service.get_offering(catalog_identifier=catalogID, offering_id=offeringID)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\";\n",
                      "offeringID = \"{offeringID}\";\n",
                      "response = await service.getOffering({ 'catalogIdentifier': catalogID, 'offeringId': offeringID });\n",
                      "console.print(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "put": {
        "operationId": "replace_offering",
        "summary": "Update offering",
        "description": "Update an offering",
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "x-codegen-request-body-name": "offering",
        "requestBody": {
          "$ref": "#/components/requestBodies/Offering"
        },
        "responses": {
          "200": {
            "description": "Offering was updated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offering"
                }
              }
            },
            "links": {
              "OfferingID": {
                "$ref": "#/components/links/OfferingID"
              },
              "OfferingRev": {
                "$ref": "#/components/links/OfferingRev"
              },
              "VersionLocator": {
                "$ref": "#/components/links/VersionLocator"
              },
              "VersionID": {
                "$ref": "#/components/links/VersionID"
              },
              "VersionRev": {
                "$ref": "#/components/links/VersionRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID := \"{catalogID}\"\n",
                      "offeringID := \"{offeringID}\"\n",
                      "label := \"{label}\"\n",
                      "shortDesc := \"{shortDesc}\"\n",
                      "revision := \"{revision}\"\n",
                      "updateOptions := service.NewReplaceOfferingOptions(catalogID, offeringID)\n",
                      "updateOptions.SetID(offeringID)\n",
                      "updateOptions.SetLabel(label)\n",
                      "updateOptions.SetShortDescription(shortDesc)\n",
                      "updateOptions.SetRev(revision)\n",
                      "_, response, _ := service.ReplaceOffering(updateOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String catalogID = \"{catalogID}\";\n",
                      "String offeringID = \"{offeringID}\";\n",
                      "String label = \"{label}\";\n",
                      "String shortDesc = \"{shortDesc}\";\n",
                      "ReplaceOfferingOptions replaceOptions = new ReplaceOfferingOptions.Builder().catalogIdentifier(catalogID).id(offeringID).offeringId(offeringID).label(label).shortDescription(shortDesc).rev(revision.rev()).build();\n",
                      "Response<Catalog> response = service.replaceOffering(replaceOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\"\n",
                      "offeringID = \"{offeringID}\"\n",
                      "revision = \"{revision}\"\n",
                      "shortDesc = \"{shortDesc}\"\n",
                      "response = self.service.replace_offering(catalog_identifier=catalogID, offering_id=offeringID, id=offeringID, rev=revision, label=label, short_description=shortDesc)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\";\n",
                      "offeringID = \"{offeringID}\";\n",
                      "revision = \"{revision}\";\n",
                      "label = \"{label}\";\n",
                      "shortDesc = \"{shortDesc}\";\n",
                      "response = await service.replaceOffering({'catalogIdentifier': catalogID, 'offeringId': offeringID, 'id': offeringID, 'rev': revision, 'label': label, 'shortDescription': shortDesc});\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "patch": {
        "parameters": [
          {
            "name": "If-Match",
            "description": "Offering etag contained in quotes.",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "operationId": "update_offering",
        "summary": "Update offering",
        "description": "Update an offering using a JSONPatch document as defined by RFC 6902.",
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "x-codegen-request-body-name": "updates",
        "requestBody": {
          "$ref": "#/components/requestBodies/PatchBody"
        },
        "responses": {
          "200": {
            "description": "Offering was updated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offering"
                }
              }
            },
            "links": {
              "OfferingRev": {
                "$ref": "#/components/links/OfferingRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        }
      },
      "delete": {
        "operationId": "delete_offering",
        "summary": "Delete offering",
        "description": "Delete an offering",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/OfferingId"
          },
          {
            "name": "X-Approver-Token",
            "description": "IAM token of partner center. Only needed when Partner Center accessing the private catalog offering. When accessing the public offering Partner Center only needs to use their token in the authorization header.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "Authorization",
            "description": "IAM token (`Bearer <token>`) for authorization. For private offerings must be token for offering owner to approve access by Partner Center. Partner Center would put its token in `X-Approver-Token`. For access to public offering Partner Center or authorized approvers would use their token here.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.delete"
          ]
        },
        "responses": {
          "200": {
            "description": "Offering was deleted successfully"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalogg"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID := \"{catalogID}\"\n",
                      "offeringID := \"{offeringID}\"\n",
                      "deleteOptions := service.NewDeleteOfferingOptions(catalogID, offeringID)\n",
                      "response, _ := service.DeleteOffering(deleteOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String catalogID = \"{catalogID}\";\n",
                      "String offeringID = \"{offeringID}\";\n",
                      "DeleteOfferingOptions deleteOfferingOptions = new DeleteOfferingOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).build();\n",
                      "Response<Void> response = service.deleteOffering(deleteOfferingOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\"\n",
                      "offeringID = \"{offeringID}\"\n",
                      "response = self.service.delete_offering(catalog_identifier=catalogID, offering_id=offeringID)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\";\n",
                      "offeringID = \"{offeringID}\";\n",
                      "response = await service.deleteOffering({ 'catalogIdentifier': catalogID, 'offeringId': offeringID });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/stats": {
      "get": {
        "tags": [
          "Offerings"
        ],
        "operationId": "get_offering_stats",
        "x-sdk-exclude": false,
        "summary": "Get offering statistics",
        "description": "Get the usage statistics for the specified offering.",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/OfferingId"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/MetricStats"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/audits": {
      "get": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "operationId": "list_offering_audits",
        "x-sdk-exclude": false,
        "summary": "Get offering audit logs",
        "description": "Get the audit logs associated with an offering.",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/OfferingId"
          },
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLogs"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/audits/{auditlog_identifier}": {
      "get": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "operationId": "get_offering_audit",
        "x-sdk-exclude": false,
        "summary": "Get an offering audit log entry",
        "description": "Get the full audit log entry associated with an offering.",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/OfferingId"
          },
          {
            "$ref": "#/components/parameters/AuditLogIdentifier"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLog"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/publish/{approval_type}/{approved}": {
      "post": {
        "operationId": "set_offering_publish",
        "summary": "Set offering publish approval settings",
        "description": "Approve or disapprove the offering to be allowed to publish to a particular public catalog based on the approval type. \nApprovers should use the catalog and offering id from the public catalog since they wouldn't have access to the private offering.",
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/OfferingId"
          },
          {
            "name": "approval_type",
            "description": "Type of approval. \n * `pc_managed` - Partner Center is managing this offering\n * `ibm_module_repo` -  Offering is from an approved repository can be published into the module registry.\n * `ibm_community` - Offering is from an approved repository can be published into the Community registry.\n * `publish_approved` - Publishing approved, offering owners can now set who sees the offering in public catalog\n * `approval_required` - Offering will be removed from public catalog when this flag is set to true, regardless of the approval and visibility settings.\n",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "pc_managed",
                "publish_approved",
                "ibm_module_repo",
                "ibm_community",
                "approval_required"
              ]
            }
          },
          {
            "name": "approved",
            "description": "Approve (true) or disapprove (false)",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "true",
                "false"
              ]
            }
          },
          {
            "name": "portal_record",
            "description": "Partner Center identifier for this offering",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "portal_url",
            "description": "Partner Center url for this offering",
            "in": "query",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Approver-Token",
            "description": "IAM token of partner center. Only needed when Partner Center accessing the private catalog offering. When accessing the public offering Partner Center only needs to use their token in the authorization header.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Auth-Token",
            "description": "Authentication token used to verify if user is a collaborator of a repository as part of the checks to set the approval type as `ibm_module_repo` or `ibm_community`",
            "in": "header",
            "required": false,
            "schema": {
              "type": "string",
              "description": "String literal or JSON encoded value of $ref:#/components/schemas/SecretInstance, prefixed with `cmsm_v1:`"
            }
          },
          {
            "name": "Authorization",
            "description": "IAM token (`Bearer <token>`) for authorization. For private offerings must be token for offering owner to approve access by Partner Center. Partner Center would put its token in `X-Approver-Token`. For access to public offering Partner Center or authorized approvers would use their token here.",
            "in": "header",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ApprovalResult"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID := \"{catalogID}\"\n",
                      "offeringID := \"{offeringID}\"\n",
                      "approvalType := \"{approvalType}\"\n",
                      "approved := \"{approved}\"\n",
                      "updateOptions := service.NewUpdateOfferingIbmOptions(catalogID, offeringID, approvalType, approved)\n",
                      "_, response, _ := service.UpdateOfferingIbm(updateOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String catalogID = \"{catalogID}\";\n",
                      "String offeringID = \"{offeringID}\";\n",
                      "String approvalType = \"{approvalType}\";\n",
                      "String approved = \"{approved}\";\n",
                      "UpdateOfferingIbmOptions updateOptions = new UpdateOfferingIbmOptions.Builder().catalogIdentifier(catalogID).offeringId(offeringID).approvalType(approvalType).approved(approved).build();\n",
                      "Response<ApprovalResult> response = service.updateOfferingIbm(updateOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\";\n",
                      "offeringID = \"{offeringID}\";\n",
                      "approvalType = \"{approvalType}\";\n",
                      "approved = \"{approved}\";\n",
                      "response = await service.updateOfferingIbm({ 'catalogIdentifier': catalogID, 'offeringId': offeringID, 'approvalType': approvalType, 'approved': approved });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "catalogID = \"{catalogID}\"\n",
                      "offeringID = \"{offeringID}\"\n",
                      "approvalType = \"{approvalType}\"\n",
                      "approved = \"{approved}\"\n",
                      "response = self.service.update_offering_ibm(catalog_identifier=catalogID, offering_id=offeringID, approval_type=approvalType, approved=approved)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/deprecate/{setting}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/OfferingId"
        },
        {
          "$ref": "#/components/parameters/DeprecateSetting"
        }
      ],
      "post": {
        "operationId": "deprecate_offering",
        "summary": "Allows offering to be deprecated",
        "description": "Approve or disapprove the offering to be deprecated.",
        "requestBody": {
          "$ref": "#/components/requestBodies/DeprecateRequestBody"
        },
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "responses": {
          "202": {
            "description": "Request accepted."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/share": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/OfferingId"
        }
      ],
      "post": {
        "operationId": "share_offering",
        "summary": "Allows offering to be shared",
        "description": "Set the share options on an offering.",
        "requestBody": {
          "$ref": "#/components/requestBodies/ShareSetting"
        },
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShareSetting"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/access/{access_identifier}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/OfferingId"
        },
        {
          "$ref": "#/components/parameters/AccessIdentifier"
        }
      ],
      "get": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.read"
          ]
        },
        "operationId": "get_offering_access",
        "summary": "Check for account ID in offering access list",
        "description": "Determine if an account ID is in an offering's access list",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Access"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "The specified account ID was not found in the offering's access list."
          }
        }
      },
      "put": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.update"
          ]
        },
        "operationId": "update_offering_access",
        "summary": "Update the access list entry for a specific account",
        "description": "Update an access list entry for a specific account",
        "x-codegen-request-body-name": "access",
        "requestBody": {
          "$ref": "#/components/requestBodies/Access"
        },
        "responses": {
          "200": {
            "description": "Access list entry was updated successsfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Access"
                }
              }
            },
            "links": {
              "AccessRev": {
                "$ref": "#/components/links/AccessRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering/access list entry"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/access": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/OfferingId"
        }
      ],
      "get": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.read"
          ]
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "$ref": "#/components/parameters/Limit"
          }
        ],
        "operationId": "get_offering_access_list",
        "summary": "Get offering access list",
        "description": "Get the access list associated with the specified offering",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessListResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      },
      "delete": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.delete"
          ]
        },
        "operationId": "delete_offering_access_list",
        "summary": "Delete accesses from offering access list",
        "description": "Delete all or a set of accesses from an offering's access list.",
        "x-codegen-request-body-name": "accesses",
        "requestBody": {
          "description": "A list of accesses to delete.  An entry with star[\"*\"] will remove all accesses",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AccessIdentifier"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response, still need to look for errors for specific accesses",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessListBulkResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      },
      "post": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.create"
          ]
        },
        "operationId": "add_offering_access_list",
        "summary": "Add accesses to offering access list",
        "description": "Add one or more accesses to the specified offering's access list.",
        "x-codegen-request-body-name": "accesses",
        "requestBody": {
          "description": "A list of accesses to add.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AccessIdentifier"
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful response, still need to look for errors for specific accesses",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessListResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/updates": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/OfferingId"
        }
      ],
      "get": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "operationId": "get_offering_updates",
        "summary": "Get version updates",
        "description": "Get available updates for the specified version",
        "parameters": [
          {
            "name": "kind",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The kind of offering (e.g, helm, ova, terraform ...)"
          },
          {
            "name": "target",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "The target kind of the currently installed version (e.g. iks, roks, etc)"
          },
          {
            "name": "version",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "optionaly provide an existing version to check updates for if one is not given, all version will be returned."
          },
          {
            "name": "cluster_id",
            "description": "The id of the cluster where this version was installed",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "region",
            "description": "The region of the cluster where this version was installed",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "resource_group_id",
            "description": "The resource group id of the cluster where this version was installed",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "namespace",
            "description": "The namespace of the cluster where this version was installed",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sha",
            "description": "The sha value of the currently installed version",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "channel",
            "description": "Optionally provide the channel value of the currently installed version",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "namespaces",
            "description": "Optionally provide a list of namespaces used for the currently installed version",
            "in": "query",
            "required": false,
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          },
          {
            "name": "all_namespaces",
            "description": "Optionally indicate that the current version was installed in all namespaces",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "flavor",
            "description": "The programmatic flavor name of the version that was installed",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "install_type",
            "description": "The install type of the version that was installed",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Auth-Refresh-Token",
            "description": "IAM Refresh token",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Version Descriptors, sorted newest first",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/VersionUpdateDescriptor"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "getOptions := service.NewGetVersionUpdatesOptions(versionLocator)\n",
                      "_, response, _ := service.GetVersionUpdates(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "GetVersionUpdatesOptions getOptions = new GetVersionUpdatesOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<List<VersionUpdateDescriptor>> response = service.getVersionUpdates(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.get_offering_updates(version_loc_id=versionLocator)\n",
                      "print(response)\n",
                      ""
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "response = await service.getVersionUpdates({ 'versionLocId': versionLocator});\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/changeNotices": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/OfferingId"
        }
      ],
      "get": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "operationId": "get_offering_change_notices",
        "summary": "Get version change notices",
        "description": "Get change notices for the specified version",
        "parameters": [
          {
            "name": "kind",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "The kind of offering (e.g, helm, ova, terraform ...)"
          },
          {
            "name": "target",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "The target kind of the currently installed version (e.g. iks, roks, etc)"
          },
          {
            "name": "version",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            },
            "description": "optionaly provide an existing version to check updates for if one is not given, all version will be returned."
          },
          {
            "name": "flavor",
            "description": "The programmatic flavor name of the version that was installed",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "versions",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string",
              "enum": [
                "latest",
                "all"
              ]
            },
            "description": "optionaly specify if change notices should be returned for all versions of this kind and flavor, or for all versions that are newer than the specified version, including the specified version"
          }
        ],
        "responses": {
          "200": {
            "description": "Change notices, sorted newest first",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ChangeNoticesResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {}
      }
    },
    "/offering/source": {
      "parameters": [],
      "get": {
        "operationId": "get_offering_source",
        "summary": "Get offering source",
        "description": "Get an offering's source.  This request requires authorization for private offerings.",
        "parameters": [
          {
            "name": "catalogID",
            "in": "query",
            "description": "Catalog ID.  If not specified, this value will default to the public catalog.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "Offering name.  An offering name or ID must be specified.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "description": "Offering id.  An offering name or ID must be specified.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kind",
            "in": "query",
            "description": "The kind of offering (e.g. helm, ova, terraform...)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "version",
            "in": "query",
            "description": "The version being requested",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "channel",
            "in": "query",
            "description": "The channel value of the specified version",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "flavor",
            "in": "query",
            "description": "The programmatic flavor name of the specified version",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "asIs",
            "in": "query",
            "description": "If false (the default), the root folder from the original onboarded tgz file is removed.  If true, the root folder is returned.",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "installType",
            "in": "query",
            "description": "The install type of the specified version.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/yaml": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              },
              "application/x-gzip": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such offering"
          }
        }
      }
    },
    "/offering/source/archive": {
      "parameters": [],
      "get": {
        "operationId": "get_offering_source_archive",
        "summary": "Get offering source",
        "description": "Get an offering's source.  This request requires authorization for private offerings.  Note that the URL can include an additional 'working directory' value (i.e. /offering/source/archive//solutions/standard), which allows this single URL to be used in a Terraform module statement as well.",
        "parameters": [
          {
            "name": "catalogID",
            "in": "query",
            "description": "Catalog ID.  If not specified, this value will default to the public catalog.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "Offering name.  An offering name or ID must be specified.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "description": "Offering id.  An offering name or ID must be specified.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "kind",
            "in": "query",
            "description": "The kind of offering (e.g. helm, ova, terraform...)",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "version",
            "in": "query",
            "description": "The version being requested",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "channel",
            "in": "query",
            "description": "The channel value of the specified version",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "flavor",
            "in": "query",
            "description": "The programmatic flavor name of the specified version",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "asIs",
            "in": "query",
            "description": "If false (the default), the root folder from the original onboarded tgz file is removed.  If true, the root folder is returned.",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "installType",
            "in": "query",
            "description": "The install type of the specified version.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/yaml": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              },
              "application/x-gzip": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such offering"
          }
        }
      }
    },
    "/offering/source/url/{key_identifier}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/KeyIdentifier"
        }
      ],
      "get": {
        "operationId": "get_offering_source_url",
        "summary": "Get offering source URL",
        "description": "Get an offering's private source image.",
        "parameters": [
          {
            "name": "catalogID",
            "in": "query",
            "description": "Catalog ID. If not specified, this value will default to the public catalog.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "Offering name. An offering name or ID must be specified.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "id",
            "in": "query",
            "description": "Offering id. An offering name or ID must be specified.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/yaml": {
                "schema": {
                  "type": "string"
                }
              },
              "application/json": {
                "schema": {
                  "type": "string"
                }
              },
              "application/x-gzip": {
                "schema": {
                  "type": "string",
                  "format": "binary"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such offering"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/audit": {
      "get": {
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "deprecated": true,
        "operationId": "get_offering_audit_old",
        "x-sdk-exclude": true,
        "summary": "Get offering audit log",
        "description": "Get the audit log associated with an offering.",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/OfferingId"
          },
          {
            "name": "id",
            "in": "query",
            "description": "Log identification.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLogOld"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/objects": {
      "get": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.objects.list"
          ]
        },
        "operationId": "search_objects",
        "summary": "List objects across catalogs",
        "description": "List the available objects from both public and private catalogs. These copies cannot be used for updating. They are not complete and only return what is visible to the caller.",
        "parameters": [
          {
            "$ref": "#/components/parameters/ObjectKind"
          },
          {
            "name": "query",
            "description": "Lucene query string",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "description": "The maximum number of results to return",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 100,
              "maximum": 1000
            }
          },
          {
            "name": "offset",
            "description": "The number of results to skip before returning values",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "collapse",
            "description": "When true, hide private objects that correspond to public or IBM published objects",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "digest",
            "description": "Display a digests of search results, has default value of true",
            "in": "query",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ObjectSearchResult"
                }
              }
            }
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/offerings/{offering_id}/kinds/{kind_id}/versions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/OfferingId"
        },
        {
          "$ref": "#/components/parameters/KindId"
        }
      ],
      "get": {
        "operationId": "get_versions",
        "summary": "Get versions",
        "description": "Get the versions of the specified kind in the specified offering. This can be used by an unauthenticated user for publicly available offerings.",
        "parameters": [
          {
            "name": "digest",
            "in": "query",
            "description": "Return the digest format of the specified offering.  Default is false.",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "name": "catalog",
            "in": "query",
            "description": "Return consumable versions.  Default is false.",
            "required": false,
            "schema": {
              "type": "boolean"
            }
          },
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "name": "limit",
            "description": "number or results to return in the query",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 150,
              "maximum": 150
            }
          }
        ],
        "tags": [
          "Offerings"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VersionsResult"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/objects": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        }
      ],
      "get": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.objects.list"
          ]
        },
        "operationId": "list_objects",
        "summary": "List objects within a catalog",
        "description": "List the available objects within the specified catalog.",
        "parameters": [
          {
            "name": "limit",
            "description": "The number of results to return",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 100,
              "maximum": 1000
            }
          },
          {
            "name": "offset",
            "description": "The number of results to skip before returning values",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0
            }
          },
          {
            "name": "name",
            "description": "Only return results that contain the specified string",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "sort",
            "description": "The field on which the output is sorted. Sorts by default by **label** property. Available fields are **name**, **label**, **created**, and **updated**. By adding **-** (i.e. **-label**) in front of the query string, you can specify descending order. Default is ascending order.",
            "in": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ObjectListResult"
                }
              }
            }
          }
        }
      },
      "post": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.object.create"
          ]
        },
        "operationId": "create_object",
        "summary": "Create catalog object",
        "description": "Create an object with a specific catalog",
        "x-codegen-request-body-name": "catalog_object",
        "requestBody": {
          "$ref": "#/components/requestBodies/CatalogObjectPrototype"
        },
        "responses": {
          "201": {
            "description": "Catalog object created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogObject"
                }
              }
            },
            "links": {
              "ObjectID": {
                "$ref": "#/components/links/ObjectID"
              },
              "ObjectRev": {
                "$ref": "#/components/links/ObjectRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/objects/{object_identifier}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/ObjectIdentifier"
        }
      ],
      "get": {
        "operationId": "get_object",
        "summary": "Get catalog object",
        "description": "Get the specified object from within the specified catalog",
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.object.read"
          ]
        },
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogObject"
                }
              }
            },
            "links": {
              "ObjectRev": {
                "$ref": "#/components/links/ObjectRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/object"
          }
        }
      },
      "put": {
        "operationId": "replace_object",
        "summary": "Update catalog object",
        "description": "Update an object within a specific catalog",
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.object.update"
          ]
        },
        "x-codegen-request-body-name": "catalog_object",
        "requestBody": {
          "$ref": "#/components/requestBodies/CatalogObject"
        },
        "responses": {
          "200": {
            "description": "Catalog object was updated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/CatalogObject"
                }
              }
            },
            "links": {
              "ObjectRev": {
                "$ref": "#/components/links/ObjectRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/object"
          }
        }
      },
      "delete": {
        "operationId": "delete_object",
        "summary": "Delete catalog object",
        "description": "Delete a specific object within a specific catalog",
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.object.delete"
          ]
        },
        "responses": {
          "200": {
            "description": "Catalog object was deleted successfully"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/objects/{object_identifier}/audits": {
      "get": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "operationId": "list_object_audits",
        "x-sdk-exclude": false,
        "summary": "Get object audit logs",
        "description": "Get the audit logs associated with an object.",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/ObjectIdentifier"
          },
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLogs"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/objects/{object_identifier}/audits/{auditlog_identifier}": {
      "get": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "operationId": "get_object_audit",
        "x-sdk-exclude": false,
        "summary": "Get an object audit log entry",
        "description": "Get the full audit log entry associated with an object.",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/ObjectIdentifier"
          },
          {
            "$ref": "#/components/parameters/AuditLogIdentifier"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLog"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/objects/{object_identifier}/consume-publish": {
      "post": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.object.update"
          ]
        },
        "operationId": "consumable_share_object",
        "summary": "Make object consumable for sharing",
        "description": "Set the object as consumable in order to use the object sharing permissions.",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/ObjectIdentifier"
          }
        ],
        "responses": {
          "202": {
            "description": "Request accepted."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/objects/{object_identifier}/share": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/ObjectIdentifier"
        }
      ],
      "post": {
        "operationId": "share_object",
        "summary": "Allows object to be shared",
        "description": "Set the share options on an object.",
        "requestBody": {
          "$ref": "#/components/requestBodies/ShareSetting"
        },
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.object.update"
          ]
        },
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ShareSetting"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/objects/{object_identifier}/accessv1": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/ObjectIdentifier"
        }
      ],
      "get": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.read"
          ]
        },
        "parameters": [
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "$ref": "#/components/parameters/Limit"
          }
        ],
        "operationId": "get_object_access_list",
        "summary": "Get object access list",
        "description": "Get the access list associated with the specified object",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessListResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/objects/{object_identifier}/access/{access_identifier}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/ObjectIdentifier"
        },
        {
          "$ref": "#/components/parameters/AccessIdentifier"
        }
      ],
      "get": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.read"
          ]
        },
        "operationId": "get_object_access",
        "summary": "Check for account ID in object access list",
        "description": "Determine if an account ID is in an object's access list",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Access"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "The specified account ID was not found in the object's access list."
          }
        }
      },
      "post": {
        "deprecated": true,
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.create"
          ]
        },
        "operationId": "create_object_access",
        "x-sdk-exclude": false,
        "summary": "Add account ID to object access list",
        "description": "Add an account ID to an object's access list.",
        "responses": {
          "201": {
            "description": "Created."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      },
      "delete": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.delete"
          ]
        },
        "deprecated": true,
        "operationId": "delete_object_access",
        "x-sdk-exclude": false,
        "summary": "Remove account ID from object access list",
        "description": "Delete the specified account ID from the specified object's access list",
        "responses": {
          "200": {
            "description": "Successful response"
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/objects/{object_identifier}/access": {
      "parameters": [
        {
          "$ref": "#/components/parameters/CatalogIdentifier"
        },
        {
          "$ref": "#/components/parameters/ObjectIdentifier"
        }
      ],
      "get": {
        "deprecated": true,
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.read"
          ]
        },
        "operationId": "get_object_access_list_deprecated",
        "x-sdk-exclude": false,
        "summary": "Get object access list",
        "description": "Deprecated - use /accessv1 instead",
        "parameters": [
          {
            "name": "limit",
            "description": "The maximum number of results to return",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 100,
              "maximum": 1000
            }
          },
          {
            "name": "offset",
            "description": "The number of results to skip before returning values",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ObjectAccessListResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      },
      "delete": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.delete"
          ]
        },
        "operationId": "delete_object_access_list",
        "summary": "Delete accesses from object access list",
        "description": "Delete all or a set of accesses from an object's access list.",
        "x-codegen-request-body-name": "accesses",
        "requestBody": {
          "description": "A list of accesses to delete.  An entry with star[\"*\"] will remove all accesses",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AccessIdentifier"
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response, still need to look for errors for specific accesses",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessListBulkResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      },
      "post": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.allow-list.create"
          ]
        },
        "operationId": "add_object_access_list",
        "summary": "Add accesses to object access list",
        "description": "Add one or more accesses to the specified object's access list.",
        "x-codegen-request-body-name": "accesses",
        "requestBody": {
          "description": "A list of accesses to add.",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AccessIdentifier"
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Successful response, still need to look for errors for specific accesses",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AccessListBulkResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/catalogs/{catalog_identifier}/objects/{object_identifier}/audit": {
      "get": {
        "tags": [
          "Objects"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.account-settings.read"
          ]
        },
        "deprecated": true,
        "operationId": "get_object_audit_old",
        "x-sdk-exclude": true,
        "summary": "Get catalog object audit log",
        "description": "Get the audit log associated with a specific catalog object.",
        "parameters": [
          {
            "$ref": "#/components/parameters/CatalogIdentifier"
          },
          {
            "$ref": "#/components/parameters/ObjectIdentifier"
          },
          {
            "name": "id",
            "in": "query",
            "description": "Log identification.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLogOld"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/versions/{version_loc_id}/about": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "get": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "operationId": "get_offering_about",
        "summary": "Get version about information",
        "description": "Get the about information, in markdown, for the current version",
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "text/markdown": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "getOptions := service.NewGetVersionAboutOptions(versionLocator)\n",
                      "_, response, _ := service.GetVersionAbout(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "GetVersionAboutOptions getOptions = new GetVersionAboutOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<String> response = service.getVersionAbout(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.get_offering_about(version_loc_id=versionLocator)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator  = \"{versionLocator}\";\n",
                      "response = await service.getVersionAbout({ 'versionLocId': versionLocator });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/iamPermissions": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "get": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "operationId": "get_iam_permissions",
        "summary": "Get the required IAM permissions for this version with the specified user context",
        "description": "Get the required IAM permissions for this version with the specified user context",
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/CheckedIAMPermission"
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/versions/{version_loc_id}/licenses/{license_id}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        },
        {
          "name": "license_id",
          "description": "The ID of the license, which maps to the file name in the 'licenses' directory of this verions tgz file",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "get": {
        "tags": [
          "Versions"
        ],
        "operationId": "get_offering_license",
        "summary": "Get version license content",
        "description": "Get the license content for the specified license ID in the specified version",
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "id := \"{id}\"\n",
                      "getOptions := service.NewGetVersionLicenseOptions(versionLocator, id)\n",
                      "response, _ := service.GetVersionLicense(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "GetVersionLicenseOptions getOption = new GetVersionLicenseOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<Void> response = service.getVersionLicense(getOption).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "id = \"{id}\";\n",
                      "response = await service.getVersionLicense({ 'versionLocId': versionLocator, 'licenseId': id });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "id = \"{id}\"\n",
                      "response = self.service.get_offering_license(version_loc_id=versionLocator, license_id=id)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/containerImages": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "get": {
        "tags": [
          "Versions"
        ],
        "operationId": "get_offering_container_images",
        "summary": "Get version's container images",
        "description": "Get the list of container images associated with the specified version. The \"image_manifest_url\" property of the version should be the URL for the image manifest, and the operation will return that content",
        "responses": {
          "200": {
            "description": "Successful response. A list of images",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ImageManifest"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "getOptions := service.NewGetVersionContainerImagesOptions(versionLocator)\n",
                      "_, response, _ := service.GetVersionContainerImages(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "GetVersionContainerImagesOptions getOption = new GetVersionContainerImagesOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<ImageManifest> response = service.getVersionContainerImages(getOption).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "response = await service.getVersionContainerImages({ 'versionLocId': versionLocator});\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.get_offering_container_images(version_loc_id=versionLocator)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/archive": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "post": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "archive_version",
        "summary": "Archive version immediately",
        "description": "Archive the specified version",
        "responses": {
          "202": {
            "description": "Request accepted."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "arcOptions := service.NewArchiveVersionOptions(versionLocator)\n",
                      "response, _ := service.ArchiveVersion(arcOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "ArchiveVersionOptions arcOptions = new ArchiveVersionOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<Void> response = service.archiveVersion(arcOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "response = await service.archiveVersion({ 'versionLocId': versionLocator});\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.archive_version(version_loc_id=versionLocator)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/deprecate/{setting}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        },
        {
          "$ref": "#/components/parameters/DeprecateSetting"
        }
      ],
      "post": {
        "operationId": "set_deprecate_version",
        "summary": "Sets version to be deprecated in a certain time period",
        "description": "Set or cancel the version to be deprecated.",
        "requestBody": {
          "$ref": "#/components/requestBodies/DeprecateRequestBody"
        },
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "responses": {
          "202": {
            "description": "Request accepted."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/versions/{version_loc_id}/consume-publish": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "post": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "consumable_version",
        "summary": "Make version consumable for sharing",
        "description": "Set the version as consumable in order to inherit the offering sharing permissions",
        "responses": {
          "202": {
            "description": "Request accepted."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/versions/{version_loc_id}/prerelease-publish": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "post": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "prerelease_version",
        "summary": "Make version prerelease",
        "description": "Set the version as prerelease",
        "responses": {
          "202": {
            "description": "Request accepted."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/versions/{version_loc_id}/test-publish": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "post": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "test_version",
        "summary": "Make version test",
        "description": "Set the version as test",
        "responses": {
          "202": {
            "description": "Request accepted."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/versions/{version_loc_id}/suspend": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "post": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "suspend_version",
        "summary": "Suspend a version",
        "description": "Limits the visibility of a version by moving a version state from consumable back to validated",
        "responses": {
          "202": {
            "description": "Request accepted."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/versions/{version_loc_id}/commit": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "post": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "commit_version",
        "summary": "Commit version",
        "description": "Commit a working copy of the specified version",
        "responses": {
          "200": {
            "description": "Working copy was committed successfully"
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "commitOptions := service.NewCommitVersionOptions(versionLocator)\n",
                      "response, _ := service.commitOptions(publishOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "CommitVersionOptions commitOptions = new CommitVersionOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<Void> response = service.commitVersion(commitOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "response = await service.commitVersion({ 'versionLocId': versionLocator});\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.commit_version(version_loc_id=versionLocator)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/copy": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "post": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "copy_version",
        "summary": "Copy version to new target kind",
        "description": "Copy the specified version to a new target kind within the same offering",
        "x-codegen-request-body-name": "offering_import",
        "requestBody": {
          "$ref": "#/components/requestBodies/ImportOfferingCopyReloadBody"
        },
        "responses": {
          "200": {
            "description": "Version was copied successfully"
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/versions/{version_loc_id}/workingcopy": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "post": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "get_offering_working_copy",
        "summary": "Create working copy of version",
        "description": "Create a working copy of the specified version",
        "responses": {
          "200": {
            "description": "Working copy created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Version"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "409": {
            "description": "Working Copy already exists"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "getOptions := service.NewGetVersionWorkingCopyOptions(versionLocator)\n",
                      "_, response, _ := service.GetVersionWorkingCopy(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "GetVersionWorkingCopyOptions getVersion = new GetVersionWorkingCopyOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<Void> response = service.getVersionWorkingCopy(getVersion).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "response = await service.getVersionWorkingCopy({ 'versionLocId': versionLocator});\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.get_offering_working_copy(version_loc_id=versionLocator)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/copy/{type}/{version_loc_id_to_copy_from}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        },
        {
          "name": "type",
          "description": "The type of data you would like to copy from a previous version. Valid values are 'configuration' or 'licenses'.",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "version_loc_id_to_copy_from",
          "description": "The version locator id of the version you wish to copy data from.",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "post": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "copy_from_previous_version",
        "summary": "Copy values from a previous version",
        "description": "Copy values from a specified previous version",
        "responses": {
          "200": {
            "description": "Values copied successfully"
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "Catalog not found from specified version locator."
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "type := \"{type}\"\n",
                      "versionLocatorToCopyFrom := \"{versionLocatorToCopyFrom}\"\n",
                      "copyOptions := service.NewCopyOptions(versionLocator, type, versionLocatorToCopyFrom)\n",
                      "_, response, _ := service.Copy(copyOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "String type = \"{type}\";\n",
                      "String versionLocatorToCopyFrom = \"{versionLocatorToCopyFrom}\";\n",
                      "GetCopyOptions copyOptions = new GetCopyOptions.Builder().versionLocId(versionLocator).type(type).versionLocIdToCopyFrom(versionLocatorToCopyFrom).build();\n",
                      "Response<Void> response = service.copy(copyOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "type = \"{type}\";\n",
                      "versionLocatorToCopyFrom = \"{versionLocatorToCopyFrom}\";\n",
                      "response = await service.copy({ 'versionLocId': versionLocator, 'type': type, 'versionLocatorToCopyFrom': versionLocatorToCopyFrom });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "type = \"{type}\"\n",
                      "versionLocatorToCopyFrom = \"{versionLocatorToCopyFrom}\"\n",
                      "response = self.service.copy(version_loc_id=versionLocator, type=type, version_loc_id_to_copy_from=versionLocatorToCopyFrom)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/validateInputs": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "post": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "operationId": "validate_inputs",
        "summary": "Validates deployment input variables",
        "description": "Validates deployment input variables",
        "requestBody": {
          "$ref": "#/components/requestBodies/ValidateInputsRequest"
        },
        "responses": {
          "200": {
            "description": "Input validation preformed successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VersionInputValidationResponse"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "Catalog not found from specified version locator."
          }
        }
      }
    },
    "/versions/{version_loc_id}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "get": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "operationId": "get_version",
        "summary": "Get offering/kind/version 'branch'",
        "description": "Get the Offering/Kind/Version 'branch' for the specified locator ID",
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offering"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "versionOptions := service.NewGetVersionOptions(versionLocator)\n",
                      "_, response, _ := service.GetVersion(versionOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "GetVersionOptions getOptions = new GetVersionOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<Offering> response = service.getVersion(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.get_version(version_loc_id=versionLocator)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "response = await service.getVersion({ 'versionLocId': versionLocator });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "put": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "update_version",
        "summary": "Update a version",
        "description": "Update the version for the specified locator ID using an offering 'branch'.  Note that any changes to the Offering and Kind in the provided Offering 'branch' are discarded.",
        "requestBody": {
          "$ref": "#/components/requestBodies/Offering"
        },
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can update",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offering"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        }
      },
      "patch": {
        "parameters": [
          {
            "name": "If-Match",
            "description": "Offering etag contained in quotes.",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "operationId": "patch_update_version",
        "summary": "Update a version",
        "description": "Update a version using a JSONPatch document as defined by RFC 6902.  Note that the path must always reference '/kinds/0/versions/0/...'",
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "x-codegen-request-body-name": "updates",
        "requestBody": {
          "$ref": "#/components/requestBodies/PatchBody"
        },
        "responses": {
          "200": {
            "description": "Version was updated successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offering"
                }
              }
            },
            "links": {
              "OfferingRev": {
                "$ref": "#/components/links/OfferingRev"
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        }
      },
      "delete": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "delete_version",
        "summary": "Delete version",
        "description": "Delete the specified version.  If the version is an active version with a working copy, the working copy will be deleted as well.",
        "responses": {
          "200": {
            "description": "Version deleted successfully"
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "deleteOptions := service.NewDeleteVersionOptions(versionLocator)\n",
                      "response, _ := service.DeleteVersion(deleteOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "deleteOption = new DeleteVersionOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<Void> response = service.deleteVersion(deleteOption).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.delete_version(version_loc_id=versionLocator)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "response = await service.deleteVersion({ 'versionLocId': versionLocator });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/dependencies": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "get": {
        "tags": [
          "Versions"
        ],
        "operationId": "get_version_dependencies",
        "summary": "Get offering/kind/version 'dependencies'",
        "description": "Get the latest version of all offerings/variations that depends on this version locator",
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/VersionDependant"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "versionOptions := service.NewGetVersionOptions(versionLocator)\n",
                      "_, response, _ := service.GetVersionDependencies(versionOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "GetVersionOptions getOptions = new GetVersionOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<Offering> response = service.getVersionDependencies(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.get_version_dependencies(version_loc_id=versionLocator)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "response = await service.getVersionDependencies({ 'versionLocId': versionLocator });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/deprecate": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "post": {
        "tags": [
          "Versions"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "deprecated": true,
        "operationId": "deprecate_version",
        "x-sdk-exclude": false,
        "summary": "Deprecate version immediately - use /archive instead",
        "description": "Deprecate the specified version",
        "responses": {
          "202": {
            "description": "Request accepted."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "depOptions := service.NewDeprecateVersionOptions(versionLocator)\n",
                      "response, _ := service.DeprecateVersion(depOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "DeprecateVersionOptions depOptions = new DeprecateVersionOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<Void> response = service.deprecateVersion(depOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "response = await service.deprecateVersion({ 'versionLocId': versionLocator});\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.deprecate_version(version_loc_id=versionLocator)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/repo/{type}/entries": {
      "parameters": [
        {
          "name": "type",
          "in": "path",
          "required": true,
          "description": "The type of repository (valid repository types: helm)",
          "schema": {
            "type": "string"
          }
        }
      ],
      "get": {
        "tags": [
          "Repo"
        ],
        "operationId": "get_repos",
        "x-sdk-exclude": true,
        "summary": "List a repository's entries",
        "description": "List the available entries from a given repository",
        "parameters": [
          {
            "name": "repourl",
            "in": "query",
            "description": "The URL for the repository's root (e.g https://kubernetes-charts-incubator.storage.googleapis.com)",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HelmRepoList"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "repoType := \"{repoType}\"\n",
                      "repoURL := \"{repoURL}\"\n",
                      "getOptions := service.NewGetReposOptions(repoType, repoURL)\n",
                      "_, response, _ := service.GetRepos(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String repoType = \"{repoType}\";\n",
                      "String repoURL = \"{repoURL}\";\n",
                      "GetReposOptions getOptions = new GetReposOptions.Builder().type(repoType).repourl(repoURL).build();\n",
                      "Response<HelmPackage> response = service.getRepos(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "repoType = \"{repoType}\";\n",
                      "repoURL = \"{repoURL}\";\n",
                      "response = await service.getRepos({ 'repoType': repoType, 'repourl':  repoURL} );\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "repoType = \"{repoType}\"\n",
                      "repoURL = \"{repoURL}\"\n",
                      "response = self.service.get_repos(type=repoType, repourl=repoURL)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/repo/{type}": {
      "parameters": [
        {
          "name": "type",
          "in": "path",
          "required": true,
          "description": "The type of repository (valid repository types: helm)",
          "schema": {
            "type": "string"
          }
        }
      ],
      "get": {
        "tags": [
          "Repo"
        ],
        "operationId": "get_repo",
        "x-sdk-exclude": true,
        "summary": "Get repository contents",
        "description": "Get the contents of a given repo",
        "parameters": [
          {
            "name": "charturl",
            "in": "query",
            "description": "The URL for the repository's chart zip file (e.g https://registry.bluemix.net/helm/ibm-charts/charts/ibm-redis-ha-dev-1.0.0.tgz)",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HelmPackage"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "repoType := \"{repoType}\"\n",
                      "chartURL := \"{chartURL}\"\n",
                      "getOptions := service.NewGetRepoOptions(repoType, chartURL)\n",
                      "_, response, _ := service.GetRepo(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String repoType = \"{repoType}\";\n",
                      "String chartURL = \"{chartURL}\";\n",
                      "GetRepoOptions getOptions = new GetRepoOptions.Builder().type(repoType).charturl(chartURL).build();\n",
                      "Response<HelmPackage> response = service.getRepo(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "repoType = \"{repoType}\";\n",
                      "chartURL = \"{chartURL}\";\n",
                      "response = await service.getRepo({ 'repoType': repoType, 'charturl':  chartURL } );\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "repoType = \"{repoType}\"\n",
                      "chartUrl = \"{chartUrl}\"\n",
                      "response = self.service.get_repo(type=repoType, charturl=chartUrl)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/deploy/kubernetes/clusters/{cluster_id}": {
      "parameters": [
        {
          "name": "cluster_id",
          "description": "ID of the cluster",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "get": {
        "tags": [
          "Deploy"
        ],
        "operationId": "get_cluster",
        "summary": "Get kubernetes cluster",
        "description": "Get the contents of the specified kubernetes cluster",
        "parameters": [
          {
            "name": "region",
            "description": "Region of the cluster",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Auth-Refresh-Token",
            "description": "IAM Refresh token",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ClusterInfo"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such cluster"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID := \"{clusterID}\"\n",
                      "region := \"{region}\"\n",
                      "authRefreshToken := \"{authRefreshToken}\"\n",
                      "getOptions := service.NewGetClusterOptions(clusterID, region, authRefreshToken)\n",
                      "_, response, _ := service.GetCluster(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String clusterID = \"{clusterID}\";\n",
                      "String region = \"{region}\";\n",
                      "String authRefreshToken = \"{authRefreshToken}\";\n",
                      "GetClusterOptions getOptions = new GetClusterOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).build();\n",
                      "Response<ClusterInfo> response = service.getCluster(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\";\n",
                      "region = \"{region}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.getCluster({ 'clusterId': clusterID, 'region': region, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\"\n",
                      "region = \"{region}\"\n",
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "response = self.service.get_cluster(cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/deploy/kubernetes/clusters/{cluster_id}/namespaces": {
      "parameters": [
        {
          "name": "cluster_id",
          "description": "ID of the cluster",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "get": {
        "tags": [
          "Deploy"
        ],
        "operationId": "get_namespaces",
        "summary": "Get cluster namespaces",
        "description": "Get the namespaces associated with the specified kubernetes cluster",
        "parameters": [
          {
            "name": "region",
            "description": "Cluster region",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "X-Auth-Refresh-Token",
            "description": "IAM Refresh token",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "limit",
            "description": "The maximum number of results to return",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 100,
              "maximum": 1000
            }
          },
          {
            "name": "offset",
            "description": "The number of results to skip before returning values",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 0
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of namespaces on the cluster that are visible by the current user",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/NamespaceSearchResult"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such cluster"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID := \"{clusterID}\"\n",
                      "region := \"{region}\"\n",
                      "authRefreshToken := \"{authRefreshToken}\"\n",
                      "getOptions := service.NewGetNamespacesOptions(clusterID, region, authRefreshToken)\n",
                      "_, response, _ := service.GetNamespaces(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String clusterID = \"{clusterID}\";\n",
                      "String region = \"{region}\";\n",
                      "String authRefreshToken = \"{authRefreshToken}\";\n",
                      "GetNamespacesOptions getOptions = new GetNamespacesOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).build();\n",
                      "Response<NamespaceSearchResult> response = service.getNamespaces(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\";\n",
                      "region = \"{region}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.getNamespaces({ 'clusterId': clusterID, 'region': region, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\"\n",
                      "region = \"{region}\"\n",
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "response = self.service.get_namespaces(cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/deploy/kubernetes/olm/operator": {
      "parameters": [
        {
          "name": "X-Auth-Refresh-Token",
          "description": "IAM Refresh token",
          "in": "header",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "post": {
        "tags": [
          "Deploy"
        ],
        "operationId": "deploy_operators",
        "summary": "Deploy operators",
        "description": "Deploy operators on a kubernetes cluster",
        "x-codegen-request-body-name": "operator_deploy",
        "requestBody": {
          "$ref": "#/components/requestBodies/OperatorDeploy"
        },
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/OperatorDeployResult"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "createOption := service.NewCreateOperatorOptions(authRefreshToken)\n",
                      "createOption.SetNamespaces({namespaces}}\n",
                      "createOption.SetClusterID(\"{clusterID}\")\n",
                      "createOption.SetRegion(\"{region}\")\n",
                      "createOption.SetVersionLocatorID(\"{versionLocator}\")\n",
                      "_, response, _ := service.CreateOperator(createOption)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String namespaces = {namespaces};\n",
                      "String clusterID = \"{clusterID}\";\n",
                      "String region = \"{region}\";\n",
                      "String authRefreshToken = \"{authRefreshToken}\";\n",
                      "String versionLocator = \"{versionLocator}\";\n",
                      "CreateOperatorOptions createOptions = new CreateOperatorOptions.Builder().namespaces(namespaces).clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build();\n",
                      "Response<List<OperatorDeployResult>> response = service.createOperator(createOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\";\n",
                      "region = \"{region}\";\n",
                      "namespaces = \"{namespaces}\";\n",
                      "versionLocator = \"{versionLocator}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.createOperator({ 'clusterId': clusterID, 'region': region, 'namespaces': namespaces, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\"\n",
                      "region = \"{region}\"\n",
                      "namespaces = {namespaces}\n",
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.create_operator(version_locator_id=versionLocator, cluster_id=clusterID, region=region, namespaces=namespaces, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "get": {
        "tags": [
          "Deploy"
        ],
        "operationId": "list_operators",
        "summary": "List operators",
        "description": "List the operators from a kubernetes cluster",
        "parameters": [
          {
            "name": "cluster_id",
            "description": "Cluster identification",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "region",
            "description": "Cluster region",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "version_locator_id",
            "description": "A dotted value of `catalogID`.`versionID`",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/OperatorDeployResult"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID := \"{clusterID}\"\n",
                      "region := \"{region}\"\n",
                      "versionLocator := \"{versionLocator}\"\n",
                      "authRefreshToken := \"{authRefreshToken}\"\n",
                      "listOptions := service.NewListOperatorsOptions(authRefreshToken, clusterID, region, versionLocator)\n",
                      "_, response, _ := service.ListOperators(listOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String clusterID = \"{clusterID}\";\n",
                      "String region = \"{region}\";\n",
                      "String authRefreshToken = \"{authRefreshToken}\";\n",
                      "String versionLocator = \"{versionLocator}\";\n",
                      "ListOperatorsOptions listOptions = new ListOperatorsOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build();\n",
                      "Response<List<OperatorDeployResult>> response = service.listOperators(listOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\";\n",
                      "region = \"{region}\";\n",
                      "versionLocator = \"{versionLocator}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.listOperators({ 'clusterId': clusterID, 'region': region, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\"\n",
                      "region = \"{region}\"\n",
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.list_operators(version_locator_id=versionLocator, cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "put": {
        "tags": [
          "Deploy"
        ],
        "operationId": "replace_operators",
        "summary": "Update operators",
        "description": "Update the operators on a kubernetes cluster",
        "x-codegen-request-body-name": "operator_deploy",
        "requestBody": {
          "$ref": "#/components/requestBodies/OperatorDeploy"
        },
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/OperatorDeployResult"
                  }
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "replaceOptions := service.NewReplaceOperatorOptions(authRefreshToken)\n",
                      "replaceOptions.SetNamespaces({namespaces}}\n",
                      "replaceOptions.SetClusterID(\"{clusterID}\")\n",
                      "replaceOptions.SetRegion(\"{region}\")\n",
                      "replaceOptions.SetVersionLocatorID(\"{versionLocator}\")\n",
                      "_, response, _ := service.ReplaceOperator(replaceOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String namespaces = {namespaces};\n",
                      "String clusterID = \"{clusterID}\";\n",
                      "String region = \"{region}\";\n",
                      "String authRefreshToken = \"{authRefreshToken}\";\n",
                      "String versionLocator = \"{versionLocator}\";\n",
                      "ReplaceOperatorOptions replaceOptions = new ReplaceOperatorOptions.Builder().namespaces(namespaces).clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build();\n",
                      "Response<List<OperatorDeployResult>> response = service.replaceOperator(replaceOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\";\n",
                      "region = \"{region}\";\n",
                      "namespaces = \"{namespaces}\";\n",
                      "versionLocator = \"{versionLocator}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.replaceOperator({ 'clusterId': clusterID, 'region': region, 'namespaces': namespaces, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\"\n",
                      "region = \"{region}\"\n",
                      "namespaces = {namespaces}\n",
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.replace_operator(version_locator_id=versionLocator, cluster_id=clusterID, region=region, namespaces=namespaces, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "delete": {
        "tags": [
          "Deploy"
        ],
        "operationId": "delete_operators",
        "summary": "Delete operators",
        "description": "Delete operators from a kubernetes cluster",
        "parameters": [
          {
            "name": "cluster_id",
            "description": "Cluster identification",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "region",
            "description": "Cluster region",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "version_locator_id",
            "description": "A dotted value of `catalogID`.`versionID`",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Result"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "deleteOptions := service.NewDeleteOperatorOptions(authRefreshToken, clusterID, region, versionLocator)\n",
                      "deleteOptions.SetNamespaces({namespaces}}\n",
                      "deleteOptions.SetClusterID(\"{clusterID}\")\n",
                      "deleteOptions.SetRegion(\"{region}\")\n",
                      "deleteOptions.SetVersionLocatorID(\"{versionLocator}\")\n",
                      "_, response, _ := service.ReplaceOperator(deleteOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String clusterID = \"{clusterID}\";\n",
                      "String region = \"{region}\";\n",
                      "String authRefreshToken = \"{authRefreshToken}\";\n",
                      "String versionLocator = \"{versionLocator}\";\n",
                      "DeleteOperatorOptions deleteOptions = new DeleteOperatorOptions.Builder().clusterId(clusterID).region(region).xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build();\n",
                      "Response<Void> response = service.deleteOperator(deleteOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\";\n",
                      "region = \"{region}\";\n",
                      "versionLocator = \"{versionLocator}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.deleteOperator({ 'clusterId': clusterID, 'region': region, 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "clusterID = \"{clusterID}\"\n",
                      "region = \"{region}\"\n",
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.delete_operator(version_locator_id=versionLocator, cluster_id=clusterID, region=region, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/install": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ],
      "post": {
        "tags": [
          "Deploy"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "operationId": "install_version",
        "summary": "Install version",
        "description": "Create an install for the specified version",
        "parameters": [
          {
            "name": "X-Auth-Refresh-Token",
            "description": "IAM Refresh token",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "x-codegen-request-body-name": "deploy_request",
        "requestBody": {
          "$ref": "#/components/requestBodies/DeployRequestBody"
        },
        "responses": {
          "202": {
            "description": "Request accepted"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "authRefreshToken := \"{authRefreshToken}\"\n",
                      "installOptions := service.NewInstallVersionOptions(versionLocator, authRefreshToken)\n",
                      "response, _ := service.InstallVersion(installOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String authRefreshToken = \"{authRefreshToken}\";\n",
                      "String versionLocator = \"{versionLocator}\";\n",
                      "InstallVersionOptions installOptions = new InstallVersionOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build();\n",
                      "Response<Void> response = service.installVersion(installOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.installVersion({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.install_version(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/preinstall": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        },
        {
          "name": "X-Auth-Refresh-Token",
          "description": "IAM Refresh token",
          "in": "header",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "post": {
        "tags": [
          "Deploy"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "operationId": "preinstall_version",
        "summary": "Pre-install version",
        "description": "Create a pre-install for the specified version",
        "x-codegen-request-body-name": "deploy_request",
        "requestBody": {
          "$ref": "#/components/requestBodies/DeployRequestBody"
        },
        "responses": {
          "202": {
            "description": "Request accepted"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "authRefreshToken := \"{authRefreshToken}\"\n",
                      "installOptions := service.NewPreinstallVersionOptions(versionLocator, authRefreshToken)\n",
                      "response, _ := service.PreinstallVersion(installOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String authRefreshToken = \"{authRefreshToken}\";\n",
                      "String versionLocator = \"{versionLocator}\";\n",
                      "PreinstallVersionOptions installOptions = new PreinstallVersionOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocatorId(versionLocator).build();\n",
                      "Response<Void> response = service.preinstallVersion(installOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.preinstallVersion({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.preinstall_version(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "get": {
        "tags": [
          "Deploy"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "operationId": "get_preinstall",
        "summary": "Get version pre-install status",
        "description": "Get the pre-install status for the specified version",
        "parameters": [
          {
            "name": "cluster_id",
            "in": "query",
            "description": "ID of the cluster",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "region",
            "in": "query",
            "description": "Cluster region",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "namespace",
            "in": "query",
            "description": "Required if the version's pre-install scope is `namespace`",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Preinstall status",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/InstallStatus"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "authRefreshToken := \"{authRefreshToken}\"\n",
                      "getOptions := service.NewGetPreinstallOptions(versionLocator, authRefreshToken)\n",
                      "_, response, _ := service.GetPreinstall(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String authRefreshToken = \"{authRefreshToken}\";\n",
                      "String versionLocator = \"{versionLocator}\";\n",
                      "GetPreinstallOptions installOptions = new GetPreinstallOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocId(versionLocator).build();\n",
                      "Response<Void> response = service.getPreinstall(installOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.getPreinstall({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.get_preinstall(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/validation/install": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        },
        {
          "$ref": "#/components/parameters/TargetContextName"
        },
        {
          "name": "X-Auth-Refresh-Token",
          "description": "IAM Refresh token",
          "in": "header",
          "required": true,
          "schema": {
            "type": "string"
          }
        }
      ],
      "post": {
        "tags": [
          "Deploy"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "validate_install",
        "summary": "Validate offering",
        "description": "Validate the offering associated with the specified version",
        "x-codegen-request-body-name": "deploy_request",
        "requestBody": {
          "$ref": "#/components/requestBodies/DeployRequestBody"
        },
        "responses": {
          "202": {
            "description": "Request accepted"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "authRefreshToken := \"{authRefreshToken}\"\n",
                      "installOptions := service.NewValidationInstallOptions(versionLocator, authRefreshToken)\n",
                      "response, _ := service.ValidationInstall(installOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String authRefreshToken = \"{authRefreshToken}\";\n",
                      "String versionLocator = \"{versionLocator}\";\n",
                      "ValidationInstallOptions installOptions = new ValidationInstallOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocId(versionLocator).build();\n",
                      "Response<Void> response = service.validationInstall(installOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.validationInstall({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.validation_install(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "get": {
        "tags": [
          "Deploy"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "get_validation_status",
        "summary": "Get offering install status",
        "description": "Returns the install status for the specified offering version",
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Validation"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "authRefreshToken := \"{authRefreshToken}\"\n",
                      "getOptions := service.NewGetValidationStatusOptions(versionLocator, authRefreshToken)\n",
                      "_, response, _ := service.GetValidationStatus(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String authRefreshToken = \"{authRefreshToken}\";\n",
                      "String versionLocator = \"{versionLocator}\";\n",
                      "GetValidationStatusOptions getOptions = new GetValidationStatusOptions.Builder().xAuthRefreshToken(authRefreshToken).versionLocId(versionLocator).build();\n",
                      "Response<Void> response = service.getValidationStatus(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.getValidationStatus({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.get_validation_status(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/workspaces": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        },
        {
          "$ref": "#/components/parameters/TargetContextName"
        }
      ],
      "get": {
        "deprecated": true,
        "tags": [
          "Deploy"
        ],
        "x-sdk-exclude": true,
        "operationId": "get_schematics_workspaces",
        "summary": "Get schematics workspaces",
        "description": "Returns the schematics workspaces for the specified offering version",
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SchematicsWorkspaceSearchResult"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog/offering/kind/version"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator := \"{versionLocator}\"\n",
                      "authRefreshToken := \"{authRefreshToken}\"\n",
                      "getOptions := service.NewGetSchematicsWorkspacesOptions(versionLocator, authRefreshToken)\n",
                      "_, response, _ := service.GetSchematicsWorkspaces(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String versionLocator = \"{versionLocator}\";\n",
                      "GetSchematicsWorkspacesOptions getOptions = new GetSchematicsWorkspacesOptions.Builder().versionLocId(versionLocator).build();\n",
                      "Response<SchematicsWorkspaceSearchResult> response = service.getSchematicsWorkspaces(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "versionLocator = \"{versionLocator}\";\n",
                      "authRefreshToken = \"{authRefreshToken}\";\n",
                      "response = await service.getSchematicsWorkspaces({ 'versionLocatorId': versionLocator, 'xAuthRefreshToken': authRefreshToken });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "authRefreshToken=\"{authRefreshToken}\"\n",
                      "versionLocator = \"{versionLocator}\"\n",
                      "response = self.service.get_schematics_workspaces(version_locator_id=versionLocator, x_auth_refresh_token=authRefreshToken)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/versions/{version_loc_id}/candeploy": {
      "parameters": [
        {
          "$ref": "#/components/parameters/VersionLocId"
        }
      ]
    },
    "/deploy/schematics/resourcegroups": {
      "get": {
        "tags": [
          "Deploy"
        ],
        "x-sdk-exclude": true,
        "operationId": "get_resource_groups",
        "summary": "Get resource groups",
        "description": "Returns all active resource groups in the current account, where the current user has permission to create schematics workspaces.",
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResourceGroups"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "getOptions := service.NewGetResourceGroupsOptions()\n",
                      "_, response, _ := service.GetResourceGroups(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "Response<ResourceGroups> response = service.getResourceGroups().execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = await service.getResourceGroups();\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = self.service.get_resource_groups()\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/license/license_providers": {
      "get": {
        "tags": [
          "Licensing"
        ],
        "x-sdk-exclude": true,
        "operationId": "get_license_providers",
        "summary": "Get license providers",
        "description": "Get license providers",
        "responses": {
          "200": {
            "description": "Successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LicenseProviders"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "getOptions := service.NewGetLicenseProvidersOptions()\n",
                      "_, response, _ := service.GetLicenseProviders(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "Response<LicenseProviders> response = service.getLicenseProviders().execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = self.service.get_license_providers()\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = await service.getLicenseProviders();\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/license/entitlements": {
      "get": {
        "tags": [
          "Licensing"
        ],
        "x-sdk-exclude": true,
        "operationId": "list_license_entitlements",
        "summary": "List license entitlements",
        "description": "Returns the license entitlements bound to an account",
        "parameters": [
          {
            "name": "account_id",
            "in": "query",
            "required": false,
            "description": "The account ID to query for the entitlement. Default is the account from the user's token.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "license_product_id",
            "in": "query",
            "required": false,
            "description": "The license product ID. If from PPA (Passport Advantage) this is the product Part number(s) which can be one or more IDs, eg. D1YGZLL,5737L09",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "version_id",
            "in": "query",
            "description": "The GC ID of the specific offering version.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "state",
            "in": "query",
            "required": false,
            "description": "The state of the license entitlement. eg. usually 'active', or if it's been deleted will show as 'removed'. ",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LicenseEntitlements"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "listOptions := service.NewListLicenseEntitlementsOptions()\n",
                      "_, response, _ := service.ListLicenseEntitlements(listOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String id = \"{id}\";\n",
                      "ListLicenseEntitlementsOptions getOptions = new ListLicenseEntitlementsOptions.Builder().licenseProductId(id).build();\n",
                      "Response<LicenseEntitlements> response = service.listLicenseEntitlements(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = self.service.list_license_entitlements()\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "response = await service.listLicenseEntitlements();\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "post": {
        "tags": [
          "Licensing"
        ],
        "operationId": "create_license_entitlement",
        "x-sdk-exclude": true,
        "summary": "Create license entitlement",
        "description": "Create an entitlement for a Cloud account.  This is used to give an account an entitlement to a license.",
        "parameters": [
          {
            "name": "account_id",
            "in": "query",
            "required": false,
            "description": "if not specified the token's account will be used",
            "schema": {
              "type": "string"
            }
          }
        ],
        "x-codegen-request-body-name": "license_entitlement",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/LicenseEntitlementBody"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful creation",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LicenseEntitlement"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "createOptions := service.NewCreateLicenseEntitlementOptions()\n",
                      "createOptions.SetName(\"{name}\")\n",
                      "_, response, _ := service.CreateLicenseEntitlement(createOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String name = \"{name}\";\n",
                      "CreateLicenseEntitlementOptions createOptions = new CreateLicenseEntitlementOptions.Builder().name(name).build();\n",
                      "Response<LicenseEntitlement> response = service.createLicenseEntitlement(createOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "name = \"{name}\";\n",
                      "response = await service.createLicenseEntitlement({ 'name': name } );\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "name = \"{name}\"\n",
                      "response = self.service.create_license_entitlement(name=name)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/license/entitlements/productID/{license_product_id}": {
      "parameters": [
        {
          "name": "license_product_id",
          "in": "path",
          "required": true,
          "description": "The license product ID. If from PPA (Passport Advantage) this is a specific product Part number, eg. D1YGZLL",
          "schema": {
            "type": "string"
          }
        }
      ],
      "get": {
        "tags": [
          "Licensing"
        ],
        "x-sdk-exclude": true,
        "operationId": "get_license_entitlements",
        "summary": "Get license entitlements for license product ID",
        "description": "Get the license entitlements for a specific license product ID bound to an account",
        "parameters": [
          {
            "name": "account_id",
            "in": "query",
            "description": "The account ID to query for the entitlement. Default is the account from the user's token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "version_id",
            "in": "query",
            "description": "The GC ID of the specific offering version.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/LicenseEntitlements"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "getOptions := service.NewGetLicenseEntitlementsOptions()\n",
                      "_, response, _ := service.GetLicenseEntitlements(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "GetLicenseEntitlementsOptions getOptions = new GetLicenseEntitlementsOptions.Builder().build();\n",
                      "Response<LicenseEntitlements> response = service.getLicenseEntitlements(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "response = await service.getLicenseEntitlements({ 'licenseProductId': id } );\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "response = self.service.get_license_entitlements(license_product_id=id)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/license/entitlements/{entitlement_id}": {
      "parameters": [
        {
          "name": "entitlement_id",
          "in": "path",
          "required": true,
          "description": "The specific entitlement ID (can be obtained from one of the license entitlement queries)",
          "schema": {
            "type": "string"
          }
        }
      ],
      "delete": {
        "tags": [
          "Licensing"
        ],
        "operationId": "delete_license_entitlement",
        "x-sdk-exclude": true,
        "summary": "Delete license entitlement",
        "description": "Delete a license entitlement that is bound to an account. Note that BSS will mark the entitlement field \"state\": \"removed\". ",
        "parameters": [
          {
            "name": "account_id",
            "in": "query",
            "description": "The account ID to query for the entitlement. Default is the account from the user's token.",
            "required": false,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response."
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id := \"{id}\"\n",
                      "deleteOptions := service.NewDeleteLicenseEntitlementOptions(id)\n",
                      "_, response, _ := service.GetLicenseEntitlements(deleteOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String id = \"{id}\";\n",
                      "DeleteLicenseEntitlementOptions deleteOptions = new DeleteLicenseEntitlementOptions.Builder().entitlementId(id).build();\n",
                      "Response<Void> response = service.deleteLicenseEntitlement(deleteOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "response = await service.deleteLicenseEntitlement({ 'entitlementId': id } );\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "response = self.service.delete_license_entitlement(entitlement_id=id)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/license/licenses": {
      "get": {
        "tags": [
          "Licensing"
        ],
        "x-sdk-exclude": true,
        "operationId": "get_licenses",
        "summary": "Get licenses",
        "description": "Retrieve available licenses from supported license subsystems.  This is used to get the list of available licenses that the user has",
        "parameters": [
          {
            "name": "license_provider_id",
            "in": "query",
            "required": true,
            "description": "ID of the license provider, ie. retrieved from GET license_providers",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "account_id",
            "in": "query",
            "required": false,
            "description": "If not specified the token's account will be used",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "License name",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "license_type",
            "in": "query",
            "required": false,
            "description": "Type of license, if not specified, default is ibm-ppa",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "license_product_id",
            "in": "query",
            "required": false,
            "description": "The license product ID. If from PPA (Passport Advantage) this is the product Part number, eg. D1YGZLL",
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Licenses"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "getOptions := service.NewGetLicensesOptions(id)\n",
                      "_, response, _ := service.GetLicenseEntitlements(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "GetLicensesOptions getOptions = new GetLicensesOptions.Builder().build();\n",
                      "Response<Licenses> response = service.getLicenses(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "response = await service.getLicenses({ 'licenseProviderId': id } );\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "response = self.service.get_(license_provider_id=id)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/instances/offerings": {
      "post": {
        "tags": [
          "Instances"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-instance.offering-instance.create"
          ]
        },
        "operationId": "create_offering_instance",
        "summary": "Create an offering resource instance",
        "description": "Provision a new offering in a given account, and return its resource instance",
        "parameters": [
          {
            "name": "X-Auth-Refresh-Token",
            "description": "IAM Refresh token",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "x-codegen-request-body-name": "offering_instance",
        "requestBody": {
          "$ref": "#/components/requestBodies/OfferingInstance"
        },
        "responses": {
          "201": {
            "description": "New instance created successfully",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OfferingInstance"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "label := \"{label}\"\n",
                      "shortDesc := \"{shortDesc}\"\n",
                      "createOptions := service.NewCreateCatalogOptions()\n",
                      "createOptions.SetLabel(label)\n",
                      "createOptions.SetShortDescription(shortDesc)\n",
                      "_, response, _ := service.CreateCatalog(createOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String label = \"{label}\";\n",
                      "String shortDesc = \"{shortDesc}\";\n",
                      "CreateCatalogOptions createOptions = new CreateCatalogOptions.Builder().label(label).shortDescription(shortDesc).build();\n",
                      "Response<Catalog> response = service.createCatalog(createOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "label = \"{label}\"\n",
                      "shortDesc = \"{shortDesc}\"\n",
                      "response = self.service.create_catalog(label=label, short_description=shortDesc)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "label = \"{label}\";\n",
                      "shortDesc = \"{shortDesc}\";\n",
                      "response = await service.createCatalog({ 'label': label, 'shortDescription': shortDesc });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "get": {
        "tags": [
          "Instances"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-instance.offering-instance.list"
          ]
        },
        "operationId": "search_offering_instance",
        "summary": "List offering instances",
        "description": "List the available offering instances for the specified account and offering.",
        "parameters": [
          {
            "name": "offeringID",
            "description": "Return all offering instances that were created from the specified offering id.",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "name": "limit",
            "description": "number or results to return in the query",
            "in": "query",
            "required": false,
            "schema": {
              "type": "integer",
              "default": 150,
              "maximum": 150
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response.  Your permissions determine what you can see.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OfferingInstanceListResult"
                }
              }
            }
          }
        }
      }
    },
    "/instances/offerings/{instance_identifier}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/InstanceIdentifier"
        }
      ],
      "get": {
        "tags": [
          "Instances"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-instance.offering-instance.read"
          ]
        },
        "operationId": "get_offering_instance",
        "summary": "Get Offering Instance",
        "description": "Get the resource associated with an installed offering instance.",
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OfferingInstance"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog id"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id := \"{id}\"\n",
                      "getOptions := service.NewGetCatalogOptions(id)\n",
                      "_, response, _ := service.GetCatalog(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String id = \"{id}\";\n",
                      "GetCatalogOptions getOptions = new GetCatalogOptions.Builder().catalogIdentifier(id).build();\n",
                      "Response<Catalog> response = service.getCatalog(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "response = self.service.get_catalog(catalog_identifier=id)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "response = await service.getCatalog({ 'catalogIdentifier': id });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "put": {
        "tags": [
          "Instances"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-instance.offering-instance.update"
          ]
        },
        "parameters": [
          {
            "name": "X-Auth-Refresh-Token",
            "description": "IAM Refresh token",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "x-codegen-request-body-name": "offering_instance",
        "requestBody": {
          "$ref": "#/components/requestBodies/OfferingInstance"
        },
        "operationId": "put_offering_instance",
        "summary": "Update Offering Instance",
        "description": "Update an installed offering instance.",
        "responses": {
          "200": {
            "description": "Successful Result",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/OfferingInstance"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog id"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id := \"{id}\"\n",
                      "getOptions := service.NewGetCatalogOptions(id)\n",
                      "_, response, _ := service.GetCatalog(getOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String id = \"{id}\";\n",
                      "GetCatalogOptions getOptions = new GetCatalogOptions.Builder().catalogIdentifier(id).build();\n",
                      "Response<Catalog> response = service.getCatalog(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "response = self.service.get_catalog(catalog_identifier=id)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "response = await service.getCatalog({ 'catalogIdentifier': id });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "delete": {
        "tags": [
          "Instances"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-instance.offering-instance.delete"
          ]
        },
        "operationId": "delete_offering_instance",
        "summary": "Delete a version instance",
        "description": "Delete and instance deployed out of a product version",
        "parameters": [
          {
            "name": "X-Auth-Refresh-Token",
            "description": "IAM Refresh token",
            "in": "header",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful Result"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          },
          "404": {
            "description": "No such catalog"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id := \"{id}\"\n",
                      "deleteOptions := service.NewDeleteCatalogOptions(id)\n",
                      "response, _ := service.DeleteCatalog(deleteOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String id = \"{id}\";\n",
                      "DeleteCatalogOptions deleteOptions = new DeleteCatalogOptions.Builder().catalogIdentifier(id).build();\n",
                      "Response<Void> response = service.deleteCatalog(deleteOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\"\n",
                      "response = self.service.delete_catalog(catalog_identifier=id, id=id)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "id = \"{id}\";\n",
                      "response = await service.deleteCatalog({ 'catalogIdentifier': id, 'id': id });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/instances/offerings/{instance_identifier}/audits": {
      "get": {
        "tags": [
          "Instances"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-instance.account-settings.retrieve_history"
          ]
        },
        "operationId": "list_offering_instance_audits",
        "x-sdk-exclude": false,
        "summary": "Get offering instance audit logs",
        "description": "Get the audit logs associated with an offering instance.",
        "parameters": [
          {
            "$ref": "#/components/parameters/InstanceIdentifier"
          },
          {
            "$ref": "#/components/parameters/Start"
          },
          {
            "$ref": "#/components/parameters/Limit"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLogs"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/instances/offerings/{instance_identifier}/audits/{auditlog_identifier}": {
      "get": {
        "tags": [
          "Instances"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-instance.account-settings.retrieve_history"
          ]
        },
        "operationId": "get_offering_instance_audit",
        "x-sdk-exclude": false,
        "summary": "Get an offering instance audit log entry",
        "description": "Get the full audit log entry associated with an offering instance.",
        "parameters": [
          {
            "$ref": "#/components/parameters/InstanceIdentifier"
          },
          {
            "$ref": "#/components/parameters/AuditLogIdentifier"
          },
          {
            "$ref": "#/components/parameters/AuditLogLookupNames"
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/AuditLog"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/plans/{plan_loc_id}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PlanLocId"
        }
      ],
      "get": {
        "tags": [
          "Plans"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.read"
          ]
        },
        "operationId": "get_plan",
        "summary": "Get offering/plan 'branch'",
        "description": "Get the Offering/Plan 'branch' for the specified locator ID",
        "responses": {
          "200": {
            "description": "Successful response. Your permissions determine what you can see",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Offering"
                }
              }
            }
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "planLocator := \"{planLocator}\"\n",
                      "planOptions := service.NewGetVersionOptions(planLocator)\n",
                      "_, response, _ := service.GetPlan(planOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String planLocator = \"{planLocator}\";\n",
                      "GetPlanOptions getOptions = new GetPlanOptions.Builder().planLocId(planLocator).build();\n",
                      "Response<Offering> response = service.getPlan(getOptions).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "planLocator = \"{planLocator}\"\n",
                      "response = self.service.get_plan(plan_loc_id=planLocator)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "planLocator = \"{planLocator}\";\n",
                      "response = await service.getPlan({ 'planLocId': planLocator });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      },
      "delete": {
        "tags": [
          "Plans"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "delete_plan",
        "summary": "Delete plan",
        "description": "Delete the specified plan.  A plan cannot be deleted if it published.",
        "responses": {
          "200": {
            "description": "Plan deleted successfully"
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        },
        "x-sdk-operations": {
          "request-examples": {
            "go": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "planLocator := \"{planLocator}\"\n",
                      "deleteOptions := service.NewDeletePlanOptions(planLocator)\n",
                      "response, _ := service.DeletePlan(deleteOptions)\n",
                      "fmt.Println(response)"
                    ]
                  }
                ]
              }
            ],
            "java": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "String planLocator = \"{planLocator}\";\n",
                      "deleteOption = new DeletePlanOptions.Builder().planLocId(planLocator).build();\n",
                      "Response<Void> response = service.deletePlan(deleteOption).execute();\n",
                      "System.out.println(response.getResult());"
                    ]
                  }
                ]
              }
            ],
            "python": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "planLocator = \"{planLocator}\"\n",
                      "response = self.service.delete_plan(plan_loc_id=planLocator)\n",
                      "print(response)"
                    ]
                  }
                ]
              }
            ],
            "node": [
              {
                "name": "Example request",
                "example": [
                  {
                    "type": "code",
                    "source": [
                      "planLocator = \"{planLocator}\";\n",
                      "response = await service.deletePlan({ 'planLocId': planLocator });\n",
                      "console.log(response);"
                    ]
                  }
                ]
              }
            ]
          }
        }
      }
    },
    "/plans/{plan_loc_id}/consume-publish": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PlanLocId"
        }
      ],
      "post": {
        "tags": [
          "Plans"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "operationId": "consumable_plan",
        "summary": "Make plan consumable for sharing",
        "description": "Set the plan as consumable in order to inherit the offering sharing permissions",
        "responses": {
          "202": {
            "description": "Request accepted."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/plans/{plan_loc_id}/deprecate/{setting}": {
      "parameters": [
        {
          "$ref": "#/components/parameters/PlanLocId"
        },
        {
          "$ref": "#/components/parameters/DeprecateSetting"
        }
      ],
      "post": {
        "operationId": "set_deprecate_plan",
        "summary": "Sets plan to be deprecated in a certain time period",
        "description": "Set or cancel the plan to be deprecated.",
        "requestBody": {
          "$ref": "#/components/requestBodies/DeprecateRequestBody"
        },
        "tags": [
          "Plans"
        ],
        "x-ibm-events": {
          "events": [
            "globalcatalog-collection.offering.update"
          ]
        },
        "responses": {
          "202": {
            "description": "Request accepted."
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    },
    "/regions": {
      "parameters": [
        {
          "name": "filter",
          "description": "Filter to apply for search",
          "in": "query",
          "schema": {
            "type": "string"
          }
        },
        {
          "name": "get_inactive",
          "description": "Returns inactive locations when true",
          "in": "query",
          "schema": {
            "type": "boolean"
          }
        },
        {
          "name": "limit",
          "description": "The maximum number of results to return",
          "in": "query",
          "required": false,
          "schema": {
            "type": "integer",
            "default": 100,
            "maximum": 1000
          }
        },
        {
          "name": "offset",
          "description": "The number of results to skip before returning values",
          "in": "query",
          "required": false,
          "schema": {
            "type": "integer",
            "default": 0
          }
        }
      ],
      "post": {
        "tags": [
          "Regions"
        ],
        "operationId": "preview_regions",
        "summary": "Returns available locations based on supplied filter",
        "description": "Returns available locations based on supplied filter",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegionsSearchResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      },
      "get": {
        "tags": [
          "Regions"
        ],
        "operationId": "list_regions",
        "summary": "Returns available locations based on filter set on the account and supplied filter",
        "description": "Returns available locations based on filter set on the account and supplied filter",
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/RegionsSearchResult"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "No Permissions"
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "IAM": {
        "type": "apiKey",
        "name": "Authorization",
        "in": "header",
        "description": "Authorization Token used for the request"
      }
    },
    "parameters": {
      "Start": {
        "name": "start",
        "in": "query",
        "description": "Start token for a query",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "Limit": {
        "name": "limit",
        "description": "number or results to return in the query",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer",
          "default": 100,
          "maximum": 1000
        }
      },
      "CatalogIdentifier": {
        "name": "catalog_identifier",
        "in": "path",
        "description": "Catalog identifier",
        "required": true,
        "schema": {
          "type": "string"
        },
        "x-linkback": "#/components/links/CatalogID"
      },
      "ObjectIdentifier": {
        "name": "object_identifier",
        "in": "path",
        "description": "Object identifier",
        "required": true,
        "schema": {
          "type": "string"
        },
        "x-linkback": "#/components/links/ObjectID"
      },
      "ObjectType": {
        "name": "object_type",
        "description": "The type for the object",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "enum": [
            "offering",
            "vpe",
            "proxy_source",
            "preset_configuration"
          ]
        }
      },
      "ObjectKind": {
        "name": "kind",
        "description": "The kind of the object. It will default to \"vpe\"",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "vpe"
          ]
        }
      },
      "OfferingId": {
        "name": "offering_id",
        "description": "Offering identification",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string"
        },
        "x-linkback": "#/components/links/OfferingID"
      },
      "KindId": {
        "name": "kind_id",
        "description": "Kind identification",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string"
        },
        "x-linkback": "#/components/links/KindId"
      },
      "VersionLocId": {
        "name": "version_loc_id",
        "description": "A dotted value of `catalogID`.`versionID`",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "PlanLocId": {
        "name": "plan_loc_id",
        "description": "A dotted value of `sw`.`catalogID`.`resourceID`",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "TargetContextName": {
        "name": "targetContextName",
        "description": "The name of a target account context on a catalog",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "InstanceIdentifier": {
        "name": "instance_identifier",
        "in": "path",
        "description": "Version Instance identifier",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "DeprecateSetting": {
        "name": "setting",
        "description": "Set deprecation (true) or cancel deprecation (false)",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "enum": [
            "true",
            "false"
          ]
        }
      },
      "EnterpriseIdentifier": {
        "name": "enterprise_identifier",
        "in": "path",
        "description": "Enterprise ID",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "EnterpriseOrAccountGroupIdentifier": {
        "name": "enterprise_id",
        "in": "query",
        "description": "Execute the request in the context of an enterprise or enterpise account group ID. Use '-ent-enterpriseid' for an enterprise and '-entgrp-enterprisegroupid for an enterprise group",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      "AccessIdentifier": {
        "name": "access_identifier",
        "in": "path",
        "description": "Identifier for access. Use 'accountId' or '-acct-accountId' for an account, '-ent-enterpriseid' for an enterprise, and '-entgrp-enterprisegroupid' for an enterprise group.",
        "required": true,
        "schema": {
          "$ref": "#/components/schemas/AccessIdentifier"
        }
      },
      "AuditLogIdentifier": {
        "name": "auditlog_identifier",
        "in": "path",
        "description": "Auditlog ID",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "AuditLogLookupNames": {
        "name": "lookupnames",
        "in": "query",
        "description": "Auditlog Lookup Names - by default names are not returned in auditlog.",
        "required": false,
        "schema": {
          "type": "boolean"
        }
      },
      "KeyIdentifier": {
        "name": "key_identifier",
        "in": "path",
        "description": "Unique key identifying an image",
        "required": true,
        "schema": {
          "type": "string"
        }
      },
      "ApprovalStateIdentifier": {
        "name": "approval_state_identifier",
        "in": "path",
        "description": "The different possible approval states for share requests or access request.",
        "required": true,
        "schema": {
          "type": "string",
          "enum": [
            "approved",
            "pending",
            "rejected"
          ]
        }
      }
    },
    "requestBodies": {
      "Access": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Access"
            }
          }
        }
      },
      "ShareSetting": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ShareSetting"
            }
          }
        }
      },
      "ValidateInputsRequest": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ValidateInputsRequest"
            }
          }
        }
      },
      "Catalog": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Catalog"
            }
          }
        }
      },
      "CatalogPrototype": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CatalogPrototype"
            }
          }
        }
      },
      "Offering": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Offering"
            }
          }
        }
      },
      "Region": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/Region"
            }
          }
        }
      },
      "OfferingPrototype": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OfferingPrototype"
            }
          }
        }
      },
      "CatalogObject": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CatalogObject"
            }
          }
        }
      },
      "CatalogObjectPrototype": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/CatalogObjectPrototype"
            }
          }
        }
      },
      "DeployRequestBody": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/DeployRequestBody"
            }
          }
        }
      },
      "OperatorDeploy": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OperatorDeploy"
            }
          }
        }
      },
      "ImportOfferingBody": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ImportOfferingBody"
            }
          }
        }
      },
      "ImportOfferingCopyReloadBody": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/ImportOfferingCopyReloadBody"
            }
          }
        }
      },
      "OfferingInstance": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OfferingInstance"
            }
          }
        }
      },
      "DeprecateRequestBody": {
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/DeprecateRequestBody"
            }
          }
        }
      },
      "PatchBody": {
        "content": {
          "application/json-patch+json": {
            "schema": {
              "$ref": "#/components/schemas/JsonPatch"
            }
          }
        }
      }
    },
    "links": {
      "OfferingID": {
        "description": "ID of offering",
        "operationId": "get_offering",
        "parameters": {
          "id": "$response.body#/id"
        }
      },
      "ObjectID": {
        "description": "ID of object",
        "operationId": "get_object",
        "parameters": {
          "id": "$response.body#/id"
        }
      },
      "CatalogID": {
        "description": "ID of catalog",
        "operationId": "get_catalog",
        "parameters": {
          "id": "$response.body#/id"
        }
      },
      "CatalogRev": {
        "description": "Revision of catalog",
        "operationId": "get_catalog_rev",
        "parameters": {
          "_rev": "$response.body#/_rev"
        }
      },
      "OfferingRev": {
        "description": "Revision of offering",
        "operationId": "get_offering_rev",
        "parameters": {
          "_rev": "$response.body#/_rev"
        }
      },
      "ObjectRev": {
        "description": "Revision of object",
        "operationId": "get_object_rev",
        "parameters": {
          "_rev": "$response.body#/_rev"
        }
      },
      "AccountRev": {
        "description": "Revision of catalog account",
        "operationId": "get_account_rev",
        "parameters": {
          "_rev": "$response.body#/_rev"
        }
      },
      "AccessRev": {
        "description": "Revision of an access list entry",
        "operationId": "get_access_rev",
        "parameters": {
          "_rev": "$response.body#/_rev"
        }
      },
      "VersionLocator": {
        "description": "Locator of offering version",
        "operationId": "get_version_locator",
        "parameters": {
          "version_locator": "$response.body#/kinds/0/versions/0/version_locator"
        }
      },
      "VersionID": {
        "description": "ID of version",
        "operationId": "get_version_id",
        "parameters": {
          "id": "$response.body#/kinds/0/versions/0/id"
        }
      },
      "VersionRev": {
        "description": "Revision of version",
        "operationId": "get_version_rev",
        "parameters": {
          "_rev": "$response.body#/kinds/0/versions/0/_rev"
        }
      }
    },
    "schemas": {
      "VersionDependant": {
        "description": "Version dependency on a VersionLocator",
        "properties": {
          "start": {
            "description": "The start token used for this response",
            "type": "string"
          },
          "limit": {
            "description": "The limit that was applied to this response. It may be smaller than in the request because that was too large",
            "type": "integer"
          },
          "total_count": {
            "description": "The total count of resources in the system that matches the request",
            "type": "integer"
          },
          "resource_count": {
            "description": "The number of resources returned in this response",
            "type": "integer"
          },
          "version": {
            "type": "object",
            "properties": {
              "account_id": {
                "type": "string",
                "description": "Dependant account"
              },
              "catalog_id": {
                "type": "string",
                "description": "Dependant Catalog"
              },
              "offering_id": {
                "type": "string",
                "description": "Dependant Offering"
              },
              "version_id": {
                "type": "string",
                "description": "Dependant Version"
              },
              "version": {
                "type": "string",
                "description": "Dependant (semver) version"
              },
              "flavor": {
                "type": "string",
                "description": "Dependant variation"
              },
              "semver": {
                "type": "string",
                "description": "Dependencies semver range"
              }
            }
          },
          "first": {
            "$ref": "#/components/schemas/PaginationTokenLink"
          },
          "next": {
            "$ref": "#/components/schemas/PaginationTokenLink"
          },
          "prev": {
            "$ref": "#/components/schemas/PaginationTokenLink"
          },
          "last": {
            "$ref": "#/components/schemas/PaginationTokenLink"
          }
        },
        "required": [
          "limit",
          "resource_count",
          "first"
        ]
      },
      "TokenPagination": {
        "description": "Common part of a token paginated response list",
        "properties": {
          "start": {
            "description": "The start token used for this response",
            "type": "string"
          },
          "limit": {
            "description": "The limit that was applied to this response. It may be smaller than in the request because that was too large",
            "type": "integer"
          },
          "total_count": {
            "description": "The total count of resources in the system that matches the request",
            "type": "integer"
          },
          "resource_count": {
            "description": "The number of resources returned in this response",
            "type": "integer"
          },
          "first": {
            "$ref": "#/components/schemas/PaginationTokenLink"
          },
          "next": {
            "$ref": "#/components/schemas/PaginationTokenLink"
          },
          "prev": {
            "$ref": "#/components/schemas/PaginationTokenLink"
          },
          "last": {
            "$ref": "#/components/schemas/PaginationTokenLink"
          }
        },
        "required": [
          "limit",
          "resource_count",
          "first"
        ]
      },
      "PaginationOffsetLink": {
        "description": "Link response on an offset paginated query",
        "properties": {
          "href": {
            "description": "The href to the linked response",
            "type": "string"
          },
          "offset": {
            "description": "The offset used in this link. Will not be returned on First links",
            "type": "integer"
          }
        },
        "required": [
          "href"
        ]
      },
      "PaginationTokenLink": {
        "description": "Link response on a token paginated query",
        "properties": {
          "href": {
            "description": "The href to the linked response",
            "type": "string"
          },
          "start": {
            "description": "The start token used in this link. Will not be returned on First links",
            "type": "string"
          }
        },
        "required": [
          "href"
        ]
      },
      "ShareSetting": {
        "description": "Share setting information",
        "properties": {
          "ibm": {
            "type": "boolean",
            "description": "Visible to IBM employees"
          },
          "public": {
            "type": "boolean",
            "description": "Visible to everyone in the public catalog"
          },
          "enabled": {
            "type": "boolean",
            "description": "Visible to access list"
          }
        }
      },
      "ValidateInputsRequest": {
        "description": "Share setting information",
        "properties": {
          "input1": {
            "type": "string",
            "description": "A deployment variable to validate"
          },
          "input2": {
            "type": "string",
            "description": "Another deployment variable to validate"
          }
        }
      },
      "JsonPatch": {
        "type": "array",
        "items": {
          "$ref": "#/components/schemas/JsonPatchOperation"
        }
      },
      "JsonPatchOperation": {
        "description": "A JSONPatch document as defined by RFC 6902.",
        "required": [
          "op",
          "path"
        ],
        "properties": {
          "op": {
            "type": "string",
            "description": "The operation to be performed.",
            "enum": [
              "add",
              "remove",
              "replace",
              "move",
              "copy",
              "test"
            ]
          },
          "path": {
            "type": "string",
            "description": "A JSON-Pointer."
          },
          "value": {
            "description": "The value to be used within the operations."
          },
          "from": {
            "type": "string",
            "description": "A string containing a JSON Pointer value"
          }
        }
      },
      "CatalogSearchResult": {
        "type": "object",
        "description": "Paginated catalog search result",
        "properties": {
          "offset": {
            "x-sdk-exclude": true,
            "type": "integer",
            "description": "The offset (origin 0) of the first resource in this page of search results."
          },
          "limit": {
            "x-sdk-exclude": true,
            "type": "integer",
            "description": "The maximum number of resources returned in each page of search results."
          },
          "total_count": {
            "type": "integer",
            "description": "The overall total number of resources in the search result set."
          },
          "resource_count": {
            "x-sdk-exclude": true,
            "type": "integer",
            "description": "The number of resources returned in this page of search results."
          },
          "first": {
            "x-sdk-exclude": true,
            "type": "string",
            "description": "A URL for retrieving the first page of search results."
          },
          "last": {
            "x-sdk-exclude": true,
            "type": "string",
            "description": "A URL for retrieving the last page of search results."
          },
          "prev": {
            "x-sdk-exclude": true,
            "type": "string",
            "description": "A URL for retrieving the previous page of search results."
          },
          "next": {
            "x-sdk-exclude": true,
            "type": "string",
            "description": "A URL for retrieving the next page of search results."
          },
          "resources": {
            "type": "array",
            "description": "Resulting objects",
            "items": {
              "$ref": "#/components/schemas/Catalog"
            }
          }
        }
      },
      "OfferingSearchResult": {
        "type": "object",
        "description": "Paginated offering search result",
        "required": [
          "offset",
          "limit"
        ],
        "properties": {
          "offset": {
            "type": "integer",
            "description": "The offset (origin 0) of the first resource in this page of search results."
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of resources returned in each page of search results."
          },
          "total_count": {
            "type": "integer",
            "description": "The overall total number of resources in the search result set."
          },
          "resource_count": {
            "type": "integer",
            "description": "The number of resources returned in this page of search results."
          },
          "first": {
            "type": "string",
            "description": "A URL for retrieving the first page of search results."
          },
          "last": {
            "type": "string",
            "description": "A URL for retrieving the last page of search results."
          },
          "prev": {
            "type": "string",
            "description": "A URL for retrieving the previous page of search results."
          },
          "next": {
            "type": "string",
            "description": "A URL for retrieving the next page of search results."
          },
          "resources": {
            "type": "array",
            "description": "Resulting objects",
            "items": {
              "$ref": "#/components/schemas/Offering"
            }
          }
        }
      },
      "ObjectSearchResult": {
        "type": "object",
        "description": "Paginated object search result",
        "required": [
          "offset",
          "limit"
        ],
        "properties": {
          "offset": {
            "type": "integer",
            "description": "The offset (origin 0) of the first resource in this page of search results."
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of resources returned in each page of search results."
          },
          "total_count": {
            "type": "integer",
            "description": "The overall total number of resources in the search result set."
          },
          "resource_count": {
            "type": "integer",
            "description": "The number of resources returned in this page of search results."
          },
          "first": {
            "type": "string",
            "description": "A URL for retrieving the first page of search results."
          },
          "last": {
            "type": "string",
            "description": "A URL for retrieving the last page of search results."
          },
          "prev": {
            "type": "string",
            "description": "A URL for retrieving the previous page of search results."
          },
          "next": {
            "type": "string",
            "description": "A URL for retrieving the next page of search results."
          },
          "resources": {
            "type": "array",
            "description": "Resulting objects",
            "items": {
              "$ref": "#/components/schemas/CatalogObject"
            }
          }
        }
      },
      "ObjectListResult": {
        "type": "object",
        "description": "Paginated object search result",
        "required": [
          "offset",
          "limit"
        ],
        "properties": {
          "offset": {
            "type": "integer",
            "description": "The offset (origin 0) of the first resource in this page of search results."
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of resources returned in each page of search results."
          },
          "total_count": {
            "type": "integer",
            "description": "The overall total number of resources in the search result set."
          },
          "resource_count": {
            "type": "integer",
            "description": "The number of resources returned in this page of search results."
          },
          "first": {
            "type": "string",
            "description": "A URL for retrieving the first page of search results."
          },
          "last": {
            "type": "string",
            "description": "A URL for retrieving the last page of search results."
          },
          "prev": {
            "type": "string",
            "description": "A URL for retrieving the previous page of search results."
          },
          "next": {
            "type": "string",
            "description": "A URL for retrieving the next page of search results."
          },
          "resources": {
            "type": "array",
            "description": "Resulting objects",
            "items": {
              "$ref": "#/components/schemas/CatalogObject"
            }
          }
        }
      },
      "ObjectAccessListResult": {
        "type": "object",
        "description": "Paginated object search result",
        "required": [
          "offset",
          "limit"
        ],
        "properties": {
          "offset": {
            "type": "integer",
            "description": "The offset (origin 0) of the first resource in this page of search results."
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of resources returned in each page of search results."
          },
          "total_count": {
            "type": "integer",
            "description": "The overall total number of resources in the search result set."
          },
          "resource_count": {
            "type": "integer",
            "description": "The number of resources returned in this page of search results."
          },
          "first": {
            "type": "string",
            "description": "A URL for retrieving the first page of search results."
          },
          "last": {
            "type": "string",
            "description": "A URL for retrieving the last page of search results."
          },
          "prev": {
            "type": "string",
            "description": "A URL for retrieving the previous page of search results."
          },
          "next": {
            "type": "string",
            "description": "A URL for retrieving the next page of search results."
          },
          "resources": {
            "type": "array",
            "description": "Resulting objects",
            "items": {
              "$ref": "#/components/schemas/Access"
            }
          }
        }
      },
      "AccessListResult": {
        "type": "object",
        "description": "Paginated Offering search result",
        "allOf": [
          {
            "$ref": "#/components/schemas/TokenPagination"
          },
          {
            "type": "object",
            "properties": {
              "resources": {
                "description": "A list of access records",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Access"
                }
              }
            },
            "required": [
              "resources"
            ]
          }
        ]
      },
      "RegionsSearchResult": {
        "type": "object",
        "description": "Paginated location search result",
        "required": [
          "offset",
          "limit"
        ],
        "properties": {
          "offset": {
            "type": "integer",
            "description": "The offset (origin 0) of the first resource in this page of search results."
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of resources returned in each page of search results."
          },
          "total_count": {
            "type": "integer",
            "description": "The overall total number of resources in the search result set."
          },
          "resource_count": {
            "type": "integer",
            "description": "The number of resources returned in this page of search results."
          },
          "first": {
            "$ref": "#/components/schemas/PaginationTokenLink"
          },
          "last": {
            "$ref": "#/components/schemas/PaginationTokenLink"
          },
          "regions": {
            "type": "array",
            "description": "Resulting objects",
            "items": {
              "$ref": "#/components/schemas/Region"
            }
          }
        }
      },
      "OfferingInstanceListResult": {
        "type": "object",
        "description": "Paginated offering instance search result",
        "allOf": [
          {
            "$ref": "#/components/schemas/TokenPagination"
          },
          {
            "type": "object",
            "properties": {
              "resources": {
                "description": "A list of offering instance records",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/OfferingInstance"
                }
              }
            },
            "required": [
              "resources"
            ]
          }
        ]
      },
      "Access": {
        "type": "object",
        "description": "access",
        "properties": {
          "id": {
            "type": "string",
            "description": "unique id"
          },
          "_rev": {
            "type": "string",
            "description": "Revision"
          },
          "account": {
            "type": "string",
            "description": "account id"
          },
          "account_type": {
            "type": "integer",
            "description": "Normal account or enterprise"
          },
          "catalog_id": {
            "type": "string",
            "description": "unique id"
          },
          "target_id": {
            "type": "string",
            "description": "object ID"
          },
          "target_account": {
            "type": "string",
            "description": "object's owner's account"
          },
          "target_kind": {
            "type": "string",
            "description": "entity type"
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "date and time create"
          },
          "approval_state": {
            "type": "string",
            "description": "Approval state for access. If this field is an empty string, then it means that it's approved"
          },
          "visible_states": {
            "type": "array",
            "description": "List of additional version states that this account can see. The default visible states are consumable and prerelease.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "ShareApprovalAccess": {
        "type": "object",
        "description": "access for share approval",
        "properties": {
          "id": {
            "type": "string",
            "description": "unique id"
          },
          "account": {
            "type": "string",
            "description": "account id"
          },
          "account_type": {
            "type": "integer",
            "description": "Normal account or enterprise"
          },
          "target_account": {
            "type": "string",
            "description": "object's owner's account"
          },
          "target_kind": {
            "type": "string",
            "description": "entity type"
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "date and time create"
          },
          "approval_state": {
            "type": "string",
            "description": "Approval state for access. If this field is an empty string, then it means that it's approved"
          }
        }
      },
      "ShareApprovalListAccessResult": {
        "type": "object",
        "description": "Paginated search result for share approval requests",
        "allOf": [
          {
            "$ref": "#/components/schemas/TokenPagination"
          },
          {
            "type": "object",
            "properties": {
              "resources": {
                "description": "A list of access records",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/ShareApprovalAccess"
                }
              }
            },
            "required": [
              "resources"
            ]
          }
        ]
      },
      "VersionsResult": {
        "type": "object",
        "description": "Paginated search result for Versions",
        "allOf": [
          {
            "$ref": "#/components/schemas/TokenPagination"
          },
          {
            "type": "object",
            "properties": {
              "versions": {
                "description": "A list of versions",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Version"
                }
              }
            },
            "required": [
              "versions"
            ]
          }
        ]
      },
      "CatalogPrototype": {
        "type": "object",
        "description": "Catalog information",
        "properties": {
          "label": {
            "type": "string",
            "description": "Display Name in the requested language"
          },
          "label_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated display name, by language code"
          },
          "short_description": {
            "type": "string",
            "description": "Description in the requested language"
          },
          "short_description_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated description, by language code"
          },
          "catalog_icon_url": {
            "type": "string",
            "description": "URL for an icon associated with this catalog"
          },
          "catalog_banner_url": {
            "type": "string",
            "description": "URL for a banner image for this catalog"
          },
          "tags": {
            "type": "array",
            "description": "List of tags associated with this catalog",
            "items": {
              "type": "string"
            }
          },
          "url": {
            "type": "string",
            "description": "The url for this specific catalog",
            "readOnly": true
          },
          "crn": {
            "type": "string",
            "description": "CRN associated with the catalog",
            "readOnly": true
          },
          "offerings_url": {
            "type": "string",
            "description": "URL path to offerings",
            "readOnly": true
          },
          "features": {
            "type": "array",
            "description": "List of features associated with this catalog",
            "items": {
              "$ref": "#/components/schemas/Feature"
            }
          },
          "disabled": {
            "type": "boolean",
            "description": "Denotes whether a catalog is disabled"
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "The date-time this catalog was created",
            "readOnly": true
          },
          "updated": {
            "type": "string",
            "format": "date-time",
            "description": "The date-time this catalog was last updated",
            "readOnly": true
          },
          "resource_group_id": {
            "type": "string",
            "description": "Resource group id the catalog is owned by"
          },
          "owning_account": {
            "type": "string",
            "description": "Account that owns catalog"
          },
          "catalog_filters": {
            "$ref": "#/components/schemas/Filters"
          },
          "kind": {
            "type": "string",
            "description": "Kind of catalog. Supported kinds are offering and vpe"
          },
          "metadata": {
            "type": "object",
            "description": "Catalog specific metadata",
            "additionalProperties": true
          },
          "target_account_contexts": {
            "type": "array",
            "description": "List of target accounts contexts on this catalog",
            "items": {
              "$ref": "#/components/schemas/TargetAccountContext"
            }
          }
        }
      },
      "Catalog": {
        "type": "object",
        "x-data-source-name": "cm_catalog",
        "x-resource-name": "cm_catalog",
        "x-terraform-resource-operations": {
          "create": "create_catalog",
          "read": "get_catalog",
          "delete": "delete_catalog"
        },
        "description": "Catalog information",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Unique ID",
                "format": "identifier"
              },
              "_rev": {
                "type": "string",
                "description": "Cloudant revision",
                "format": "identifier"
              }
            }
          },
          {
            "$ref": "#/components/schemas/CatalogPrototype"
          }
        ]
      },
      "Feature": {
        "type": "object",
        "description": "Feature information",
        "properties": {
          "title": {
            "type": "string",
            "description": "Heading"
          },
          "title_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated heading, by language code"
          },
          "description": {
            "type": "string",
            "description": "Feature description"
          },
          "description_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated description, by language code"
          }
        }
      },
      "VersionRange": {
        "type": "object",
        "description": "Version range information",
        "properties": {
          "kinds": {
            "type": "array",
            "description": "Format kinds that this plan applies to in the current offering.  If empty, applies to all kinds.",
            "items": {
              "type": "string"
            }
          },
          "version": {
            "description": "Semantic version range that this plan applies to.  If empty, applies to all versions.",
            "type": "string"
          },
          "flavors": {
            "description": "List of applicable flavors in the specified range.  If empty, or not specified, applies to all flavors.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "TargetAccountContext": {
        "type": "object",
        "description": "Target account context",
        "properties": {
          "api_key": {
            "type": "string",
            "description": "API Key"
          },
          "trusted_profile": {
            "$ref": "#/components/schemas/TrustedProfileInfo",
            "description": "Trusted profile info"
          },
          "name": {
            "type": "string",
            "description": "Unique identifier/name"
          },
          "label": {
            "type": "string",
            "description": "Display name"
          },
          "project_id": {
            "type": "string",
            "description": "Project ID"
          }
        }
      },
      "TrustedProfileInfo": {
        "type": "object",
        "description": "Trusted profile info",
        "properties": {
          "trusted_profile_id": {
            "type": "string",
            "description": "Trusted profile ID"
          },
          "catalog_crn": {
            "type": "string",
            "description": "Catalog CRN"
          },
          "catalog_name": {
            "type": "string",
            "description": "Catalog name"
          },
          "target_service_id": {
            "type": "string",
            "description": "Target service ID"
          }
        }
      },
      "OfferingPrototype": {
        "type": "object",
        "description": "Offering information",
        "properties": {
          "url": {
            "type": "string",
            "description": "The url for this specific offering"
          },
          "crn": {
            "type": "string",
            "description": "The crn for this specific offering"
          },
          "label": {
            "type": "string",
            "description": "Display Name in the requested language"
          },
          "label_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated display Name, by language code"
          },
          "name": {
            "type": "string",
            "description": "The programmatic name of this offering"
          },
          "offering_icon_url": {
            "type": "string",
            "description": "URL for an icon associated with this offering"
          },
          "offering_docs_url": {
            "type": "string",
            "description": "URL for an additional docs with this offering"
          },
          "offering_support_url": {
            "type": "string",
            "description": "[deprecated] - Use offering.support instead.  URL to be displayed in the Consumption UI for getting support on this offering"
          },
          "tags": {
            "type": "array",
            "description": "List of tags associated with this catalog",
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "type": "array",
            "description": "List of keywords associated with offering, typically used to search for it",
            "items": {
              "type": "string"
            }
          },
          "rating": {
            "$ref": "#/components/schemas/Rating"
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time this catalog was created"
          },
          "updated": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time this catalog was last updated"
          },
          "short_description": {
            "type": "string",
            "description": "Short description in the requested language"
          },
          "short_description_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated short description, by language code"
          },
          "long_description": {
            "type": "string",
            "description": "Long description in the requested language"
          },
          "long_description_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated long description, by language code"
          },
          "features": {
            "type": "array",
            "description": "list of features associated with this offering",
            "items": {
              "$ref": "#/components/schemas/Feature"
            }
          },
          "kinds": {
            "type": "array",
            "description": "Array of kind",
            "items": {
              "$ref": "#/components/schemas/Kind"
            }
          },
          "publish": {
            "$ref": "#/components/schemas/PublishObject"
          },
          "pc_managed": {
            "type": "boolean",
            "description": "Offering is managed by Partner Center"
          },
          "publish_approved": {
            "type": "boolean",
            "description": "Offering has been approved to publish to permitted to IBM or Public Catalog"
          },
          "share_with_all": {
            "type": "boolean",
            "description": "Denotes public availability of an Offering"
          },
          "share_with_ibm": {
            "type": "boolean",
            "description": "Denotes IBM employee availability of an Offering - if share_enabled is true"
          },
          "share_enabled": {
            "type": "boolean",
            "description": "Denotes sharing including access list availability of an Offering is enabled"
          },
          "public_original_crn": {
            "type": "string",
            "description": "The original offering CRN that this publish entry came from"
          },
          "publish_public_crn": {
            "type": "string",
            "description": "The crn of the public catalog entry of this offering"
          },
          "portal_approval_record": {
            "type": "string",
            "description": "The portal's approval record ID"
          },
          "portal_ui_url": {
            "type": "string",
            "description": "The portal UI URL"
          },
          "catalog_id": {
            "type": "string",
            "description": "The id of the catalog containing this offering",
            "format": "identifier",
            "x-linkback": "#/components/links/CatalogID"
          },
          "catalog_name": {
            "type": "string",
            "description": "The name of the catalog"
          },
          "metadata": {
            "description": "Map of metadata values for this offering",
            "type": "object",
            "additionalProperties": true
          },
          "disclaimer": {
            "type": "string",
            "description": "A disclaimer for this offering"
          },
          "hidden": {
            "type": "boolean",
            "description": "Determine if this offering should be displayed in the Consumption UI"
          },
          "provider": {
            "type": "string",
            "description": "Deprecated - Provider of this offering",
            "deprecated": true
          },
          "provider_info": {
            "type": "object",
            "$ref": "#/components/schemas/ProviderInfo"
          },
          "repo_info": {
            "$ref": "#/components/schemas/RepoInfo"
          },
          "image_pull_keys": {
            "type": "array",
            "description": "Image pull keys for this offering",
            "items": {
              "$ref": "#/components/schemas/ImagePullKey"
            }
          },
          "support": {
            "$ref": "#/components/schemas/Support"
          },
          "media": {
            "type": "array",
            "description": "A list of media items related to this offering",
            "items": {
              "$ref": "#/components/schemas/MediaItem"
            }
          },
          "deprecate_pending": {
            "description": "Deprecation information for this offering.",
            "$ref": "#/components/schemas/DeprecatePending"
          },
          "product_kind": {
            "type": "string",
            "description": "The product kind.  Valid values are module, solution, or empty string"
          },
          "badges": {
            "type": "array",
            "description": "A list of badges for this offering",
            "items": {
              "$ref": "#/components/schemas/Badge"
            }
          },
          "plans": {
            "type": "array",
            "description": "A list of plans for this offering",
            "items": {
              "$ref": "#/components/schemas/Plan"
            }
          }
        }
      },
      "Offering": {
        "type": "object",
        "x-data-source-name": "cm_offering",
        "x-resource-name": "cm_offering",
        "x-terraform-resource-operations": {
          "create": "create_offering",
          "read": "get_offering",
          "delete": "delete_offering"
        },
        "x-terraform-datasource-operations": {
          "read": "get_offering"
        },
        "description": "Offering information",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "unique id",
                "format": "identifier"
              },
              "_rev": {
                "type": "string",
                "description": "Cloudant revision",
                "format": "identifier"
              }
            }
          },
          {
            "$ref": "#/components/schemas/OfferingPrototype"
          }
        ]
      },
      "Region": {
        "type": "object",
        "description": "Region information",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "format": "identifier"
              },
              "name": {
                "type": "string",
                "format": "identifier"
              },
              "catalog_crn": {
                "type": "string",
                "format": "identifier"
              },
              "kind": {
                "type": "string",
                "format": "identifier"
              },
              "public": {
                "type": "boolean",
                "format": "identifier"
              },
              "ui": {
                "type": "object",
                "format": "identifier",
                "properties": {
                  "_language_": {
                    "type": "object",
                    "properties": {
                      "description": {
                        "type": "string"
                      },
                      "display_name": {
                        "type": "string"
                      }
                    }
                  }
                }
              },
              "icon": {
                "type": "string",
                "format": "identifier"
              },
              "parent_id": {
                "type": "string",
                "format": "identifier"
              },
              "metro_id": {
                "type": "string",
                "format": "identifier"
              },
              "country_id": {
                "type": "string",
                "format": "identifier"
              },
              "geo_id": {
                "type": "string",
                "format": "identifier"
              },
              "authority": {
                "type": "object",
                "format": "identifier",
                "properties": {
                  "url": {
                    "type": "string"
                  },
                  "crn": {
                    "type": "string"
                  },
                  "provider": {
                    "type": "string"
                  }
                }
              },
              "tags": {
                "type": "array",
                "format": "identifier",
                "items": {
                  "type": "string"
                }
              },
              "capabilities": {
                "type": "string",
                "format": "identifier"
              },
              "created": {
                "type": "string",
                "format": "identifier"
              },
              "updated": {
                "type": "string",
                "format": "identifier"
              },
              "active": {
                "type": "boolean",
                "format": "identifier"
              },
              "visibility": {
                "type": "object",
                "format": "identifier"
              },
              "services": {
                "type": "array",
                "format": "identifier",
                "items": {
                  "type": "string"
                }
              }
            }
          }
        ]
      },
      "MediaItem": {
        "type": "object",
        "description": "Offering Media information",
        "properties": {
          "url": {
            "type": "string",
            "description": "URL of the specified media item"
          },
          "api_url": {
            "type": "string",
            "description": "CM API specific URL of the specified media item"
          },
          "url_proxy": {
            "type": "object",
            "description": "URL proxy related to this offering",
            "$ref": "#/components/schemas/URLProxy"
          },
          "caption": {
            "type": "string",
            "description": "Caption for this media item"
          },
          "caption_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translations for caption, by language code"
          },
          "type": {
            "type": "string",
            "description": "Type of this media item"
          },
          "thumbnail_url": {
            "type": "string",
            "description": "Thumbnail URL for this media item"
          }
        }
      },
      "Badge": {
        "type": "object",
        "description": "Badge information",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID of the current badge"
          },
          "label": {
            "type": "string",
            "description": "Display name for the current badge"
          },
          "label_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated display name for the current badge, by language code"
          },
          "description": {
            "type": "string",
            "description": "Description of the current badge"
          },
          "description_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translaged description of the current badge, by language code"
          },
          "icon": {
            "type": "string",
            "description": "Icon for the current badge"
          },
          "authority": {
            "type": "string",
            "description": "Authority for the current badge"
          },
          "tag": {
            "type": "string",
            "description": "Tag for the current badge"
          },
          "learn_more_links": {
            "$ref": "#/components/schemas/LearnMoreLinks",
            "description": "Icon for the current badge"
          },
          "constraints": {
            "type": "array",
            "description": "An optional set of constraints indicating which versions in an Offering have this particular badge.",
            "items": {
              "$ref": "#/components/schemas/Constraint"
            }
          }
        }
      },
      "Plan": {
        "type": "object",
        "x-data-source-name": "cm_plan",
        "x-resource-name": "cm_plan",
        "x-terraform-resource-operations": {
          "read": "get_plan",
          "delete": "delete_plan"
        },
        "x-terraform-datasource-operations": {
          "read": "get_plan"
        },
        "description": "Plan information",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique ID",
            "format": "identifier",
            "readOnly": true
          },
          "_rev": {
            "type": "string",
            "description": "Cloudant revision",
            "format": "identifier",
            "readOnly": true
          },
          "url": {
            "type": "string",
            "description": "The url for this specific plan"
          },
          "crn": {
            "type": "string",
            "description": "Plans's CRN"
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time this plan was created"
          },
          "updated": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time this plan was last updated"
          },
          "offering_id": {
            "type": "string",
            "description": "Offering ID",
            "format": "identifier",
            "x-linkback": "#/components/links/OfferingID"
          },
          "catalog_id": {
            "type": "string",
            "description": "Catalog ID",
            "format": "identifier",
            "x-linkback": "#/components/links/CatalogID"
          },
          "label": {
            "type": "string",
            "description": "Display name for the current plan"
          },
          "label_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated display name for the current plan, by language code"
          },
          "name": {
            "type": "string",
            "description": "Programmatic name for the current plan"
          },
          "short_description": {
            "type": "string",
            "description": "Description of the current plan"
          },
          "short_description_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translaged description of the current plan, by language code"
          },
          "pricing_tags": {
            "type": "array",
            "description": "Tags array.",
            "items": {
              "type": "string"
            }
          },
          "version_range": {
            "$ref": "#/components/schemas/VersionRange",
            "description": "Versions associated with this plan"
          },
          "features": {
            "type": "array",
            "description": "List of features associated with this catalog",
            "items": {
              "$ref": "#/components/schemas/Feature"
            }
          },
          "state": {
            "$ref": "#/components/schemas/State"
          },
          "deprecate_pending": {
            "$ref": "#/components/schemas/DeprecatePending",
            "description": "Deprecation information for this plan"
          },
          "metadata": {
            "description": "Map of metadata values for this plan",
            "type": "object",
            "additionalProperties": true
          },
          "publish_approved": {
            "type": "boolean",
            "description": "Plan has been approved to publish for other users"
          },
          "licenses": {
            "type": "array",
            "description": "List of licenses associated with this plan",
            "items": {
              "$ref": "#/components/schemas/EntitlementLicense"
            }
          }
        }
      },
      "EntitlementLicense": {
        "type": "object",
        "description": "License that is associated with a pricing plan",
        "properties": {
          "config_id": {
            "type": "string",
            "description": "Configuration ID for the license"
          },
          "sku": {
            "type": "string",
            "description": "The Stock Keeping Unit (SKU) identifier for the license"
          },
          "provider_id": {
            "type": "string",
            "description": "Provider ID for the license"
          },
          "vendor_id": {
            "type": "string",
            "description": "Vendor ID for the license"
          }
        }
      },
      "PlanEntitlement": {
        "type": "object",
        "description": "Entitlement information returned from the license manager when a plan contains licenses. This object tracks the license entitlement status and associated licenses for a software offering instance.",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID for the license entitlement"
          },
          "status": {
            "type": "string",
            "description": "The current status of the license entitlement"
          },
          "license_instances": {
            "type": "array",
            "description": "Array of licenses associated with this entitlement",
            "items": {
              "$ref": "#/components/schemas/EntitlementLicense"
            }
          }
        }
      },
      "LearnMoreLinks": {
        "type": "object",
        "description": "Learn more links for a badge",
        "properties": {
          "first_party": {
            "type": "string",
            "description": "First party link"
          },
          "third_party": {
            "type": "string",
            "description": "Third party link"
          }
        }
      },
      "Constraint": {
        "type": "object",
        "description": "Constraint information",
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of the current constraint"
          },
          "rule": {
            "description": "Rule for the current constraint"
          }
        }
      },
      "URLProxy": {
        "type": "object",
        "description": "Offering URL proxy information",
        "properties": {
          "url": {
            "type": "string",
            "description": "URL of the specified media item being proxied"
          },
          "sha": {
            "type": "string",
            "description": "SHA256 fingerprint of image"
          }
        }
      },
      "Support": {
        "type": "object",
        "description": "Offering Support information",
        "properties": {
          "url": {
            "type": "string",
            "description": "URL to be displayed in the Consumption UI for getting support on this offering"
          },
          "process": {
            "type": "string",
            "description": "Support process as provided by an ISV"
          },
          "process_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated support process as provided by an ISV, by language code"
          },
          "locations": {
            "type": "array",
            "description": "A list of country codes indicating where support is provided",
            "items": {
              "type": "string"
            }
          },
          "support_details": {
            "type": "array",
            "description": "A list of support options (e.g. email, phone, slack, other)",
            "items": {
              "$ref": "#/components/schemas/SupportDetail"
            }
          },
          "support_escalation": {
            "$ref": "#/components/schemas/SupportEscalation",
            "description": "Support process as provided by an ISV"
          },
          "support_type": {
            "type": "string",
            "description": "Support type for this product"
          }
        }
      },
      "SupportEscalation": {
        "type": "object",
        "description": "Support escalation policy",
        "properties": {
          "escalation_wait_time": {
            "$ref": "#/components/schemas/SupportWaitTime",
            "description": "Minimum time to wait before escalating an issue"
          },
          "response_wait_time": {
            "$ref": "#/components/schemas/SupportWaitTime",
            "description": "Expected response wait time for accepting an escalation request"
          },
          "contact": {
            "type": "string",
            "description": "Escalation contact"
          }
        }
      },
      "SupportDetail": {
        "type": "object",
        "description": "A support option",
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of the current support detail"
          },
          "contact": {
            "type": "string",
            "description": "Contact for the current support detail"
          },
          "response_wait_time": {
            "$ref": "#/components/schemas/SupportWaitTime",
            "description": "Time before a user can expect a response from support"
          },
          "availability": {
            "$ref": "#/components/schemas/SupportAvailability",
            "description": "Time period when this type of support is available"
          }
        }
      },
      "SupportWaitTime": {
        "type": "object",
        "description": "Time descriptor",
        "properties": {
          "value": {
            "type": "integer",
            "description": "Amount of time to wait in unit 'type'"
          },
          "type": {
            "type": "string",
            "description": "Valid values are hour or day"
          }
        }
      },
      "SupportAvailability": {
        "type": "object",
        "description": "Times when support is available",
        "properties": {
          "times": {
            "type": "array",
            "description": "A list of support times",
            "items": {
              "$ref": "#/components/schemas/SupportTime"
            }
          },
          "timezone": {
            "type": "string",
            "description": "Timezone (e.g. America/New_York)"
          },
          "always_available": {
            "type": "boolean",
            "description": "Is this support always available"
          }
        }
      },
      "SupportTime": {
        "type": "object",
        "description": "Time range for support on a given day",
        "properties": {
          "day": {
            "type": "integer",
            "description": "The day of the week, represented as an integer"
          },
          "start_time": {
            "type": "string",
            "description": "HOURS:MINUTES:SECONDS using 24 hour time (e.g. 8:15:00)"
          },
          "end_time": {
            "type": "string",
            "description": "HOURS:MINUTES:SECONDS using 24 hour time (e.g. 8:15:00)"
          }
        }
      },
      "CatalogObjectPrototype": {
        "type": "object",
        "description": "object information",
        "properties": {
          "name": {
            "type": "string",
            "description": "The programmatic name of this object"
          },
          "crn": {
            "type": "string",
            "description": "The crn for this specific object"
          },
          "url": {
            "type": "string",
            "description": "The url for this specific object"
          },
          "parent_id": {
            "type": "string",
            "description": "The parent for this specific object"
          },
          "label_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated display name in the requested language"
          },
          "label": {
            "type": "string",
            "description": "Display name in the requested language"
          },
          "tags": {
            "type": "array",
            "description": "List of tags associated with this catalog",
            "items": {
              "type": "string"
            }
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time this catalog was created"
          },
          "updated": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time this catalog was last updated"
          },
          "short_description": {
            "type": "string",
            "description": "Short description in the requested language"
          },
          "short_description_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Short description translation"
          },
          "kind": {
            "type": "string",
            "description": "Kind of object"
          },
          "publish": {
            "$ref": "#/components/schemas/PublishObject"
          },
          "state": {
            "$ref": "#/components/schemas/State"
          },
          "catalog_id": {
            "type": "string",
            "description": "The id of the catalog containing this offering",
            "format": "identifier",
            "x-linkback": "#/components/links/CatalogID"
          },
          "catalog_name": {
            "type": "string",
            "description": "The name of the catalog"
          },
          "data": {
            "description": "Map of data values for this object",
            "type": "object",
            "additionalProperties": true
          }
        }
      },
      "CatalogObject": {
        "type": "object",
        "x-data-source-name": "cm_object",
        "x-resource-name": "cm_object",
        "x-terraform-resource-operations": {
          "create": "create_object",
          "read": "get_object",
          "delete": "delete_object"
        },
        "x-terraform-datasource-operations": {
          "read": "get_object"
        },
        "description": "object information",
        "allOf": [
          {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "unique id",
                "format": "identifier"
              },
              "_rev": {
                "type": "string",
                "description": "Cloudant revision",
                "format": "identifier"
              }
            }
          },
          {
            "$ref": "#/components/schemas/CatalogObjectPrototype"
          }
        ]
      },
      "Rating": {
        "description": "Repository info for offerings",
        "type": "object",
        "properties": {
          "one_star_count": {
            "type": "integer",
            "description": "One start rating"
          },
          "two_star_count": {
            "type": "integer",
            "description": "Two start rating"
          },
          "three_star_count": {
            "type": "integer",
            "description": "Three start rating"
          },
          "four_star_count": {
            "type": "integer",
            "description": "Four start rating"
          }
        }
      },
      "ProviderInfo": {
        "description": "Information on the provider for this offering, or omitted if no provider information is given.",
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The id of this provider"
          },
          "name": {
            "type": "string",
            "description": "The name of this provider"
          }
        }
      },
      "RepoInfo": {
        "description": "Repository info for offerings",
        "type": "object",
        "properties": {
          "token": {
            "type": "string",
            "description": "Token for private repos"
          },
          "type": {
            "type": "string",
            "description": "Public or enterprise GitHub"
          }
        }
      },
      "Kind": {
        "type": "object",
        "description": "Offering kind",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique ID"
          },
          "format_kind": {
            "type": "string",
            "description": "content kind, e.g., helm, vm image"
          },
          "format_kind_label": {
            "type": "string",
            "description": "display value for content kind, e.g., helm, vm image"
          },
          "install_kind": {
            "type": "string",
            "description": "install kind, e.g., helm, operator, terraform"
          },
          "install_kind_label": {
            "type": "string",
            "description": "display value for install kind, e.g., helm, operator, terraform"
          },
          "target_kind": {
            "type": "string",
            "description": "target cloud to install, e.g., iks, open_shift_iks"
          },
          "target_kind_label": {
            "type": "string",
            "description": "display value for target cloud to install, e.g., iks, open_shift_iks"
          },
          "metadata": {
            "description": "Open ended metadata information",
            "type": "object",
            "additionalProperties": true
          },
          "tags": {
            "type": "array",
            "description": "List of tags associated with this catalog",
            "items": {
              "type": "string"
            }
          },
          "additional_features": {
            "type": "array",
            "description": "List of features associated with this offering",
            "items": {
              "$ref": "#/components/schemas/Feature"
            }
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time this catalog was created"
          },
          "updated": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time this catalog was last updated"
          },
          "versions": {
            "type": "array",
            "description": "list of versions",
            "items": {
              "$ref": "#/components/schemas/Version"
            }
          },
          "all_versions": {
            "type": "object",
            "description": "URLs for paging through all versions within this kind",
            "properties": {
              "first": {
                "$ref": "#/components/schemas/PaginationTokenLink"
              },
              "next": {
                "$ref": "#/components/schemas/PaginationTokenLink"
              }
            }
          }
        }
      },
      "Version": {
        "type": "object",
        "x-data-source-name": "cm_version",
        "x-resource-name": "cm_version",
        "x-terraform-resource-operations": {
          "create": "import_offering_version",
          "read": "get_version",
          "delete": "delete_version"
        },
        "x-terraform-datasource-operations": {
          "read": "get_version"
        },
        "description": "Offering version information",
        "properties": {
          "id": {
            "type": "string",
            "description": "Unique ID",
            "format": "identifier",
            "readOnly": true
          },
          "_rev": {
            "type": "string",
            "description": "Cloudant revision",
            "format": "identifier",
            "readOnly": true
          },
          "crn": {
            "type": "string",
            "description": "Version's CRN"
          },
          "version": {
            "type": "string",
            "description": "Version of content type"
          },
          "flavor": {
            "$ref": "#/components/schemas/Flavor",
            "description": "Optional flavor information for this version.  Only supported for Product kind Solution."
          },
          "sha": {
            "type": "string",
            "description": "hash of the content"
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time this version was created"
          },
          "updated": {
            "type": "string",
            "format": "date-time",
            "description": "The date and time this version was last updated"
          },
          "offering_id": {
            "type": "string",
            "description": "Offering ID",
            "format": "identifier",
            "x-linkback": "#/components/links/OfferingID"
          },
          "catalog_id": {
            "type": "string",
            "description": "Catalog ID",
            "format": "identifier",
            "x-linkback": "#/components/links/CatalogID"
          },
          "kind_id": {
            "type": "string",
            "description": "Kind ID"
          },
          "tags": {
            "type": "array",
            "description": "List of tags associated with this catalog",
            "items": {
              "type": "string"
            }
          },
          "repo_url": {
            "type": "string",
            "description": "Content's repo URL"
          },
          "source_url": {
            "type": "string",
            "description": "Content's source URL (e.g git repo)"
          },
          "tgz_url": {
            "type": "string",
            "description": "File used to on-board this version"
          },
          "configuration": {
            "type": "array",
            "description": "List of user solicited overrides",
            "items": {
              "$ref": "#/components/schemas/Configuration"
            }
          },
          "outputs": {
            "type": "array",
            "description": "List of output values for this version",
            "items": {
              "$ref": "#/components/schemas/Output"
            }
          },
          "iam_permissions": {
            "type": "array",
            "description": "List of IAM permissions that are required to consume this version",
            "items": {
              "$ref": "#/components/schemas/IAMPermission"
            }
          },
          "metadata": {
            "description": "Open ended metadata information",
            "type": "object",
            "additionalProperties": true
          },
          "validation": {
            "$ref": "#/components/schemas/Validation"
          },
          "required_resources": {
            "type": "array",
            "description": "Resource requirments for installation",
            "items": {
              "$ref": "#/components/schemas/Resource"
            }
          },
          "single_instance": {
            "type": "boolean",
            "description": "Denotes if single instance can be deployed to a given cluster"
          },
          "schematics_env_values": {
            "type": "object",
            "$ref": "#/components/schemas/SchematicsEnvValues"
          },
          "install": {
            "$ref": "#/components/schemas/Script"
          },
          "pre_install": {
            "type": "array",
            "description": "Optional pre-install instructions",
            "items": {
              "$ref": "#/components/schemas/Script"
            }
          },
          "scripts": {
            "type": "object",
            "description": "A map of scripts to be run by a Project during a particular stage of a specified action.  Each key in the map must match the format \"action\"_\"stage\" in the specified ScriptRef.",
            "additionalProperties": {
              "$ref": "#/components/schemas/ScriptRef"
            }
          },
          "entitlement": {
            "type": "object",
            "description": "Entitlement license info",
            "properties": {
              "provider_name": {
                "type": "string",
                "description": "Provider name"
              },
              "provider_id": {
                "type": "string",
                "description": "Provider ID"
              },
              "product_id": {
                "type": "string",
                "description": "Product ID"
              },
              "part_numbers": {
                "type": "array",
                "description": "list of license entitlement part numbers, eg. D1YGZLL,D1ZXILL",
                "items": {
                  "type": "string"
                }
              },
              "image_repo_name": {
                "type": "string",
                "description": "Image repository name"
              }
            }
          },
          "licenses": {
            "type": "array",
            "description": "List of licenses the product was built with",
            "items": {
              "$ref": "#/components/schemas/License"
            }
          },
          "image_manifest_url": {
            "type": "string",
            "description": "If set, denotes a url to a YAML file with list of container images used by this version"
          },
          "deprecated": {
            "type": "boolean",
            "description": "read only field, indicating if this version is deprecated"
          },
          "package_version": {
            "type": "string",
            "description": "Version of the package used to create this version"
          },
          "state": {
            "$ref": "#/components/schemas/State"
          },
          "version_locator": {
            "type": "string",
            "description": "A dotted value of `catalogID`.`versionID`",
            "format": "identifier",
            "x-linkback": "#/components/links/VersionLocator"
          },
          "long_description": {
            "type": "string",
            "description": "Long description for version"
          },
          "long_description_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated long description for version, by language code"
          },
          "short_description": {
            "type": "string",
            "description": "Short description for version"
          },
          "short_description_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated short description for version, by language code"
          },
          "whitelisted_accounts": {
            "type": "array",
            "description": "Whitelisted accounts for version",
            "items": {
              "type": "string"
            }
          },
          "image_pull_key_name": {
            "type": "string",
            "description": "ID of the image pull key to use from Offering.ImagePullKeys"
          },
          "deprecate_pending": {
            "$ref": "#/components/schemas/DeprecatePending",
            "description": "Deprecation information for this version"
          },
          "solution_info": {
            "$ref": "#/components/schemas/SolutionInfo",
            "description": "Solution information for version.  Only supported for Product kind Solution."
          },
          "is_consumable": {
            "type": "boolean",
            "description": "Is the version able to be shared"
          },
          "compliance_v3": {
            "$ref": "#/components/schemas/Compliance",
            "description": "Compliance info for a version"
          },
          "change_notices": {
            "$ref": "#/components/schemas/ChangeNotices",
            "description": "Change notices for a version"
          },
          "plan_ids": {
            "type": "array",
            "description": "A list of plan ids that are applicable for this version",
            "items": {
              "type": "string"
            }
          },
          "stack": {
            "type": "object",
            "description": "Optional. Stack definition that was used to create this version",
            "additionalProperties": true
          },
          "minimum_compatible_version": {
            "type": "string",
            "description": "The lowest version (semver) that can upgrade to this version"
          }
        }
      },
      "VersionInputValidationResponse": {
        "type": "object",
        "description": "Validate deployment variables",
        "properties": {
          "message": {
            "description": "Failure message",
            "type": "string"
          },
          "code": {
            "description": "Response code",
            "type": "string"
          },
          "global_transaction_id": {
            "description": "Transaction ID",
            "type": "string"
          },
          "errors": {
            "description": "Transaction ID",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "message": {
                  "type": "string"
                },
                "entity": {
                  "type": "string"
                },
                "error_code": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "SchematicsEnvValues": {
        "type": "object",
        "description": "Environment values to be passed to Schematics Workspace on creation",
        "properties": {
          "value": {
            "type": "string",
            "description": "JSON string containing an array of values in Environment Variable format defined by the Schematics service",
            "example": "[{\"name\": \"TF_LOG\",\"value\": \"TRACE\",\"secure\": false,\"hidden\": false}]"
          },
          "sm_ref": {
            "type": "string",
            "description": "JSON encoded value of $ref:#/components/schemas/SecretInstance, prefixed with `cmsm_v1:`, where the secret value in Secrets Manager specifies a JSON string, which contains an array of values in the Environment Variable foramt defined by the Schematics service",
            "example": "cmsm_v1:{\"name\": \"envVarSecret\",\"id\":\"1234567890\",\"service_id\":\"crn:v1:bluemix:public:secrets-manager:eu-gb:a/1234567890:1234567890::\",\"service_name\":\"My SM Instance\",\"group_id\":\"1234567890\",\"group_name\":\"My SM Group\",\"resource_group_id\":\"1234567890\",\"region\":\"eu-gb\",\"type\":\"arbitrary\"}"
          }
        }
      },
      "Resource": {
        "type": "object",
        "description": "Resource requirements",
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of requirement",
            "enum": [
              "mem",
              "disk",
              "cores",
              "targetVersion",
              "nodes",
              "terraformVersion"
            ]
          },
          "value": {
            "description": "mem, disk, cores, and nodes can be parsed as an int.  targetVersion and terraformVersion will be a semver range value."
          }
        }
      },
      "State": {
        "type": "object",
        "description": "Offering state",
        "properties": {
          "current": {
            "type": "string",
            "description": "one of: new, validated, consumable"
          },
          "current_entered": {
            "type": "string",
            "description": "Date and time of current request",
            "format": "date-time"
          },
          "pending": {
            "type": "string",
            "description": "one of: new, validated, consumable"
          },
          "pending_requested": {
            "type": "string",
            "description": "Date and time of pending request",
            "format": "date-time"
          },
          "previous": {
            "type": "string",
            "description": "one of: new, validated, consumable"
          }
        }
      },
      "Flavor": {
        "type": "object",
        "description": "Version Flavor Information.  Only supported for Product kind Solution.",
        "properties": {
          "name": {
            "type": "string",
            "description": "Programmatic name for this flavor"
          },
          "label": {
            "type": "string",
            "description": "Label for this flavor"
          },
          "label_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated label for this flavor, by language code"
          },
          "index": {
            "type": "integer",
            "description": "Order that this flavor should appear when listed for a single version"
          }
        }
      },
      "SolutionInfo": {
        "type": "object",
        "description": "Version Solution Information.  Only supported for Product kind Solution.",
        "properties": {
          "architecture_diagrams": {
            "type": "array",
            "description": "Architecture diagrams for this solution",
            "items": {
              "$ref": "#/components/schemas/ArchitectureDiagram"
            }
          },
          "features": {
            "type": "array",
            "description": "Features - titles only",
            "items": {
              "$ref": "#/components/schemas/Feature"
            }
          },
          "cost_estimate": {
            "$ref": "#/components/schemas/CostEstimate",
            "description": "Cost estimate cost for this solution"
          },
          "dependencies": {
            "type": "array",
            "description": "Dependencies for this solution",
            "items": {
              "$ref": "#/components/schemas/OfferingReference"
            }
          },
          "install_type": {
            "type": "string",
            "description": "The install type for this solution"
          }
        }
      },
      "ArchitectureDiagram": {
        "type": "object",
        "description": "An Architecture Diagram",
        "properties": {
          "diagram": {
            "$ref": "#/components/schemas/MediaItem"
          },
          "description": {
            "type": "string",
            "description": "Description of this diagram"
          },
          "description_i18n": {
            "$ref": "#/components/schemas/I18n"
          }
        }
      },
      "PublishObject": {
        "type": "object",
        "description": "Publish information",
        "properties": {
          "pc_managed": {
            "type": "boolean",
            "description": "Offering is managed by Partner Center"
          },
          "approval_type": {
            "type": "string",
            "description": "Determines how the offering gets approved into the public catalog. The values supported right now are `pc_managed`, `ibm_module_repo`, and `ibm_community`."
          },
          "publish_approved": {
            "type": "boolean",
            "description": "Offering has been approved to publish to permitted to IBM or Public Catalog"
          },
          "share_with_all": {
            "type": "boolean",
            "description": "Denotes public availability of an Offering"
          },
          "share_with_ibm": {
            "type": "boolean",
            "description": "Denotes IBM employee availability of an Offering - if share_enabled is true"
          },
          "share_enabled": {
            "type": "boolean",
            "description": "Denotes sharing including access list availability of an Offering is enabled"
          },
          "original_crn": {
            "type": "string",
            "description": "The original offering CRN that this publish entry came from"
          },
          "public_crn": {
            "type": "string",
            "description": "The crn of the public catalog entry of this offering"
          },
          "approval_record": {
            "type": "object",
            "description": "Record describing offering's approval details",
            "additionalProperties": true
          },
          "permit_ibm_public_publish": {
            "type": "boolean",
            "description": "Is it permitted to request publishing to IBM or Public"
          },
          "ibm_approved": {
            "type": "boolean",
            "description": "Indicates if this offering has been approved for use by all IBMers"
          },
          "public_approved": {
            "type": "boolean",
            "description": "Indicates if this offering has been approved for use by all IBM Cloud users"
          }
        }
      },
      "Configuration": {
        "type": "object",
        "description": "Configuration description",
        "properties": {
          "key": {
            "type": "string",
            "description": "Configuration key"
          },
          "type": {
            "type": "string",
            "description": "Value type (string, boolean, int)"
          },
          "default_value": {
            "description": "The default value.  To use a secret when the type is password, specify a JSON encoded value of $ref:#/components/schemas/SecretInstance, prefixed with `cmsm_v1:`"
          },
          "display_name": {
            "type": "string",
            "description": "Display name for configuration type"
          },
          "value_constraint": {
            "type": "string",
            "description": "Deprecated - Constraint associated with value, e.g., for string type - regx:[a-z]"
          },
          "value_constraints": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ValueConstraint"
            },
            "description": "Validation rules for this input value"
          },
          "description": {
            "type": "string",
            "description": "Key description"
          },
          "required": {
            "type": "boolean",
            "description": "Is key required to install"
          },
          "options": {
            "type": "array",
            "description": "List of options of type",
            "items": {
              "description": "An option value of any type"
            }
          },
          "hidden": {
            "type": "boolean",
            "description": "Hide values"
          },
          "custom_config": {
            "$ref": "#/components/schemas/RenderType",
            "description": "Configuration object for custom types"
          },
          "type_metadata": {
            "type": "string",
            "description": "The original type, as found in the source being onboarded"
          },
          "random_string": {
            "description": "The specified random string rules are applied to this configuration item's default value if the item is of type string.  Random characters include lowercase letters and numbers.",
            "type": "object",
            "properties": {
              "length": {
                "type": "integer",
                "description": "How many random characters to generate.  Default is 10, max is 25."
              }
            }
          },
          "value": {
            "description": "Only added to a configuration item when getting a single version by locator ID.  Contains the default value and a random string where specified.   If no default value is provided, value is set to a random string, otherwise value as appended with a `-` character followed by the random string."
          }
        }
      },
      "RenderType": {
        "type": "object",
        "description": "Render type",
        "properties": {
          "type": {
            "type": "string",
            "description": "ID of the widget type"
          },
          "grouping": {
            "type": "string",
            "description": "Determines where this configuration type is rendered (3 sections today - Target, Resource, and Deployment)"
          },
          "original_grouping": {
            "type": "string",
            "description": "Original grouping type for this configuration (3 types - Target, Resource, and Deployment)"
          },
          "grouping_index": {
            "type": "integer",
            "description": "Determines the order that this configuration item shows in that particular grouping"
          },
          "config_constraints": {
            "type": "object",
            "description": "Map of constraint parameters that will be passed to the custom widget"
          },
          "associations": {
            "type": "object",
            "description": "List of parameters that are associated with this configuration",
            "properties": {
              "parameters": {
                "type": "array",
                "description": "Parameters for this association",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Name of this parameter"
                    },
                    "optionsRefresh": {
                      "type": "boolean",
                      "description": "Refresh options"
                    }
                  }
                }
              }
            }
          }
        }
      },
      "Validation": {
        "type": "object",
        "description": "Validation response",
        "properties": {
          "validated": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time of last successful validation"
          },
          "requested": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time of last validation was requested"
          },
          "state": {
            "type": "string",
            "description": "Current validation state - <empty>, in_progress, valid, invalid, expired"
          },
          "last_operation": {
            "type": "string",
            "description": "Last operation (e.g. submit_deployment, generate_installer, install_offering"
          },
          "target": {
            "description": "Validation target information (e.g. cluster_id, region, namespace, etc).  Values will vary by Content type",
            "type": "object",
            "additionalProperties": true
          },
          "message": {
            "type": "string",
            "description": "Any message needing to be conveyed as part of the validation job"
          }
        }
      },
      "HelmRepoList": {
        "type": "object",
        "description": "Helm repository metadata",
        "properties": {
          "chart": {
            "type": "object",
            "description": "A chart entry in the repo. This response will contain many chart names.",
            "properties": {
              "api_version": {
                "type": "string",
                "description": "API version"
              },
              "created": {
                "type": "string",
                "description": "Date and time created",
                "format": "date-time"
              },
              "description": {
                "type": "string",
                "description": "Description of Helm repo entry"
              },
              "deprecated": {
                "type": "boolean",
                "description": "Denotes whether repo entry is deprecated"
              },
              "digest": {
                "type": "string",
                "description": "Digest of entry"
              },
              "home": {
                "type": "string",
                "description": "Location of repo entry"
              },
              "icon": {
                "type": "string",
                "description": "Entry icon"
              },
              "keywords": {
                "type": "array",
                "description": "List of keywords",
                "items": {
                  "type": "string"
                }
              },
              "maintainers": {
                "type": "array",
                "description": "Emails and names of repo maintainers",
                "items": {
                  "$ref": "#/components/schemas/Maintainers"
                }
              },
              "name": {
                "type": "string",
                "description": "Entry name"
              },
              "tiller_version": {
                "type": "string",
                "description": "Helm server version"
              },
              "urls": {
                "type": "array",
                "description": "Array of URLs",
                "items": {
                  "type": "string"
                }
              },
              "sources": {
                "type": "array",
                "description": "Array of sources",
                "items": {
                  "type": "string"
                }
              },
              "version": {
                "type": "string",
                "description": "Entry version"
              },
              "appVersion": {
                "type": "string",
                "description": "Application version"
              }
            }
          }
        }
      },
      "Maintainers": {
        "type": "object",
        "description": "Repo maintainers",
        "properties": {
          "email": {
            "type": "string",
            "description": "Maintainer email address"
          },
          "name": {
            "type": "string",
            "description": "Name of maintainer"
          }
        }
      },
      "HelmPackage": {
        "type": "object",
        "description": "Helm package",
        "properties": {
          "chart": {
            "type": "object",
            "description": "The name of the requested chart, or the name of a nested chart within the requested chart.",
            "properties": {
              "Chart.yaml": {
                "$ref": "#/components/schemas/HelmChart"
              },
              "sha": {
                "type": "string",
                "description": "Project SHA"
              },
              "README.md": {
                "type": "string",
                "description": "Helm chart description"
              },
              "values-metadata": {
                "description": "Values metadata",
                "type": "object",
                "additionalProperties": true
              },
              "license-metadata": {
                "description": "License metadata",
                "type": "object",
                "additionalProperties": true
              }
            }
          }
        }
      },
      "HelmChart": {
        "type": "object",
        "description": "Helm chart",
        "properties": {
          "name": {
            "type": "string",
            "description": "Chart name"
          },
          "description": {
            "type": "string",
            "description": "Chart description"
          },
          "icon": {
            "type": "string",
            "description": "Chart icon"
          },
          "version": {
            "type": "string",
            "description": "Chart version"
          },
          "appVersion": {
            "type": "string",
            "description": "Chart app version"
          }
        }
      },
      "ClusterSearchResult": {
        "type": "object",
        "description": "Paginated cluster search result",
        "required": [
          "offset",
          "limit"
        ],
        "properties": {
          "offset": {
            "type": "integer",
            "description": "The offset (origin 0) of the first resource in this page of search results."
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of resources returned in each page of search results."
          },
          "total_count": {
            "type": "integer",
            "description": "The overall total number of resources in the search result set."
          },
          "resource_count": {
            "type": "integer",
            "description": "The number of resources returned in this page of search results."
          },
          "first": {
            "type": "string",
            "description": "A URL for retrieving the first page of search results."
          },
          "last": {
            "type": "string",
            "description": "A URL for retrieving the last page of search results."
          },
          "prev": {
            "type": "string",
            "description": "A URL for retrieving the previous page of search results."
          },
          "next": {
            "type": "string",
            "description": "A URL for retrieving the next page of search results."
          },
          "resources": {
            "type": "array",
            "description": "Resulting objects",
            "items": {
              "$ref": "#/components/schemas/ClusterInfo"
            }
          }
        }
      },
      "OperatorDeployResult": {
        "type": "object",
        "description": "Operator deploy result",
        "properties": {
          "phase": {
            "type": "string",
            "description": "Status phase"
          },
          "message": {
            "type": "string",
            "description": "Status message"
          },
          "link": {
            "type": "string",
            "description": "Operator API path"
          },
          "name": {
            "type": "string",
            "description": "Name of Operator"
          },
          "version": {
            "type": "string",
            "description": "Operator version"
          },
          "namespace": {
            "type": "string",
            "description": "Kube namespace"
          },
          "package_name": {
            "type": "string",
            "description": "Package Operator exists in"
          },
          "catalog_id": {
            "type": "string",
            "description": "Catalog identification"
          }
        }
      },
      "ClusterInfo": {
        "type": "object",
        "description": "Cluster information",
        "properties": {
          "resource_group_id": {
            "type": "string",
            "description": "Resource Group ID"
          },
          "resource_group_name": {
            "type": "string",
            "description": "Resource Group name"
          },
          "id": {
            "type": "string",
            "description": "Cluster ID"
          },
          "name": {
            "type": "string",
            "description": "Cluster name"
          },
          "region": {
            "type": "string",
            "description": "Cluster region"
          },
          "ingress_hostname": {
            "type": "string",
            "description": "Cluster Ingress hostname"
          },
          "provider": {
            "type": "string",
            "description": "Cluster provider"
          },
          "status": {
            "type": "string",
            "description": "Cluster status"
          }
        }
      },
      "ImportOfferingBody": {
        "type": "object",
        "description": "Additional data to be used when importing an offering or version",
        "properties": {
          "tags": {
            "type": "array",
            "description": "Tags array.",
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "type": "array",
            "description": "Keywords array.",
            "items": {
              "type": "string"
            }
          },
          "content": {
            "description": "Byte array representing the content to be imported. Only supported for OVA images at this time.",
            "type": "string",
            "format": "byte"
          },
          "name": {
            "description": "Name of version. Required for virtual server image for VPC.",
            "type": "string"
          },
          "label": {
            "description": "Display name of version. Required for virtual server image for VPC.",
            "type": "string"
          },
          "install_kind": {
            "description": "Install type. Example: instance. Required for virtual server image for VPC.",
            "type": "string"
          },
          "target_kinds": {
            "type": "array",
            "description": "Deployment target of the content being onboarded. Current valid values are iks, roks, vcenter, power-iaas, terraform, and vpc-x86. Required for virtual server image for VPC.",
            "items": {
              "type": "string"
            }
          },
          "format_kind": {
            "description": "Format of content being onboarded. Example: vsi-image. Required for virtual server image for VPC.",
            "type": "string"
          },
          "product_kind": {
            "description": "Optional product kind for the software being onboarded.  Valid values are software, module, or solution.  Default value is software.",
            "type": "string"
          },
          "product_kind_label": {
            "description": "Display value for optional product kind for the software being onboarded.",
            "type": "string"
          },
          "sha": {
            "description": "SHA256 fingerprint of the image file. Required for virtual server image for VPC. ",
            "type": "string"
          },
          "version": {
            "description": "Semantic version of the software being onboarded. Required for virtual server image for VPC.",
            "type": "string"
          },
          "flavor": {
            "description": "The flavor of the current software being onboarded.  Only valid if the Product kind is module or solution.",
            "$ref": "#/components/schemas/Flavor"
          },
          "metadata": {
            "description": "Generic data to be included with content being onboarded. Required for virtual server image for VPC.",
            "properties": {
              "operating_system": {
                "description": "Operating system included in this image. Required for virtual server image for VPC.",
                "properties": {
                  "dedicated_host_only": {
                    "type": "boolean",
                    "description": "Images with this operating system can only be used on dedicated hosts or dedicated host groups. Required for virtual server image for VPC."
                  },
                  "vendor": {
                    "type": "string",
                    "description": "Vendor of the operating system. Required for virtual server image for VPC."
                  },
                  "name": {
                    "type": "string",
                    "description": "Globally unique name for this operating system Required for virtual server image for VPC."
                  },
                  "href": {
                    "type": "string",
                    "description": "URL for this operating system. Required for virtual server image for VPC."
                  },
                  "display_name": {
                    "type": "string",
                    "description": "Unique, display-friendly name for the operating system. Required for virtual server image for VPC."
                  },
                  "family": {
                    "type": "string",
                    "description": "Software family for this operating system. Required for virtual server image for VPC."
                  },
                  "version": {
                    "type": "string",
                    "description": "Major release version of this operating system. Required for virtual server image for VPC."
                  },
                  "architecture": {
                    "type": "string",
                    "description": "Operating system architecture. Required for virtual server image for VPC."
                  }
                }
              },
              "file": {
                "description": "Details for the stored image file. Required for virtual server image for VPC.",
                "properties": {
                  "size": {
                    "type": "integer",
                    "description": "Size of the stored image file rounded up to the next gigabyte. Required for virtual server image for VPC."
                  }
                }
              },
              "minimum_provisioned_size": {
                "type": "integer",
                "description": "Minimum size (in gigabytes) of a volume onto which this image may be provisioned. Required for virtual server image for VPC."
              },
              "images": {
                "type": "array",
                "description": "Image operating system. Required for virtual server image for VPC.",
                "items": {
                  "type": "object",
                  "description": "A list of details that identify a virtual server image. Required for virtual server image for VPC.",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Programmatic ID of virtual server image. Required for virtual server image for VPC."
                    },
                    "name": {
                      "type": "string",
                      "description": "Programmatic name of virtual server image. Required for virtual server image for VPC."
                    },
                    "region": {
                      "type": "string",
                      "description": "Region the virtual server image is available in. Required for virtual server image for VPC."
                    }
                  }
                }
              }
            }
          },
          "working_directory": {
            "description": "Optional - The sub-folder within the specified tgz file that contains the software being onboarded",
            "type": "string"
          },
          "install_type": {
            "description": "The install type of the variation.  Specify extension or fullstack.",
            "type": "string"
          }
        }
      },
      "ImportOfferingCopyReloadBody": {
        "type": "object",
        "description": "Additional data to be used when importing an offering or version",
        "properties": {
          "tags": {
            "type": "array",
            "description": "Tags array",
            "items": {
              "type": "string"
            }
          },
          "content": {
            "description": "byte array representing the content to be imported.  Only supported for OVA images at this time.",
            "type": "string",
            "format": "byte"
          },
          "target_kinds": {
            "type": "array",
            "description": "Target kinds.  Current valid values are 'iks', 'roks', 'vcenter', 'power-iaas', and 'terraform'",
            "items": {
              "type": "string"
            }
          },
          "format_kind": {
            "description": "Format of content being onboarded. Example: vsi-image. Required for virtual server image for VPC.",
            "type": "string"
          },
          "flavor": {
            "description": "The flavor of the current software being onboarded.  Only valid if the Product kind is module or solution.",
            "$ref": "#/components/schemas/Flavor"
          },
          "working_directory": {
            "description": "Optional - The sub-folder within the specified tgz file that contains the software being onboarded",
            "type": "string"
          },
          "install_type": {
            "description": "The install type of the current software being onboarded.",
            "type": "string"
          }
        }
      },
      "DeployRequestBody": {
        "type": "object",
        "description": "Cluster request data",
        "properties": {
          "cluster_id": {
            "type": "string",
            "description": "Cluster ID"
          },
          "region": {
            "type": "string",
            "description": "Cluster region"
          },
          "namespace": {
            "type": "string",
            "description": "Kube namespace"
          },
          "namespaces": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Kube namespaces"
          },
          "all_namespaces": {
            "type": "boolean",
            "description": "Used when installing an operator, to indicate that it should be made avaiable in all namespaces on the target cluster"
          },
          "override_values": {
            "description": "Validation override values. Required for virtual server image for VPC.",
            "type": "object",
            "additionalProperties": true,
            "properties": {
              "vsi_instance_name": {
                "type": "string",
                "description": "Name of virtual server image instance to create. Required for virtual server image for VPC."
              },
              "vpc_profile": {
                "type": "string",
                "description": "Profile to use when validating virtual server image. Required for virtual server image for VPC."
              },
              "subnet_id": {
                "type": "string",
                "description": "ID of subnet to use when validating virtual server image. Required for virtual server image for VPC."
              },
              "vpc_id": {
                "type": "string",
                "description": "ID of VPC to use when validating virtual server image. Required for virtual server image for VPC."
              },
              "subnet_zone": {
                "type": "string",
                "description": "Zone of subnet to use when validating virtual server image. Required for virtual server image for VPC."
              },
              "ssh_key_id": {
                "type": "string",
                "description": "ID off SSH key to use when validating virtual server image. Required for virtual server image for VPC."
              },
              "vpc_region": {
                "type": "string",
                "description": "Region virtual server image exists in. Required for virtual server image for VPC."
              }
            }
          },
          "dependency_configs": {
            "type": "array",
            "description": "Used when the product has required dependencies, to indicated existing dependencies to reuse during validation",
            "items": {
              "type": "string",
              "description": "Project config ID for a required dependency"
            }
          },
          "environment_variables": {
            "type": "array",
            "description": "Schematics environment variables to use with this workspace",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string",
                  "description": "Variable name"
                },
                "value": {
                  "description": "Variable value"
                },
                "secure": {
                  "type": "boolean",
                  "description": "Does this variable contain a secure value"
                },
                "hidden": {
                  "type": "boolean",
                  "description": "Environment variable is hidden"
                }
              }
            }
          },
          "entitlement_apikey": {
            "type": "string",
            "description": "Entitlement API Key for this offering"
          },
          "schematics": {
            "type": "object",
            "description": "Schematics workspace configuration",
            "properties": {
              "name": {
                "type": "string",
                "description": "Schematics workspace name"
              },
              "description": {
                "type": "string",
                "description": "Schematics workspace description"
              },
              "tags": {
                "type": "array",
                "description": "Schematics workspace tags",
                "items": {
                  "type": "string"
                }
              },
              "resource_group_id": {
                "type": "string",
                "description": "Resource group to use when creating the schematics workspace"
              },
              "terraform_version": {
                "type": "string",
                "description": "Terraform version override"
              },
              "region": {
                "type": "string",
                "description": "Schematics workspace region"
              }
            }
          },
          "script": {
            "type": "string",
            "description": "Script"
          },
          "script_id": {
            "type": "string",
            "description": "Script ID"
          },
          "version_locator_id": {
            "type": "string",
            "description": "A dotted value of `catalogID`.`versionID`"
          },
          "vcenter_id": {
            "type": "string",
            "description": "VCenter ID"
          },
          "vcenter_location": {
            "type": "string",
            "description": "VCenter Location"
          },
          "vcenter_user": {
            "type": "string",
            "description": "VCenter User"
          },
          "vcenter_password": {
            "type": "string",
            "description": "VCenter Password"
          },
          "vcenter_datastore": {
            "type": "string",
            "description": "VCenter Datastore"
          },
          "plan_id": {
            "type": "string",
            "description": "Software plan ID"
          },
          "channel": {
            "type": "string",
            "description": "Used when installing an operator, to indicate which channel to use"
          },
          "install_plan": {
            "type": "string",
            "description": "Used when installing an operator, to indicate which install plan to use"
          }
        }
      },
      "OperatorDeploy": {
        "type": "object",
        "description": "Cluster request data",
        "properties": {
          "cluster_id": {
            "type": "string",
            "description": "Cluster ID"
          },
          "region": {
            "type": "string",
            "description": "Cluster region"
          },
          "namespaces": {
            "type": "array",
            "description": "Kube namespaces to deploy Operator(s) to",
            "items": {
              "type": "string"
            }
          },
          "all_namespaces": {
            "type": "boolean",
            "description": "Denotes whether to install Operator(s) globally"
          },
          "version_locator_id": {
            "type": "string",
            "description": "A dotted value of `catalogID`.`versionID`"
          },
          "channel": {
            "type": "string",
            "description": "Operator channel"
          },
          "install_plan": {
            "type": "string",
            "description": "Plan"
          }
        }
      },
      "NamespaceSearchResult": {
        "type": "object",
        "description": "Paginated list of namespace search results",
        "required": [
          "offset",
          "limit"
        ],
        "properties": {
          "offset": {
            "type": "integer",
            "description": "The offset (origin 0) of the first resource in this page of search results."
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of resources returned in each page of search results."
          },
          "total_count": {
            "type": "integer",
            "description": "The overall total number of resources in the search result set."
          },
          "resource_count": {
            "type": "integer",
            "description": "The number of resources returned in this page of search results."
          },
          "first": {
            "type": "string",
            "description": "A URL for retrieving the first page of search results."
          },
          "last": {
            "type": "string",
            "description": "A URL for retrieving the last page of search results."
          },
          "prev": {
            "type": "string",
            "description": "A URL for retrieving the previous page of search results."
          },
          "next": {
            "type": "string",
            "description": "A URL for retrieving the next page of search results."
          },
          "resources": {
            "type": "array",
            "description": "Resulting objects",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "InstallStatus": {
        "type": "object",
        "description": "Installation status",
        "properties": {
          "metadata": {
            "type": "object",
            "description": "Installation status metadata",
            "properties": {
              "cluster_id": {
                "description": "Cluster ID",
                "type": "string"
              },
              "region": {
                "description": "Cluster region",
                "type": "string"
              },
              "namespace": {
                "description": "Cluster namespace",
                "type": "string"
              },
              "workspace_id": {
                "description": "Workspace ID",
                "type": "string"
              },
              "workspace_name": {
                "description": "Workspace name",
                "type": "string"
              }
            }
          },
          "release": {
            "type": "object",
            "description": "Release information",
            "properties": {
              "deployments": {
                "type": "array",
                "description": "Kube deployments",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "replicasets": {
                "type": "array",
                "description": "Kube replica sets",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "statefulsets": {
                "type": "array",
                "description": "Kube stateful sets",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "pods": {
                "type": "array",
                "description": "Kube pods",
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "errors": {
                "description": "Kube errors",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              }
            }
          },
          "content_mgmt": {
            "type": "object",
            "description": "Content management information",
            "properties": {
              "pods": {
                "type": "array",
                "description": "Pods",
                "items": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              },
              "errors": {
                "description": "Errors",
                "type": "array",
                "items": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      },
      "License": {
        "type": "object",
        "description": "BSS license",
        "properties": {
          "id": {
            "type": "string",
            "description": "License ID"
          },
          "name": {
            "type": "string",
            "description": "license name"
          },
          "type": {
            "type": "string",
            "description": "type of license e.g., Apache xxx"
          },
          "url": {
            "type": "string",
            "description": "URL for the license text"
          },
          "description": {
            "type": "string",
            "description": "License description"
          }
        }
      },
      "LicenseProviders": {
        "type": "object",
        "description": "Paginated list of license providers",
        "properties": {
          "total_results": {
            "type": "integer",
            "description": "Total number of results"
          },
          "total_pages": {
            "type": "integer",
            "description": "Total number of pages"
          },
          "prev_url": {
            "type": "string",
            "description": "Previous URL"
          },
          "next_url": {
            "type": "string",
            "description": "Next URL"
          },
          "resources": {
            "type": "array",
            "description": "Resulting License Provider objects",
            "items": {
              "$ref": "#/components/schemas/LicenseProvider"
            }
          }
        }
      },
      "LicenseProvider": {
        "type": "object",
        "description": "BSS License provider",
        "properties": {
          "name": {
            "type": "string",
            "description": "Provider name, eg. IBM Passport Advantage"
          },
          "short_description": {
            "type": "string",
            "description": "Short description of license provider"
          },
          "id": {
            "type": "string",
            "description": "Provider ID"
          },
          "licence_type": {
            "type": "string",
            "description": "Type of license entitlement, e.g. ibm-ppa"
          },
          "offering_type": {
            "type": "string",
            "description": "Type of offering"
          },
          "create_url": {
            "type": "string",
            "description": "URL of the license provider for where to create/get a license, e.g. https://www.ibm.com/software/passportadvantage/aboutpassport.html"
          },
          "info_url": {
            "type": "string",
            "description": "URL of the license provider for additional info, e.g. https://www.ibm.com/software/passportadvantage"
          },
          "url": {
            "type": "string",
            "description": "URL for the BSS license provider, e.g. /v1/licensing/license_providers/:id"
          },
          "crn": {
            "type": "string",
            "description": "Provider CRN"
          },
          "state": {
            "type": "string",
            "description": "State of license provider"
          }
        }
      },
      "LicenseEntitlements": {
        "type": "object",
        "description": "Paginated list of license entitlements",
        "properties": {
          "total_results": {
            "type": "integer",
            "description": "Total number of results"
          },
          "total_pages": {
            "type": "integer",
            "description": "Total number of pages"
          },
          "prev_url": {
            "type": "string",
            "description": "Previous URL"
          },
          "next_url": {
            "type": "string",
            "description": "Next URL"
          },
          "resources": {
            "type": "array",
            "description": "Resulting Entitlement objects",
            "items": {
              "$ref": "#/components/schemas/LicenseEntitlement"
            }
          }
        }
      },
      "LicenseEntitlement": {
        "type": "object",
        "description": "License entitlement",
        "properties": {
          "name": {
            "type": "string",
            "description": "Entitlement name"
          },
          "id": {
            "type": "string",
            "description": "Entitlement ID"
          },
          "crn": {
            "type": "string",
            "description": "Entitlement CRN"
          },
          "url": {
            "type": "string",
            "description": "URL for the BSS entitlement, e.g. /v1/licensing/entitlements/:id"
          },
          "offering_type": {
            "type": "string",
            "description": "Entitlement offering type"
          },
          "state": {
            "type": "string",
            "description": "State of the BSS entitlement, e.g. 'active' or if it's been deleted, 'removed'. "
          },
          "effective_from": {
            "type": "string",
            "description": "Entitlement is good from this starting date. eg. '2019-07-17T21:21:47.6794935Z' "
          },
          "effective_until": {
            "type": "string",
            "description": "Entitlement is good until this ending date. eg. '2019-07-17T21:21:47.6794935Z' "
          },
          "account_id": {
            "type": "string",
            "description": "Account ID where this entitlement is bound to"
          },
          "owner_id": {
            "type": "string",
            "description": "Account ID of owner"
          },
          "version_id": {
            "type": "string",
            "description": "GC ID of the specific offering version"
          },
          "license_offering_id": {
            "type": "string",
            "description": "Marketplace offering ID for this license entitlement"
          },
          "license_id": {
            "type": "string",
            "description": "Specific license entitlement ID from the license provider, eg. D1W3R4"
          },
          "license_owner_id": {
            "type": "string",
            "description": "IBM ID of the owner of this license entitlement"
          },
          "license_type": {
            "type": "string",
            "description": "Type of license entitlement, e.g. ibm-ppa"
          },
          "license_provider_id": {
            "type": "string",
            "description": "ID of the license provider"
          },
          "license_provider_url": {
            "type": "string",
            "description": "URL for the BSS license provider, e.g. /v1/licensing/license_providers/:license_provider_id"
          },
          "license_product_id": {
            "type": "string",
            "description": "Specific license entitlement ID from the license provider, eg. D1W3R4"
          },
          "namespace_repository": {
            "type": "string",
            "description": "Location of the registry images, eg. cp/cp4d"
          },
          "apikey": {
            "type": "string",
            "description": "API key for access to the license entitlement"
          },
          "create_by": {
            "type": "string",
            "description": "IBM ID"
          },
          "update_by": {
            "type": "string",
            "description": "IBM ID"
          },
          "create_at": {
            "type": "string",
            "description": "Creation date, eg. '2019-07-17T21:21:47.6794935Z' "
          },
          "updated_at": {
            "type": "string",
            "description": "Date last updated, eg. '2019-07-17T21:21:47.6794935Z' "
          },
          "history": {
            "type": "array",
            "description": "Entitlement history",
            "items": {
              "type": "object",
              "properties": {
                "action": {
                  "type": "string",
                  "description": "Eg. create"
                },
                "user": {
                  "type": "string",
                  "description": "Eg. IBM ID of user"
                },
                "date": {
                  "type": "string",
                  "description": "Date of action, eg. '2019-07-17T21:21:47.6794935Z' "
                }
              }
            }
          },
          "offering_list": {
            "type": "array",
            "description": "Array of license offering references",
            "items": {
              "$ref": "#/components/schemas/LicenseOfferingReference"
            }
          }
        }
      },
      "LicenseOfferingReference": {
        "type": "object",
        "description": "License offering reference",
        "properties": {
          "id": {
            "type": "string",
            "description": "Offering ID"
          },
          "name": {
            "type": "string",
            "description": "Offering name"
          },
          "label": {
            "type": "string",
            "description": "Offering label' "
          },
          "offering_icon_url": {
            "type": "string",
            "description": "URL to offering icon "
          },
          "account_id": {
            "type": "string",
            "description": "Account ID associated with offering"
          },
          "catalog_id": {
            "type": "string",
            "description": "Catalog ID associated with offering"
          }
        }
      },
      "LicenseEntitlementBody": {
        "type": "object",
        "description": "License entitlement information",
        "properties": {
          "name": {
            "type": "string",
            "description": "Entitlement name"
          },
          "effective_from": {
            "type": "string",
            "description": "Entitlement is good from this starting date. eg. '2019-07-17T21:21:47.6794935Z' "
          },
          "effective_until": {
            "type": "string",
            "description": "Entitlement is good until this ending date. eg. '2019-07-17T21:21:47.6794935Z' "
          },
          "version_id": {
            "type": "string",
            "description": "Global Catalog ID of the version"
          },
          "license_id": {
            "type": "string",
            "description": "Specific license entitlement ID from the license provider, eg. D1W3R4"
          },
          "license_owner_id": {
            "type": "string",
            "description": "IBM ID of the owner of this license entitlement"
          },
          "license_provider_id": {
            "type": "string",
            "description": "License provider ID"
          },
          "license_product_id": {
            "type": "string",
            "description": "License product ID"
          }
        }
      },
      "Licenses": {
        "type": "object",
        "description": "Paginated list of licenses",
        "properties": {
          "total_results": {
            "type": "integer",
            "description": "Total number of results"
          },
          "total_pages": {
            "type": "integer",
            "description": "Total number of pages"
          },
          "prev_url": {
            "type": "string",
            "description": "Previous URL"
          },
          "next_url": {
            "type": "string",
            "description": "Next URL"
          },
          "resources": {
            "type": "array",
            "description": "Resulting License objects",
            "items": {
              "$ref": "#/components/schemas/LicenseObject"
            }
          }
        }
      },
      "LicenseObject": {
        "type": "object",
        "description": "License information",
        "properties": {
          "name": {
            "type": "string",
            "description": "License name"
          },
          "offering_type": {
            "type": "string",
            "description": "Type of offering"
          },
          "seats_allowed": {
            "type": "string",
            "description": "Number of seats allowed for license"
          },
          "seats_used": {
            "type": "string",
            "description": "Number of seats used for license"
          },
          "owner_id": {
            "type": "string",
            "description": "ID of license owner"
          },
          "license_offering_id": {
            "type": "string",
            "description": "Marketplace offering ID for this license"
          },
          "license_id": {
            "type": "string",
            "description": "specific license entitlement ID from the license provider, eg. D1W3R4"
          },
          "license_owner_id": {
            "type": "string",
            "description": "IBM ID of the owner of this license entitlement"
          },
          "license_type": {
            "type": "string",
            "description": "type of license entitlement, e.g. ibm-ppa"
          },
          "license_provider_id": {
            "type": "string",
            "description": "ID of the license provider"
          },
          "license_product_id": {
            "type": "string",
            "description": "specific license entitlement ID from the license provider, eg. D1W3R4"
          },
          "license_provider_url": {
            "type": "string",
            "description": "URL for the BSS license provider, e.g. /v1/licensing/license_providers/:license_provider_id"
          },
          "effective_from": {
            "type": "string",
            "description": "license is good from this starting date. eg. '2019-07-17T21:21:47.6794935Z' "
          },
          "effective_until": {
            "type": "string",
            "description": "license is good until this ending date. eg. '2019-07-17T21:21:47.6794935Z' "
          },
          "internal": {
            "type": "boolean",
            "description": "If true, this will allow use of this license by all IBMers"
          },
          "offering_list": {
            "type": "array",
            "description": "Array of license offering references",
            "items": {
              "$ref": "#/components/schemas/LicenseOfferingReference"
            }
          }
        }
      },
      "Script": {
        "type": "object",
        "description": "Script information",
        "properties": {
          "instructions": {
            "type": "string",
            "description": "Instruction on step and by whom (role) that are needed to take place to prepare the target for installing this version"
          },
          "instructions_i18n": {
            "$ref": "#/components/schemas/I18n",
            "description": "Translated instructions, by language code"
          },
          "script": {
            "type": "string",
            "description": "Optional script that needs to be run post any pre-condition script"
          },
          "script_permission": {
            "type": "string",
            "description": "Optional iam permissions that are required on the target cluster to run this script"
          },
          "delete_script": {
            "type": "string",
            "description": "Optional script that if run will remove the installed version"
          },
          "scope": {
            "type": "string",
            "description": "Optional value indicating if this script is scoped to a namespace or the entire cluster"
          }
        }
      },
      "ScriptRef": {
        "type": "object",
        "description": "A script to be run as part of a Project configuration, during the specified stage and action",
        "properties": {
          "short_description": {
            "type": "string",
            "description": "The short description for this script"
          },
          "type": {
            "type": "string",
            "description": "The type of the script",
            "example": "ansible"
          },
          "path": {
            "type": "string",
            "description": "The path to this script within the current version source.  Must begin with scripts/",
            "example": "scripts/validate-post-ansible-playbook.yaml"
          },
          "stage": {
            "type": "string",
            "description": "The stage of the specified action where this script should be run",
            "enum": [
              "pre",
              "post"
            ]
          },
          "action": {
            "type": "string",
            "description": "The action where this script should be run",
            "enum": [
              "validate",
              "deploy",
              "undeploy"
            ]
          }
        }
      },
      "SchematicsWorkspaceSearchResult": {
        "type": "object",
        "description": "Result of schematics workspace search",
        "required": [
          "offset",
          "limit"
        ],
        "properties": {
          "offset": {
            "type": "integer",
            "description": "The offset (origin 0) of the first resource in this page of search results."
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of resources returned in each page of search results."
          },
          "total_count": {
            "type": "integer",
            "description": "The overall total number of resources in the search result set."
          },
          "resource_count": {
            "type": "integer",
            "description": "The number of resources returned in this page of search results."
          },
          "first": {
            "type": "string",
            "description": "A URL for retrieving the first page of search results."
          },
          "last": {
            "type": "string",
            "description": "A URL for retrieving the last page of search results."
          },
          "prev": {
            "type": "string",
            "description": "A URL for retrieving the previous page of search results."
          },
          "next": {
            "type": "string",
            "description": "A URL for retrieving the next page of search results."
          },
          "resources": {
            "type": "array",
            "description": "Resulting objects",
            "items": {
              "$ref": "#/components/schemas/SchematicsWorkspace"
            }
          }
        }
      },
      "SchematicsWorkspace": {
        "type": "object",
        "description": "Schematics workspace information",
        "properties": {
          "id": {
            "type": "string",
            "description": "Workspace ID"
          },
          "name": {
            "type": "string",
            "description": "Workspace name"
          },
          "type": {
            "type": "array",
            "description": "Workspace types",
            "items": {
              "type": "string"
            }
          },
          "description": {
            "type": "string",
            "description": "Workspace description"
          },
          "resource_group": {
            "type": "string",
            "description": "Resource group for this workspace"
          },
          "location": {
            "type": "string",
            "description": "Location of this workspace"
          },
          "tags": {
            "type": "array",
            "description": "Workspace tags",
            "items": {
              "type": "string"
            }
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Workspace creation date and time"
          },
          "created_by": {
            "type": "string",
            "description": "Email address of user that created the ID"
          },
          "status": {
            "type": "string",
            "description": "Workspace apply status"
          },
          "workspace_status": {
            "type": "object",
            "description": "Workspace frozen/locked status",
            "properties": {
              "frozen": {
                "type": "boolean",
                "description": "Workspace frozen state"
              },
              "locked": {
                "type": "boolean",
                "description": "Workspace locked state"
              }
            }
          },
          "template_ref": {
            "type": "string",
            "description": "Template reference"
          },
          "template_repo": {
            "type": "object",
            "description": "Template repository",
            "properties": {
              "repo_url": {
                "type": "string",
                "description": "The fully qualified path of the tgz used in the deploy"
              },
              "chart_name": {
                "type": "string",
                "description": "Name of chart"
              },
              "script_name": {
                "type": "string",
                "description": "Name of script"
              },
              "uninstall_script_name": {
                "type": "string",
                "description": "Name of uninstall script"
              },
              "folder_name": {
                "type": "string",
                "description": "Name of folder"
              },
              "repo_sha_value": {
                "type": "string",
                "description": "Digest of project"
              }
            }
          },
          "template_data": {
            "type": "array",
            "description": "Map of template data",
            "items": {
              "type": "object",
              "additionalProperties": true
            }
          },
          "runtime_data": {
            "type": "object",
            "description": "Data describing runtime",
            "properties": {
              "id": {
                "type": "string",
                "description": "Runtime ID"
              },
              "engine_name": {
                "type": "string",
                "description": "Engine name"
              },
              "engine_version": {
                "type": "string",
                "description": "Engine version"
              },
              "state_store_url": {
                "type": "string",
                "description": "URL path to state store"
              },
              "log_store_url": {
                "type": "string",
                "description": "URL path to log store"
              }
            }
          },
          "shared_data": {
            "description": "Map of shared data",
            "type": "object",
            "additionalProperties": true
          },
          "catalog_ref": {
            "type": "object",
            "description": "Catalog reference",
            "properties": {
              "item_id": {
                "type": "string",
                "description": "Version locator ID"
              },
              "catalog_id": {
                "type": "string",
                "description": "Catalog ID"
              },
              "offering_id": {
                "type": "string",
                "description": "Offering ID"
              },
              "offering_version": {
                "type": "string",
                "description": "Version ID"
              },
              "offering_kind": {
                "type": "string",
                "description": "Offering kind"
              },
              "offering_target_kind": {
                "type": "string",
                "description": "Offering target kind"
              },
              "item_url": {
                "type": "string",
                "description": "Relative Dashboard URL for content that generated this Blueprint"
              },
              "item_name": {
                "type": "string",
                "description": "The name of the offering that generated this Blueprint"
              },
              "item_readme_url": {
                "type": "string",
                "description": "Readme URL for the installed software version"
              },
              "item_icon_url": {
                "type": "string",
                "description": "Icon URL for the installed software version"
              },
              "launch_url": {
                "type": "string",
                "description": "Launch URL to the \"console\" for this cloud pak, if applicable"
              }
            }
          },
          "worksapce_status": {
            "type": "object",
            "description": "Workspace status",
            "properties": {
              "status_code": {
                "type": "string",
                "description": "Workspace status code"
              },
              "status_msg": {
                "type": "string",
                "description": "Worksapce status message"
              }
            }
          },
          "last_action_name": {
            "type": "string",
            "description": "Last worksapce action name"
          },
          "last_activity_id": {
            "type": "string",
            "description": "Last worksapce activity id"
          }
        }
      },
      "DeployRequirementsCheck": {
        "type": "object",
        "description": "Failed deployment requirements",
        "properties": {
          "pre_install": {
            "description": "Failed during pre-install",
            "type": "object",
            "additionalProperties": true
          },
          "install": {
            "description": "Failed during install",
            "type": "object",
            "additionalProperties": true
          }
        }
      },
      "ImageManifest": {
        "type": "object",
        "description": "Image Manifest",
        "properties": {
          "description": {
            "type": "string",
            "description": "Image manifest description"
          },
          "images": {
            "type": "array",
            "description": "List of images",
            "items": {
              "$ref": "#/components/schemas/Image"
            }
          }
        }
      },
      "Image": {
        "type": "object",
        "description": "Image",
        "properties": {
          "image": {
            "type": "string",
            "description": "Image"
          }
        }
      },
      "ApprovalResult": {
        "type": "object",
        "description": "Result of approval",
        "properties": {
          "shared": {
            "type": "boolean",
            "description": "Shared - object is shared using access list - not set when using PC Managed objects",
            "deprecated": true
          },
          "ibm": {
            "type": "boolean",
            "description": "Shared with IBM only - access list is also applicable - not set when using PC Managed objects",
            "deprecated": true
          },
          "public": {
            "type": "boolean",
            "description": "Shared with everyone - not set when using PC Managed objects",
            "deprecated": true
          },
          "allow_request": {
            "type": "boolean",
            "description": "Published to Partner Center (pc_managed) or for objects, allowed to request publishing"
          },
          "approved": {
            "type": "boolean",
            "description": "Approvers have approved publishing to public catalog"
          },
          "portal_record": {
            "type": "string",
            "description": "Partner Center document ID"
          },
          "portal_url": {
            "type": "string",
            "description": "Partner Center URL for this product"
          },
          "changed": {
            "type": "boolean",
            "description": "Denotes whether approvals have changed"
          }
        }
      },
      "DeprecateRequestBody": {
        "type": "object",
        "description": "Information for deprecation request",
        "properties": {
          "description": {
            "type": "string",
            "description": "Additional information that users can provide to be displayed in deprecation notification"
          },
          "days_until_deprecate": {
            "type": "integer",
            "description": "Specifies the amount of days until product is not available in catalog"
          }
        }
      },
      "ChangeNoticesResponse": {
        "type": "object",
        "description": "Change notices response",
        "properties": {
          "has_breaking": {
            "type": "boolean",
            "description": "Set to true if any of the included change notices contain a breaking change"
          },
          "has_new": {
            "type": "boolean",
            "description": "Set to true if any of the included change notices contain a new change"
          },
          "has_update": {
            "type": "boolean",
            "description": "Set to true if any of the included change notices contain an update"
          },
          "change_notices": {
            "type": "array",
            "description": "All changes notices for the requested versions",
            "items": {
              "type": "object",
              "description": "Change notices for the specified version",
              "properties": {
                "version_locator": {
                  "type": "string",
                  "description": "A dotted value of `catalogID`.`versionID`",
                  "format": "identifier",
                  "x-linkback": "#/components/links/VersionLocator"
                },
                "version": {
                  "type": "string",
                  "description": "the version number of this version"
                },
                "flavor": {
                  "$ref": "#/components/schemas/Flavor",
                  "description": "Optional flavor information for this version.  Only supported for Product kind Solution."
                },
                "breaking": {
                  "description": "Breaking changes for this version",
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Feature"
                  }
                },
                "new": {
                  "description": "New changes for this version",
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Feature"
                  }
                },
                "update": {
                  "description": "Updates for this version",
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Feature"
                  }
                }
              }
            }
          }
        }
      },
      "VersionUpdateDescriptor": {
        "type": "object",
        "description": "Indicates if the current version can be upgraded to the version identified by the descriptor",
        "properties": {
          "version_locator": {
            "type": "string",
            "description": "A dotted value of `catalogID`.`versionID`",
            "format": "identifier",
            "x-linkback": "#/components/links/VersionLocator"
          },
          "version": {
            "type": "string",
            "description": "the version number of this version"
          },
          "flavor": {
            "$ref": "#/components/schemas/Flavor",
            "description": "Optional flavor information for this version.  Only supported for Product kind Solution."
          },
          "state": {
            "$ref": "#/components/schemas/State"
          },
          "required_resources": {
            "type": "array",
            "description": "Resource requirments for installation",
            "items": {
              "$ref": "#/components/schemas/Resource"
            }
          },
          "package_version": {
            "type": "string",
            "description": "Version of package"
          },
          "sha": {
            "type": "string",
            "description": "The SHA value of this version"
          },
          "can_update": {
            "type": "boolean",
            "description": "true if the current version can be upgraded to this version, false otherwise"
          },
          "messages": {
            "description": "If can_update is false, this map will contain messages for each failed check, otherwise it will be omitted.  Possible keys include nodes, cores, mem, disk, targetVersion, and install-permission-check",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "Account": {
        "type": "object",
        "x-data-source-name": "cm_account",
        "x-resource-name": "cm_account",
        "x-terraform-resource-operations": {
          "create": "get_catalog_account",
          "read": "get_catalog_account"
        },
        "x-terraform-datasource-operations": {
          "read": "get_catalog_account"
        },
        "description": "Account information",
        "properties": {
          "id": {
            "type": "string",
            "description": "Account identification"
          },
          "_rev": {
            "type": "string",
            "description": "Cloudant revision",
            "format": "identifier"
          },
          "hide_IBM_cloud_catalog": {
            "type": "boolean",
            "description": "Hide the public catalog in this account"
          },
          "account_filters": {
            "$ref": "#/components/schemas/Filters"
          },
          "region_filter": {
            "type": "string",
            "description": "Region filter string"
          },
          "terraform_engines": {
            "type": "array",
            "description": "List of terraform engines configured for this account",
            "items": {
              "$ref": "#/components/schemas/TerraformEngines"
            }
          }
        }
      },
      "Enterprise": {
        "type": "object",
        "description": "Enterprise account information",
        "properties": {
          "id": {
            "type": "string",
            "description": "Enterprise identification"
          },
          "_rev": {
            "type": "string",
            "description": "Cloudant revision"
          },
          "account_filters": {
            "$ref": "#/components/schemas/Filters"
          },
          "account_groups": {
            "type": "object",
            "properties": {
              "keys": {
                "$ref": "#/components/schemas/AccountGroup"
              }
            },
            "description": "Map of account group ids to AccountGroup objects"
          },
          "region_filters": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "AccountGroup": {
        "type": "object",
        "description": "Filters for an Account Group",
        "properties": {
          "id": {
            "type": "string",
            "description": "Account group identification"
          },
          "account_filters": {
            "$ref": "#/components/schemas/Filters"
          },
          "region_filters": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "Filters": {
        "type": "object",
        "description": "Filters for account and catalog filters",
        "properties": {
          "include_all": {
            "type": "boolean",
            "description": "-> true - Include all of the public catalog when filtering. Further settings will specifically exclude some offerings. false - Exclude all of the public catalog when filtering. Further settings will specifically include some offerings."
          },
          "category_filters": {
            "description": "Filter against offering properties",
            "type": "object",
            "additionalProperties": {
              "$ref": "#/components/schemas/CategoryFilter"
            }
          },
          "id_filters": {
            "$ref": "#/components/schemas/IDFilter"
          }
        }
      },
      "CategoryFilter": {
        "type": "object",
        "description": "Filter on a category. The filter will match against the values of the given category with include or exclude",
        "properties": {
          "include": {
            "type": "boolean",
            "description": "-> true - This is an include filter, false - this is an exclude filter"
          },
          "filter": {
            "$ref": "#/components/schemas/FilterTerms"
          }
        }
      },
      "FilterTerms": {
        "type": "object",
        "description": "Offering filter terms",
        "properties": {
          "filter_terms": {
            "type": "array",
            "description": "List of values to match against. If include is true, then if the offering has one of the values then the offering is included. If include is false, then if the offering has one of the values then the offering is excluded.",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "IDFilter": {
        "description": "Filter on offering ID's. There is an include filter and an exclule filter. Both can be set.",
        "type": "object",
        "properties": {
          "include": {
            "$ref": "#/components/schemas/FilterTerms"
          },
          "exclude": {
            "$ref": "#/components/schemas/FilterTerms"
          }
        }
      },
      "AccumulatedFilters": {
        "type": "object",
        "description": "The accumulated filters for an account. This will return the account filters plus a filter for each catalog the user has access to.",
        "properties": {
          "hide_IBM_cloud_catalog": {
            "type": "boolean",
            "description": "Hide the public catalog in this account"
          },
          "account_filters": {
            "description": "Filters for accounts (at this time this will always be just one item array)",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Filters"
            }
          },
          "catalog_filters": {
            "type": "array",
            "description": "The filters for all of the accessible catalogs.",
            "items": {
              "type": "object",
              "properties": {
                "catalog": {
                  "type": "object",
                  "description": "Filters for catalog",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "The ID of the catalog"
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the catalog"
                    }
                  }
                },
                "filters": {
                  "$ref": "#/components/schemas/Filters"
                }
              }
            }
          },
          "region_filters": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "filtered_regions": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "filter_regions": {
            "type": "boolean"
          }
        }
      },
      "TerraformEngines": {
        "type": "object",
        "description": "The properties of the engine that is used to deploy terraform and auto-create deployable architectures on this account based on workspaces in the engine instance",
        "properties": {
          "name": {
            "type": "string",
            "description": "User provided name for the specified engine"
          },
          "type": {
            "type": "string",
            "description": "The terraform engine type. The only one supported at the moment is terraform-enterprise"
          },
          "public_endpoint": {
            "type": "string",
            "description": "The public endpoint for the engine instance"
          },
          "private_endpoint": {
            "type": "string",
            "description": "The private endpoint for the engine instance"
          },
          "api_token": {
            "type": "string",
            "description": "The api key used to access the engine instance"
          },
          "da_creation": {
            "$ref": "#/components/schemas/DACreation"
          }
        }
      },
      "DACreation": {
        "type": "object",
        "description": "The settings that determines how deployable architectures are auto-created from workspaces in the terraform engine",
        "properties": {
          "enabled": {
            "type": "boolean",
            "description": "Determines whether deployable architectures are auto-created from workspaces in the engine"
          },
          "default_private_catalog_id": {
            "type": "string",
            "description": "Default private catalog to create the deployable architectures in"
          },
          "polling_info": {
            "type": "object",
            "$ref": "#/components/schemas/PollingInfo"
          }
        }
      },
      "PollingInfo": {
        "type": "object",
        "description": "Determines which workspace scope to query to auto-create deployable architectures from",
        "properties": {
          "scopes": {
            "type": "array",
            "description": "List of scopes to auto-create deployable architectures from workspaces in the engine",
            "items": {
              "$ref": "#/components/schemas/TerraformEngineScope"
            }
          },
          "last_polling_status": {
            "type": "object",
            "description": "Last polling status of the engine scope",
            "properties": {
              "code": {
                "type": "integer",
                "description": "Status code of the last polling attempt"
              },
              "message": {
                "type": "string",
                "description": "Status message from the last polling attempt"
              }
            }
          }
        }
      },
      "TerraformEngineScope": {
        "type": "object",
        "description": "Properties of the engine scope",
        "properties": {
          "name": {
            "type": "string",
            "description": "Identifier for the specified type in the scope"
          },
          "org_name": {
            "type": "string",
            "description": "Optional field to provide the organization name of the scope. Needed if you want to query project or workspace scope by name instead of ID."
          },
          "type": {
            "type": "string",
            "description": "Scope to auto-create deployable architectures from. The supported scopes today are workspace, org, and project"
          }
        }
      },
      "ResourceGroups": {
        "type": "object",
        "description": "Resource groups details",
        "required": [
          "offset",
          "limit"
        ],
        "properties": {
          "offset": {
            "type": "integer",
            "description": "The offset (origin 0) of the first resource in this page of search results."
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of resources returned in each page of search results."
          },
          "total_count": {
            "type": "integer",
            "description": "The overall total number of resources in the search result set."
          },
          "resource_count": {
            "type": "integer",
            "description": "The number of resources returned in this page of search results."
          },
          "first": {
            "type": "string",
            "description": "A URL for retrieving the first page of search results."
          },
          "last": {
            "type": "string",
            "description": "A URL for retrieving the last page of search results."
          },
          "prev": {
            "type": "string",
            "description": "A URL for retrieving the previous page of search results."
          },
          "next": {
            "type": "string",
            "description": "A URL for retrieving the next page of search results."
          },
          "resources": {
            "type": "array",
            "description": "Resulting Resource Group objects",
            "items": {
              "$ref": "#/components/schemas/ResourceGroup"
            }
          }
        }
      },
      "ResourceGroup": {
        "type": "object",
        "description": "Resource group details",
        "properties": {
          "id": {
            "type": "string",
            "description": "Resource Group ID"
          },
          "name": {
            "type": "string",
            "description": "Provider name, eg. IBM Passport Advantage"
          },
          "crn": {
            "type": "string",
            "description": "Provider CRN"
          },
          "account_id": {
            "type": "string",
            "description": "Account ID for this Resource Group"
          },
          "state": {
            "type": "string",
            "description": "State of this Resource Group"
          },
          "default": {
            "type": "boolean",
            "description": "Indicates if this Resource Group is active or not"
          }
        }
      },
      "AccessListBulkResponse": {
        "type": "object",
        "description": "Access List Add/Remove result",
        "properties": {
          "errors": {
            "description": "in the case of error on an account add/remove - account: error",
            "type": "object",
            "additionalProperties": {
              "type": "string"
            }
          }
        }
      },
      "SecretInstance": {
        "type": "object",
        "description": "Secrets Manager instance information, which is prefixed by `cmsm_v1:` when written out (see example)",
        "example": "cmsm_v1:{\"name\": \"mySecret\",\"id\":\"1234567890\",\"service_id\":\"crn:v1:bluemix:public:secrets-manager:eu-gb:a/1234567890:1234567890::\",\"service_name\":\"My SM Instance\",\"group_id\":\"1234567890\",\"group_name\":\"My SM Group\",\"resource_group_id\":\"1234567890\",\"region\":\"eu-gb\",\"type\":\"arbitrary\"}",
        "properties": {
          "id": {
            "type": "string",
            "description": "Secret id"
          },
          "name": {
            "type": "string",
            "description": "Secret name"
          },
          "type": {
            "type": "string",
            "description": "Secret type"
          },
          "service_id": {
            "type": "string",
            "description": "Secret Manager instance crn"
          },
          "service_name": {
            "type": "string",
            "description": "Secret Manager instance name"
          },
          "region": {
            "type": "string",
            "description": "Secret Manager instance region"
          },
          "group_id": {
            "type": "string",
            "description": "Secret Manager group id"
          },
          "group_name": {
            "type": "string",
            "description": "Secret Manager group name"
          },
          "resource_group_id": {
            "type": "string",
            "description": "Secret Manager instance resource group id"
          }
        }
      },
      "MetricStats": {
        "type": "object",
        "description": "Accumulated statistics for the specified target.  Statistics are accumulated on a weekly basis for at most a year.",
        "properties": {
          "target_type": {
            "description": "What these statistics are for (i.e. Offering, Object, Plan, etc)",
            "type": "string"
          },
          "id": {
            "description": "Target ID",
            "type": "string"
          },
          "stats": {
            "description": "Statistics array.  Sorted on YearWeekIdx.  This array may have at most 52 entries, but may contain fewer if there are no statistics in a particular week",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WeeklyMetricBucket"
            }
          },
          "totals": {
            "description": "Total statistics for the specified target",
            "$ref": "#/components/schemas/WeeklyMetricBucket"
          }
        }
      },
      "WeeklyMetricBucket": {
        "type": "object",
        "description": "Statistics for a given week",
        "properties": {
          "year_week_idx": {
            "description": "ISO based YearWeek index yyyyww,  e.g., 202303 for third week in 2003",
            "type": "integer"
          },
          "download": {
            "description": "Number of times the resource was downloaded",
            "type": "integer"
          },
          "update": {
            "description": "Number of times the resource was updated",
            "type": "integer"
          },
          "get": {
            "description": "Number of times the resource was accessed",
            "type": "integer"
          },
          "bundle_download": {
            "description": "Number of times the customization bundle was downloaded for this resource",
            "type": "integer"
          }
        }
      },
      "AuditLog": {
        "type": "object",
        "description": "An audit log which describes a change made to a catalog or associated resource.",
        "allOf": [
          {
            "$ref": "#/components/schemas/AuditLogDigest"
          },
          {
            "type": "object",
            "properties": {
              "gid": {
                "description": "Transaction id for this change",
                "type": "string"
              },
              "who_id": {
                "description": "IAM identifier of the user who made the change",
                "type": "string"
              },
              "who_name": {
                "description": "Name of the user who made the change",
                "type": "string"
              },
              "who_delegate_id": {
                "description": "IAM identifier of the delegate user who made the change",
                "type": "string"
              },
              "who_delegate_name": {
                "description": "Name of the delegate user who made the change",
                "type": "string"
              },
              "data": {
                "description": "Data about the change. Usually a change log of what was changed, both before and after. Can be of any type."
              }
            }
          }
        ]
      },
      "AuditLogDigest": {
        "type": "object",
        "description": "An reduced audit log which describes a change made to a catalog or associated resource.",
        "properties": {
          "id": {
            "type": "string",
            "description": "The identifier of the audit record."
          },
          "_rev": {
            "type": "string",
            "description": "Cloudant revision"
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "The time at which the change was made."
          },
          "change_type": {
            "type": "string",
            "description": "The type of change described by the audit record."
          },
          "target_type": {
            "type": "string",
            "description": "The resource type associated with the change."
          },
          "target_id": {
            "type": "string",
            "description": "The identifier of the resource that was changed."
          },
          "who_email": {
            "type": "string",
            "description": "The email address of the user that made the change."
          },
          "who_delegate_email": {
            "type": "string",
            "description": "The email address of the delegate user that made the change. This happens when a service makes a change onbehalf of the user"
          },
          "message": {
            "type": "string",
            "description": "A message which describes the change."
          }
        }
      },
      "AuditLogOld": {
        "type": "object",
        "description": "A collection of audit records",
        "properties": {
          "bookmark": {
            "type": "string",
            "description": "The bookmark of the first resource in this page of search results. Omit for first entry."
          },
          "limit": {
            "type": "integer",
            "description": "The maximum number of resources returned in each page of search results."
          },
          "resource_count": {
            "type": "integer",
            "description": "The number of resources returned in this page of search results."
          },
          "first": {
            "type": "string",
            "description": "A URL for retrieving the first page of search results."
          },
          "last": {
            "type": "string",
            "description": "A URL for retrieving the last page of search results."
          },
          "prev": {
            "type": "string",
            "description": "A URL for retrieving the previous page of search results."
          },
          "next": {
            "type": "string",
            "description": "A URL for retrieving the next page of search results."
          },
          "list": {
            "description": "A list of audit records",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/AuditLog"
            }
          }
        }
      },
      "AuditLogs": {
        "type": "object",
        "description": "A collection of audit records",
        "allOf": [
          {
            "$ref": "#/components/schemas/TokenPagination"
          },
          {
            "type": "object",
            "properties": {
              "audits": {
                "description": "A list of audit records",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/AuditLogDigest"
                }
              }
            },
            "required": [
              "audits"
            ]
          }
        ]
      },
      "OfferingInstance": {
        "type": "object",
        "x-data-source-name": "cm_offering_instance",
        "x-resource-name": "cm_offering_instance",
        "description": "A offering instance resource (provision instance of a catalog offering)",
        "properties": {
          "id": {
            "type": "string",
            "description": "provisioned instance ID (part of the CRN)."
          },
          "_rev": {
            "type": "string",
            "description": "Cloudant revision"
          },
          "url": {
            "type": "string",
            "description": "url reference to this object."
          },
          "crn": {
            "type": "string",
            "description": "platform CRN for this instance."
          },
          "label": {
            "type": "string",
            "description": "the label for this instance."
          },
          "catalog_id": {
            "type": "string",
            "description": "Catalog ID this instance was created from."
          },
          "offering_id": {
            "type": "string",
            "description": "Offering ID this instance was created from."
          },
          "kind_format": {
            "type": "string",
            "description": "the format this instance has (helm, operator, ova...)."
          },
          "kind_format_label": {
            "type": "string",
            "description": "Display value for the format this instance has (helm, operator, ova...)."
          },
          "version": {
            "type": "string",
            "description": "The version this instance was installed from (semver - not version id)"
          },
          "version_id": {
            "type": "string",
            "description": "The version id this instance was installed from (version id - not semver)"
          },
          "cluster_id": {
            "type": "string",
            "description": "Cluster ID"
          },
          "cluster_region": {
            "type": "string",
            "description": "Cluster region (e.g., us-south)"
          },
          "cluster_namespaces": {
            "type": "array",
            "description": "List of target namespaces to install into",
            "items": {
              "type": "string"
            }
          },
          "cluster_all_namespaces": {
            "type": "boolean",
            "description": "designate to install into all namespaces"
          },
          "schematics_workspace_id": {
            "type": "string",
            "description": "Id of the schematics workspace, for offering instances provisioned through schematics"
          },
          "install_plan": {
            "type": "string",
            "description": "Type of install plan (also known as approval strategy) for operator subscriptions. Can be either automatic, which automatically upgrades operators to the latest in a channel, or manual, which requires approval on the cluster"
          },
          "channel": {
            "type": "string",
            "description": "Channel to pin the operator subscription to"
          },
          "created": {
            "type": "string",
            "format": "date-time",
            "description": "date and time create"
          },
          "updated": {
            "type": "string",
            "format": "date-time",
            "description": "date and time updated"
          },
          "metadata": {
            "description": "Map of metadata values for this offering instance",
            "type": "object",
            "additionalProperties": true
          },
          "resource_group_id": {
            "type": "string",
            "description": "Id of the resource group to provision the offering instance into"
          },
          "location": {
            "type": "string",
            "description": "String location of OfferingInstance deployment"
          },
          "disabled": {
            "type": "boolean",
            "description": "Indicates if Resource Controller has disabled this instance"
          },
          "account": {
            "type": "string",
            "description": "The account this instance is owned by"
          },
          "last_operation": {
            "type": "object",
            "description": "the last operation performed and status",
            "properties": {
              "operation": {
                "description": "last operation performed",
                "type": "string"
              },
              "state": {
                "description": "state after the last operation performed",
                "type": "string"
              },
              "message": {
                "description": "additional information about the last operation",
                "type": "string"
              },
              "transaction_id": {
                "description": "transaction id from the last operation",
                "type": "string"
              },
              "updated": {
                "description": "Date and time last updated",
                "type": "string",
                "format": "date-time"
              },
              "code": {
                "description": "Error code from the last operation, if applicable",
                "type": "string"
              }
            }
          },
          "kind_target": {
            "type": "string",
            "description": "The target kind for the installed software version"
          },
          "kind_target_label": {
            "type": "string",
            "description": "Display value for the target kind for the installed software version"
          },
          "sha": {
            "type": "string",
            "description": "The digest value of the installed software version"
          },
          "plan_id": {
            "type": "string",
            "description": "The software plan ID used when creating this software instance"
          },
          "parent_crn": {
            "type": "string",
            "description": "The CRN of the resource that is considered a parent of this software instance"
          },
          "plan_entitlement": {
            "type": "object",
            "description": "Entitlement information for licenses provisioned from plan",
            "$ref": "#/components/schemas/PlanEntitlement"
          }
        }
      },
      "I18n": {
        "type": "object",
        "description": "A map of translated strings, by language code",
        "additionalProperties": {
          "type": "string"
        }
      },
      "AccessIdentifier": {
        "type": "string",
        "description": "Identifier for access. Use 'accountId' or '-acct-accountId' for an account, '-ent-enterpriseid' for an enterprise, and '-entgrp-enterprisegroupid' for an enterprise group."
      },
      "DeprecatePending": {
        "type": "object",
        "description": "Deprecation information for an Offering.",
        "properties": {
          "deprecate_date": {
            "description": "Date of deprecation",
            "type": "string",
            "format": "date-time"
          },
          "deprecate_state": {
            "description": "Deprecation state",
            "$ref": "#/components/schemas/DeprecationState"
          },
          "description": {
            "type": "string"
          }
        }
      },
      "DeprecationState": {
        "type": "string",
        "description": "Deprecation state."
      },
      "Output": {
        "type": "object",
        "description": "Outputs for a version",
        "properties": {
          "key": {
            "description": "Output key",
            "type": "string"
          },
          "description": {
            "description": "Output description",
            "type": "string"
          }
        }
      },
      "IAMPermission": {
        "type": "object",
        "description": "IAM Permission definition",
        "properties": {
          "service_name": {
            "description": "Service name",
            "type": "string"
          },
          "role_crns": {
            "description": "Role CRNs for this permission",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "resources": {
            "description": "Resources for this permission",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IAMResource"
            }
          }
        }
      },
      "CheckedIAMPermission": {
        "type": "object",
        "description": "Checked IAM Permission for the current user context",
        "properties": {
          "service_name": {
            "description": "Service name",
            "type": "string"
          },
          "service_display_name": {
            "description": "Service display name",
            "type": "string"
          },
          "role_crns": {
            "description": "Checked Role CRNs for this permission",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CheckedRoleCRN"
            }
          },
          "resources": {
            "description": "Resources for this permission",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IAMResource"
            }
          }
        }
      },
      "CheckedRoleCRN": {
        "type": "object",
        "description": "Checked IAM role permission for the current user context",
        "properties": {
          "id": {
            "description": "Role id",
            "type": "string"
          },
          "display_name": {
            "description": "Role display name",
            "type": "string"
          },
          "description": {
            "description": "Role description",
            "type": "string"
          },
          "has_permissions": {
            "description": "Checked permission",
            "type": "boolean"
          }
        }
      },
      "IAMResource": {
        "type": "object",
        "description": "IAM Resource definition",
        "properties": {
          "name": {
            "description": "Resource name",
            "type": "string"
          },
          "description": {
            "description": "Resource description",
            "type": "string"
          },
          "role_crns": {
            "description": "Role CRNs for this permission",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "ChangeNotices": {
        "type": "object",
        "description": "Change notices for a version",
        "properties": {
          "breaking": {
            "description": "Breaking changes for this version",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Feature"
            }
          },
          "new": {
            "description": "New changes for this version",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Feature"
            }
          },
          "update": {
            "description": "Updates for this version",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Feature"
            }
          }
        }
      },
      "Compliance": {
        "type": "object",
        "description": "Compliance info for a version",
        "properties": {
          "authority": {
            "description": "Authority",
            "type": "string"
          },
          "claims": {
            "$ref": "#/components/schemas/Claims",
            "description": "Claims"
          },
          "evaluations": {
            "type": "array",
            "description": "Evaluations",
            "items": {
              "$ref": "#/components/schemas/Evaluation"
            }
          }
        }
      },
      "Evaluation": {
        "type": "object",
        "description": "Evaluation",
        "properties": {
          "scan_id": {
            "type": "string",
            "description": "Scan ID"
          },
          "account_id": {
            "type": "string",
            "description": "Account ID"
          },
          "profile": {
            "$ref": "#/components/schemas/SCCProfile",
            "description": "SCC Profile"
          },
          "result": {
            "$ref": "#/components/schemas/Result",
            "description": "Result"
          },
          "controls": {
            "type": "array",
            "description": "Controls",
            "items": {
              "$ref": "#/components/schemas/EvaluatedControl"
            }
          }
        }
      },
      "EvaluatedControl": {
        "type": "object",
        "description": "Evaluated control",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "description": {
            "type": "string",
            "description": "Description"
          },
          "specifications": {
            "type": "array",
            "description": "Specifications",
            "items": {
              "$ref": "#/components/schemas/SCCSpecification"
            }
          },
          "child_controls": {
            "type": "array",
            "description": "Child controls",
            "items": {
              "$ref": "#/components/schemas/EvaluatedControl"
            }
          },
          "failure_count": {
            "type": "integer",
            "description": "Failure count"
          },
          "pass_count": {
            "type": "integer",
            "description": "Pass count"
          },
          "parent": {
            "$ref": "#/components/schemas/SCCControl",
            "description": "Parent"
          },
          "ui_href": {
            "type": "string",
            "description": "UI href"
          }
        }
      },
      "SCCControl": {
        "type": "object",
        "description": "SCC Control",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "version": {
            "type": "string",
            "description": "Version"
          },
          "description": {
            "type": "string",
            "description": "Description"
          },
          "profile": {
            "$ref": "#/components/schemas/SCCProfile",
            "description": "SCC Profile"
          },
          "parent": {
            "$ref": "#/components/schemas/SCCControl",
            "description": "Parent"
          },
          "parent_name": {
            "type": "string",
            "description": "Parent name"
          },
          "specifications": {
            "type": "array",
            "description": "Specifications",
            "items": {
              "$ref": "#/components/schemas/SCCSpecification"
            }
          },
          "ui_href": {
            "type": "string",
            "description": "UI href"
          }
        }
      },
      "SCCSpecification": {
        "type": "object",
        "description": "SCC Specification",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID"
          },
          "description": {
            "type": "string",
            "description": "Description"
          },
          "component_name": {
            "type": "string",
            "description": "Component name"
          },
          "assessments": {
            "type": "array",
            "description": "Assessments",
            "items": {
              "$ref": "#/components/schemas/SCCAssessment"
            }
          },
          "ui_href": {
            "type": "string",
            "description": "UI href"
          }
        }
      },
      "SCCAssessment": {
        "type": "object",
        "description": "SCC Assessment",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID"
          },
          "description": {
            "type": "string",
            "description": "Description"
          },
          "version": {
            "type": "string",
            "description": "Version"
          },
          "type": {
            "type": "string",
            "description": "Type"
          },
          "method": {
            "type": "string",
            "description": "Method"
          },
          "ui_href": {
            "type": "string",
            "description": "UI href"
          }
        }
      },
      "Result": {
        "type": "object",
        "description": "Result",
        "properties": {
          "failure_count": {
            "type": "integer",
            "description": "Total (assessment) errors against claimed controls"
          },
          "scan_time": {
            "type": "string",
            "format": "date-time",
            "description": "When the scan took place"
          },
          "error_message": {
            "type": "string",
            "description": "Error message, empty implies no error"
          },
          "complete_scan": {
            "type": "boolean",
            "description": "False if just a subset of (profile) controls will be looked at for this DA"
          },
          "unscanned_resources": {
            "type": "array",
            "description": "List of un-scanned resource IDs",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "Claims": {
        "type": "object",
        "description": "SCC Claims",
        "properties": {
          "profiles": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SCCProfile"
            },
            "description": "Profiles"
          },
          "controls": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ClaimedControl"
            },
            "description": "Controls"
          }
        }
      },
      "SCCProfile": {
        "type": "object",
        "description": "SCC Profile",
        "properties": {
          "id": {
            "type": "string",
            "description": "ID"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "version": {
            "type": "string",
            "description": "Version"
          },
          "description": {
            "type": "string",
            "description": "Description"
          },
          "type": {
            "type": "string",
            "description": "Type"
          },
          "ui_href": {
            "type": "string",
            "description": "UI href"
          }
        }
      },
      "ClaimedControl": {
        "type": "object",
        "description": "Claimed control",
        "properties": {
          "profile": {
            "$ref": "#/components/schemas/SCCProfile",
            "description": "ID"
          },
          "names": {
            "type": "array",
            "description": "Names",
            "items": {
              "type": "string"
            }
          }
        }
      },
      "OfferingReference": {
        "type": "object",
        "description": "Offering reference definition",
        "properties": {
          "catalog_id": {
            "description": "Optional - If not specified, assumes the Public Catalog",
            "type": "string"
          },
          "id": {
            "description": "Optional - Offering ID - not required if name is set",
            "type": "string"
          },
          "name": {
            "description": "Optional - Programmatic Offering name",
            "type": "string"
          },
          "kind": {
            "description": "Format kind",
            "type": "string"
          },
          "version": {
            "description": "Required - Semver value or range",
            "type": "string"
          },
          "description": {
            "description": "Reason why the user might want to include this dependency",
            "type": "string"
          },
          "default_flavor": {
            "description": "The default selected flavor of this dependency",
            "type": "string"
          },
          "flavors": {
            "description": "Optional - List of dependent flavors in the specified range",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "optional": {
            "type": "boolean",
            "description": "Is this dependency optional"
          },
          "on_by_default": {
            "type": "boolean",
            "description": "Is this dependency on by default"
          }
        }
      },
      "CostEstimate": {
        "type": "object",
        "description": "Cost estimate definition",
        "properties": {
          "version": {
            "description": "Cost estimate version",
            "type": "string"
          },
          "currency": {
            "description": "Cost estimate currency",
            "type": "string"
          },
          "projects": {
            "description": "Cost estimate projects",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Project"
            }
          },
          "summary": {
            "description": "Cost estimate summary",
            "$ref": "#/components/schemas/CostSummary"
          },
          "totalHourlyCost": {
            "description": "Total hourly cost",
            "type": "string"
          },
          "totalMonthlyCost": {
            "description": "Total monthly cost",
            "type": "string"
          },
          "pastTotalHourlyCost": {
            "description": "Past total hourly cost",
            "type": "string"
          },
          "pastTotalMonthlyCost": {
            "description": "Past total monthly cost",
            "type": "string"
          },
          "diffTotalHourlyCost": {
            "description": "Difference in total hourly cost",
            "type": "string"
          },
          "diffTotalMonthlyCost": {
            "description": "Difference in total monthly cost",
            "type": "string"
          },
          "timeGenerated": {
            "description": "When this estimate was generated",
            "type": "string",
            "format": "date-time"
          }
        }
      },
      "Project": {
        "type": "object",
        "description": "Cost estimate project definition",
        "properties": {
          "name": {
            "description": "Project name",
            "type": "string"
          },
          "metadata": {
            "description": "Project metadata",
            "type": "object",
            "additionalProperties": true
          },
          "pastBreakdown": {
            "description": "Past breakdown",
            "$ref": "#/components/schemas/CostBreakdown"
          },
          "breakdown": {
            "description": "Breakdown",
            "$ref": "#/components/schemas/CostBreakdown"
          },
          "diff": {
            "description": "Difference",
            "$ref": "#/components/schemas/CostBreakdown"
          },
          "summary": {
            "description": "Cost estimate summary",
            "$ref": "#/components/schemas/CostSummary"
          }
        }
      },
      "CostBreakdown": {
        "type": "object",
        "description": "Cost breakdown definition",
        "properties": {
          "totalHourlyCost": {
            "description": "Total hourly cost",
            "type": "string"
          },
          "totalMonthlyCost": {
            "description": "Total monthly cost",
            "type": "string"
          },
          "resources": {
            "description": "Resources",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CostResource"
            }
          }
        }
      },
      "CostResource": {
        "type": "object",
        "description": "Cost resource definition",
        "properties": {
          "name": {
            "description": "Resource name",
            "type": "string"
          },
          "metadata": {
            "description": "Resource metadata",
            "type": "object",
            "additionalProperties": true
          },
          "hourlyCost": {
            "description": "Hourly cost",
            "type": "string"
          },
          "monthlyCost": {
            "description": "Monthly cost",
            "type": "string"
          },
          "costComponents": {
            "description": "Cost components",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/CostComponent"
            }
          }
        }
      },
      "CostComponent": {
        "type": "object",
        "description": "Cost component definition",
        "properties": {
          "name": {
            "description": "Cost component name",
            "type": "string"
          },
          "unit": {
            "description": "Cost component unit",
            "type": "string"
          },
          "hourlyQuantity": {
            "description": "Cost component hourly quantity",
            "type": "string"
          },
          "monthlyQuantity": {
            "description": "Cost component monthly quantity",
            "type": "string"
          },
          "price": {
            "description": "Cost component price",
            "type": "string"
          },
          "hourlyCost": {
            "description": "Cost component hourly cost",
            "type": "string"
          },
          "monthlyCost": {
            "description": "Cost component monthly cost",
            "type": "string"
          },
          "metric": {
            "description": "Cost component metric",
            "type": "string"
          }
        }
      },
      "CostSummary": {
        "type": "object",
        "description": "Cost summary definition",
        "properties": {
          "totalDetectedResources": {
            "description": "Total detected resources",
            "type": "integer"
          },
          "totalSupportedResources": {
            "description": "Total supported resources",
            "type": "integer"
          },
          "totalUnsupportedResources": {
            "description": "Total unsupported resources",
            "type": "integer"
          },
          "totalUsageBasedResources": {
            "description": "Total usage based resources",
            "type": "integer"
          },
          "totalNoPriceResources": {
            "description": "Total no price resources",
            "type": "integer"
          },
          "unsupportedResourceCounts": {
            "description": "Unsupported resource counts",
            "type": "object",
            "additionalProperties": {
              "type": "integer"
            }
          },
          "noPriceResourceCounts": {
            "description": "No price resource counts",
            "type": "object",
            "additionalProperties": {
              "type": "integer"
            }
          }
        }
      },
      "ImagePullKey": {
        "type": "object",
        "description": "Image pull keys for an offering.",
        "properties": {
          "name": {
            "description": "Key name",
            "type": "string"
          },
          "value": {
            "description": "Key value",
            "type": "string"
          },
          "description": {
            "description": "Key description",
            "type": "string"
          }
        }
      },
      "CatalogManifest": {
        "type": "object",
        "description": "The catalog manifest definition.  All properties are optional.",
        "properties": {
          "label": {
            "description": "The product display name",
            "type": "string"
          },
          "name": {
            "description": "The product programmatic name",
            "type": "string"
          },
          "version": {
            "description": "The version of the product in semver format",
            "type": "string"
          },
          "product_kind": {
            "description": "The product kind.  Valid values are software, module, or solution",
            "type": "string"
          },
          "tags": {
            "description": "The tags for this product",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "keywords": {
            "description": "The keywords for this product",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "short_description": {
            "description": "The short description for this product",
            "type": "string"
          },
          "long_description": {
            "description": "The long description for this product",
            "type": "string"
          },
          "provider_name": {
            "description": "The provider name for this product",
            "type": "string"
          },
          "offering_docs_url": {
            "description": "The documentation url for this product",
            "type": "string"
          },
          "offering_icon_url": {
            "description": "The icon url for this product",
            "type": "string"
          },
          "support_details": {
            "description": "The support details for this product, in markdown",
            "type": "string"
          },
          "features": {
            "description": "A list of features",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Feature"
            }
          },
          "module_info": {
            "description": "The list of offerings that this offering works well with",
            "$ref": "#/components/schemas/ModuleInfo"
          },
          "flavors": {
            "description": "The list of variations provided by this product",
            "$ref": "#/components/schemas/ManifestFlavor"
          }
        }
      },
      "ModuleInfo": {
        "type": "object",
        "description": "The list of offerings that this offering works well with.",
        "properties": {
          "works_with": {
            "description": "The list of products",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OfferingReference"
            }
          }
        }
      },
      "ManifestArchitecture": {
        "type": "object",
        "description": "Architecture information for this product",
        "properties": {
          "features": {
            "description": "A list of features",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Feature"
            }
          },
          "diagrams": {
            "description": "Architecure diagrams for this version",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ArchitectureDiagram"
            }
          }
        }
      },
      "ManifestConfiguration": {
        "type": "object",
        "description": "Configuration description",
        "properties": {
          "key": {
            "type": "string",
            "description": "Configuration key"
          },
          "type": {
            "type": "string",
            "description": "Value type (string, boolean, int)"
          },
          "default_value": {
            "description": "The default value.  To use a secret when the type is password, specify a JSON encoded value of $ref:#/components/schemas/SecretInstance, prefixed with `cmsm_v1:`"
          },
          "display_name": {
            "type": "string",
            "description": "Display name for configuration type"
          },
          "value_constraint": {
            "type": "string",
            "description": "Deprecated - Constraint associated with value, e.g., for string type - regx:[a-z]"
          },
          "value_constraints": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ValueConstraint"
            },
            "description": "Validation rules for this input value"
          },
          "description": {
            "type": "string",
            "description": "Key description"
          },
          "required": {
            "type": "boolean",
            "description": "Is key required to install"
          },
          "options": {
            "type": "array",
            "description": "List of options of type",
            "items": {
              "description": "An option value of any type"
            }
          },
          "hidden": {
            "type": "boolean",
            "description": "Hide values"
          },
          "custom_config": {
            "$ref": "#/components/schemas/RenderType",
            "description": "Configuration object for custom types"
          }
        }
      },
      "ManifestFlavor": {
        "type": "object",
        "description": "The list of offerings that this offering works well with.",
        "properties": {
          "label": {
            "description": "The variation display name",
            "type": "string"
          },
          "name": {
            "description": "The variation programmatic name",
            "type": "string"
          },
          "working_directory": {
            "description": "The working directory relative to the root directory within the repo",
            "type": "string"
          },
          "usage": {
            "description": "A short statement of how to consume the variation",
            "type": "string"
          },
          "usage_template": {
            "description": "A template to form the usage statement",
            "type": "string"
          },
          "licenses": {
            "type": "array",
            "description": "The licenses for this variation",
            "items": {
              "$ref": "#/components/schemas/License"
            }
          },
          "compliance": {
            "type": "object",
            "description": "The list of compliance controls for this variation",
            "properties": {
              "controls": {
                "description": "The variation display name",
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Control"
                }
              }
            }
          },
          "iam_permissions": {
            "type": "array",
            "description": "List of IAM permissions that are required to consume this version",
            "items": {
              "$ref": "#/components/schemas/IAMPermission"
            }
          },
          "architecture": {
            "type": "array",
            "description": "Architecture information for this version",
            "items": {
              "$ref": "#/components/schemas/ManifestArchitecture"
            }
          },
          "dependencies": {
            "description": "The list of products that are prerequisites",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/OfferingReference"
            }
          },
          "release_notes_url": {
            "description": "A url that specifies the location of the release notes for this version",
            "type": "string"
          },
          "configuration": {
            "description": "Configuration for this version",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ManifestConfiguration"
            }
          },
          "terraform_version": {
            "description": "The Terraform version to use when validating and installing this version of software, overriding what is specified in the source",
            "type": "string"
          },
          "outputs": {
            "description": "Information to be applied to the output fields for this version",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Output"
            }
          },
          "install_type": {
            "description": "Install type for a solution, set to fullstack or extension",
            "type": "string"
          },
          "scripts": {
            "description": "An array of scripts to be run by a Project during a particular stage of a specified action.  Each key in the map must match the format \"action\"_\"stage\" in the specified ScriptRef.",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ScriptRef"
            }
          },
          "ignore_readme": {
            "description": "Do not import the readme from the tgz file for this version.",
            "type": "boolean"
          },
          "short_description": {
            "description": "A short description for this version",
            "type": "string"
          }
        }
      },
      "Control": {
        "type": "object",
        "description": "An SCC profile name and control id",
        "properties": {
          "profile_name": {
            "description": "The name of the SCC profile",
            "type": "string"
          },
          "control_id": {
            "description": "The control id within the profile",
            "type": "string"
          }
        }
      },
      "ValueConstraint": {
        "type": "object",
        "description": "Constraint associated with value",
        "properties": {
          "type": {
            "type": "string",
            "description": "Type of constraint",
            "enum": [
              "regex"
            ]
          },
          "value": {
            "type": "string",
            "description": "Contstraint value.  For type regex, this is a regular expression in Javascript notation"
          },
          "description": {
            "type": "string",
            "description": "The value to display if the inptu value does not match the specified constraint."
          }
        }
      }
    }
  }
}