Issue #3748
closeddocumentation fails to mention that distribution 'name' must be unique
Description
Auto generated docs for Pulp 3 do not say anything about the 'name' of distribution having to be unique.
Updated by CodeHeeler over 6 years ago
- Triaged changed from No to Yes
- Sprint set to Sprint 38
Updated by amacdona@redhat.com over 6 years ago
This is probably general and affects all unique fields, not just "name". When this is fixed, please fix generally.
Should we file an upstream RFE?
Updated by bizhang over 6 years ago
Neither CoreAPI nor OpenAPI has a unique field on a parameter definition:
https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#fixed-fields-7
I'm not convinced that this is a bug either- the purpose of a API Schema is to help the user formulate a request. A unique field does not help with that since it's unreasonable to assume that the user would have knowledge of all the fields in the database in order to generate a unique one.
Parameter uniqueness also does not help with response validation since, again, the schema-client would not know what the other field values are in the database.
Having a field marked as unique might help a new user not run into an error when they attempt to create two objects with the same name, but for {repositories, remotes, publishers} our help_text does say "A unique name for this {repostiroy, remote, publisher}"
Which I think is sufficient
Updated by dkliban@redhat.com over 6 years ago
- Subject changed from documentation fails to mention that 'name' must be unique to documentation fails to mention that distribution 'name' must be unique
- Description updated (diff)
Updated by daviddavis over 6 years ago
- Status changed from NEW to POST
- Assignee set to daviddavis
Added by daviddavis over 6 years ago
Added by daviddavis over 6 years ago
Revision fa2aa862 | View on GitHub
Updating distribution name help text to mention uniqueness
Updated by daviddavis over 6 years ago
- Status changed from POST to MODIFIED
Applied in changeset pulp|fa2aa8622245317fd6686d835c5e50c73f59db2b.
Updated by bmbouter about 5 years ago
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
Updating distribution name help text to mention uniqueness
fixes #3748 https://pulp.plan.io/issues/3748