October 2020 api spec update (#96)

* sort endpoint parameters by their name, and auto-merge conversation and user objects
* updated spec and regenerated patch file
* re-generated SDK classes
* upgraded to Jane 6.2

* Improve the Changelog
Co-authored-by: Damien ALEXANDRE <mobman02@gmail.com>

Author: xavierlacot

CHANGELOG.md

@@ -1,5 +1,26 @@
 # Changes between versions
 
+## Unreleased
+
+* **Breaking** Specification update to latest Slack official version - see slackapi/slack-api-specs#44
+  * added methods:
+    * `/admin.conversations.*`
+    * `/admin.usergroups.*`
+    * `/admin.users.session.invalidate`
+    * `/apps.event.authorizations.list`
+    * `/calls.*`
+    * `/conversations.mark`
+    * `/workflows.*`
+  * removed methods:
+    * `/im*`
+    * `/mpim*`
+    * `/channels*`
+    * `/groups*`
+* ease up the patching process:
+  * in the patched json file, sort endpoint query parameters by their `name` attributes, to keep a consistent order
+  * auto-merge `objs_user` and `objs_conversation` polymorphic properties in order to keep the patch hunks as small as possible
+* Upgrade to JanePHP version 6.2
+
 ## 3.0.2 (2020-10-20)
 
 * **Specification override** Allow string and integer for the "post_at" field in chatScheduleMessage

composer.json

@@ -23,14 +23,14 @@
     },
     "require": {
         "php": ">= 7.2",
-        "jane-php/open-api-runtime": "~6.1.0",
+        "jane-php/open-api-runtime": "~6.2.0",
         "psr/http-client-implementation": "*",
         "php-http/client-common": "^1.9 || ^2.0",
         "php-http/discovery": "^1.7",
         "php-http/multipart-stream-builder": "^1.1"
     },
     "require-dev": {
-        "jane-php/open-api-2": "~6.1.0",
+        "jane-php/open-api-2": "~6.2.0",
         "symfony/http-client": "^4.3.3 || ^5.1",
         "nyholm/psr7": "^1.2",
         "friendsofphp/php-cs-fixer": "^2.16",

doc/updating-sdk.md

@@ -24,6 +24,14 @@ You can now build a new SDK using this patched specification.
 
 ## Regenerate the SDk
 
+If you suspect that some endpoints or models have been removed, first remove all the content
+of the `generated` directory:
+
+```bash
+rm -Rf generated/*
+```
+
+
 When the versioned specification has been updated, you can run Jane to regenerate the SDK:
 
 ```bash
@@ -43,4 +51,9 @@ a new specification bug, here is the process to propose changes:
 ./bin/slack-api-client-generator spec:generate-patch
 ```
 
-It will create a new version of the cumulative patch in `resources`.
+It will create a new version of the cumulative patch in the `resources` directory. Before pushing
+changes, you can check that the patch is correctly re-applied:
+
+```bash
+./bin/slack-api-client-generator spec:update
+```

generated/Client.php

@@ -13,18 +13,18 @@
 
 namespace JoliCode\Slack\Api\Endpoint;
 
-class AdminAppsApprove extends \Jane\OpenApiRuntime\Client\BaseEndpoint implements \Jane\OpenApiRuntime\Client\Endpoint
+class AdminAppsApprove extends \JoliCode\Slack\Api\Runtime\Client\BaseEndpoint implements \JoliCode\Slack\Api\Runtime\Client\Endpoint
 {
-    use \Jane\OpenApiRuntime\Client\EndpointTrait;
+    use \JoliCode\Slack\Api\Runtime\Client\EndpointTrait;
 
     /**
      * Approve an app for installation on a workspace.
      *
      * @param array $formParameters {
      *
-     *     @var string $team_id
      *     @var string $app_id the id of the app to approve
-     *     @var string $request_id The id of the request to approve.
+     *     @var string $request_id the id of the request to approve
+     *     @var string $team_id
      * }
      *
      * @param array $headerParameters {
@@ -66,12 +66,12 @@ public function getAuthenticationScopes(): array
     protected function getFormOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
     {
         $optionsResolver = parent::getFormOptionsResolver();
-        $optionsResolver->setDefined(['team_id', 'app_id', 'request_id']);
+        $optionsResolver->setDefined(['app_id', 'request_id', 'team_id']);
         $optionsResolver->setRequired([]);
         $optionsResolver->setDefaults([]);
-        $optionsResolver->setAllowedTypes('team_id', ['string']);
         $optionsResolver->setAllowedTypes('app_id', ['string']);
         $optionsResolver->setAllowedTypes('request_id', ['string']);
+        $optionsResolver->setAllowedTypes('team_id', ['string']);
 
         return $optionsResolver;
     }

generated/Endpoint/AdminAppsApprove.php

@@ -13,20 +13,20 @@
 
 namespace JoliCode\Slack\Api\Endpoint;
 
-class AdminAppsApprovedList extends \Jane\OpenApiRuntime\Client\BaseEndpoint implements \Jane\OpenApiRuntime\Client\Endpoint
+class AdminAppsApprovedList extends \JoliCode\Slack\Api\Runtime\Client\BaseEndpoint implements \JoliCode\Slack\Api\Runtime\Client\Endpoint
 {
-    use \Jane\OpenApiRuntime\Client\EndpointTrait;
+    use \JoliCode\Slack\Api\Runtime\Client\EndpointTrait;
 
     /**
      * List approved apps for an org or workspace.
      *
      * @param array $queryParameters {
      *
      *     @var string $cursor Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
-     *     @var string $token Authentication token. Requires scope: `admin.apps:read`
+     *     @var string $enterprise_id
      *     @var int $limit The maximum number of items to return. Must be between 1 - 1000 both inclusive.
      *     @var string $team_id
-     *     @var string $enterprise_id
+     *     @var string $token Authentication token. Requires scope: `admin.apps:read`
      * }
      */
     public function __construct(array $queryParameters = [])
@@ -62,14 +62,14 @@ public function getAuthenticationScopes(): array
     protected function getQueryOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
     {
         $optionsResolver = parent::getQueryOptionsResolver();
-        $optionsResolver->setDefined(['cursor', 'token', 'limit', 'team_id', 'enterprise_id']);
+        $optionsResolver->setDefined(['cursor', 'enterprise_id', 'limit', 'team_id', 'token']);
         $optionsResolver->setRequired([]);
         $optionsResolver->setDefaults([]);
         $optionsResolver->setAllowedTypes('cursor', ['string']);
-        $optionsResolver->setAllowedTypes('token', ['string']);
+        $optionsResolver->setAllowedTypes('enterprise_id', ['string']);
         $optionsResolver->setAllowedTypes('limit', ['int']);
         $optionsResolver->setAllowedTypes('team_id', ['string']);
-        $optionsResolver->setAllowedTypes('enterprise_id', ['string']);
+        $optionsResolver->setAllowedTypes('token', ['string']);
 
         return $optionsResolver;
     }

generated/Endpoint/AdminAppsApprovedList.php

@@ -13,19 +13,19 @@
 
 namespace JoliCode\Slack\Api\Endpoint;
 
-class AdminAppsRequestsList extends \Jane\OpenApiRuntime\Client\BaseEndpoint implements \Jane\OpenApiRuntime\Client\Endpoint
+class AdminAppsRequestsList extends \JoliCode\Slack\Api\Runtime\Client\BaseEndpoint implements \JoliCode\Slack\Api\Runtime\Client\Endpoint
 {
-    use \Jane\OpenApiRuntime\Client\EndpointTrait;
+    use \JoliCode\Slack\Api\Runtime\Client\EndpointTrait;
 
     /**
      * List app requests for a team/workspace.
      *
      * @param array $queryParameters {
      *
      *     @var string $cursor Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
-     *     @var string $token Authentication token. Requires scope: `admin.apps:read`
      *     @var int $limit The maximum number of items to return. Must be between 1 - 1000 both inclusive.
      *     @var string $team_id
+     *     @var string $token Authentication token. Requires scope: `admin.apps:read`
      * }
      */
     public function __construct(array $queryParameters = [])
@@ -61,13 +61,13 @@ public function getAuthenticationScopes(): array
     protected function getQueryOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
     {
         $optionsResolver = parent::getQueryOptionsResolver();
-        $optionsResolver->setDefined(['cursor', 'token', 'limit', 'team_id']);
+        $optionsResolver->setDefined(['cursor', 'limit', 'team_id', 'token']);
         $optionsResolver->setRequired([]);
         $optionsResolver->setDefaults([]);
         $optionsResolver->setAllowedTypes('cursor', ['string']);
-        $optionsResolver->setAllowedTypes('token', ['string']);
         $optionsResolver->setAllowedTypes('limit', ['int']);
         $optionsResolver->setAllowedTypes('team_id', ['string']);
+        $optionsResolver->setAllowedTypes('token', ['string']);
 
         return $optionsResolver;
     }

generated/Endpoint/AdminAppsRequestsList.php

@@ -13,18 +13,18 @@
 
 namespace JoliCode\Slack\Api\Endpoint;
 
-class AdminAppsRestrict extends \Jane\OpenApiRuntime\Client\BaseEndpoint implements \Jane\OpenApiRuntime\Client\Endpoint
+class AdminAppsRestrict extends \JoliCode\Slack\Api\Runtime\Client\BaseEndpoint implements \JoliCode\Slack\Api\Runtime\Client\Endpoint
 {
-    use \Jane\OpenApiRuntime\Client\EndpointTrait;
+    use \JoliCode\Slack\Api\Runtime\Client\EndpointTrait;
 
     /**
      * Restrict an app for installation on a workspace.
      *
      * @param array $formParameters {
      *
-     *     @var string $team_id
      *     @var string $app_id the id of the app to restrict
-     *     @var string $request_id The id of the request to restrict.
+     *     @var string $request_id the id of the request to restrict
+     *     @var string $team_id
      * }
      *
      * @param array $headerParameters {
@@ -66,12 +66,12 @@ public function getAuthenticationScopes(): array
     protected function getFormOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
     {
         $optionsResolver = parent::getFormOptionsResolver();
-        $optionsResolver->setDefined(['team_id', 'app_id', 'request_id']);
+        $optionsResolver->setDefined(['app_id', 'request_id', 'team_id']);
         $optionsResolver->setRequired([]);
         $optionsResolver->setDefaults([]);
-        $optionsResolver->setAllowedTypes('team_id', ['string']);
         $optionsResolver->setAllowedTypes('app_id', ['string']);
         $optionsResolver->setAllowedTypes('request_id', ['string']);
+        $optionsResolver->setAllowedTypes('team_id', ['string']);
 
         return $optionsResolver;
     }

generated/Endpoint/AdminAppsRestrict.php

@@ -13,20 +13,20 @@
 
 namespace JoliCode\Slack\Api\Endpoint;
 
-class AdminAppsRestrictedList extends \Jane\OpenApiRuntime\Client\BaseEndpoint implements \Jane\OpenApiRuntime\Client\Endpoint
+class AdminAppsRestrictedList extends \JoliCode\Slack\Api\Runtime\Client\BaseEndpoint implements \JoliCode\Slack\Api\Runtime\Client\Endpoint
 {
-    use \Jane\OpenApiRuntime\Client\EndpointTrait;
+    use \JoliCode\Slack\Api\Runtime\Client\EndpointTrait;
 
     /**
      * List restricted apps for an org or workspace.
      *
      * @param array $queryParameters {
      *
      *     @var string $cursor Set `cursor` to `next_cursor` returned by the previous call to list items in the next page
-     *     @var string $token Authentication token. Requires scope: `admin.apps:read`
+     *     @var string $enterprise_id
      *     @var int $limit The maximum number of items to return. Must be between 1 - 1000 both inclusive.
      *     @var string $team_id
-     *     @var string $enterprise_id
+     *     @var string $token Authentication token. Requires scope: `admin.apps:read`
      * }
      */
     public function __construct(array $queryParameters = [])
@@ -62,14 +62,14 @@ public function getAuthenticationScopes(): array
     protected function getQueryOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
     {
         $optionsResolver = parent::getQueryOptionsResolver();
-        $optionsResolver->setDefined(['cursor', 'token', 'limit', 'team_id', 'enterprise_id']);
+        $optionsResolver->setDefined(['cursor', 'enterprise_id', 'limit', 'team_id', 'token']);
         $optionsResolver->setRequired([]);
         $optionsResolver->setDefaults([]);
         $optionsResolver->setAllowedTypes('cursor', ['string']);
-        $optionsResolver->setAllowedTypes('token', ['string']);
+        $optionsResolver->setAllowedTypes('enterprise_id', ['string']);
         $optionsResolver->setAllowedTypes('limit', ['int']);
         $optionsResolver->setAllowedTypes('team_id', ['string']);
-        $optionsResolver->setAllowedTypes('enterprise_id', ['string']);
+        $optionsResolver->setAllowedTypes('token', ['string']);
 
         return $optionsResolver;
     }

generated/Endpoint/AdminAppsRestrictedList.php

@@ -13,21 +13,21 @@
 
 namespace JoliCode\Slack\Api\Endpoint;
 
-class ChannelsLeave extends \Jane\OpenApiRuntime\Client\BaseEndpoint implements \Jane\OpenApiRuntime\Client\Endpoint
+class AdminConversationsArchive extends \JoliCode\Slack\Api\Runtime\Client\BaseEndpoint implements \JoliCode\Slack\Api\Runtime\Client\Endpoint
 {
-    use \Jane\OpenApiRuntime\Client\EndpointTrait;
+    use \JoliCode\Slack\Api\Runtime\Client\EndpointTrait;
 
     /**
-     * Leaves a channel.
+     * Archive a public or private channel.
      *
      * @param array $formParameters {
      *
-     *     @var string $channel Channel to leave
+     *     @var string $channel_id The channel to archive.
      * }
      *
      * @param array $headerParameters {
      *
-     *     @var string $token Authentication token. Requires scope: `channels:write`
+     *     @var string $token Authentication token. Requires scope: `admin.conversations:write`
      * }
      */
     public function __construct(array $formParameters = [], array $headerParameters = [])
@@ -43,7 +43,7 @@ public function getMethod(): string
 
     public function getUri(): string
     {
-        return '/channels.leave';
+        return '/admin.conversations.archive';
     }
 
     public function getBody(\Symfony\Component\Serializer\SerializerInterface $serializer, $streamFactory = null): array
@@ -64,10 +64,10 @@ public function getAuthenticationScopes(): array
     protected function getFormOptionsResolver(): \Symfony\Component\OptionsResolver\OptionsResolver
     {
         $optionsResolver = parent::getFormOptionsResolver();
-        $optionsResolver->setDefined(['channel']);
-        $optionsResolver->setRequired([]);
+        $optionsResolver->setDefined(['channel_id']);
+        $optionsResolver->setRequired(['channel_id']);
         $optionsResolver->setDefaults([]);
-        $optionsResolver->setAllowedTypes('channel', ['string']);
+        $optionsResolver->setAllowedTypes('channel_id', ['string']);
 
         return $optionsResolver;
     }
@@ -86,14 +86,14 @@ protected function getHeadersOptionsResolver(): \Symfony\Component\OptionsResolv
     /**
      * {@inheritdoc}
      *
-     * @return \JoliCode\Slack\Api\Model\ChannelsLeavePostResponse200|\JoliCode\Slack\Api\Model\ChannelsLeavePostResponsedefault|null
+     * @return \JoliCode\Slack\Api\Model\AdminConversationsArchivePostResponse200|\JoliCode\Slack\Api\Model\AdminConversationsArchivePostResponsedefault|null
      */
     protected function transformResponseBody(string $body, int $status, \Symfony\Component\Serializer\SerializerInterface $serializer, ?string $contentType)
     {
         if (200 === $status) {
-            return $serializer->deserialize($body, 'JoliCode\\Slack\\Api\\Model\\ChannelsLeavePostResponse200', 'json');
+            return $serializer->deserialize($body, 'JoliCode\\Slack\\Api\\Model\\AdminConversationsArchivePostResponse200', 'json');
         }
 
-        return $serializer->deserialize($body, 'JoliCode\\Slack\\Api\\Model\\ChannelsLeavePostResponsedefault', 'json');
+        return $serializer->deserialize($body, 'JoliCode\\Slack\\Api\\Model\\AdminConversationsArchivePostResponsedefault', 'json');
     }
 }