Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: OPTIC-1419: Expand comments CSV export columns #42

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions fern/openapi/overrides.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,13 @@ paths:
x-fern-sdk-method-name: delete
x-fern-audiences:
- public
/api/comments/export/:
get:
$ref: "./resources/comments.yaml#/paths/~1api~1comments~1/export"
x-fern-sdk-group-name: comments
x-fern-sdk-method-name: export
x-fern-audiences:
- public
"/api/annotations/{id}/":
get:
summary: Get annotation by its ID
Expand Down
55 changes: 48 additions & 7 deletions fern/openapi/resources/comments.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ paths:
summary: List comments
description: >

Get a list of comments for a specific project.
Get a list of comments for the specified annotation, annotators or projects.
parameters:
- name: project
- name: projects
in: query
description: Project ID
description: Comma-separated list of project IDs
schema:
type: integer
type: string
- name: expand_created_by
in: query
description: Expand the created_by field with object instead of ID
Expand All @@ -21,11 +21,11 @@ paths:
description: Annotation ID
schema:
type: integer
- name: project
- name: annotators
in: query
description: Project ID
description: Comma-separated list of annotator user IDs
schema:
type: integer
type: string
responses:
"200":
description: ""
Expand Down Expand Up @@ -105,6 +105,47 @@ paths:
responses:
"204":
description: ""
/api/comments/export/:
get:
summary: Export comments
description: >

Export comments for a specific annotation or list of projects.
parameters:
- name: projects
in: query
description: Comma-separated list of project IDs
schema:
type: string
- name: expand_created_by
in: query
description: Expand the created_by field with object instead of ID
schema:
type: boolean
- name: annotation
in: query
description: Annotation ID
schema:
type: integer
- name: annotators
in: query
description: Comma-separated list of annotator user IDs
schema:
type: string
- name: tz
in: query
description: Timezone in which to export the data. Format IANA timezone name, e.g. "America/New_York"
schema:
type: string
responses:
"200":
description: ""
content:
text/csv:
schema:
type: array
items:
type: string

components:
schemas:
Expand Down
Loading