$$import_Request method
Import a recipe using schema.org metadata from a website.
Returns a DynamiteRequest
backing the $import operation.
Throws a DynamiteApiException
if the API call does not return an expected status code.
Status codes:
- 200: Successfully imported recipe
- 400: The URL to be imported was not inserted in the request or any other issue was rosen.
- 409: There exists a recipe with that name already. Import was aborted.
See:
- $import for a method executing this request and parsing the response.
- $$import_Serializer for a converter to parse the
Response
from an executed this request.
Implementation
@_i2.experimental
_i3.Request $$import_Request({required Url $body}) {
const _path = '/index.php/apps/cookbook/api/v1/import';
final _uri = Uri.parse('${_rootClient.baseURL}$_path');
final _request = _i3.Request('post', _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
_request.headers['Content-Type'] = 'application/json';
_request.body = json.encode(_$jsonSerializers.serialize($body, specifiedType: const FullType(Url)));
return _request;
}