Amazon Codecatalyst Project Summary Structure

Information about a project.

Type: object Properties: 3 Required: 1

AmazonDeveloper ToolsCI/CDCollaborationDevOpsSource Control

ProjectSummary is a JSON Structure definition published by Amazon CodeCatalyst, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name displayName description

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-codecatalyst/refs/heads/main/json-structure/amazon-codecatalyst-project-summary-structure.json",
  "name": "ProjectSummary",
  "description": "Information about a project.",
  "type": "object",
  "properties": {
    "name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The name of the project in the space."
        }
      ]
    },
    "displayName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The friendly name displayed to users of the project in Amazon CodeCatalyst."
        }
      ]
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "The description of the project."
        }
      ]
    }
  },
  "required": [
    "name"
  ]
}