Differential D329 Diff 1247 docs/getting-started.rst

Changeset View

Standalone View

docs/getting-started.rst

	Show First 20 Lines • Show All 169 Lines • ▼ Show 20 Lines



	multisteps deposit			multisteps deposit
	^^^^^^^^^^^^^^^^^^^^^^^^^			^^^^^^^^^^^^^^^^^^^^^^^^^
	The steps to create a multisteps deposit:			The steps to create a multisteps deposit:

	1. Create an incomplete deposit			1. Create an incomplete deposit
	~~~~~~~~~~~~~~~~~~~			~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	First use the ``--partial`` argument to declare there is more to come			First use the ``--partial`` argument to declare there is more to come

	.. code:: shell			.. code:: shell

	$ swh-deposit --username name --password secret \			$ swh-deposit --username name --password secret \
	--archive foo.tar.gz \			--archive foo.tar.gz \
	--partial			--partial


	2. Add content or metadata to the deposit			2. Add content or metadata to the deposit
	~~~~~~~~~~~~~~~~~~~			~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
	Continue the deposit by using the ``--deposit-id`` argument given as a response			Continue the deposit by using the ``--deposit-id`` argument given as a response
	for the first step. You can continue adding content or metadata while you use			for the first step. You can continue adding content or metadata while you use
	the ``--partial`` argument.			the ``--partial`` argument.

	.. code:: shell			.. code:: shell

	$ swh-deposit --username name --password secret \			$ swh-deposit --username name --password secret \
	--archive add-foo.tar.gz \			--archive add-foo.tar.gz \
	▲ Show 20 Lines • Show All 65 Lines • ▼ Show 20 Lines

	Check the deposit's status			Check the deposit's status
	--------------------------			--------------------------

	You can check the status of the deposit by using the ``--deposit-id`` argument:			You can check the status of the deposit by using the ``--deposit-id`` argument:

	.. code:: shell			.. code:: shell

	$ swh-deposit --username name --password secret --deposit-id '11' --status			$ swh-deposit --username name --password secret --deposit-id '11' --status

	.. code:: json			.. code:: json

	{			{
	'deposit_id': '11',			'deposit_id': '11',
	'deposit_status': 'deposited',			'deposit_status': 'deposited',
	'deposit_swh_id': None,			'deposit_swh_id': None,
	'deposit_status_detail': 'Deposit is ready for additional checks \			'deposit_status_detail': 'Deposit is ready for additional checks \
	Show All 30 Lines