Skip to content

Commit

Permalink
documented namespace param
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim Whitlock committed Jun 20, 2015
1 parent 1504454 commit 786c5f7
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 4 deletions.
21 changes: 20 additions & 1 deletion src/Http/Resources/service.json
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,11 @@
"text"
]
},
"namespace": {
"description": "Override the project name for some language packs that use it as a key prefix",
"type": "string",
"location": "query"
},
"fallback": {
"description": "Fallback locale for untranslated assets, specified as short code. e.g. `en` or `en_GB`",
"type": "string",
Expand Down Expand Up @@ -324,6 +329,11 @@
"text"
]
},
"namespace": {
"description": "Override the project name for some language packs that use it as a key prefix",
"type": "string",
"location": "query"
},
"fallback": {
"description": "Fallback locale for untranslated assets, specified as short code. e.g. `en` or `en_GB`",
"type": "string",
Expand Down Expand Up @@ -422,6 +432,11 @@
"text"
]
},
"namespace": {
"description": "Override the project name for some language packs that use it as a key prefix",
"type": "string",
"location": "query"
},
"fallback": {
"description": "Fallback locale for untranslated assets, specified as short code. e.g. `en` or `en_GB`",
"type": "string",
Expand Down Expand Up @@ -594,7 +609,7 @@
"class": "\\Loco\\Http\\Command\\LocoCommand",
"responseClass": "Creds",
"responseType": "model",
"responseNotes": "Loco API keys authenticate your user account for accessing a specific project.<br \/>\n This endpoint verifies an API key and returns the authenticated user, account and project.",
"responseNotes": "<p>Loco API keys authenticate your user account for accessing a specific project.<br \/>\n This endpoint verifies an API key and returns the authenticated user, account and project.<\/p>\n <p>If you want to verify whether the key has read or write access, just send this endpoint a POST request instead. Read only keys will respond 403 to any non-GET request.<\/p>",
"summary": "Verify an API project key",
"parameters": {
"key": {
Expand All @@ -608,6 +623,10 @@
{
"code": 401,
"phrase": "Invalid API key"
},
{
"code": 403,
"phrase": "Insufficient privileges"
}
]
},
Expand Down
30 changes: 27 additions & 3 deletions src/Http/Resources/service.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* Auto-generated with Swizzle at 2015-06-12 00:06:40 +0100
* Auto-generated with Swizzle at 2015-06-20 15:18:55 +0100
*/
return array (
'name' => 'Loco',
Expand Down Expand Up @@ -286,6 +286,12 @@
2 => 'text',
),
),
'namespace' =>
array (
'description' => 'Override the project name for some language packs that use it as a key prefix',
'type' => 'string',
'location' => 'query',
),
'fallback' =>
array (
'description' => 'Fallback locale for untranslated assets, specified as short code. e.g. `en` or `en_GB`',
Expand Down Expand Up @@ -393,6 +399,12 @@
2 => 'text',
),
),
'namespace' =>
array (
'description' => 'Override the project name for some language packs that use it as a key prefix',
'type' => 'string',
'location' => 'query',
),
'fallback' =>
array (
'description' => 'Fallback locale for untranslated assets, specified as short code. e.g. `en` or `en_GB`',
Expand Down Expand Up @@ -507,6 +519,12 @@
2 => 'text',
),
),
'namespace' =>
array (
'description' => 'Override the project name for some language packs that use it as a key prefix',
'type' => 'string',
'location' => 'query',
),
'fallback' =>
array (
'description' => 'Fallback locale for untranslated assets, specified as short code. e.g. `en` or `en_GB`',
Expand Down Expand Up @@ -720,8 +738,9 @@
'class' => '\\Loco\\Http\\Command\\LocoCommand',
'responseClass' => 'Creds',
'responseType' => 'model',
'responseNotes' => 'Loco API keys authenticate your user account for accessing a specific project.<br />
This endpoint verifies an API key and returns the authenticated user, account and project.',
'responseNotes' => '<p>Loco API keys authenticate your user account for accessing a specific project.<br />
This endpoint verifies an API key and returns the authenticated user, account and project.</p>
<p>If you want to verify whether the key has read or write access, just send this endpoint a POST request instead. Read only keys will respond 403 to any non-GET request.</p>',
'summary' => 'Verify an API project key',
'parameters' =>
array (
Expand All @@ -740,6 +759,11 @@
'code' => 401,
'phrase' => 'Invalid API key',
),
1 =>
array (
'code' => 403,
'phrase' => 'Insufficient privileges',
),
),
),
'getAssets' =>
Expand Down

0 comments on commit 786c5f7

Please sign in to comment.