Ansible Roles · Schema

Collection

An Ansible collection — a distributable package containing roles, modules, plugins, and documentation.

AnsibleAutomationCollectionsConfiguration ManagementDevOpsInfrastructure As CodeRoles

Properties

Name Type Description
namespace string The Galaxy namespace for this collection.
name string The collection name.
version string The current latest version of the collection.
description string Short description of what the collection provides.
download_count integer Total download count for this collection.
certified boolean Whether this collection is Red Hat certified.
license array List of SPDX license identifiers.
tags array Tags categorizing the collection content.
requires_ansible string Minimum Ansible version required.
repository string Source code repository URL.
documentation string Link to collection documentation.
created_at string When this collection was first published.
updated_at string When this collection was last updated.
View JSON Schema on GitHub

JSON Schema

ansible-roles-collection-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ansible-roles/refs/heads/main/json-schema/ansible-roles-collection-schema.json",
  "title": "Collection",
  "description": "An Ansible collection — a distributable package containing roles, modules, plugins, and documentation.",
  "type": "object",
  "properties": {
    "namespace": {"type": "string", "description": "The Galaxy namespace for this collection.", "example": "community"},
    "name": {"type": "string", "description": "The collection name.", "example": "general"},
    "version": {"type": "string", "description": "The current latest version of the collection.", "example": "8.6.0"},
    "description": {"type": "string", "description": "Short description of what the collection provides.", "example": "A collection of general-purpose Ansible modules and roles."},
    "download_count": {"type": "integer", "description": "Total download count for this collection.", "example": 5000000},
    "certified": {"type": "boolean", "description": "Whether this collection is Red Hat certified.", "example": false},
    "license": {"type": "array", "items": {"type": "string"}, "description": "List of SPDX license identifiers.", "example": ["GPL-3.0-or-later"]},
    "tags": {"type": "array", "items": {"type": "string"}, "description": "Tags categorizing the collection content.", "example": ["networking", "cloud", "linux"]},
    "requires_ansible": {"type": "string", "description": "Minimum Ansible version required.", "example": ">=2.14.0"},
    "repository": {"type": "string", "format": "uri", "description": "Source code repository URL.", "example": "https://github.com/ansible-collections/community.general"},
    "documentation": {"type": "string", "format": "uri", "description": "Link to collection documentation.", "example": "https://docs.ansible.com/ansible/latest/collections/community/general/"},
    "created_at": {"type": "string", "format": "date-time", "description": "When this collection was first published.", "example": "2020-01-01T00:00:00Z"},
    "updated_at": {"type": "string", "format": "date-time", "description": "When this collection was last updated.", "example": "2026-04-01T00:00:00Z"}
  },
  "required": ["namespace", "name", "version"]
}