Vridlo/api/vridlo.assembler.index: Difference between revisions

From ALT Linux Wiki
No edit summary
Line 1: Line 1:
==== vridlo.assembler.index ====
== vridlo.assembler.index ==


Returns a list of assemblers, which are presented in the system. Do not poll this method more than once an hour.
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.
Added into API v1.0.


===== Path =====
=== Path ===
 
/v1/assemblers
 
=== Methods ===


GET: /v1/assemblers
==== GET ====
 
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 =====
===== Authentication =====
Line 18: Line 25:
* page (Optional)
* page (Optional)
  The page of results to return. If this argument is omitted, it defaults to 1.
  The page of results to return. If this argument is omitted, it defaults to 1.
NOTE: Arguments can be provided as arguments alog with headers fields.


===== Example Response =====
===== Example Response =====

Revision as of 13:12, 22 August 2019

vridlo.assembler.index

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.

Path

/v1/assemblers

Methods

GET

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
  • per_page (Optional)
Number of items to return per page. If this argument is omitted, it defaults to 10. The maximum allowed value is 50.
  • page (Optional)
The page of results to return. If this argument is omitted, it defaults to 1.

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

Example Response
[
 {
  "name": "Core Assembler"
  "host": "assembler.altlinux.org"
  "source_path_count": 3
  "export_path_base": "/export/path/to"
 },
 {
  "name": "Secondary Assembler"
  "host": "secondary.altlinux.org"
  "source_path_count": 1
  "export_path_base": "/export/path/to/sec/"
 }
]
Return Codes
  • 200 (OK)
The resource list is accessible. Returned data responds to the current state of the resource list, and reading the list is finished.
  • 206 (Partial Content)
The resource list is accessible. Returned data responds to the current state of the resource list, and reading the list is NOT finished yet.
  • 416 (Range Not Satisfiable)
The resource list is accessible. But data can't be returned since range provided don't match the list boundaries.
  • 422.3 (SSL is required)
SSL is required to access the Vridlo API.
  • 500 (Service currently unavailable)
The requested service is temporarily unavailable.