<div dir="ltr"><div>I just want to point out that we have a somewhat similar kind of feature implemented, "minimal serializers", which uses the 2-serializer approach.  It is a very tiny amount of extra code/work.  <br></div><div><br></div><div>e.g.</div><div><a href="https://github.com/pulp/pulpcore/blob/master/pulpcore/app/serializers/task.py#L119">https://github.com/pulp/pulpcore/blob/master/pulpcore/app/serializers/task.py#L119</a></div><div><a href="https://github.com/pulp/pulp_rpm/blob/master/pulp_rpm/app/serializers.py#L290">https://github.com/pulp/pulp_rpm/blob/master/pulp_rpm/app/serializers.py#L290</a></div><div><br></div><div>the implementation</div><div><a href="https://github.com/pulp/pulpcore/blob/master/pulpcore/app/viewsets/base.py#L114-L139">https://github.com/pulp/pulpcore/blob/master/pulpcore/app/viewsets/base.py#L114-L139</a></div><div><br></div><div>I lean towards option 2 as well for consistency.<br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Mon, Apr 27, 2020 at 5:20 AM Ina Panova <<a href="mailto:ipanova@redhat.com">ipanova@redhat.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr">I like option number 2 more, even if there is more work behind the scene it is more explicit and does not leave opened questions like ' why certain fields are null'<br><div><div><div dir="ltr"><div dir="ltr"><div><div dir="ltr">--------<br>Regards,<br><br>Ina Panova<br>Senior Software Engineer| Pulp| Red Hat Inc.<br><br>"Do not go where the path may lead,<br> go instead where there is no path and leave a trail."<br></div></div></div></div></div><br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, Apr 24, 2020 at 5:24 PM Dennis Kliban <<a href="mailto:dkliban@redhat.com" target="_blank">dkliban@redhat.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div>Today during open floor we concluded that write_only fields cannot be used in serializers because any automated handling of them during OpenAPI schema generation will cause mutations to the schema which will result in backwards incompatible changes to our bindings users. <br></div><div><br></div><div>This change should only affect the Content serializers that have a 'file' and 'repository' write_only fields that can be used for uploading content into a repository in a single request. Two solutions were proposed:</div><div><br></div><div>1) Use a single serializer for GET and POST and leave 'file' and 'repository' null for GET requests. This solution is the simplest for plugin writers because they don't have to do anything extra. However, it does cause users to wonder why those fields are present and null on GET requests.<br></div><div><br></div><div>2) Require plugin writers to provide 2 serializers for Content - one for GET and another for POST. This is more work for plugin writers, but will make it clear to users what fields are expected in each case. <br></div><div><br></div><div></div><div>Even though I initially proposed 1, I am in favor of adopting 2. What does everyone else think?</div><div><br></div><div>We will need to provide validation at startup that will check serializers for presence of write_only fields. The application should fail to start if any are present. This way plugin writers will know not to use the fields. We will also need to provide plugin writer docs that clearly state the guidelines around write_only fields and suggestions for getting by without them. <br></div></div>
_______________________________________________<br>
Pulp-dev mailing list<br>
<a href="mailto:Pulp-dev@redhat.com" target="_blank">Pulp-dev@redhat.com</a><br>
<a href="https://www.redhat.com/mailman/listinfo/pulp-dev" rel="noreferrer" target="_blank">https://www.redhat.com/mailman/listinfo/pulp-dev</a><br>
</blockquote></div>
_______________________________________________<br>
Pulp-dev mailing list<br>
<a href="mailto:Pulp-dev@redhat.com" target="_blank">Pulp-dev@redhat.com</a><br>
<a href="https://www.redhat.com/mailman/listinfo/pulp-dev" rel="noreferrer" target="_blank">https://www.redhat.com/mailman/listinfo/pulp-dev</a><br>
</blockquote></div>