Project

Profile

Help

Issue #3785

pulpcore-plugin does not have documentation for ModelSerializer.validate()

Added by muattiyah over 1 year ago. Updated about 1 month ago.

Status:
NEW
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
-
Start date:
Due date:
Severity:
2. Medium
Version:
Platform Release:
Blocks Release:
OS:
Backwards Incompatible:
No
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Plugin Template
QA Contact:
Complexity:
Smash Test:
Verified:
No
Verification Required:
No
Sprint:

Description

In https://github.com/pulp/pulp/pull/3531 we added extra validation such that if extra parameters that are not defined are passed to the serializer, it will raise a `serializers.ValidationError`.

The plugin API documentation is missing a description for ModelSerializer.validate()[0]. Plugin writers would benefit from knowing the type of validation provided by pulpcore.

[0] https://docs.pulpproject.org/en/pulpcore-plugin/nightly/api-reference/serializers.html#pulpcore.plugin.serializers.ModelSerializer.validate


Related issues

Related to Pulp - Issue #2970: REST API silently ignores object attributes that don't exist on the serializer MODIFIED Actions

History

#1 Updated by muattiyah over 1 year ago

  • Related to Issue #2970: REST API silently ignores object attributes that don't exist on the serializer added

#2 Updated by bmbouter 6 months ago

  • Tags Plugin Template added

#3 Updated by bmbouter 6 months ago

  • Project changed from 27 to Pulp

The plugin template Redmine project is being consolidated into the Pulp Redmine project so all issues are being moved over.

#4 Updated by amacdona@redhat.com 6 months ago

  • Sprint/Milestone set to 3.0
  • Triaged changed from No to Yes
  • Sprint set to Sprint 52

#5 Updated by dkliban@redhat.com 5 months ago

  • Subject changed from Document that plugin implementors will have to call super().validate() on their serializers. to Update plugin_template with a call to super().validate() for the serializers validate methods
  • Tags deleted (Documentation)

#6 Updated by rchan 5 months ago

  • Sprint changed from Sprint 52 to Sprint 53

#7 Updated by bmbouter 5 months ago

  • Status changed from NEW to ASSIGNED
  • Assignee set to bmbouter

#8 Updated by amacdona@redhat.com 5 months ago

  • Sprint changed from Sprint 53 to Sprint 54

#9 Updated by ttereshc 4 months ago

  • Sprint changed from Sprint 54 to Sprint 55

#10 Updated by dkliban@redhat.com 3 months ago

  • Sprint changed from Sprint 55 to Sprint 56

#11 Updated by dkliban@redhat.com 3 months ago

This looks like a documentation story to me. We need to add a description for the validate() method on ModelSerializer0 so plugin writers can know what kind of validation is already being performed for their Models.

[0] https://docs.pulpproject.org/en/pulpcore-plugin/nightly/api-reference/serializers.html#pulpcore.plugin.serializers.ModelSerializer.validate

#12 Updated by bmbouter 3 months ago

  • Status changed from ASSIGNED to NEW
  • Assignee deleted (bmbouter)

I am not actively working on this.

#13 Updated by dkliban@redhat.com 3 months ago

  • Subject changed from Update plugin_template with a call to super().validate() for the serializers validate methods to pulpcore-plugin does not have documentation for ModelSerializer.validate()
  • Description updated (diff)

#14 Updated by rchan 3 months ago

  • Sprint changed from Sprint 56 to Sprint 57

#15 Updated by rchan about 2 months ago

  • Sprint changed from Sprint 57 to Sprint 58

#16 Updated by bmbouter about 1 month ago

  • Sprint/Milestone deleted (3.0)

#17 Updated by rchan about 1 month ago

  • Sprint deleted (Sprint 58)

Please register to edit this issue

Also available in: Atom PDF