Skip to content
Draft
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
10 changes: 3 additions & 7 deletions .mock/definition/__package__.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ errors:
examples:
- value:
key: value
NotImplementedError:
status-code: 501
ForbiddenError:
status-code: 403
type: unknown
docs: KPI depends on other KPIs - not implemented
docs: Organization does not allow to invite people
BadRequestError:
status-code: 400
type: unknown
Expand All @@ -24,10 +24,6 @@ errors:
docs: Predicting error
examples:
- value: Server responded with an error.
ForbiddenError:
status-code: 403
type: unknown
docs: Permission Denied
MethodNotAllowedError:
status-code: 405
type: unknown
Expand Down
193 changes: 77 additions & 116 deletions .mock/definition/dashboard.yml
Original file line number Diff line number Diff line change
@@ -1,50 +1,80 @@
imports:
root: __package__.yml
types:
ApiProjectsDashboardRetrieveResponse:
properties:
annotated_tasks:
type: optional<integer>
docs: Number of annotated (completed) tasks
annotations:
type: optional<integer>
docs: Total number of annotations
remaining_tasks:
type: optional<integer>
docs: Total number of uncompleted tasks
reviewed_tasks:
type: optional<integer>
docs: Number of tasks that have been reviewed by at least one reviewer
skipped_tasks:
type: optional<integer>
docs: Number of tasks that have been skipped by at least one annotator
tasks:
type: optional<integer>
docs: Total number of tasks
source:
openapi: openapi/openapi.yaml
ApiProjectsDashboardMembersRetrieveResponseStatsItem:
docs: User statistics
properties:
accepted:
type: optional<integer>
docs: Number of annotations marked as "Accepted" by reviewer
finished:
type: optional<integer>
gt:
type: optional<double>
docs: Average agreement with Ground Truth annotations
mean_time:
type: optional<double>
docs: Average mean time spent on annotation
median_time:
type: optional<double>
docs: Average median time spent on annotation
predictions:
type: optional<double>
docs: Average agreement with predictions
progress:
type: optional<integer>
docs: Fraction of annotation work done so far
rejected:
type: optional<integer>
docs: Number of annotations marked as "Rejected" by reviewer
review_score:
type: optional<double>
docs: >-
Average reviewing score, when calling with "per_label=true", returns
dictionary with labels to score breakdown
skipped:
type: optional<integer>
source:
openapi: openapi/openapi.yaml
inline: true
ApiProjectsDashboardMembersRetrieveResponse:
docs: Task creation response
properties:
similarity:
type: optional<list<map<string, unknown>>>
docs: Consensus statistics between different users
stats:
type: optional<list<ApiProjectsDashboardMembersRetrieveResponseStatsItem>>
docs: Number of annotated (completed) tasks
users:
type: optional<list<map<string, unknown>>>
docs: List of users
source:
openapi: openapi/openapi.yaml
service:
auth: false
base-path: ''
endpoints:
api_dashboards_kpis_retrieve:
path: /api/dashboards/{id}/kpis/{kpi_key}
method: GET
auth: true
docs: >-
Get Key Performance Indicator (KPI) data for a dashboard. Supports
various KPIs including: skipped_annotations, accepted_annotations,
rejected_annotations, average_time_per_task_min, total_annotations,
regions_created, and more.
source:
openapi: openapi/openapi.yaml
path-parameters:
id: integer
kpi_key: string
display-name: Get KPI data
request:
name: ApiDashboardsKpisRetrieveRequest
query-parameters:
end:
type: optional<string>
docs: End date for filtering (ISO format)
members:
type: optional<integer>
allow-multiple: true
docs: Array of user IDs to filter by
start:
type: optional<string>
docs: Start date for filtering (ISO format)
response:
docs: KPI data
type: map<string, unknown>
errors:
- root.NotFoundError
- root.NotImplementedError
examples:
- path-parameters:
id: 1
kpi_key: kpi_key
response:
body:
key: value
api_projects_dashboard_retrieve:
path: /api/projects/{id}/dashboard
method: GET
Expand All @@ -70,6 +100,8 @@ service:
reviewed_tasks: 1
skipped_tasks: 1
tasks: 1
audiences:
- internal
api_projects_dashboard_members_retrieve:
path: /api/projects/{id}/dashboard-members
method: GET
Expand Down Expand Up @@ -135,78 +167,7 @@ service:
skipped: 1
users:
- key: value
audiences:
- internal
source:
openapi: openapi/openapi.yaml
types:
ApiProjectsDashboardRetrieveResponse:
properties:
annotated_tasks:
type: optional<integer>
docs: Number of annotated (completed) tasks
annotations:
type: optional<integer>
docs: Total number of annotations
remaining_tasks:
type: optional<integer>
docs: Total number of uncompleted tasks
reviewed_tasks:
type: optional<integer>
docs: Number of tasks that have been reviewed by at least one reviewer
skipped_tasks:
type: optional<integer>
docs: Number of tasks that have been skipped by at least one annotator
tasks:
type: optional<integer>
docs: Total number of tasks
source:
openapi: openapi/openapi.yaml
ApiProjectsDashboardMembersRetrieveResponseStatsItem:
docs: User statistics
properties:
accepted:
type: optional<integer>
docs: Number of annotations marked as "Accepted" by reviewer
finished:
type: optional<integer>
gt:
type: optional<double>
docs: Average agreement with Ground Truth annotations
mean_time:
type: optional<double>
docs: Average mean time spent on annotation
median_time:
type: optional<double>
docs: Average median time spent on annotation
predictions:
type: optional<double>
docs: Average agreement with predictions
progress:
type: optional<integer>
docs: Fraction of annotation work done so far
rejected:
type: optional<integer>
docs: Number of annotations marked as "Rejected" by reviewer
review_score:
type: optional<double>
docs: >-
Average reviewing score, when calling with "per_label=true", returns
dictionary with labels to score breakdown
skipped:
type: optional<integer>
source:
openapi: openapi/openapi.yaml
inline: true
ApiProjectsDashboardMembersRetrieveResponse:
docs: Task creation response
properties:
similarity:
type: optional<list<map<string, unknown>>>
docs: Consensus statistics between different users
stats:
type: optional<list<ApiProjectsDashboardMembersRetrieveResponseStatsItem>>
docs: Number of annotated (completed) tasks
users:
type: optional<list<map<string, unknown>>>
docs: List of users
source:
openapi: openapi/openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,22 +1,34 @@
imports:
root: ../__package__.yml
service:
auth: false
base-path: ''
endpoints:
api_invite_retrieve:
get_invite_link:
path: /api/invite
method: GET
auth: true
docs: Get invite link for organization
source:
openapi: openapi/openapi.yaml
display-name: Invite people
display-name: Get invite link
response:
docs: ''
type: root.OrganizationInvite
errors:
- root.ForbiddenError
examples:
- {}
api_invite_revoke_create:
- response:
body:
invite_url: invite_url
token: token
audiences:
- public
revoke_invite:
path: /api/invite/revoke
method: POST
auth: true
docs: Revoke invite
docs: Revoke invite to organization
source:
openapi: openapi/openapi.yaml
display-name: Revoke invite
Expand All @@ -32,7 +44,9 @@ service:
examples:
- request:
email: email
api_invite_send_email_create:
audiences:
- public
send_email:
path: /api/invite/send-email
method: POST
auth: true
Expand All @@ -50,10 +64,14 @@ service:
validation:
minLength: 1
content-type: application/json
errors:
- root.ForbiddenError
examples:
- request:
emails:
- emails
role: role
audiences:
- public
source:
openapi: openapi/openapi.yaml
Loading
Loading