From 32f9e4a48c95526f4c0c8b7fa743e97428ac1795 Mon Sep 17 00:00:00 2001 From: Gary Gitton Date: Tue, 31 Jul 2018 05:28:13 +0200 Subject: [PATCH 1/2] add operation id to documentation --- src/ApiFactory.php | 15 +++++++++++++++ src/Operation.php | 22 ++++++++++++++++++++++ 2 files changed, 37 insertions(+) diff --git a/src/ApiFactory.php b/src/ApiFactory.php index e8cf9e9..a99232e 100644 --- a/src/ApiFactory.php +++ b/src/ApiFactory.php @@ -223,6 +223,11 @@ public function createService(Api $api, $serviceName) $op->setHttpMethod($httpMethod); if ($isRest) { + $operationId = isset($docsArray[$serviceClassName]['collection'][$httpMethod]['operationId']) + ? $docsArray[$serviceClassName]['collection'][$httpMethod]['operationId'] + : ''; + $op->setOperationId($operationId); + $description = isset($docsArray[$serviceClassName]['collection'][$httpMethod]['description']) ? $docsArray[$serviceClassName]['collection'][$httpMethod]['description'] : ''; @@ -253,6 +258,11 @@ public function createService(Api $api, $serviceName) } if ($isRpc) { + $operationId = isset($docsArray[$serviceClassName][$httpMethod]['operationId']) + ? $docsArray[$serviceClassName][$httpMethod]['operationId'] + : ''; + $op->setOperationId($operationId); + $description = isset($docsArray[$serviceClassName][$httpMethod]['description']) ? $docsArray[$serviceClassName][$httpMethod]['description'] : ''; @@ -293,6 +303,11 @@ public function createService(Api $api, $serviceName) $op = new Operation(); $op->setHttpMethod($httpMethod); + $operationId = isset($docsArray[$serviceClassName]['entity'][$httpMethod]['operationId']) + ? $docsArray[$serviceClassName]['entity'][$httpMethod]['operationId'] + : ''; + $op->setOperationId($operationId); + $description = isset($docsArray[$serviceClassName]['entity'][$httpMethod]['description']) ? $docsArray[$serviceClassName]['entity'][$httpMethod]['description'] : ''; diff --git a/src/Operation.php b/src/Operation.php index 2b0b03a..56abae2 100644 --- a/src/Operation.php +++ b/src/Operation.php @@ -16,6 +16,11 @@ class Operation implements IteratorAggregate */ protected $httpMethod; + /** + * @var string + */ + protected $operationId; + /** * @var string */ @@ -61,6 +66,22 @@ public function getHttpMethod() return $this->httpMethod; } + /** + * @param string $operationId + */ + public function setOperationId($operationId) + { + $this->operationId = $operationId; + } + + /** + * @return string + */ + public function getOperationId() + { + return $this->operationId; + } + /** * @param string $description */ @@ -149,6 +170,7 @@ public function getResponseStatusCodes() public function toArray() { return [ + 'operationId' => $this->operationId, 'description' => $this->description, 'request' => $this->requestDescription, 'requires_authorization' => $this->requiresAuthorization, From 6fa8a462a2abbf948a1b3131145422e96634f0ff Mon Sep 17 00:00:00 2001 From: Gary Gitton Date: Fri, 14 Sep 2018 17:16:16 +0200 Subject: [PATCH 2/2] rename operationId to identifier --- src/ApiFactory.php | 18 +++++++++--------- src/Operation.php | 14 +++++++------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/src/ApiFactory.php b/src/ApiFactory.php index a99232e..106164c 100644 --- a/src/ApiFactory.php +++ b/src/ApiFactory.php @@ -223,10 +223,10 @@ public function createService(Api $api, $serviceName) $op->setHttpMethod($httpMethod); if ($isRest) { - $operationId = isset($docsArray[$serviceClassName]['collection'][$httpMethod]['operationId']) - ? $docsArray[$serviceClassName]['collection'][$httpMethod]['operationId'] + $identifier = isset($docsArray[$serviceClassName]['collection'][$httpMethod]['identifier']) + ? $docsArray[$serviceClassName]['collection'][$httpMethod]['identifier'] : ''; - $op->setOperationId($operationId); + $op->setIdentifier($identifier); $description = isset($docsArray[$serviceClassName]['collection'][$httpMethod]['description']) ? $docsArray[$serviceClassName]['collection'][$httpMethod]['description'] @@ -258,10 +258,10 @@ public function createService(Api $api, $serviceName) } if ($isRpc) { - $operationId = isset($docsArray[$serviceClassName][$httpMethod]['operationId']) - ? $docsArray[$serviceClassName][$httpMethod]['operationId'] + $identifier = isset($docsArray[$serviceClassName][$httpMethod]['identifier']) + ? $docsArray[$serviceClassName][$httpMethod]['identifier'] : ''; - $op->setOperationId($operationId); + $op->setIdentifier($identifier); $description = isset($docsArray[$serviceClassName][$httpMethod]['description']) ? $docsArray[$serviceClassName][$httpMethod]['description'] @@ -303,10 +303,10 @@ public function createService(Api $api, $serviceName) $op = new Operation(); $op->setHttpMethod($httpMethod); - $operationId = isset($docsArray[$serviceClassName]['entity'][$httpMethod]['operationId']) - ? $docsArray[$serviceClassName]['entity'][$httpMethod]['operationId'] + $identifier = isset($docsArray[$serviceClassName]['entity'][$httpMethod]['identifier']) + ? $docsArray[$serviceClassName]['entity'][$httpMethod]['identifier'] : ''; - $op->setOperationId($operationId); + $op->setIdentifier($identifier); $description = isset($docsArray[$serviceClassName]['entity'][$httpMethod]['description']) ? $docsArray[$serviceClassName]['entity'][$httpMethod]['description'] diff --git a/src/Operation.php b/src/Operation.php index 56abae2..30b6443 100644 --- a/src/Operation.php +++ b/src/Operation.php @@ -19,7 +19,7 @@ class Operation implements IteratorAggregate /** * @var string */ - protected $operationId; + protected $identifier; /** * @var string @@ -67,19 +67,19 @@ public function getHttpMethod() } /** - * @param string $operationId + * @param string $identifier */ - public function setOperationId($operationId) + public function setIdentifier($identifier) { - $this->operationId = $operationId; + $this->identifier = $identifier; } /** * @return string */ - public function getOperationId() + public function getIdentifier() { - return $this->operationId; + return $this->identifier; } /** @@ -170,7 +170,7 @@ public function getResponseStatusCodes() public function toArray() { return [ - 'operationId' => $this->operationId, + 'identifier' => $this->identifier, 'description' => $this->description, 'request' => $this->requestDescription, 'requires_authorization' => $this->requiresAuthorization,