Project

Profile

Help

Story #3173

closed

As a plugin author, I have documentation on how to implement a sync operation for my importer

Added by daviddavis over 6 years ago. Updated about 5 years ago.

Status:
CLOSED - DUPLICATE
Priority:
Normal
Assignee:
-
Category:
-
Sprint/Milestone:
Start date:
Due date:
% Done:

100%

Estimated time:
Platform Release:
Groomed:
No
Sprint Candidate:
Yes
Tags:
Documentation
Sprint:
Sprint 31
Quarter:

Description

The syncing with an importer portion of the plugin writer's guide needs to be updated. The guide needs to explain that it's the author's responsibility to

- define a UserFacingTask that creates a new RepositoryVersion of a repository by syncing with a specific importer.

- the task should create a repository version and add it to `task.created_resources` in a single transaction
- the task should add / remove content using the Importer to drive the download API
- the task should set the repository version's to complete field to true after all content manipulation is done

- define a detail route on the Importer ViewSet for 'sync' that accepts a 'repository' POST body parameter

- the route should perform validation and then dispatch the the sync task with reservations for the repository and the importer.


Related issues

Has duplicate Pulp - Issue #3228: As an authenticated user, I can create a new repository versionCLOSED - DUPLICATEActions
Is duplicate of Pulp - Task #3220: Expand plugin writer's guide to include RepositoryVersion creating actions (including sync)CLOSED - CURRENTRELEASEbizhang

Actions

Also available in: Atom PDF