Issue #3785: pulpcore-plugin does not have documentation for ModelSerializer.validate() - Pulp

Actions

Send by e-mail Copy link

Issue #3785

closed

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

Added by muattiyah over 6 years ago. Updated about 4 years ago.

Status:

CLOSED - WONTFIX

Priority:

Normal

Assignee:

-

Category:

-

Sprint/Milestone:

-

Start date:

Due date:

Estimated time:

Severity:

2. Medium

Version:

Platform Release:

OS:

Triaged:

Yes

Groomed:

No

Sprint Candidate:

No

Tags:

Plugin Template

Sprint:

Quarter:

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

Actions

#1

Updated by muattiyah over 6 years ago

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

Actions

#2

Updated by bmbouter over 5 years ago

Tags Plugin Template added

Actions

#3

Updated by bmbouter over 5 years 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.

Actions

#4

Updated by amacdona@redhat.com over 5 years ago

Sprint/Milestone set to 3.0.0
Triaged changed from No to Yes
Sprint set to Sprint 52

Actions

#5

Updated by dkliban@redhat.com over 5 years 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~~)

Actions

#6

Updated by rchan over 5 years ago

Sprint changed from Sprint 52 to Sprint 53

Actions

#7

Updated by bmbouter over 5 years ago

Status changed from NEW to ASSIGNED
Assignee set to bmbouter

Actions

#8

Updated by amacdona@redhat.com over 5 years ago

Sprint changed from Sprint 53 to Sprint 54

Actions

#9

Updated by ttereshc over 5 years ago

Sprint changed from Sprint 54 to Sprint 55

Actions

#10

Updated by dkliban@redhat.com over 5 years ago

Sprint changed from Sprint 55 to Sprint 56

Actions

#11

Updated by dkliban@redhat.com over 5 years ago

This looks like a documentation story to me. We need to add a description for the validate() method on ModelSerializer[0] 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

Actions

#12

Updated by bmbouter over 5 years ago

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

I am not actively working on this.

Actions

#13

Updated by dkliban@redhat.com over 5 years 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)

Actions

#14

Updated by rchan over 5 years ago

Sprint changed from Sprint 56 to Sprint 57

Actions

#15

Updated by rchan about 5 years ago

Sprint changed from Sprint 57 to Sprint 58

Actions

#16

Updated by bmbouter about 5 years ago

Sprint/Milestone deleted (~~3.0.0~~)

Actions

#17

Updated by rchan about 5 years ago

Sprint deleted (~~Sprint 58~~)

Actions

#18

Updated by daviddavis about 4 years ago

Status changed from NEW to CLOSED - WONTFIX

Actions

Send by e-mail Copy link

Also available in: Atom PDF