Project

Profile

Help

Issue #3748

closed

documentation fails to mention that distribution 'name' must be unique

Added by dkliban@redhat.com almost 6 years ago. Updated over 4 years ago.

Status:
CLOSED - CURRENTRELEASE
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:
Documentation
Sprint:
Sprint 38
Quarter:

Description

Auto generated docs for Pulp 3 do not say anything about the 'name' of distribution having to be unique.

Actions #1

Updated by CodeHeeler almost 6 years ago

  • Triaged changed from No to Yes
  • Sprint set to Sprint 38
Actions #2

Updated by amacdona@redhat.com almost 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?

Actions #3

Updated by bizhang almost 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

Actions #4

Updated by dkliban@redhat.com almost 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)
Actions #5

Updated by daviddavis almost 6 years ago

  • Status changed from NEW to POST
  • Assignee set to daviddavis

Added by daviddavis almost 6 years ago

Revision fa2aa862 | View on GitHub

Updating distribution name help text to mention uniqueness

fixes #3748 https://pulp.plan.io/issues/3748

Added by daviddavis almost 6 years ago

Revision fa2aa862 | View on GitHub

Updating distribution name help text to mention uniqueness

fixes #3748 https://pulp.plan.io/issues/3748

Actions #6

Updated by daviddavis almost 6 years ago

  • Status changed from POST to MODIFIED
Actions #7

Updated by daviddavis almost 5 years ago

  • Sprint/Milestone set to 3.0.0
Actions #8

Updated by bmbouter almost 5 years ago

  • Tags deleted (Pulp 3)
Actions #9

Updated by bmbouter over 4 years ago

  • Status changed from MODIFIED to CLOSED - CURRENTRELEASE

Also available in: Atom PDF