Skip to content

Clarify API coverage of IP restriction

Harsh Chouraria requested to merge hchouraria-docs-group-ip-restriction-api-enforcement into master

What does this MR do?

The IP restriction is enforced by disabling permissions to read a project or group resource to the authenticated user when disallowed due to their request IP.

This effectively disables all possibility of reading the group or project metadata, and therefore covers all APIs of form /groups/:id[/*] or /projects/:id[/*]. In a test everything under these resources began to yield 404s when requested from a disallowed IP.

The current document entry links to specific API resources that imply only certain endpoints are restricted.

This change attempts to clarify that every project and group related API resource is covered by linking instead to the API resources documentation page.

Related issues

Customer ticket: https://gitlab.zendesk.com/agent/tickets/256505

Author's checklist

If you are 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.

Review 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 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.
    • 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.
  • Ensure a release milestone is set.

Merge request reports