Project

Profile

Help

Task #5428

closed

Story #5443: [Epic] Remove leading _ from pulpcore model fields

Rename the fields "_relative_path" and "_artifact" on the SingleArtifactContentSerializer to "relative_path" and "artifact" respectively

Added by mdellweg over 4 years ago. Updated over 4 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Normal
Assignee:
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

100%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
No
Tags:
Easy Fix
Sprint:
Quarter:

Description

The content serializers provided by pulpcore-plugin are only convenience layers for the plugin writer. Their _artifact and _relative_path fields do not refer directly to filed on the corresponding content models, but are translated into ContentArtifacts on create. Plugins really exposing the relative_path field take some effort to rename it to relative_path in a way that might even skip some valuable validation.

There has been some consensus that those fields should be named artifact and relative_path.


Related issues

Related to Pulp - Issue #5445: "KeyError: 'relative_path'" in SingleArtifactContentSerializerCLOSED - CURRENTRELEASEdaviddavisActions

Also available in: Atom PDF