Issue #3748
closed
documentation fails to mention that distribution 'name' must be unique
Status:
CLOSED - CURRENTRELEASE
Description
Auto generated docs for Pulp 3 do not say anything about the 'name' of distribution having to be unique.
- Triaged changed from No to Yes
- Sprint set to Sprint 38
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?
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
- 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)
- Status changed from NEW to POST
- Assignee set to daviddavis
- Status changed from POST to MODIFIED
- Sprint/Milestone set to 3.0.0
- Status changed from MODIFIED to CLOSED - CURRENTRELEASE
Also available in: Atom
PDF
Updating distribution name help text to mention uniqueness
fixes #3748 https://pulp.plan.io/issues/3748