|
|
| Line 1: |
Line 1: |
| == vridlo.source_path.index ==
| |
|
| |
|
| 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.
| |
|
| |
| === Path ===
| |
|
| |
| /v1/source_paths
| |
|
| |
| === Methods ===
| |
|
| |
| ==== GET ====
| |
|
| |
| 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 =====
| |
|
| |
| * 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 along with headers fields.
| |
|
| |
| ===== Example Response =====
| |
|
| |
| [
| |
| {
| |
| "name": "Core Assembler p9 i586 Path",
| |
| "assembler_slug": "core",
| |
| "relative_path": "p9/i586",
| |
| "branch": "p9",
| |
| "arch": "i586",
| |
| },
| |
| {
| |
| "name": "Core Assembler p9 x96_64 Path",
| |
| "assembler_slug": "core",
| |
| "relative_path": "p9/x86_64",
| |
| "branch": "p9",
| |
| "arch": "x86_64",
| |
| },
| |
| {
| |
| "name": "Core Assembler p8 i586 Path",
| |
| "assembler_slug": "core",
| |
| "relative_path": "p8/i586",
| |
| "branch": "p8",
| |
| "arch": "i586",
| |
| },
| |
| ]
| |
|
| |
| ===== 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.
| |