APIGen · JSON Structure

Apigen Project Structure

An API generation project that groups related APIs, connectors, and configurations.

Type: object Properties: 9 Required: 6
CodeDocumentationGenerationOpen SourcePHP

APIGen Project is a JSON Structure definition published by APIGen, describing 9 properties, of which 6 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name description status ownerId settings tags createdAt updatedAt

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

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://api.apigen.com/schemas/project.json",
  "description": "An API generation project that groups related APIs, connectors, and configurations.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the project."
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "description": "Human-readable name of the project."
    },
    "description": {
      "type": "string",
      "description": "Detailed description of the project purpose and scope."
    },
    "status": {
      "type": "string",
      "enum": [
        "active",
        "archived"
      ],
      "description": "Current lifecycle status of the project."
    },
    "ownerId": {
      "type": "string",
      "description": "User ID of the project owner."
    },
    "settings": {
      "type": "object",
      "description": "Project-level settings and preferences.",
      "properties": {
        "defaultEnvironment": {
          "type": "string",
          "enum": [
            "development",
            "staging",
            "production"
          ],
          "description": "Default deployment target environment."
        },
        "aiModel": {
          "type": "string",
          "description": "Preferred AI model for API generation tasks."
        },
        "autoGenerateTests": {
          "type": "boolean",
          "default": true,
          "description": "Whether to auto-generate tests when creating endpoints."
        },
        "autoGenerateDocs": {
          "type": "boolean",
          "default": true,
          "description": "Whether to auto-generate documentation."
        }
      },
      "additionalProperties": true
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Tags for categorizing the project."
    },
    "createdAt": {
      "type": "datetime",
      "description": "Timestamp when the project was created."
    },
    "updatedAt": {
      "type": "datetime",
      "description": "Timestamp when the project was last updated."
    }
  },
  "required": [
    "id",
    "name",
    "status",
    "ownerId",
    "createdAt",
    "updatedAt"
  ],
  "additionalProperties": false,
  "name": "APIGen Project"
}