Vridlo/api/vridlo.source paths

vridlo.source_paths
It allows accessing to a list of source paths, which are presented in the system. Do not poll this method more than once an hour. Added into API v1.0. It implements operation on the SourcePath structure.

GET:/v1/source_paths.json
Returns a list of source paths, which are presented in the system. Do not poll this method more than once an hour. Added into API v1.0.

Authentication
This method requires NO authentication.

Arguments
NOTE: Arguments can be provided as arguments along with headers fields.

Number of items to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50. The page of results to return. If this argument is omitted, it defaults to 1. Search by specified slug, if provided value begins with "/", it is treated as regexp. Search by specified name, if provided value begins with "/", it is treated as regexp. Search by specified assembler slug, if provided value begins with "/", it is treated as regexp. Search by specified relative path, if provided value begins with "/", it is treated as regexp. Search by specified branch name, if provided value begins with "/", it is treated as regexp. Search by specified arch, if provided value begins with "/", it is treated as regexp.
 * per_page is natural optional
 * page is natural optional
 * slug is string optional
 * name is string optional
 * assembler_slug is string optional
 * relative_path is string optional
 * branch is string optional
 * arch is string optional

Example Request Url
GET:/v1/tags.json?name=/Core/

Example Good Response
[   {       "slug": "sp", "name": "Core Assembler p9 i586 Path", "assembler_slug": "core", "relative_path": "p9/i586", "repo_slug": "p9", "arch_slug": "i586", },   {       "slug": "sp2", "name": "Core Assembler p9 x96_64 Path", "assembler_slug": "core", "relative_path": "p9/x86_64", "repo_slug": "p9", "arch_slug": "x86_64", },   {       "slug": "sp3", "name": "Core Assembler p8 i586 Path", "assembler_slug": "core", "relative_path": "p8/i586", "repo_slug": "p8", "arch_slug": "i586", }, ]

Return Codes
The resource list is accessible. Returned data responds to the current state of the resource list, and reading the list is finished.
 * 200 (OK)

The resource list is accessible. Returned data responds to the current state of the resource list, and reading the list is NOT finished yet.
 * 206 (Partial Content)

The resource list is accessible. But data can't be returned since range provided don't match the list boundaries.
 * 416 (Range Not Satisfiable)

SSL is required to access the Vridlo API.
 * 422.3 (SSL is required)

The requested service is temporarily unavailable.
 * 500 (Service currently unavailable)

POST:/v1/source_paths.json
Creates the source path specified by URI-parameter using he set of properties passed as form data or get parameter array, and returns state of the created record as JSON. Added into API v1.0.

Authentication
This method requires write authentication with write permission to source path model.

Arguments
Slug of the source path. Can contain only letters and underscores. Must be unique per system. Slug of the arch. Must be valid arch among the all arches. Source path name. Must be unique among the branch paths. Slug of the repo. Must be valid among the repos. Assembler slug, which the source path belongs to. Can be blank, in case when the path is the standalone path. Must be valid among the assembler slugs if presented. File path part relative from the assembler's path base for exporting of the source or built RPMs.
 * slug is string mandatory write-once
 * arch_slug is string mandatory write-once
 * name is string mandatory
 * repo_slug is string mandatory
 * assembler_slug is string optional
 * relative_path is string optional

Example Request Url
POST:/v1/source_paths.json?name=Core Assembler Source Path&slug=sp&assembler_slug=ca&repo=p9&arch=i586&relative_path=p9/i586

Example Request Form
POST:/v1/source_paths.json DATA: {  "slug": "sp", "name": "Core Assembler Source Path", "assembler_slug": "ca", "repo_slug": "p9", "arch_slug": "i586", "relative_path": "p9/i586", }

Example Good Response
Good response with created record:

{  "slug": "sp", "name": "Core Assembler Source Path", "assembler_slug": "ca", "repo_slug": "p9", "arch_slug": "i586", "relative_path": "p9/i586", }

Example Bad Response
Error response 423:

{  "error_code": 3, "message": "Error text according the active language", }

Return Codes
The resource wasn't found, and was created. Returned data responds to the current state of the resource.
 * 200 (OK)

SSL is required to access the Vridlo API.
 * 422.3 (SSL is required)

The record with provided slug is not found.
 * 404 (Not Found)

The Internal Server Error has occurred.
 * 500 (Internal Server Error)

GET:/v1/assemblers/ .json
Gets properties of the source path specified by URI-parameter, and returns then as JSON. Do not poll this method more than once an hour. Added into API v1.0.

Authentication
This method requires NO authentication.

Inline argument
Slug of the source path. Can contain only letters and underscores. Must be unique per system.
 * slug is string mandatory

Arguments
This method requires NO arguments.

Example Request Url
GET:/v1/assemblers/sp

Example Good Response
Good response with the returned record:

{  "slug": "sp", "name": "Core Assembler Source Path", "assembler_slug": "ca", "repo_slug": "p9", "arch_slug": "i586", "relative_path": "p9/i586", }

Example Bad Response
Error response 422:

{  "error_code": 3, "message": "Error text according the active language", }

Return Codes
The resource was found and is accessible. Returned data responds to the current state of the resource.
 * 200 (OK)

SSL is required to access the Vridlo API.
 * 422.3 (SSL is required)

The record with provided slug is not found.
 * 404 (Not Found)

The Internal Server Error has occurred.
 * 500 (Internal Server Error)

PATCH:/v1/source_paths/ .json
Sets one or many properties of the source path specified by URI-parameter, and returns updated state as JSON.

Authentication
This method requires write authentication with write permission to source path model.

Inline argument
Slug of the source path. Can contain only letters and underscores. Must be unique per system.
 * slug is string mandatory

Arguments
Source path name. Must be unique among the branch paths. Slug of the repo. Must be valid among the repos. Assembler slug, which the source path belongs to. Can be blank, in case when the path is the standalone path. Must be valid among the assembler slugs if presented. File path part relative from the assembler's path base for exporting of the source or built RPMs.
 * name is string optional
 * repo_slug is string optional
 * assembler_slug is string optional
 * relative_path is string optional

Example Request Url
PATCH:/v1/source_paths/sp?name=Core_Assembler_New

Example Request Form
PATCH:/v1/source_paths/sp DATA: {  "name": "Core_Assembler_New", }

Example Bad Response
Error response 422:

{  "error_code": 3, "message": "Error text according the active language", }

Return Codes
The resource was found and is accessible. Changes were made on the resource successfully. Returned data responds to the current state of the resource.
 * 200 (OK)

The resource was found and is accessible. But no changes were made on the resource.
 * 204 (No Content)

SSL is required to access the Vridlo API.
 * 422.3 (SSL is required)

The record with provided id/slug is not found.
 * 404 (Not Found)

The Internal Server Error has occurred.
 * 500 (Internal Server Error)

DELETE:/v1/source_paths/ .json
Destroys the source path specified by URI-parameter, and returns state of the destroyed record as JSON.

Authentication
This method requires write authentication with write permission to source path model.

Inline argument
Slug of the source path. Can contain only letters and underscores. Must be unique per system.
 * slug is string mandatory

Arguments
This method requires NO arguments.

Example Request Url
DELETE:/v1/source_paths/sp.json

Example Good Response
Good response returning deleted record:

{  "slug": "sp", "name": "Core Assembler Source Path", "assembler_slug": "ca", "repo_slug": "p9", "arch_slug": "i586", "relative_path": "p9/i586", }

Example Bad Response
Error response 422:

{  "error_code": 3, "message": "Error text according the active language", }

Return Codes
The resource was found and is accessible, and successfully destroyed. Returned data responds to the state of the destroyed resource.
 * 200 (OK)

SSL is required to access the Vridlo API.
 * 422.3 (SSL is required)

The record with provided slug is not found.
 * 404 (Not Found)

The Internal Server Error has occurred.
 * 500 (Internal Server Error)