Sdk

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-sdk-schema.json",
  "title": "Sdk",
  "description": "Information about the SDK.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-apigateway-api-openapi.yml#/components/schemas/Sdk",
  "properties": {
    "apiId": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of API resource\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "artifactUrl": {
      "description": "File location for generated SDK.",
      "type": "string"
    },
    "compartmentId": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment in which the\nresource is created.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only the String type is supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing a defined tag key and value, scoped to a\nnamespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a\nnamespace. For more information, see\n[Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
      "type": "object"
    },
    "displayName": {
      "description": "A user-friendly name. Does not have to be unique, and it's changeable.\nAvoid entering confidential information.\n\nExample: `My new resource`\n",
      "type": "string"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Free-form tags for this resource. Each tag is a simple key-value pair\nwith no predefined name, type, or namespace. For more information, see\n[Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "lifecycleDetails": {
      "description": "A message describing the current state in more detail.\nFor example, can be used to provide actionable information for a\nresource in a Failed state.\n",
      "type": "string"
    },
    "lifecycleState": {
      "description": "The current state of the SDK.\n- The SDK will be in CREATING state if the SDK creation is in progress.\n- The SDK will be in ACTIVE state if create is successful.\n- The SDK will be in FAILED state if the create, or delete fails.\n- The SDK will be in DELETING state if the deletion in in progress.\n- The SDK will be in DELETED state if the delete is successful.\n",
      "enum": [
        "CREATING",
        "ACTIVE",
        "FAILED",
        "DELETING",
        "DELETED"
      ],
      "type": "string"
    },
    "locks": {
      "description": "Locks associated with this resource.",
      "items": {
        "$ref": "#/$defs/ResourceLock"
      },
      "maxItems": 2,
      "type": "array"
    },
    "parameters": {
      "additionalProperties": {
        "description": "The value of the config. Only the String type is supported.\n",
        "type": "string"
      },
      "description": "Additional optional configurations passed.\nThe applicable config keys are listed under \"parameters\" when \"/sdkLanguageTypes\" is called.\n\nExample: `{\"configName\": \"configValue\"}`\n",
      "type": "object"
    },
    "systemTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only string type is supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing system tags' keys and values scoped to a namespace.\nExample: `{\"bar-key\": \"value\"}`\n",
        "type": "object"
      },
      "description": "System tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
      "type": "object"
    },
    "targetLanguage": {
      "description": "The string representing the target programming language for generating the SDK.\n",
      "type": "string"
    },
    "timeArtifactUrlExpiresAt": {
      "description": "Expiry of artifact url.",
      "format": "date-time",
      "type": "string"
    },
    "timeCreated": {
      "description": "The time this resource was created. An RFC3339 formatted datetime string.",
      "format": "date-time",
      "type": "string"
    },
    "timeUpdated": {
      "description": "The time this resource was last updated. An RFC3339 formatted datetime string.",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "id",
    "apiId",
    "targetLanguage",
    "displayName"
  ],
  "type": "object",
  "$defs": {
    "ResourceLock": {
      "description": "Resource locks are used to prevent certain APIs from being called for the resource.\nA full lock prevents both updating the resource and deleting the resource. A delete\nlock prevents deleting the resource.\n",
      "properties": {
        "message": {
          "description": "A message added by the creator of the lock. This is typically used to give an\nindication of why the resource is locked.\n",
          "type": "string"
        },
        "relatedResourceId": {
          "description": "The id of the resource that is locking this resource. Indicates that deleting this resource will remove the lock.\n",
          "type": "string"
        },
        "timeCreated": {
          "description": "When the lock was created.",
          "format": "date-time",
          "type": "string"
        },
        "type": {
          "description": "Type of the lock.",
          "enum": [
            "FULL",
            "DELETE"
          ],
          "type": "string"
        }
      },
      "required": [
        "type"
      ],
      "type": "object"
    }
  }
}