Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
…ent the api-docs.json with metadata. Also updated wordnik/swagger-core/wiki/ urls to the wordnik/swagger-spec/
- Loading branch information
Showing
21 changed files
with
559 additions
and
122 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| <?php | ||
|
|
||
| namespace Swagger\Annotations; | ||
|
|
||
| /** | ||
| * @license http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Copyright [2013] [Robert Allen] | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * @package | ||
| * @category | ||
| * @subpackage | ||
| */ | ||
| use Swagger\Logger; | ||
|
|
||
| /** | ||
| * Provide information about the authorization schemes provided on this API. | ||
| * @link https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#514-authorizations-object | ||
| * | ||
| * @package | ||
| * @category | ||
| * @subpackage | ||
| * | ||
| * @Annotation | ||
| */ | ||
| class Authorization extends AbstractAnnotation | ||
| { | ||
|
|
||
| /** | ||
| * The type of the authorization scheme. | ||
| * @var string | ||
| */ | ||
| public $type; | ||
|
|
||
| /** | ||
| * Denotes how the API key must be passed. Valid values are "header" or "query". | ||
| * @var string | ||
| */ | ||
| public $passAs; | ||
|
|
||
| /** | ||
| * The name of the header or query parameter to be used when passing the API key. | ||
| * @var string | ||
| */ | ||
| public $keyname; | ||
|
|
||
| /** | ||
| * A list of supported OAuth2 scopes. | ||
| * @var Scope[] | ||
| */ | ||
| public $scopes; | ||
|
|
||
| /** | ||
| * Detailed information about the grant types supported by the OAuth2 authorization scheme. | ||
| * @var object | ||
| */ | ||
| public $grantTypes; | ||
|
|
||
| protected static $mapAnnotations = array( | ||
| '\Swagger\Annotations\Scope' => 'scopes[]' | ||
| ); | ||
|
|
||
| public function validate() { | ||
| if (in_array($this->type, array('basicAuth', 'apiKey', 'oauth2')) === false) { | ||
| Logger::warning('Unexpected '.$this->identity().'->type "'.$this->type.'", expection "basicAuth", "apiKey" or "oauth2" in '.$this->_context); | ||
| return false; | ||
| } | ||
| if ($this->type === 'apiKey' && (empty($this->passAs) || empty($this->keyname))) { | ||
| Logger::notice('Fields "passAs" and "keyname" are required for '.$this->identity().'->type "apiKey" in '.$this->_context); | ||
| } | ||
| return true; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| <?php | ||
|
|
||
| namespace Swagger\Annotations; | ||
|
|
||
| /** | ||
| * @license http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Copyright [2013] [Robert Allen] | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| * | ||
| * @package | ||
| * @category | ||
| * @subpackage | ||
| */ | ||
| use Swagger\Logger; | ||
|
|
||
| /** | ||
| * Describes the metadata about the API. | ||
| * @link https://github.com/wordnik/swagger-spec/blob/master/versions/1.2.md#513-info-object | ||
| * | ||
| * @package | ||
| * @category | ||
| * @subpackage | ||
| * | ||
| * @Annotation | ||
| */ | ||
| class Info extends AbstractAnnotation | ||
| { | ||
|
|
||
| /** | ||
| * The title of the application. | ||
| * @var string | ||
| */ | ||
| public $title; | ||
|
|
||
| /** | ||
| * A short description of the application. | ||
| * @var string | ||
| */ | ||
| public $description; | ||
|
|
||
| /** | ||
| * A URL to the Terms of Service of the API. | ||
| * @var string | ||
| */ | ||
| public $termsOfServiceUrl; | ||
|
|
||
| /** | ||
| * An email to be used for API-related correspondence. | ||
| * @var string | ||
| */ | ||
| public $contact; | ||
|
|
||
| /** | ||
| * The license name used for the API. | ||
| * @var string | ||
| */ | ||
| public $license; | ||
|
|
||
| /** | ||
| * A URL to the license used for the API. | ||
| * @var string | ||
| */ | ||
| public $licenseUrl; | ||
|
|
||
| public function validate() | ||
| { | ||
| foreach (array('title', 'description') as $required) { | ||
| if (empty($this->$required)) { | ||
| Logger::notice('Required field "'.$required.'" is missing for "'.$this->identity().'" in '.$this->_context); | ||
| return false; | ||
| } | ||
| } | ||
| return true; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.