SearchApiInterface.md

OpenAPI\Server\Api\SearchApiInterface

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

Method	HTTP request	Description
searchGet	GET /search	Search for projects, users,.. -- StatusCode: 501 - Not yet implemented

Service Declaration

# src/Acme/MyBundle/Resources/services.yml
services:
    # ...
    acme.my_bundle.api.search:
        class: Acme\MyBundle\Api\SearchApi
        tags:
            - { name: "open_api_server.api", api: "search" }
    # ...

searchGet

OpenAPI\Server\Model\SearchResponse searchGet($query, $type, $limit, $offset)

Search for projects, users,.. -- StatusCode: 501 - Not yet implemented

The default is to search in all categories.

Example Implementation

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

namespace Acme\MyBundle\Api;

use OpenAPI\Server\Api\SearchApiInterface;

class SearchApi implements SearchApiInterface
{

    // ...

    /**
     * Implementation of SearchApiInterface#searchGet
     */
    public function searchGet(string $query, string $type = null, int $limit = '20', int $offset = '0')
    {
        // Implement the operation ...
    }

    // ...
}

Parameters

Name	Type	Description	Notes
query	string
type	string		[optional]
limit	int		[optional] [default to 20]
offset	int		[optional] [default to 0]

Return type

OpenAPI\Server\Model\SearchResponse

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]