ApiMetadataByEntityTypeCollection

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-api-metadata-by-entity-type-collection-schema.json",
  "title": "ApiMetadataByEntityTypeCollection",
  "description": "Results of a api search.",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-apimetadata-api-openapi.yml#/components/schemas/ApiMetadataByEntityTypeCollection",
  "properties": {
    "items": {
      "description": "List of apiMetadataByEntityTypeSummary.",
      "items": {
        "$ref": "#/$defs/ApiMetadataByEntityTypeSummary"
      },
      "type": "array"
    }
  },
  "required": [
    "items"
  ],
  "type": "object",
  "$defs": {
    "ApiMetadataByEntityTypeSummary": {
      "description": "Summary information about a ApiMetadata.",
      "properties": {
        "apiMetadatas": {
          "description": "List of apiMetadataSummary.",
          "items": {
            "$ref": "#/$defs/ApiMetadataSummary"
          },
          "type": "array"
        },
        "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 namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
            "type": "object"
          },
          "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
          "type": "object"
        },
        "entityType": {
          "description": "The entity Type to which the Api belongs to.",
          "type": "string"
        },
        "freeformTags": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
          "type": "object"
        },
        "systemTags": {
          "additionalProperties": {
            "additionalProperties": {
              "description": "The value of the tag. Only the String type is supported.\n",
              "type": "object"
            },
            "description": "Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
            "type": "object"
          },
          "description": "System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
          "type": "object"
        }
      },
      "required": [
        "resourceType",
        "lifecycleState",
        "timeCreated",
        "displayName"
      ],
      "type": "object"
    },
    "ApiMetadataSummary": {
      "description": "Summary information about a ApiMetadata.",
      "properties": {
        "apiName": {
          "description": "The name of the api to execute the api request.",
          "type": "string"
        },
        "attributes": {
          "description": "List of the fields that is use while calling post or put for the data.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "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 namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
            "type": "object"
          },
          "description": "Defined tags for this resource. Each key is predefined and scoped to a namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
          "type": "object"
        },
        "displayName": {
          "description": "Name of the Api.",
          "type": "string"
        },
        "entityType": {
          "description": "EntityType to which the apiMetadata belongs to.",
          "type": "string"
        },
        "freeformTags": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.\nFor more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
          "type": "object"
        },
        "id": {
          "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the ApiDetail.",
          "type": "string"
        },
        "lifecycleDetails": {
          "description": "A message that describes the current state of the ApiMetadata in more detail. For example,\ncan be used to provide actionable information for a resource in the Failed state.\n",
          "type": "string"
        },
        "lifecycleState": {
          "description": "The current state of the ApiMetadata.",
          "type": "string",
          "x-obmcs-enumref": "#/definitions/ApiMetadata/lifecycleState"
        },
        "serviceName": {
          "description": "The service Name to which the Api belongs to.",
          "type": "string"
        },
        "systemTags": {
          "additionalProperties": {
            "additionalProperties": {
              "description": "The value of the tag. Only the String type is supported.\n",
              "type": "object"
            },
            "description": "Key-value pair representing a system tag key and value, scoped to a namespace.\n\nExample: `{\"free-tier-retained\": \"true\"}`\n",
            "type": "object"
          },
          "description": "System tags for this resource. Each key is predefined and scoped to a namespace.\n\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n",
          "type": "object"
        },
        "timeCreated": {
          "description": "The date and time the PrivilegedApiControl was created, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\nExample: `2016-08-25T21:10:29.600Z`\n",
          "format": "date-time",
          "type": "string"
        },
        "timeUpdated": {
          "description": "The date and time the PrivilegedApiControl was updated, in the format defined by [RFC 3339](https://tools.ietf.org/html/rfc3339).\n\nExample: `2016-08-25T21:10:29.600Z`\n",
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "id",
        "lifecycleState",
        "timeCreated",
        "displayName"
      ],
      "type": "object"
    }
  }
}