Add docs related to reporting data export #267
Conversation
themuhammad2
force-pushed
the
muhammad.murtaza/add-docs-related-to-reporting-data-export
branch
from
fccb5ad to
2ddcc8e
Compare
| "/export/reporting_data/enqueue": | ||
| post: | ||
| summary: Enqueue a new reporting data export job | ||
| tags: [Export] |
There was a problem hiding this comment.
I think this tag achieves the grouping rather than needing to nest the resource name.
There was a problem hiding this comment.
Yes, this is for grouping.
descriptions/0/api.intercom.io.yaml
Outdated
| message: "Export job not found for identifier: job1" | ||
| schema: | ||
| "$ref": "#/components/schemas/error" | ||
| '504': |
There was a problem hiding this comment.
504 is specific to timeouts. Is this a known issue that comes up, and if so could we explain that in the description?
There was a problem hiding this comment.
I have updated the docs after updating the API. Thanks for pointing out.
| "/export/reporting_data/get_datasets": | ||
| get: |
There was a problem hiding this comment.
Usually wouldn't have get in the path as well as being the HTTP method.
There was a problem hiding this comment.
But if it matches the behaviour we can update the docs for now. While it's in Unstable though we could change to align with other API endpoints.
There was a problem hiding this comment.
@steve-henry yeah that's a good point we shouldn't have get in the name of the resource according to REST conventions. It should have been like
GET /export/reporting_data/datasets
There was a problem hiding this comment.
Yes I think that would be clearer and more consistent with the rest of the APIs
themuhammad2
force-pushed
the
muhammad.murtaza/add-docs-related-to-reporting-data-export
branch
2 times, most recently
from
63b64dd to
a6833b9
Compare
themuhammad2
force-pushed
the
muhammad.murtaza/add-docs-related-to-reporting-data-export
branch
from
a6833b9 to
d771cd3
Compare
themuhammad2
deleted the
muhammad.murtaza/add-docs-related-to-reporting-data-export
branch
The aim of this PR is to add API docs related to reporting data-export.
We are documenting below requests handled by
app/controllers/api/v3/export/reporting_data_export_controller.rbcontroller.POST /export/reporting_data/enqueueGET /export/reporting_data/{job_identifier}GET /download/reporting_data/{job_identifier}GET /export/reporting_data/get_datasets