StudioApiInterface.md

OpenAPI\Server\Api\StudioApiInterface

All URIs are relative to https://share.catrob.at/api

Method	HTTP request	Description
studioIdDelete	DELETE /studio/{id}	Delete a studio (only available to studio admins)
studioIdGet	GET /studio/{id}	Get studio details (private studios are only available to members)
studioIdPost	POST /studio/{id}	Update a Studio (only available to studio admins)
studioPost	POST /studio	Create a new Studio

Service Declaration

# config/services.yaml
services:
    # ...
    Acme\MyBundle\Api\StudioApi:
        tags:
            - { name: "open_api_server.api", api: "studio" }
    # ...

studioIdDelete

studioIdDelete($id, $accept_language)

Delete a studio (only available to studio admins)

Example Implementation

<?php
// src/Acme/MyBundle/Api/StudioApiInterface.php

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\StudioApiInterface;

class StudioApi implements StudioApiInterface
{

    // ...

    /**
     * Implementation of StudioApiInterface#studioIdDelete
     */
    public function studioIdDelete(string $id, string $accept_language, int &$responseCode, array &$responseHeaders): void
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
id	string
accept_language	string		[optional] [default to 'en']

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

studioIdGet

OpenAPI\Server\Model\StudioResponse studioIdGet($id, $accept_language)

Get studio details (private studios are only available to members)

Example Implementation

<?php
// src/Acme/MyBundle/Api/StudioApiInterface.php

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\StudioApiInterface;

class StudioApi implements StudioApiInterface
{

    // ...

    /**
     * Implementation of StudioApiInterface#studioIdGet
     */
    public function studioIdGet(string $id, string $accept_language, int &$responseCode, array &$responseHeaders): array|object|null
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
id	string
accept_language	string		[optional] [default to 'en']

Return type

OpenAPI\Server\Model\StudioResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

studioIdPost

OpenAPI\Server\Model\StudioResponse studioIdPost($id, $accept_language, $name, $description, $is_public, $enable_comments, $image_file)

Update a Studio (only available to studio admins)

Example Implementation

<?php
// src/Acme/MyBundle/Api/StudioApiInterface.php

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\StudioApiInterface;

class StudioApi implements StudioApiInterface
{

    // ...

    /**
     * Implementation of StudioApiInterface#studioIdPost
     */
    public function studioIdPost(string $id, string $accept_language, ?string $name, ?string $description, ?bool $is_public, ?bool $enable_comments, ?UploadedFile $image_file, int &$responseCode, array &$responseHeaders): array|object|null
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
id	string
accept_language	string		[optional] [default to 'en']
name	string	The name of the studio (character: min 3, max 180)	[optional]
description	string	A small description about the Studio (character: min 1, max 3000)	[optional]
is_public	bool	This flag sets the studios' visibility to public or private	[optional]
enable_comments	bool	This flag enables or disabled the possibility to add comments to the studio	[optional]
image_file	UploadedFile****UploadedFile	Cover image; Size limit 1MB; Supported extensions are jpeg, png, webp;	[optional]

Return type

OpenAPI\Server\Model\StudioResponse

Authorization

BearerAuth

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

studioPost

OpenAPI\Server\Model\StudioResponse studioPost($accept_language, $name, $description, $is_public, $enable_comments, $image_file)

Create a new Studio

Example Implementation

<?php
// src/Acme/MyBundle/Api/StudioApiInterface.php

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\StudioApiInterface;

class StudioApi implements StudioApiInterface
{

    // ...

    /**
     * Implementation of StudioApiInterface#studioPost
     */
    public function studioPost(string $accept_language, ?string $name, ?string $description, bool $is_public, bool $enable_comments, ?UploadedFile $image_file, int &$responseCode, array &$responseHeaders): array|object|null
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
accept_language	string		[optional] [default to 'en']
name	string	The name of the studio (character: min 3, max 180)	[optional]
description	string	A small description about the Studio (character: min 1, max 3000)	[optional]
is_public	bool	This flag sets the studios' visibility to public or private	[optional] [default to true]
enable_comments	bool	This flag enables or disabled the possibility to add comments to the studio	[optional] [default to true]
image_file	UploadedFile****UploadedFile	Cover image; Size limit 1MB; Supported extensions are jpeg, png, webp;	[optional]

Return type

OpenAPI\Server\Model\StudioResponse

Authorization

BearerAuth

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]