Pulp

If we remove the leading _ from _id then we're back to the place we were originally -- we need to find a new name for the pk field, or else, plugins will need to avoid "id", which is a pretty common name for a field.

Either would work, but we should decide on a strategy going forwards.

e.g. UpdateRecord https://github.com/pulp/pulp_rpm/blob/master/pulp_rpm/app/models.py#L386

The same applies to _href -> href, if we decide to do that.

https://github.com/pulp/pulp_rpm/blob/master/pulp_rpm/app/models.py#L666

I have no example of "last_updated" but I feel like it would be a likely future conflict.

Personally, I propose using a "pulp_" prefix.

Adding a 'pulp' or 'pulpcore' to the field names would eliminate the chance of conflict between fields provided by pulpcore and the plugin.

pulp_id
pulp_href
pulp_created
pulp_last_updated

The names are very descriptive. They eliminate ambiguity for the REST API users.

dkliban@redhat.com wrote:

Adding a 'pulp' or 'pulpcore' to the field names would eliminate the chance of conflict between fields provided by pulpcore and the plugin.

pulp_id
pulp_href
pulp_created
pulp_last_updated

The names are very descriptive. They eliminate ambiguity for the REST API users.

+1, these names are descriptive and they avoid the conflicts so I think that is the goal.

+0. Not a big fan of this change but I see no other path forward.

+0.75 for prepending everything with pulp_. I agree with @daviddavis.

Should we also change the names of "_versions_href" and "_latest_version_href" on RepositoryVersion? We would not need a "pulp_" prefix, but we would potentially want to drop the "_" prefix. I do not know whether that is an issue for the bindings the same way that the others were (as I don't think we filter on those fields at all), but since we're getting rid of that pattern everywhere else, it might no longer fit ergonomically speaking. And, it is not particularly necessary as nobody subclasses RepositoryVersion.

Let's open a separate ticket to remove _ from "_versions_href" and "_latest_version_href".

pulpcore: https://github.com/pulp/pulpcore/pull/317
pulpcore-plugin: https://github.com/pulp/pulpcore-plugin/pull/137
pulp_file: https://github.com/pulp/pulp_file/pull/284
pulp-certguard: https://github.com/pulp/pulp-certguard/pull/31
pulp-smash: https://github.com/PulpQE/pulp-smash/pull/1220
plugin_template: https://github.com/pulp/plugin_template/pull/115
pulp_rpm: https://github.com/pulp/pulp_rpm/pull/1466
pulp_ansible: https://github.com/pulp/pulp_ansible/pull/218
pulp_docker: https://github.com/pulp/pulp_docker/pull/424
pulp_deb: https://github.com/pulp/pulp_deb/pull/125
pulp-2to3-migration: https://github.com/pulp/pulp-2to3-migration/pull/29
pulp_python: https://github.com/pulp/pulp_python/pull/259
pulp_maven: https://github.com/pulp/pulp_maven/pull/22