Skip to content

Add note about 404 result if not enabled

Justin Farmiloe requested to merge jfarmiloe-docs-404-note into master

What does this MR do?

The suggested request to https://gitlab.com/api/v4/ml/ai-assist returns the following when code suggestions is enabled for the user and their top-level groups:

{"user_is_allowed":true,"third_party_ai_features_enabled":true}

but when either of those conditions is not met you get the following returned:

{"message":"404 Not Found"}

whereas users may expect to get something like the following:

{"user_is_allowed":false,"third_party_ai_features_enabled":false}

This MR describes the 404 as expected behavior.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.
Edited by Justin Farmiloe

Merge request reports