getHelpArticlesBySlugWithHttpInfo method

Future<Response> getHelpArticlesBySlugWithHttpInfo(
  1. String slug
)

Returns one public article by slug, with its body.

Returns one public article by slug, with its body. A missing, Draft, or internal (non-public) article is 404 — fail-closed, so this route is no existence oracle for anything beyond "published and public".

Note: This method returns the HTTP Response.

Parameters:

  • String slug (required): Slug is the article's public identifier, from the path. It IS the document name in the help center's store.

Implementation

Future<Response> getHelpArticlesBySlugWithHttpInfo(String slug,) async {
  // ignore: prefer_const_declarations
  final path = r'/v1/help/articles/{slug}'
    .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,
  );
}