Skip to content

Update Direct Transfer API responses

Luke Duncalfe requested to merge ld-docs-update-bulk_imports-api-responses into master
  • Please check this box if this contribution uses AI-generated content as outlined in the GitLab DCO & CLA.

What does this MR do?

This MR updates the API docs for Direct Transfer responses to reflect the latest properties.

QA

QA the API response by first creating some Direct Transfer data locally if there is none already, and then doing the following curl commands.

Example endpoint returning API::Entities::BulkImport

GET api/v4/bulk_imports:

curl --location 'http://gdk.test:3000/api/v4/bulk_imports' \
--header 'Authorization: Bearer <PAT>'

These other endpoints also serialize the response using the same API entity:

  • POST /bulk_imports
  • POST /bulk_imports/:id/cancel

Example endpoint returning API::Entities::BulkImports::Entity

GET api/v4/bulk_imports/entities:

curl --location 'http://gdk.test:3000/api/v4/bulk_imports/entities' \
--header 'Authorization: Bearer <PAT>'

These other endpoints also serialize the response using the same API entity:

  • GET api/v4/bulk_imports/:import_id/entities
  • GET api/v4/bulk_imports/:import_id/entities/:entity_id

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 Luke Duncalfe

Merge request reports