Task #5550: Remove "_type" / "pulp_type" as a public-facing field, and MasterModelSerializer - Pulp

Send by e-mail

Task #5550

Remove "_type" / "pulp_type" as a public-facing field, and MasterModelSerializer

Added by dalley 4 months ago. Updated about 1 month ago.

Status:

CLOSED - CURRENTRELEASE

Priority:

Normal

Assignee:

fabricio.aguiar

Category:

Sprint/Milestone:

3.0.0

Start date:

Due date:

% Done:

100%

Platform Release:

Blocks Release:

Backwards Incompatible:

Groomed:

Sprint Candidate:

Tags:

QA Contact:

Complexity:

Smash Test:

Verified:

Verification Required:

Sprint:

Description

Rationale:

"_type" / "pulp_type" is a field that shows up on models using master-detail inheritance. However, there is no way to query these types generically. In order to query these types, you have to provide the app name and the type name, which are the two components of that field. Therefore it doesn't really provide the end user any valuable information.

This is probably a leftover relic from when the /content/ endpoint existed and returned content of all types.

Pulpcore still needs this information for various things, but, the user doesn't. Therefore we can remove it from the serializers.

"_type" / "pulp_type" is the only thing provided by MasterModelSerializer, so the whole thing can go. Everything inheriting from MasterModelSerializer can inherit from ModelSerializer instead.

https://github.com/pulp/pulpcore/blob/master/pulpcore/app/serializers/base.py#L81-L110

Related issues

Associated revisions

Revision 2a62d16b View on GitHub
Added by Fabricio Aguiar 4 months ago

Removing _type field

closes #5550
https://pulp.plan.io/issues/5550

Required PR: https://github.com/pulp/pulp_file/pull/284
 Required PR: https://github.com/pulp/pulpcore-plugin/pull/137
 Required PR: https://github.com/PulpQE/pulp-smash/pull/1220
 Required PR: https://github.com/pulp/pulp-certguard/pull/31

Revision dd03135d View on GitHub
Added by Fabricio Aguiar 4 months ago

Removing _type field

ref #5550
https://pulp.plan.io/issues/5550

Required PR: https://github.com/pulp/pulpcore-plugin/pull/137
Required PR: https://github.com/pulp/pulpcore/pull/317
Required PR: https://github.com/PulpQE/pulp-smash/pull/1220

Revision 57e1f2ca View on GitHub
Added by Fabricio Aguiar 4 months ago

Removing _type field

ref #5550
https://pulp.plan.io/issues/5550

Revision e69bba70 View on GitHub
Added by Fabricio Aguiar 4 months ago

Removing _type field

ref #5550
https://pulp.plan.io/issues/5550

Revision 3e4c9db8 View on GitHub
Added by Fabricio Aguiar 4 months ago

Removing _type field