$search_Request method

  1. @experimental
Request $search_Request({
  1. required String query,
})

Search for recipes for keywords, tags and categories with the named search string.

Returns a DynamiteRequest backing the search operation. Throws a DynamiteApiException if the API call does not return an expected status code.

Status codes:

  • 200: The recipes were obtained successfully
  • 500: An error has been thrown

See:

  • search for a method executing this request and parsing the response.
  • $search_Serializer for a converter to parse the Response from an executed this request.

Implementation

@_i2.experimental
_i3.Request $search_Request({required String query}) {
  final _parameters = <String, Object?>{};
  final __query = _$jsonSerializers.serialize(query, specifiedType: const FullType(String));
  _parameters['query'] = __query;

  final _path = _i5.UriTemplate('/index.php/apps/cookbook/api/v1/search/{query}').expand(_parameters);
  final _uri = Uri.parse('${_rootClient.baseURL}$_path');
  final _request = _i3.Request('get', _uri);
  _request.headers['Accept'] = 'application/json';
// coverage:ignore-start
  final authentication = _i4.IterableExtension(_rootClient.authentications)?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _request.headers.addAll(
      authentication.headers,
    );
  } else {
    throw Exception('Missing authentication for app_password');
  }

// coverage:ignore-end
  return _request;
}