Skip to content
This repository was archived by the owner on Mar 28, 2025. It is now read-only.

Commit ecbef86

Browse files
dmetznerdmetzner
authored
Merge pull request #159 from Catrobat/create-pull-request/patch-1725103132
Bump autogenerated OpenAPI code
2 parents b58ef4a + 7e9b0d8 commit ecbef86

10 files changed

+399
-35
lines changed

‎Api/AuthenticationApiInterface.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public function authenticationDelete(
7070
/**
7171
* Operation authenticationGet.
7272
*
73-
* Check token
73+
* Check JWT token validity
7474
*
7575
* @param int &$responseCode The HTTP Response Code
7676
* @param array $responseHeaders Additional HTTP headers to return with the response ()
@@ -98,7 +98,7 @@ public function authenticationOauthPost(
9898
/**
9999
* Operation authenticationPost.
100100
*
101-
* Login
101+
* Login - create a new JWT token
102102
*
103103
* @param LoginRequest $login_request (required)
104104
* @param int &$responseCode The HTTP Response Code

‎Api/StudioApiInterface.php

+37-3
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,43 @@ interface StudioApiInterface
5050
public function setBearerAuth(?string $value): void;
5151

5252
/**
53-
* Operation studioIdPut.
53+
* Operation studioIdDelete.
5454
*
55-
* Update a Studio
55+
* Delete a studio (only available to studio admins)
56+
*
57+
* @param string $id (required)
58+
* @param string $accept_language (optional, default to 'en')
59+
* @param int &$responseCode The HTTP Response Code
60+
* @param array $responseHeaders Additional HTTP headers to return with the response ()
61+
*/
62+
public function studioIdDelete(
63+
string $id,
64+
string $accept_language,
65+
int &$responseCode,
66+
array &$responseHeaders
67+
): void;
68+
69+
/**
70+
* Operation studioIdGet.
71+
*
72+
* Get studio details (private studios are only available to members)
73+
*
74+
* @param string $id (required)
75+
* @param string $accept_language (optional, default to 'en')
76+
* @param int &$responseCode The HTTP Response Code
77+
* @param array $responseHeaders Additional HTTP headers to return with the response ()
78+
*/
79+
public function studioIdGet(
80+
string $id,
81+
string $accept_language,
82+
int &$responseCode,
83+
array &$responseHeaders
84+
): array|object|null;
85+
86+
/**
87+
* Operation studioIdPost.
88+
*
89+
* Update a Studio (only available to studio admins)
5690
*
5791
* @param string $id (required)
5892
* @param string $accept_language (optional, default to 'en')
@@ -64,7 +98,7 @@ public function setBearerAuth(?string $value): void;
6498
* @param int &$responseCode The HTTP Response Code
6599
* @param array $responseHeaders Additional HTTP headers to return with the response ()
66100
*/
67-
public function studioIdPut(
101+
public function studioIdPost(
68102
string $id,
69103
string $accept_language,
70104
?string $name,

‎Controller/AuthenticationController.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ public function authenticationDeleteAction(Request $request)
123123
/**
124124
* Operation authenticationGet.
125125
*
126-
* Check token
126+
* Check JWT token validity
127127
*
128128
* @param Request $request the Symfony request to handle
129129
*
@@ -265,7 +265,7 @@ public function authenticationOauthPostAction(Request $request)
265265
/**
266266
* Operation authenticationPost.
267267
*
268-
* Login
268+
* Login - create a new JWT token
269269
*
270270
* @param Request $request the Symfony request to handle
271271
*

‎Controller/StudioController.php

+172-4
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,183 @@
4848
class StudioController extends Controller
4949
{
5050
/**
51-
* Operation studioIdPut.
51+
* Operation studioIdDelete.
5252
*
53-
* Update a Studio
53+
* Delete a studio (only available to studio admins)
5454
*
5555
* @param Request $request the Symfony request to handle
5656
*
5757
* @return Response the Symfony response
5858
*/
59-
public function studioIdPutAction(Request $request, $id)
59+
public function studioIdDeleteAction(Request $request, $id)
60+
{
61+
// Handle authentication
62+
// Authentication 'BearerAuth' required
63+
// HTTP bearer authentication required
64+
$securityBearerAuth = $request->headers->get('authorization');
65+
66+
// Read out all input parameter values into variables
67+
$accept_language = $request->headers->get('Accept-Language', 'en');
68+
69+
// Use the default value if no value was provided
70+
71+
// Deserialize the input values that needs it
72+
try {
73+
$id = $this->deserialize($id, 'string', 'string');
74+
$accept_language = $this->deserialize($accept_language, 'string', 'string');
75+
} catch (SerializerRuntimeException $exception) {
76+
return $this->createBadRequestResponse($exception->getMessage());
77+
}
78+
79+
// Validate the input values
80+
$asserts = [];
81+
$asserts[] = new Assert\NotNull();
82+
$asserts[] = new Assert\Type('string');
83+
$asserts[] = new Assert\Regex('/^[a-zA-Z0-9\\-]+$/');
84+
$response = $this->validate($id, $asserts);
85+
if ($response instanceof Response) {
86+
return $response;
87+
}
88+
$asserts = [];
89+
$asserts[] = new Assert\Type('string');
90+
$response = $this->validate($accept_language, $asserts);
91+
if ($response instanceof Response) {
92+
return $response;
93+
}
94+
95+
try {
96+
$handler = $this->getApiHandler();
97+
98+
// Set authentication method 'BearerAuth'
99+
$handler->setBearerAuth($securityBearerAuth);
100+
101+
// Make the call to the business logic
102+
$responseCode = 204;
103+
$responseHeaders = [];
104+
105+
$handler->studioIdDelete($id, $accept_language, $responseCode, $responseHeaders);
106+
107+
$message = match ($responseCode) {
108+
204 => 'OK',
109+
400 => 'Bad request (Invalid, or missing parameters)',
110+
401 => 'Invalid JWT token | JWT token not found | JWT token expired',
111+
403 => 'Insufficient privileges, action not allowed.',
112+
404 => 'Not found',
113+
406 => 'Not acceptable - client must accept application/json as content type',
114+
default => '',
115+
};
116+
117+
return new Response(
118+
'',
119+
$responseCode,
120+
array_merge(
121+
$responseHeaders,
122+
[
123+
'X-OpenAPI-Message' => $message,
124+
]
125+
)
126+
);
127+
} catch (\Throwable $fallthrough) {
128+
return $this->createErrorResponse(new HttpException(500, 'An unsuspected error occurred.', $fallthrough));
129+
}
130+
}
131+
132+
/**
133+
* Operation studioIdGet.
134+
*
135+
* Get studio details (private studios are only available to members)
136+
*
137+
* @param Request $request the Symfony request to handle
138+
*
139+
* @return Response the Symfony response
140+
*/
141+
public function studioIdGetAction(Request $request, $id)
142+
{
143+
// Figure out what data format to return to the client
144+
$produces = ['application/json'];
145+
// Figure out what the client accepts
146+
$clientAccepts = $request->headers->has('Accept') ? $request->headers->get('Accept') : '*/*';
147+
$responseFormat = $this->getOutputFormat($clientAccepts, $produces);
148+
if (null === $responseFormat) {
149+
return new Response('', 406);
150+
}
151+
152+
// Handle authentication
153+
154+
// Read out all input parameter values into variables
155+
$accept_language = $request->headers->get('Accept-Language', 'en');
156+
157+
// Use the default value if no value was provided
158+
159+
// Deserialize the input values that needs it
160+
try {
161+
$id = $this->deserialize($id, 'string', 'string');
162+
$accept_language = $this->deserialize($accept_language, 'string', 'string');
163+
} catch (SerializerRuntimeException $exception) {
164+
return $this->createBadRequestResponse($exception->getMessage());
165+
}
166+
167+
// Validate the input values
168+
$asserts = [];
169+
$asserts[] = new Assert\NotNull();
170+
$asserts[] = new Assert\Type('string');
171+
$asserts[] = new Assert\Regex('/^[a-zA-Z0-9\\-]+$/');
172+
$response = $this->validate($id, $asserts);
173+
if ($response instanceof Response) {
174+
return $response;
175+
}
176+
$asserts = [];
177+
$asserts[] = new Assert\Type('string');
178+
$response = $this->validate($accept_language, $asserts);
179+
if ($response instanceof Response) {
180+
return $response;
181+
}
182+
183+
try {
184+
$handler = $this->getApiHandler();
185+
186+
// Make the call to the business logic
187+
$responseCode = 200;
188+
$responseHeaders = [];
189+
190+
$result = $handler->studioIdGet($id, $accept_language, $responseCode, $responseHeaders);
191+
192+
$message = match ($responseCode) {
193+
200 => 'OK',
194+
400 => 'Bad request (Invalid, or missing parameters)',
195+
401 => 'Invalid JWT token | JWT token not found | JWT token expired',
196+
403 => 'Insufficient privileges, action not allowed.',
197+
404 => 'Not found',
198+
406 => 'Not acceptable - client must accept application/json as content type',
199+
default => '',
200+
};
201+
202+
return new Response(
203+
null !== $result ? $this->serialize($result, $responseFormat) : '',
204+
$responseCode,
205+
array_merge(
206+
$responseHeaders,
207+
[
208+
'Content-Type' => $responseFormat,
209+
'X-OpenAPI-Message' => $message,
210+
]
211+
)
212+
);
213+
} catch (\Throwable $fallthrough) {
214+
return $this->createErrorResponse(new HttpException(500, 'An unsuspected error occurred.', $fallthrough));
215+
}
216+
}
217+
218+
/**
219+
* Operation studioIdPost.
220+
*
221+
* Update a Studio (only available to studio admins)
222+
*
223+
* @param Request $request the Symfony request to handle
224+
*
225+
* @return Response the Symfony response
226+
*/
227+
public function studioIdPostAction(Request $request, $id)
60228
{
61229
// Figure out what data format to return to the client
62230
$produces = ['application/json'];
@@ -150,7 +318,7 @@ public function studioIdPutAction(Request $request, $id)
150318
$responseCode = 200;
151319
$responseHeaders = [];
152320

153-
$result = $handler->studioIdPut($id, $accept_language, $name, $description, $is_public, $enable_comments, $image_file, $responseCode, $responseHeaders);
321+
$result = $handler->studioIdPost($id, $accept_language, $name, $description, $is_public, $enable_comments, $image_file, $responseCode, $responseHeaders);
154322

155323
$message = match ($responseCode) {
156324
200 => 'Studio successfully updated.',

‎README.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,9 @@ All URIs are relative to *https://share.catrob.at/api*
112112
Class | Method | HTTP request | Description
113113
------------ | ------------- | ------------- | -------------
114114
*AuthenticationApiInterface* | [**authenticationDelete**](docs/Api/AuthenticationApiInterface.md#authenticationdelete) | **DELETE** /authentication | Expires refresh token
115-
*AuthenticationApiInterface* | [**authenticationGet**](docs/Api/AuthenticationApiInterface.md#authenticationget) | **GET** /authentication | Check token
115+
*AuthenticationApiInterface* | [**authenticationGet**](docs/Api/AuthenticationApiInterface.md#authenticationget) | **GET** /authentication | Check JWT token validity
116116
*AuthenticationApiInterface* | [**authenticationOauthPost**](docs/Api/AuthenticationApiInterface.md#authenticationoauthpost) | **POST** /authentication/oauth | OAuth Login
117-
*AuthenticationApiInterface* | [**authenticationPost**](docs/Api/AuthenticationApiInterface.md#authenticationpost) | **POST** /authentication | Login
117+
*AuthenticationApiInterface* | [**authenticationPost**](docs/Api/AuthenticationApiInterface.md#authenticationpost) | **POST** /authentication | Login - create a new JWT token
118118
*AuthenticationApiInterface* | [**authenticationRefreshPost**](docs/Api/AuthenticationApiInterface.md#authenticationrefreshpost) | **POST** /authentication/refresh | Refresh token
119119
*AuthenticationApiInterface* | [**authenticationUpgradePost**](docs/Api/AuthenticationApiInterface.md#authenticationupgradepost) | **POST** /authentication/upgrade | Upgrade a deprecated token to JWT
120120
*MediaLibraryApiInterface* | [**mediaFileIdGet**](docs/Api/MediaLibraryApiInterface.md#mediafileidget) | **GET** /media/file/{id} | Get the information of a specific media file
@@ -141,7 +141,9 @@ Class | Method | HTTP request | Description
141141
*ProjectsApiInterface* | [**projectsUserGet**](docs/Api/ProjectsApiInterface.md#projectsuserget) | **GET** /projects/user | Get the projects of the logged in user
142142
*ProjectsApiInterface* | [**projectsUserIdGet**](docs/Api/ProjectsApiInterface.md#projectsuseridget) | **GET** /projects/user/{id} | Get the public projects of a given user
143143
*SearchApiInterface* | [**searchGet**](docs/Api/SearchApiInterface.md#searchget) | **GET** /search | Search for projects, users,..
144-
*StudioApiInterface* | [**studioIdPut**](docs/Api/StudioApiInterface.md#studioidput) | **PUT** /studio/{id} | Update a Studio
144+
*StudioApiInterface* | [**studioIdDelete**](docs/Api/StudioApiInterface.md#studioiddelete) | **DELETE** /studio/{id} | Delete a studio (only available to studio admins)
145+
*StudioApiInterface* | [**studioIdGet**](docs/Api/StudioApiInterface.md#studioidget) | **GET** /studio/{id} | Get studio details (private studios are only available to members)
146+
*StudioApiInterface* | [**studioIdPost**](docs/Api/StudioApiInterface.md#studioidpost) | **POST** /studio/{id} | Update a Studio (only available to studio admins)
145147
*StudioApiInterface* | [**studioPost**](docs/Api/StudioApiInterface.md#studiopost) | **POST** /studio | Create a new Studio
146148
*UserApiInterface* | [**userDelete**](docs/Api/UserApiInterface.md#userdelete) | **DELETE** /user | Delete user account
147149
*UserApiInterface* | [**userGet**](docs/Api/UserApiInterface.md#userget) | **GET** /user | Get your private user data

‎Resources/config/routing.yaml

+19-3
Original file line numberDiff line numberDiff line change
@@ -208,11 +208,27 @@ open_api_server_search_searchget:
208208
_controller: open_api_server.controller.search::searchGetAction
209209

210210
# studio
211-
open_api_server_studio_studioidput:
211+
open_api_server_studio_studioiddelete:
212212
path: /studio/{id}
213-
methods: [PUT]
213+
methods: [DELETE]
214+
defaults:
215+
_controller: open_api_server.controller.studio::studioIdDeleteAction
216+
requirements:
217+
id: '^[a-zA-Z0-9\\-]+$'
218+
219+
open_api_server_studio_studioidget:
220+
path: /studio/{id}
221+
methods: [GET]
222+
defaults:
223+
_controller: open_api_server.controller.studio::studioIdGetAction
224+
requirements:
225+
id: '^[a-zA-Z0-9\\-]+$'
226+
227+
open_api_server_studio_studioidpost:
228+
path: /studio/{id}
229+
methods: [POST]
214230
defaults:
215-
_controller: open_api_server.controller.studio::studioIdPutAction
231+
_controller: open_api_server.controller.studio::studioIdPostAction
216232
requirements:
217233
id: '^[a-zA-Z0-9\\-]+$'
218234

‎Tests/Api/AuthenticationApiInterfaceTest.php

+2-2
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ public function testAuthenticationDelete(): void
9898
/**
9999
* Test case for authenticationGet.
100100
*
101-
* Check token.
101+
* Check JWT token validity.
102102
*/
103103
public function testAuthenticationGet(): void
104104
{
@@ -128,7 +128,7 @@ public function testAuthenticationOauthPost(): void
128128
/**
129129
* Test case for authenticationPost.
130130
*
131-
* Login.
131+
* Login - create a new JWT token.
132132
*/
133133
public function testAuthenticationPost(): void
134134
{

0 commit comments

Comments
 (0)