OpenAPI\Server\Api\ProjectsApiInterface

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

Method	HTTP request	Description
projectIdCatrobatGet	GET /project/{id}/catrobat	Download the .catrobat (=zip) file of a project
projectIdDelete	DELETE /project/{id}	Delete a project
projectIdGet	GET /project/{id}	Get the information of a project
projectIdPut	PUT /project/{id}	Update details of a project
projectIdRecommendationsGet	GET /project/{id}/recommendations	Get recommended projects related to the specific project
projectIdReportPost	POST /project/{id}/report	Report a project -- StatusCode: 501 - Not yet implemented
projectsCategoriesGet	GET /projects/categories	Get default number of projects per category (Most downloaded etc.)
projectsExtensionsGet	GET /projects/extensions	Get all possible project extensions. Extensions are automatically added to projects based on their bricks.
projectsFeaturedGet	GET /projects/featured	Get the currently featured projects
projectsGet	GET /projects	Get projects
projectsPost	POST /projects	Upload a catrobat project
projectsSearchGet	GET /projects/search	Search for projects associated with a keywords
projectsTagsGet	GET /projects/tags	Get all possible project tags. Some Tags will only be availabe during events.
projectsUserGet	GET /projects/user	Get the projects of the logged in user
projectsUserIdGet	GET /projects/user/{id}	Get the public projects of a given user

Service Declaration

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

projectIdCatrobatGet

UploadedFile projectIdCatrobatGet($id)

Download the .catrobat (=zip) file of a project

If the request is made by an authenticated user, further internal actions are triggered. (Download counter, ...)

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

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

    // ...
}

Parameters

Name	Type	Description	Notes
id	string

Return type

UploadedFile

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/zip

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

projectIdDelete

projectIdDelete($id)

Delete a project

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

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

    // ...
}

Parameters

Name	Type	Description	Notes
id	string

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]

projectIdGet

OpenAPI\Server\Model\ProjectResponse projectIdGet($id)

Get the information of a project

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

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

    // ...
}

Parameters

Name	Type	Description	Notes
id	string

Return type

OpenAPI\Server\Model\ProjectResponse

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]

projectIdPut

array projectIdPut($id, $update_project_request, $accept_language)

Update details of a project

Update one of your projects. All attributes are optional. For example you can update only the description. Or you can update multiple attributes at once.

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

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

    // ...
}

Parameters

Name	Type	Notes
id	string
update_project_request	OpenAPI\Server\Model\UpdateProjectRequest
accept_language	string	[optional] [default to 'en']

Return type

array

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

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

projectIdRecommendationsGet

OpenAPI\Server\Model\ProjectResponse projectIdRecommendationsGet($id, $category, $accept_language, $max_version, $limit, $offset, $attributes, $flavor)

Get recommended projects related to the specific project

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

    /**
     * Implementation of ProjectsApiInterface#projectIdRecommendationsGet
     */
    public function projectIdRecommendationsGet(string $id, string $category, string $accept_language, string $max_version, int $limit, int $offset, string $attributes, string $flavor, int &$responseCode, array &$responseHeaders): array|object|null
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
id	string
category	string	* `similar` - Get similar projects to the specific project * `also_downloaded` - Get projects that users who downloaded the specific project also downloaded * `more_from_user` - Get more projects from the owner of the specific project
accept_language	string		[optional] [default to 'en']
max_version	string	Only shows project with a smaller version number than max version. `Warning!` Current implementation is kinda broken. To ensure correct results use the following format '[0-9].[0-9]{3}'	[optional] [default to '']
limit	int		[optional] [default to 20]
offset	int		[optional] [default to 0]
attributes	string		[optional] [default to '']
flavor	string		[optional] [default to '']

Return type

OpenAPI\Server\Model\ProjectResponse

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]

projectIdReportPost

projectIdReportPost($id, $project_report_request)

Report a project -- StatusCode: 501 - Not yet implemented

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

    /**
     * Implementation of ProjectsApiInterface#projectIdReportPost
     */
    public function projectIdReportPost(string $id, ProjectReportRequest $project_report_request, int &$responseCode, array &$responseHeaders): void
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
id	string
project_report_request	OpenAPI\Server\Model\ProjectReportRequest

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

projectsCategoriesGet

OpenAPI\Server\Model\ProjectsCategory projectsCategoriesGet($max_version, $flavor, $accept_language)

Get default number of projects per category (Most downloaded etc.)

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

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

    // ...
}

Parameters

Name	Type	Description	Notes
max_version	string	Only shows project with a smaller version number than max version. `Warning!` Current implementation is kinda broken. To ensure correct results use the following format '[0-9].[0-9]{3}'	[optional] [default to '']
flavor	string		[optional] [default to '']
accept_language	string		[optional] [default to 'en']

Return type

OpenAPI\Server\Model\ProjectsCategory

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]

projectsExtensionsGet

OpenAPI\Server\Model\ExtensionResponse projectsExtensionsGet($accept_language)

Get all possible project extensions. Extensions are automatically added to projects based on their bricks.

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

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

    // ...
}

Parameters

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

Return type

OpenAPI\Server\Model\ExtensionResponse

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]

projectsFeaturedGet

OpenAPI\Server\Model\FeaturedProjectResponse projectsFeaturedGet($platform, $max_version, $limit, $offset, $attributes, $flavor)

Get the currently featured projects

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

    /**
     * Implementation of ProjectsApiInterface#projectsFeaturedGet
     */
    public function projectsFeaturedGet(string $platform, string $max_version, int $limit, int $offset, string $attributes, string $flavor, int &$responseCode, array &$responseHeaders): array|object|null
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
platform	string	Indication for which platform the response should be optimized (ios, android)	[optional] [default to '']
max_version	string	Only shows project with a smaller version number than max version. `Warning!` Current implementation is kinda broken. To ensure correct results use the following format '[0-9].[0-9]{3}'	[optional] [default to '']
limit	int		[optional] [default to 20]
offset	int		[optional] [default to 0]
attributes	string		[optional] [default to '']
flavor	string		[optional] [default to '']

Return type

OpenAPI\Server\Model\FeaturedProjectResponse

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]

projectsGet

OpenAPI\Server\Model\ProjectResponse projectsGet($category, $accept_language, $max_version, $limit, $offset, $attributes, $flavor)

Get projects

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

    /**
     * Implementation of ProjectsApiInterface#projectsGet
     */
    public function projectsGet(string $category, string $accept_language, string $max_version, int $limit, int $offset, string $attributes, string $flavor, int &$responseCode, array &$responseHeaders): array|object|null
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
category	string
accept_language	string		[optional] [default to 'en']
max_version	string	Only shows project with a smaller version number than max version. `Warning!` Current implementation is kinda broken. To ensure correct results use the following format '[0-9].[0-9]{3}'	[optional] [default to '']
limit	int		[optional] [default to 20]
offset	int		[optional] [default to 0]
attributes	string		[optional] [default to '']
flavor	string		[optional] [default to '']

Return type

OpenAPI\Server\Model\ProjectResponse

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]

projectsPost

OpenAPI\Server\Model\ProjectResponse projectsPost($checksum, $file, $accept_language, $flavor, $private)

Upload a catrobat project

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

    /**
     * Implementation of ProjectsApiInterface#projectsPost
     */
    public function projectsPost(string $checksum, UploadedFile $file, string $accept_language, string $flavor, bool $private, int &$responseCode, array &$responseHeaders): array|object|null
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
checksum	string	Checksum of the *.catrobat file
file	UploadedFileUploadedFile	The *.catrobat project file
accept_language	string		[optional] [default to 'en']
flavor	string	The flavor of this project	[optional] [default to 'pocketcode']
private	bool	Indicates whether a project should be private	[optional] [default to false]

Return type

OpenAPI\Server\Model\ProjectResponse

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]

projectsSearchGet

OpenAPI\Server\Model\ProjectResponse projectsSearchGet($query, $max_version, $limit, $offset, $attributes, $flavor)

Search for projects associated with a keywords

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

    /**
     * Implementation of ProjectsApiInterface#projectsSearchGet
     */
    public function projectsSearchGet(string $query, string $max_version, int $limit, int $offset, string $attributes, string $flavor, int &$responseCode, array &$responseHeaders): array|object|null
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
query	string
max_version	string	Only shows project with a smaller version number than max version. `Warning!` Current implementation is kinda broken. To ensure correct results use the following format '[0-9].[0-9]{3}'	[optional] [default to '']
limit	int		[optional] [default to 20]
offset	int		[optional] [default to 0]
attributes	string		[optional] [default to '']
flavor	string		[optional] [default to '']

Return type

OpenAPI\Server\Model\ProjectResponse

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]

projectsTagsGet

OpenAPI\Server\Model\TagResponse projectsTagsGet($accept_language)

Get all possible project tags. Some Tags will only be availabe during events.

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

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

    // ...
}

Parameters

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

Return type

OpenAPI\Server\Model\TagResponse

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]

projectsUserGet

OpenAPI\Server\Model\ProjectResponse projectsUserGet($max_version, $limit, $offset, $attributes, $flavor)

Get the projects of the logged in user

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

    /**
     * Implementation of ProjectsApiInterface#projectsUserGet
     */
    public function projectsUserGet(string $max_version, int $limit, int $offset, string $attributes, string $flavor, int &$responseCode, array &$responseHeaders): array|object|null
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
max_version	string	Only shows project with a smaller version number than max version. `Warning!` Current implementation is kinda broken. To ensure correct results use the following format '[0-9].[0-9]{3}'	[optional] [default to '']
limit	int		[optional] [default to 20]
offset	int		[optional] [default to 0]
attributes	string		[optional] [default to '']
flavor	string		[optional] [default to '']

Return type

OpenAPI\Server\Model\ProjectResponse

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

projectsUserIdGet

OpenAPI\Server\Model\ProjectResponse projectsUserIdGet($id, $max_version, $limit, $offset, $attributes, $flavor)

Get the public projects of a given user

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\ProjectsApiInterface;

class ProjectsApi implements ProjectsApiInterface
{

    // ...

    /**
     * Implementation of ProjectsApiInterface#projectsUserIdGet
     */
    public function projectsUserIdGet(string $id, string $max_version, int $limit, int $offset, string $attributes, string $flavor, int &$responseCode, array &$responseHeaders): array|object|null
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
id	string
max_version	string	Only shows project with a smaller version number than max version. `Warning!` Current implementation is kinda broken. To ensure correct results use the following format '[0-9].[0-9]{3}'	[optional] [default to '']
limit	int		[optional] [default to 20]
offset	int		[optional] [default to 0]
attributes	string		[optional] [default to '']
flavor	string		[optional] [default to '']

Return type

OpenAPI\Server\Model\ProjectResponse

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]

Files

ProjectsApiInterface.md

Latest commit

History

ProjectsApiInterface.md

File metadata and controls

OpenAPI\Server\Api\ProjectsApiInterface

Service Declaration

projectIdCatrobatGet

Example Implementation

Parameters

Return type

Authorization

HTTP request headers

projectIdDelete

Example Implementation

Parameters

Return type

Authorization

HTTP request headers

projectIdGet

Example Implementation

Parameters

Return type

Authorization

HTTP request headers

projectIdPut

Example Implementation

Parameters

Return type

Authorization

HTTP request headers

projectIdRecommendationsGet

Example Implementation

Parameters

Return type

Authorization

HTTP request headers

projectIdReportPost

Example Implementation

Parameters

Return type

Authorization

HTTP request headers

projectsCategoriesGet

Example Implementation

Parameters

Return type

Authorization

HTTP request headers

projectsExtensionsGet

Example Implementation

Parameters

Return type

Authorization

HTTP request headers

projectsFeaturedGet

Example Implementation

Parameters

Return type

Authorization

HTTP request headers

projectsGet

Example Implementation

Parameters

Return type

Authorization

HTTP request headers

projectsPost

Example Implementation

Parameters

Return type

Authorization

HTTP request headers

projectsSearchGet

Example Implementation

Parameters

Return type

Authorization

HTTP request headers