Files
freezer-api/api-ref/source/v2/parameters.yaml
Saad Zaher 69719590b7 Updated freezer-api api-ref documentation
* Update api-ref structure
   * Added v2
   * Backup list
   * Job list
   * Job Create

Implements blueprint implement-api-ref-doc

Change-Id: I643ca44565331ef9d0fc36189d60489523e3235e
2017-04-26 15:24:26 +00:00

69 lines
1.5 KiB
YAML

############################### Response ####################################
limit:
description: |
Requests a page size of items. Returns a number of items up to a limit
value. Use the ``limit`` parameter to make an initial limited request and
use the ID of the last-seen item from the response as the ``marker``
parameter value in a subsequent limited request.
in: query
required: false
type: integer
marker:
description: |
The ID of the last-seen item. Use the ``limit`` parameter to make an
initial limited request and use the ID of the last-seen item from the
response as the ``marker`` parameter value in a subsequent limited request.
in: query
required: false
type: string
project_id_path:
type: string
in: query
required: true
description: |
The UUID of the project. A project was also known as
a tenant.
backups:
type: list
in: body
description: |
A list of backups
job_actions_req:
type: list
in: body
required: true
description: |
A list of actions that carry out the backup/restore job.
job_description_req:
type: string
in: body
required: true
description: |
The name of the job
job_schedule_req:
type: dict
in: body
required: true
description: |
The schedule information of the job
jobs:
type: list
in: body
description: |
A list of jobs
versions:
type: list
in: body
required: True
description: |
A list of supported major API versions.