Story #5044: As a plugin writer, I have docs on how to have custom Remote fields be usable for 1-time options - Pulp

Actions

Send by e-mail Copy link

Story #5044

closed

Story #3802: [Epic] As a user, I can override a remote's settings when making a request to start a sync

As a plugin writer, I have docs on how to have custom Remote fields be usable for 1-time options

Added by bmbouter over 5 years ago. Updated about 4 years ago.

Status:

CLOSED - WONTFIX

Priority:

Normal

Assignee:

Category:

Sprint/Milestone:

Start date:

Due date:

% Done:

Estimated time:

Platform Release:

Groomed:

Yes

Sprint Candidate:

Tags:

Documentation

Sprint:

Quarter:

Description

The plugin writer docs should have a section that covers how to add this. Effectively the plugin writer must:

1. Include custom Remote fields by subclassing RepositoryURLSerializer similar to how RepositoryURLSerializer subclassed RemoteSerializer in core.
2. Have the plugin's view specify their subclassed serializer.

The core provided feature should be identified that get_object() method work generically so the plugin writer does not have to take an additional step to overlay custom attributes.