Vridlo/api/vridlo.assemblers

vridlo.assemblers
It allows accessing to a list of assemblers, 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 Assembler structure.

GET:/v1/assemblers.json
Returns a list of assemblers, 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.
 * per_page (Optional)
 * page (Optional)

Example Request Url
GET:/v1/assemblers.json?name=/Assembler/

Example Good Response
[   {       "slug": "ca", "name": "Core Assembler" "host": "assembler.altlinux.org" "source_path_count": 3 "export_path_base": "/export/path/to" },   {       "slug": "sa", "name": "Secondary Assembler" "host": "secondary.altlinux.org" "source_path_count": 1 "export_path_base": "/export/path/to/sec/" } ]

Example Bad Response
Error response 416:

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

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/assemblers.json
Creates the assembler 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 assembler model.

Arguments
Slug of the assembler. Must be unique per system. Name of the assembler. Must be unique among the assemblers. Host URI of the assembler. If presented it must be unique among the assemblers. File path base for exporting of the source or built RPMs.
 * slug (Mandatory)
 * name (Mandatory)
 * host (Optional)
 * export_path_base (Optional)

Example Request Url
POST:/v1/assemblers.json?name=assembler_name&slug=asse

Example Request Form
POST:/v1/assemblers.json DATA: {  "slug": "ca", "name": "Core Assembler", "host": "assembler.altlinux.org", "export_path_base": "/export/path/to", }

Example Good Response
Good response with created record:

{  "slug": "ca", "name": "Core Assembler", "host": "assembler.altlinux.org", "source_path_count": 0, "export_path_base": "/export/path/to", }

Example Bad Response
Error response 422:

{  "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 assembler 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.

Arguments
This method requires NO arguments.

Example Request Url
GET:/v1/assemblers/ca.json

Example Good Response
Good response with the returned record:

{  "slug": "ca", "name": "Core Assembler" "host": "assembler.altlinux.org" "source_path_count": 3 "export_path_base": "/export/path/to" }

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/assemblers/ .json
Sets one or many properties of the assembler specified by URI-parameter, and returns updated state as JSON. Added into API v1.0.

Authentication
This method requires write authentication with write permission to assembler model.

Arguments
NOTE: Blank fields will be skipped

Name of the assembler. If presented it must be unique among the assemblers. Host URI of the assembler. If presented it must be unique among the assemblers. File path base for exporting of the source or built RPMs.
 * name (Optional)
 * host (Optional)
 * export_path_base (Optional)

Example Request Url
PATCH:/v1/assemblers/ca.json?name=Core_Assembler

Example Request Form
PATCH:/v1/assemblers/ca.json DATA: {  "name": "Core_Assembler", }

Example Good Response
{  "slug": "ca", "name": "Core Assembler" "host": "assembler.altlinux.org" "source_path_count": 3 "export_path_base": "/export/path/to" }

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/assemblers/ .json
Destroys the assembler specified by URI-parameter, and returns state of the destroyed record as JSON. Added into API v1.0.

Authentication
This method requires write authentication with write permission token to assembler model.

Arguments
This method requires NO arguments.

Example Request Url
DELETE:/v1/assemblers/ca.json

Example Good Response
Good response returning deleted record:

{  "slug": "ca", "name": "Core Assembler" "host": "assembler.altlinux.org" "source_path_count": 3 "export_path_base": "/export/path/to" }

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)