getProjectsBySlugShotWithHttpInfo method

Future<Response> getProjectsBySlugShotWithHttpInfo(
  1. String slug
)

Get a PNG of the project's live site

Returns a screenshot of what this project currently serves, as image/png. The capture is keyed by the deployment, so a redeploy invalidates it by construction rather than by anyone remembering to clear a cache. A project with nothing deployed answers 404 — that is a 404 about the PICTURE and not about the project, which is still right there in the list. Scoped to the caller's org: a validated principal is required, and a slug belonging to another org is not found rather than forbidden.

Note: This method returns the HTTP Response.

Parameters:

Implementation

Future<Response> getProjectsBySlugShotWithHttpInfo(String slug,) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/projects/{slug}/shot'
    .replaceAll('{slug}', slug);

  // ignore: prefer_final_locals
  Object? postBody;

  final queryParams = <QueryParam>[];
  final headerParams = <String, String>{};
  final formParams = <String, String>{};

  const contentTypes = <String>[];


  return apiClient.invokeAPI(
    path,
    'GET',
    queryParams,
    postBody,
    headerParams,
    formParams,
    contentTypes.isEmpty ? null : contentTypes.first,
  );
}