canonical/cloud-init

[enhancement]: Relocate json schemas somewhere more sensible

Open

#4,688 opened on Dec 13, 2023

View on GitHubContributor guide
 (6 comments) (2 reactions) (0 assignees)Python (1,108 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (3,772 stars)
PR merge metrics
 (PR metrics pending)

Description

Enhancement

All of our jsonschemas are hidden down under cloudinit/config/schemas/, which doesn't make sense:

a) these files contain data not Python code b) some of these files are not specific to configuration modules c) the __init__.py was never required

These file should exist in a directory under the top directory, probably named something like schema (alternatively jsonschema or maybe something more generic like data).

Expected changes:

  • code in cloudinit/, specifically schema.py
  • test/unittest/
  • setup.py
  • possibly distro packaging too (presumably avoidable with setup.py finesse)

Contributor guide

Research direction
Create a new directory (e.g., schema/) at the repository root. Move all JSON schema files from cloudinit/config/schemas/ into that directory. Update all references in cloudinit/schema.py, test files, and setup.py (e.g., package data or data files) to point to the new location. Ensure tests pass. Consider distro packaging implications via setup.py adjustments.
Tech stack
python
Domain
backenddevops
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60