Add missing uuid to config_export for AZQuickstartCitationStyle entity

Open Beginner friendly
#4,838 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
php
Domain
backend

Research direction

Locate the AZQuickstartCitationStyle entity class and inspect its config_export array. Add the missing uuid entry, then run drush config:export and the config schema validation or test suite to confirm the exported keys match the schema.

Written by the indexing model from the issue text.

Description

backport-2.x bug wowlit

Problem/Motivation

See https://www.drupal.org/node/2481909

The AZQuickstartCitationStyle config entity currently defines config_export as:

config_export = {
  "id",
  "label",
  "style",
  "custom"
}

However, it does not include uuid, even though the schema correctly declares it and all config entities are expected to export their UUIDs.
This causes problems with config synchronization and validation since the exported YAML will always contain a uuid key that isn't accounted for in config_export.

Steps to reproduce
  1. Create a citation style config entity (/admin/config/az-quickstart/settings/az-publication/style/add).
  2. Export configuration using drush cex or the UI.
  3. Inspect the exported YAML at config/sync/az_publication.az_citation_style.[id].yml.
  4. Observe that the file contains a uuid key even though it is missing from the entity's config_export list.

Example export:

uuid: e8dc3819-33c1-42f7-9cd3-9c678bc0aa5a
id: apa
label: 'APA Style'
style: apa
custom: false


Schema file

Proposed resolution

Add uuid to the config_export array in AZQuickstartCitationStyle so that it matches the schema and Drupal core expectations for config entities.

config_export = {
  "id",
  "label",
  "style",
  "custom",
  "uuid"
}

Remaining tasks

  • Update config_export array to include uuid.
  • Run drush config:export to confirm that the export matches the updated list.
  • Verify with config schema validation (drush php:cs or test suite).
  • Add a test to confirm that the exported keys match the schema.

User interface changes

None.

API changes

None.

Data model changes

None — this only ensures proper alignment between exports and schema.

Dominant language
PHP
Stars
52
Forks
24
Avg merge
2d 21h
Merged PRs (30d)
47

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from az-digital/az_quickstart

All issues in az-digital/az_quickstart

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.