discoveryRaw method

  1. @experimental
DynamiteRawResponse<OcmDiscoveryResponseApplicationJson, OcmOcmDiscoveryHeaders> discoveryRaw()

generate a OCMProvider with local data and send it as DataResponse. This replaces the old PHP file ocm-provider/index.php.

This method and the response it returns is experimental. The API might change without a major version bump.

Returns a Future containing a DynamiteRawResponse with the raw HttpClientResponse and serialization helpers. Throws a DynamiteApiException if the API call does not return an expected status code.

Status codes:

  • 200: OCM Provider details returned
  • 500: OCM not supported

See:

  • discovery for an operation that returns a DynamiteResponse with a stable API.

Implementation

@_i4.experimental
_i1.DynamiteRawResponse<OcmDiscoveryResponseApplicationJson, OcmOcmDiscoveryHeaders> discoveryRaw() {
  final _headers = <String, String>{'Accept': 'application/json'};

// coverage:ignore-start
  final authentication = _rootClient.authentications?.firstWhereOrNull(
    (auth) => switch (auth) {
      _i1.DynamiteHttpBearerAuthentication() || _i1.DynamiteHttpBasicAuthentication() => true,
      _ => false,
    },
  );

  if (authentication != null) {
    _headers.addAll(
      authentication.headers,
    );
  }

// coverage:ignore-end
  const _path = '/index.php/ocm-provider';
  return _i1.DynamiteRawResponse<OcmDiscoveryResponseApplicationJson, OcmOcmDiscoveryHeaders>(
    response: _rootClient.executeRequest(
      'get',
      _path,
      headers: _headers,
      validStatuses: const {200},
    ),
    bodyType: const FullType(OcmDiscoveryResponseApplicationJson),
    headersType: const FullType(OcmOcmDiscoveryHeaders),
    serializers: _$jsonSerializers,
  );
}