Last active
June 17, 2019 14:43
-
-
Save bceskavich/e2f8abbf5ed7f0678da562623efebcc0 to your computer and use it in GitHub Desktop.
Frame.io public docs deploy issue with ReadMe.io
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "components": { | |
| "requestBodies": { | |
| "AssetCreateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "description": { | |
| "description": "Brief description of the Asset", | |
| "type": "string" | |
| }, | |
| "filesize": { | |
| "description": "The file size in bytes", | |
| "type": "integer" | |
| }, | |
| "filetype": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Name of the Asset", | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "description": "Custom key-value data", | |
| "type": "object" | |
| }, | |
| "source": { | |
| "$ref": "#/components/schemas/AssetSource" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "file", | |
| "folder" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "type", | |
| "name", | |
| "filesize" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Asset to create" | |
| }, | |
| "AssetSearchRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "$ref": "#/components/schemas/AssetSearch" | |
| } | |
| } | |
| }, | |
| "description": "Asset search" | |
| }, | |
| "AssetUpdateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "description": { | |
| "description": "Brief description of the Asset", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Name of the Asset", | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "description": "Custom key-value data", | |
| "type": "object" | |
| } | |
| }, | |
| "required": [ | |
| "name" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Asset to update" | |
| }, | |
| "CollaboratorRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Collaborator to create or update" | |
| }, | |
| "CommentRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "annotation": { | |
| "description": "Serialized list of geometry and/or drawing data.", | |
| "type": "string" | |
| }, | |
| "page": { | |
| "description": "Page number for a comment (documents only).", | |
| "type": "integer" | |
| }, | |
| "pitch": { | |
| "description": "Pitch measurement for the comment (360deg video only).", | |
| "type": "integer" | |
| }, | |
| "text": { | |
| "description": "The body of the comment.", | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "description": "Timestamp for the comment, in frames.", | |
| "type": "integer" | |
| }, | |
| "yaw": { | |
| "description": "Yaw measurement for the comment (360deg video only).", | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Comment to create or update" | |
| }, | |
| "PresentationCreateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "autoplay": { | |
| "type": "boolean" | |
| }, | |
| "background_color": { | |
| "type": "string" | |
| }, | |
| "can_download": { | |
| "type": "boolean" | |
| }, | |
| "color": { | |
| "type": "string" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "enabled": { | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "format": { | |
| "type": "string" | |
| }, | |
| "include_ext": { | |
| "type": "boolean" | |
| }, | |
| "include_upload_date": { | |
| "type": "boolean" | |
| }, | |
| "layout": { | |
| "enum": [ | |
| "blog", | |
| "reel" | |
| ], | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "secure": { | |
| "type": "boolean" | |
| }, | |
| "style": { | |
| "type": "string" | |
| }, | |
| "text_color": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "project_id", | |
| "owner_id", | |
| "asset_id" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Presentation to create" | |
| }, | |
| "PresentationUpdateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "autoplay": { | |
| "type": "boolean" | |
| }, | |
| "background_color": { | |
| "type": "string" | |
| }, | |
| "can_download": { | |
| "type": "boolean" | |
| }, | |
| "color": { | |
| "type": "string" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "enabled": { | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "format": { | |
| "type": "string" | |
| }, | |
| "include_ext": { | |
| "type": "boolean" | |
| }, | |
| "include_upload_date": { | |
| "type": "boolean" | |
| }, | |
| "layout": { | |
| "enum": [ | |
| "blog", | |
| "reel" | |
| ], | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "secure": { | |
| "type": "boolean" | |
| }, | |
| "style": { | |
| "type": "string" | |
| }, | |
| "text_color": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Presentation to update" | |
| }, | |
| "ProjectRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "name": { | |
| "description": "Project name", | |
| "type": "string" | |
| }, | |
| "private": { | |
| "description": "If true, the project is private to the creating user", | |
| "type": "boolean" | |
| }, | |
| "project_preferences": { | |
| "$ref": "#/components/schemas/ProjectPreferences" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Project to create or update" | |
| }, | |
| "ReviewLinkCreateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "allow_approvals": { | |
| "type": "boolean" | |
| }, | |
| "current_version_only": { | |
| "type": "boolean" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "enable_downloading": { | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "is_active": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "notify_on_view": { | |
| "type": "boolean" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "secure": { | |
| "type": "boolean" | |
| }, | |
| "view_count": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "project_id", | |
| "owner_id", | |
| "name" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLink to create" | |
| }, | |
| "ReviewLinkItemCreateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "asset_ids": { | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLinkItem to create" | |
| }, | |
| "ReviewLinkUpdateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "allow_approvals": { | |
| "type": "boolean" | |
| }, | |
| "current_version_only": { | |
| "type": "boolean" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "enable_downloading": { | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "is_active": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "notify_on_view": { | |
| "type": "boolean" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "secure": { | |
| "type": "boolean" | |
| }, | |
| "view_count": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLink to update" | |
| }, | |
| "TeamMemberRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| }, | |
| "role": { | |
| "type": "string" | |
| }, | |
| "user_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "role" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Team member to create or update" | |
| } | |
| }, | |
| "responses": { | |
| "AssetResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "$ref": "#/components/schemas/Asset" | |
| } | |
| } | |
| }, | |
| "description": "Asset success response" | |
| }, | |
| "AssetsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Assets success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "AuditsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Audit" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Audit logs list response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "CollaboratorResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "$ref": "#/components/schemas/Collaborator" | |
| } | |
| } | |
| }, | |
| "description": "Collaborator success response" | |
| }, | |
| "CommentResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "annotation": "[...]", | |
| "completed_at": null, | |
| "completer_id": null, | |
| "has_replies": true, | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "like_count": 10, | |
| "owner": "Elixir.API.Docs.Schemas.User", | |
| "owner_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", | |
| "text": "This is a comment.", | |
| "timestamp": 60 | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "$ref": "#/components/schemas/Comment" | |
| } | |
| } | |
| }, | |
| "description": "Comment success response" | |
| }, | |
| "CommentsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": [ | |
| { | |
| "annotation": "[...]", | |
| "completed_at": null, | |
| "completer_id": null, | |
| "has_replies": true, | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "like_count": 10, | |
| "owner": "Elixir.User", | |
| "owner_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", | |
| "text": "This is a comment.", | |
| "timestamp": 60 | |
| } | |
| ] | |
| } | |
| }, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Comment" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Comments success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "PresentationResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "$ref": "#/components/schemas/Presentation" | |
| } | |
| } | |
| }, | |
| "description": "Presentation success response" | |
| }, | |
| "PresentationsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Presentation" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Presentations success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "ProjectMembershipResonse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "collaborator": true, | |
| "owner": true, | |
| "team_member": true, | |
| "team_role": "team_manager" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "$ref": "#/components/schemas/ProjectMembership" | |
| } | |
| } | |
| }, | |
| "description": "Project membership success response" | |
| }, | |
| "ProjectResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "name": "My Project", | |
| "owner_id": "dddddddd-dddd-dddd-dddd-dddddddddddd", | |
| "private": false, | |
| "project_preferences": {}, | |
| "root_asset_id": "cccccccc-cccc-cccc-cccc-cccccccccccc", | |
| "team_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "$ref": "#/components/schemas/Project" | |
| } | |
| } | |
| }, | |
| "description": "Project success response" | |
| }, | |
| "ProjectsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": [ | |
| { | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "name": "My Project", | |
| "owner_id": "dddddddd-dddd-dddd-dddd-dddddddddddd", | |
| "private": false, | |
| "project_preferences": {}, | |
| "root_asset_id": "cccccccc-cccc-cccc-cccc-cccccccccccc", | |
| "team_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb" | |
| } | |
| ] | |
| } | |
| }, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Project" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Paginated projects success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "ReviewLinkItemsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/ReviewLinkItem" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLinkItems success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "ReviewLinkResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "$ref": "#/components/schemas/ReviewLink" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLink success response" | |
| }, | |
| "ReviewLinksResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/ReviewLink" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLink success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "TeamMemberResonse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "role": "team_manager", | |
| "user_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "properties": { | |
| "role": { | |
| "type": "string" | |
| }, | |
| "user_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Team member success response" | |
| }, | |
| "TeamMembershipResonse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "role": "team_manager" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "properties": { | |
| "role": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Team membership success response" | |
| }, | |
| "TeamsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": [ | |
| { | |
| "access": "public", | |
| "collaborator_count": 3, | |
| "file_count": 1, | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "name": "My Team", | |
| "project_count": 2, | |
| "storage": 123456 | |
| } | |
| ] | |
| } | |
| }, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Paginated teams success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "Unauthorized": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "code": 401, | |
| "errors": [ | |
| { | |
| "code": 401, | |
| "detail": "You are not allowed to access that resource", | |
| "status": 401, | |
| "title": "Not Authorized" | |
| } | |
| ], | |
| "message": "Not Authorized" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPError" | |
| } | |
| } | |
| }, | |
| "description": "Unauthorized response" | |
| }, | |
| "UserResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "account_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", | |
| "email": "jane@frame.io", | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "name": "Jane Doe" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "$ref": "#/components/schemas/User" | |
| } | |
| } | |
| }, | |
| "description": "User success response" | |
| } | |
| }, | |
| "schemas": { | |
| "AnonymousUser": { | |
| "properties": { | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "notification_preferences": { | |
| "$ref": "#/components/schemas/ProjectPreferences" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "user_default_color": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Asset": { | |
| "properties": { | |
| "asset_type": { | |
| "enum": [ | |
| "stream", | |
| "image", | |
| "document" | |
| ], | |
| "type": "string" | |
| }, | |
| "creator": { | |
| "$ref": "#/components/schemas/User" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "label": { | |
| "enum": [ | |
| "approved", | |
| "needs_review", | |
| "in_progress" | |
| ], | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "type": "object" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "original": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "type": "object" | |
| }, | |
| "required_transcodes": { | |
| "$ref": "#/components/schemas/RequiredTranscodes" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "file", | |
| "folder" | |
| ], | |
| "type": "string" | |
| }, | |
| "view_count": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "AssetSearch": { | |
| "properties": { | |
| "account_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "include": { | |
| "type": "string" | |
| }, | |
| "page": { | |
| "description": "The page to retrieve", | |
| "type": "integer" | |
| }, | |
| "page_size": { | |
| "description": "The number of results to include in the page", | |
| "type": "integer" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "type": "object" | |
| }, | |
| "shared_projects": { | |
| "type": "boolean" | |
| }, | |
| "team_id": { | |
| "oneOf": [ | |
| { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| { | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| ] | |
| }, | |
| "type": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "AssetSource": { | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Audit": { | |
| "properties": { | |
| "account_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "action": { | |
| "type": "string" | |
| }, | |
| "actor": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/User" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/AnonymousUser" | |
| } | |
| ] | |
| }, | |
| "actor_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "application_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "ip_address": { | |
| "type": "string" | |
| }, | |
| "item_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "item_type": { | |
| "type": "string" | |
| }, | |
| "request_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "resource": { | |
| "type": "object" | |
| }, | |
| "team_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Collaborator": { | |
| "properties": { | |
| "_type": { | |
| "enum": [ | |
| "collaborator", | |
| "pending_collaborator" | |
| ], | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/components/schemas/User" | |
| }, | |
| "user_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Comment": { | |
| "properties": { | |
| "annotation": { | |
| "type": "string" | |
| }, | |
| "completed_at": { | |
| "type": "string" | |
| }, | |
| "completer_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "has_replies": { | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "like_count": { | |
| "type": "integer" | |
| }, | |
| "owner": { | |
| "$ref": "#/components/schemas/User" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "HTTPError": { | |
| "properties": { | |
| "code": { | |
| "type": "integer" | |
| }, | |
| "errors": { | |
| "items": { | |
| "properties": { | |
| "code": { | |
| "type": "integer" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "type": "array" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Presentation": { | |
| "properties": { | |
| "asset": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "assets": { | |
| "items": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "type": "array" | |
| }, | |
| "autoplay": { | |
| "type": "boolean" | |
| }, | |
| "available_features": { | |
| "type": "object" | |
| }, | |
| "background_color": { | |
| "type": "string" | |
| }, | |
| "can_download": { | |
| "type": "boolean" | |
| }, | |
| "color": { | |
| "type": "string" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "enabled": { | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "format": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "include_ext": { | |
| "type": "boolean" | |
| }, | |
| "include_upload_date": { | |
| "type": "boolean" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "layout": { | |
| "enum": [ | |
| "blog", | |
| "reel" | |
| ], | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "presentation_items": { | |
| "items": { | |
| "$ref": "#/components/schemas/PresentationItem" | |
| }, | |
| "type": "array" | |
| }, | |
| "project": { | |
| "$ref": "#/components/schemas/Project" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "secure": { | |
| "type": "boolean" | |
| }, | |
| "short_url": { | |
| "type": "string" | |
| }, | |
| "style": { | |
| "type": "string" | |
| }, | |
| "team": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "text_color": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "vanity": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "PresentationItem": { | |
| "properties": { | |
| "asset": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "index": { | |
| "type": "integer" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "presentation": { | |
| "$ref": "#/components/schemas/Presentation" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Project": { | |
| "properties": { | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "private": { | |
| "type": "boolean" | |
| }, | |
| "project_preferences": { | |
| "$ref": "#/components/schemas/ProjectPreferences" | |
| }, | |
| "root_asset": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "root_asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "team_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ProjectMembership": { | |
| "properties": { | |
| "collaborator": { | |
| "type": "boolean" | |
| }, | |
| "owner": { | |
| "type": "boolean" | |
| }, | |
| "team_member": { | |
| "type": "boolean" | |
| }, | |
| "team_role": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ProjectPreferences": { | |
| "properties": { | |
| "collaborator_can_download": { | |
| "type": "boolean" | |
| }, | |
| "collaborator_can_invite": { | |
| "type": "boolean" | |
| }, | |
| "collaborator_can_share": { | |
| "type": "boolean" | |
| }, | |
| "notify_on_new_asset": { | |
| "type": "boolean" | |
| }, | |
| "notify_on_new_collaborator": { | |
| "type": "boolean" | |
| }, | |
| "notify_on_new_comment": { | |
| "type": "boolean" | |
| }, | |
| "notify_on_updated_label": { | |
| "type": "boolean" | |
| }, | |
| "notify_slack": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "RequiredTranscodes": { | |
| "properties": { | |
| "cover": { | |
| "type": "boolean" | |
| }, | |
| "finalized": { | |
| "items": { | |
| "enum": [ | |
| "thumb", | |
| "thumb_540", | |
| "thumb_scrub", | |
| "image_full", | |
| "image_high", | |
| "cover", | |
| "h264_360", | |
| "h264_540", | |
| "h264_720", | |
| "h264_1080_best", | |
| "h264_2160", | |
| "page_proxy" | |
| ], | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "h264_1080_best": { | |
| "type": "boolean" | |
| }, | |
| "h264_2160": { | |
| "type": "boolean" | |
| }, | |
| "h264_360": { | |
| "type": "boolean" | |
| }, | |
| "h264_540": { | |
| "type": "boolean" | |
| }, | |
| "h264_720": { | |
| "type": "boolean" | |
| }, | |
| "image_full": { | |
| "type": "boolean" | |
| }, | |
| "image_high": { | |
| "type": "boolean" | |
| }, | |
| "page_proxy": { | |
| "type": "boolean" | |
| }, | |
| "thumb": { | |
| "type": "boolean" | |
| }, | |
| "thumb_540": { | |
| "type": "boolean" | |
| }, | |
| "thumb_scrub": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ReviewLink": { | |
| "properties": { | |
| "allow_approvals": { | |
| "default": true, | |
| "type": "boolean" | |
| }, | |
| "available_features": { | |
| "type": "object" | |
| }, | |
| "current_version_only": { | |
| "default": false, | |
| "type": "boolean" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "enable_downloading": { | |
| "default": true, | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "has_password": { | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "is_active": { | |
| "default": true, | |
| "type": "boolean" | |
| }, | |
| "item_count": { | |
| "default": 0, | |
| "type": "integer" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/ReviewLinkItem" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "notify_on_view": { | |
| "default": true, | |
| "type": "boolean" | |
| }, | |
| "owner": { | |
| "$ref": "#/components/schemas/User" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "project": { | |
| "$ref": "#/components/schemas/Project" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "short_url": { | |
| "type": "string" | |
| }, | |
| "team": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "view_count": { | |
| "default": 0, | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ReviewLinkItem": { | |
| "properties": { | |
| "asset": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "index": { | |
| "type": "integer" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "review_link": { | |
| "$ref": "#/components/schemas/ReviewLink" | |
| }, | |
| "review_link_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Team": { | |
| "properties": { | |
| "access": { | |
| "enum": [ | |
| "public", | |
| "private" | |
| ], | |
| "type": "string" | |
| }, | |
| "collaborator_count": { | |
| "type": "integer" | |
| }, | |
| "file_count": { | |
| "type": "integer" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "project_count": { | |
| "type": "integer" | |
| }, | |
| "storage": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "User": { | |
| "properties": { | |
| "account_id": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| }, | |
| "securitySchemes": { | |
| "JWTAuth": { | |
| "bearerFormat": "JWT", | |
| "scheme": "bearer", | |
| "type": "http" | |
| }, | |
| "OAuth": { | |
| "flows": { | |
| "authorizationCode": { | |
| "authorizationUrl": "https://applications.frame.io/oauth2/auth", | |
| "refreshUrl": "https://applications.frame.io/oauth2/token", | |
| "scopes": { | |
| "account.read": "read accounts", | |
| "asset.create": "create assets", | |
| "asset.delete": "delete assets", | |
| "asset.read": "read assets", | |
| "asset.update": "modify assets", | |
| "auditlog.read": "read audit logs", | |
| "comment.create": "create comments", | |
| "comment.delete": "delete comments", | |
| "comment.read": "read comments", | |
| "comment.update": "modify comments", | |
| "offline": "generate refresh tokens", | |
| "presentation.create": "create presentations", | |
| "presentation.delete": "delete presentations", | |
| "presentation.read": "read presentations", | |
| "presentation.update": "modify presentations", | |
| "project.create": "create projects", | |
| "project.delete": "delete projects", | |
| "project.read": "read projects", | |
| "project.update": "modify projects", | |
| "reviewlink.create": "create review links", | |
| "reviewlink.delete": "delete review links", | |
| "reviewlink.read": "read review links", | |
| "reviewlink.update": "modify review links", | |
| "team.read": "read teams", | |
| "team.update": "modify teams" | |
| }, | |
| "tokenUrl": "https://applications.frame.io/oauth2/token" | |
| }, | |
| "implicit": { | |
| "authorizationUrl": "https://applications.frame.io/oauth2/auth", | |
| "scopes": { | |
| "account.read": "read accounts", | |
| "asset.create": "create assets", | |
| "asset.delete": "delete assets", | |
| "asset.read": "read assets", | |
| "asset.update": "modify assets", | |
| "auditlog.read": "read audit logs", | |
| "comment.create": "create comments", | |
| "comment.delete": "delete comments", | |
| "comment.read": "read comments", | |
| "comment.update": "modify comments", | |
| "offline": "generate refresh tokens", | |
| "presentation.create": "create presentations", | |
| "presentation.delete": "delete presentations", | |
| "presentation.read": "read presentations", | |
| "presentation.update": "modify presentations", | |
| "project.create": "create projects", | |
| "project.delete": "delete projects", | |
| "project.read": "read projects", | |
| "project.update": "modify projects", | |
| "reviewlink.create": "create review links", | |
| "reviewlink.delete": "delete review links", | |
| "reviewlink.read": "read review links", | |
| "reviewlink.update": "modify review links", | |
| "team.read": "read teams", | |
| "team.update": "modify teams" | |
| } | |
| } | |
| }, | |
| "type": "oauth2" | |
| }, | |
| "SecretTokenAuth": { | |
| "scheme": "token", | |
| "type": "http" | |
| }, | |
| "UserTokenAuth": { | |
| "scheme": "bearer", | |
| "type": "http" | |
| } | |
| } | |
| }, | |
| "info": { | |
| "description": "Documentation for the Frame.io API", | |
| "title": "Frame.io v2 API", | |
| "version": "2.0.0" | |
| }, | |
| "openapi": "3.0.0", | |
| "paths": { | |
| "/v2/accounts/{account_id}/audit_logs": { | |
| "get": { | |
| "operationId": "getAuditLogs", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "account_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AuditsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "auditlog.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get Audit Logs for an Account", | |
| "tags": [ | |
| "Audit Logs" | |
| ] | |
| } | |
| }, | |
| "/v2/accounts/{account_id}/teams": { | |
| "get": { | |
| "operationId": "getTeamsByAccount", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "account_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/TeamsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "team.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get teams for user or account", | |
| "tags": [ | |
| "Teams" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{asset_id}/children": { | |
| "get": { | |
| "operationId": "getAssets", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "include_deleted", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Gets an Asset's children", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "createAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/AssetCreateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Create an asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{asset_id}/comments": { | |
| "get": { | |
| "operationId": "getComments", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get comments by asset or get replies by comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "createComment", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/CommentRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Create a comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{asset_id}/presentations": { | |
| "get": { | |
| "operationId": "getAssetPresentations", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Gets a paginated list of presentations", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "createPresentation", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/PresentationCreateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Create an asset presentation", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{asset_id}/unversion": { | |
| "delete": { | |
| "operationId": "unversionAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Unversion an Asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{asset_id}/version": { | |
| "post": { | |
| "operationId": "addVersionToAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "properties": { | |
| "next_asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "next_asset_id" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Add a version to an Asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{id}": { | |
| "delete": { | |
| "operationId": "deleteAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.delete" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Delete an asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| }, | |
| "get": { | |
| "operationId": "getAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "include_deleted", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get an asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "updateAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/AssetUpdateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Update an asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| } | |
| }, | |
| "/v2/comments/{comment_id}/replies": { | |
| "get": { | |
| "operationId": "getReplies", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "comment_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get comments by asset or get replies by comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "createReply", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "comment_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/CommentRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Create a comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| } | |
| }, | |
| "/v2/comments/{id}": { | |
| "delete": { | |
| "operationId": "deleteComment", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.delete" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Deletes a comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| }, | |
| "get": { | |
| "operationId": "getComment", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get a comment by id.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "updateComment", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/CommentRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Update a comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| } | |
| }, | |
| "/v2/me": { | |
| "get": { | |
| "operationId": "getMe", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/UserResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get the current authenticated user.", | |
| "tags": [ | |
| "Users" | |
| ] | |
| } | |
| }, | |
| "/v2/presentations": { | |
| "get": { | |
| "operationId": "getUserPresentations", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Gets a paginated list of presentations", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| } | |
| }, | |
| "/v2/presentations/{id}": { | |
| "delete": { | |
| "operationId": "deletePresentation", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.delete" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Delete a presentation", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| }, | |
| "get": { | |
| "operationId": "showPresentation", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Show a presentation", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "updatePresentation", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/PresentationUpdateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Update a presentation", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| } | |
| }, | |
| "/v2/projects/{id}": { | |
| "delete": { | |
| "operationId": "deleteProject", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.delete" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Delete project by ID", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| }, | |
| "get": { | |
| "operationId": "getProject", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get project by id", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "updateProject", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/ProjectRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Update a project", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| } | |
| }, | |
| "/v2/projects/{project_id}/collaborators": { | |
| "post": { | |
| "operationId": "addCollaboratorToProject", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "project_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/CollaboratorRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CollaboratorResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Add a collaborator to a project", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| } | |
| }, | |
| "/v2/projects/{project_id}/membership": { | |
| "get": { | |
| "operationId": "getProjectMembership", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "project_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "user_id", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectMembershipResonse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get user(s) membership for project", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| } | |
| }, | |
| "/v2/projects/{project_id}/presentations": { | |
| "get": { | |
| "operationId": "getProjectPresentations", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "project_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Gets a paginated list of presentations", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| } | |
| }, | |
| "/v2/projects/{project_id}/review_links": { | |
| "get": { | |
| "operationId": "reviewLinksList", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "project_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinksResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get a review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "reviewLinkCreate", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "project_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/ReviewLinkCreateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Creates a new review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| } | |
| }, | |
| "/v2/review_links/{id}": { | |
| "delete": { | |
| "operationId": "reviewLinkDelete", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.delete" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Delete a review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| }, | |
| "get": { | |
| "operationId": "reviewLinkGet", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "include", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get a review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "reviewLinkUpdate", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/ReviewLinkUpdateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Update a review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| } | |
| }, | |
| "/v2/review_links/{review_link_id}/assets": { | |
| "post": { | |
| "operationId": "reviewLinkItemCreate", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "review_link_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/ReviewLinkItemCreateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Add an Asset to a Review Link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| } | |
| }, | |
| "/v2/review_links/{review_link_id}/items": { | |
| "get": { | |
| "operationId": "reviewLinkItemsList", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "review_link_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "include", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkItemsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get the items in a review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| } | |
| }, | |
| "/v2/search/assets": { | |
| "get": { | |
| "operationId": "assetSearchGet", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "account_id", | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "include", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "description": "The page to retrieve", | |
| "in": "query", | |
| "name": "page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| { | |
| "description": "The number of results to include in the page", | |
| "in": "query", | |
| "name": "page_size", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "project_id", | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "properties", | |
| "schema": { | |
| "type": "object" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "shared_projects", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "team_id", | |
| "schema": { | |
| "oneOf": [ | |
| { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| { | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| ] | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "type", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Search for Assets", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "assetSearchPost", | |
| "parameters": [], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/AssetSearchRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Search for Assets", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| } | |
| }, | |
| "/v2/teams": { | |
| "get": { | |
| "operationId": "getTeams", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/TeamsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "team.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get teams for user or account", | |
| "tags": [ | |
| "Teams" | |
| ] | |
| } | |
| }, | |
| "/v2/teams/{team_id}/members": { | |
| "post": { | |
| "operationId": "addTeamMember", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "team_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/TeamMemberRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/TeamMemberResonse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "team.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Add a team member", | |
| "tags": [ | |
| "Teams" | |
| ] | |
| } | |
| }, | |
| "/v2/teams/{team_id}/membership": { | |
| "get": { | |
| "operationId": "getMembershipByTeam", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "team_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/TeamMembershipResonse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "team.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get user membership for team", | |
| "tags": [ | |
| "Teams" | |
| ] | |
| } | |
| }, | |
| "/v2/teams/{team_id}/projects": { | |
| "get": { | |
| "operationId": "getProjectsByTeam", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "team_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get projects by team", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "createProject", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "team_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/ProjectRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Create a project", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| } | |
| } | |
| }, | |
| "servers": [ | |
| { | |
| "url": "https://api.frame.io" | |
| } | |
| ], | |
| "x-explorer-enabled": true, | |
| "x-proxy-enabled": true, | |
| "x-samples-enabled": true, | |
| "x-samples-languages": [ | |
| "curl", | |
| "node", | |
| "ruby", | |
| "javascript", | |
| "python" | |
| ] | |
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "components": { | |
| "requestBodies": { | |
| "AssetCreateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "description": { | |
| "description": "Brief description of the Asset", | |
| "type": "string" | |
| }, | |
| "filesize": { | |
| "description": "The file size in bytes", | |
| "type": "integer" | |
| }, | |
| "filetype": { | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Name of the Asset", | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "description": "Custom key-value data", | |
| "type": "object" | |
| }, | |
| "source": { | |
| "$ref": "#/components/schemas/AssetSource" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "file", | |
| "folder" | |
| ], | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "type", | |
| "name", | |
| "filesize" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Asset to create" | |
| }, | |
| "AssetSearchRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "$ref": "#/components/schemas/AssetSearch" | |
| } | |
| } | |
| }, | |
| "description": "Asset search" | |
| }, | |
| "AssetUpdateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "description": { | |
| "description": "Brief description of the Asset", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "description": "Name of the Asset", | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "description": "Custom key-value data", | |
| "type": "object" | |
| } | |
| }, | |
| "required": [ | |
| "name" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Asset to update" | |
| }, | |
| "CollaboratorRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Collaborator to create or update" | |
| }, | |
| "CommentRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "annotation": { | |
| "description": "Serialized list of geometry and/or drawing data.", | |
| "type": "string" | |
| }, | |
| "page": { | |
| "description": "Page number for a comment (documents only).", | |
| "type": "integer" | |
| }, | |
| "pitch": { | |
| "description": "Pitch measurement for the comment (360deg video only).", | |
| "type": "integer" | |
| }, | |
| "text": { | |
| "description": "The body of the comment.", | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "description": "Timestamp for the comment, in frames.", | |
| "type": "integer" | |
| }, | |
| "yaw": { | |
| "description": "Yaw measurement for the comment (360deg video only).", | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Comment to create or update" | |
| }, | |
| "PresentationCreateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "autoplay": { | |
| "type": "boolean" | |
| }, | |
| "background_color": { | |
| "type": "string" | |
| }, | |
| "can_download": { | |
| "type": "boolean" | |
| }, | |
| "color": { | |
| "type": "string" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "enabled": { | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "format": { | |
| "type": "string" | |
| }, | |
| "include_ext": { | |
| "type": "boolean" | |
| }, | |
| "include_upload_date": { | |
| "type": "boolean" | |
| }, | |
| "layout": { | |
| "enum": [ | |
| "blog", | |
| "reel" | |
| ], | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "secure": { | |
| "type": "boolean" | |
| }, | |
| "style": { | |
| "type": "string" | |
| }, | |
| "text_color": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "project_id", | |
| "owner_id", | |
| "asset_id" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Presentation to create" | |
| }, | |
| "PresentationUpdateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "autoplay": { | |
| "type": "boolean" | |
| }, | |
| "background_color": { | |
| "type": "string" | |
| }, | |
| "can_download": { | |
| "type": "boolean" | |
| }, | |
| "color": { | |
| "type": "string" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "enabled": { | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "format": { | |
| "type": "string" | |
| }, | |
| "include_ext": { | |
| "type": "boolean" | |
| }, | |
| "include_upload_date": { | |
| "type": "boolean" | |
| }, | |
| "layout": { | |
| "enum": [ | |
| "blog", | |
| "reel" | |
| ], | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "secure": { | |
| "type": "boolean" | |
| }, | |
| "style": { | |
| "type": "string" | |
| }, | |
| "text_color": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Presentation to update" | |
| }, | |
| "ProjectRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "name": { | |
| "description": "Project name", | |
| "type": "string" | |
| }, | |
| "private": { | |
| "description": "If true, the project is private to the creating user", | |
| "type": "boolean" | |
| }, | |
| "project_preferences": { | |
| "$ref": "#/components/schemas/ProjectPreferences" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Project to create or update" | |
| }, | |
| "ReviewLinkCreateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "allow_approvals": { | |
| "type": "boolean" | |
| }, | |
| "current_version_only": { | |
| "type": "boolean" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "enable_downloading": { | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "is_active": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "notify_on_view": { | |
| "type": "boolean" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "secure": { | |
| "type": "boolean" | |
| }, | |
| "view_count": { | |
| "type": "integer" | |
| } | |
| }, | |
| "required": [ | |
| "project_id", | |
| "owner_id", | |
| "name" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLink to create" | |
| }, | |
| "ReviewLinkItemCreateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "asset_ids": { | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLinkItem to create" | |
| }, | |
| "ReviewLinkUpdateRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "allow_approvals": { | |
| "type": "boolean" | |
| }, | |
| "current_version_only": { | |
| "type": "boolean" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "enable_downloading": { | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "is_active": { | |
| "type": "boolean" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "notify_on_view": { | |
| "type": "boolean" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "secure": { | |
| "type": "boolean" | |
| }, | |
| "view_count": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLink to update" | |
| }, | |
| "TeamMemberRequest": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "properties": { | |
| "email": { | |
| "type": "string" | |
| }, | |
| "role": { | |
| "type": "string" | |
| }, | |
| "user_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "role" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Team member to create or update" | |
| } | |
| }, | |
| "responses": { | |
| "AssetResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "$ref": "#/components/schemas/Asset" | |
| } | |
| } | |
| }, | |
| "description": "Asset success response" | |
| }, | |
| "AssetsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Assets success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "AuditsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Audit" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Audit logs list response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "CollaboratorResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "$ref": "#/components/schemas/Collaborator" | |
| } | |
| } | |
| }, | |
| "description": "Collaborator success response" | |
| }, | |
| "CommentResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "annotation": "[...]", | |
| "completed_at": null, | |
| "completer_id": null, | |
| "has_replies": true, | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "like_count": 10, | |
| "owner": "Elixir.API.Docs.Schemas.User", | |
| "owner_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", | |
| "text": "This is a comment.", | |
| "timestamp": 60 | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "$ref": "#/components/schemas/Comment" | |
| } | |
| } | |
| }, | |
| "description": "Comment success response" | |
| }, | |
| "CommentsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": [ | |
| { | |
| "annotation": "[...]", | |
| "completed_at": null, | |
| "completer_id": null, | |
| "has_replies": true, | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "like_count": 10, | |
| "owner": "Elixir.User", | |
| "owner_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", | |
| "text": "This is a comment.", | |
| "timestamp": 60 | |
| } | |
| ] | |
| } | |
| }, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Comment" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Comments success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "PresentationResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "$ref": "#/components/schemas/Presentation" | |
| } | |
| } | |
| }, | |
| "description": "Presentation success response" | |
| }, | |
| "PresentationsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Presentation" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Presentations success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "ProjectMembershipResonse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "collaborator": true, | |
| "owner": true, | |
| "team_member": true, | |
| "team_role": "team_manager" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "$ref": "#/components/schemas/ProjectMembership" | |
| } | |
| } | |
| }, | |
| "description": "Project membership success response" | |
| }, | |
| "ProjectResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "name": "My Project", | |
| "owner_id": "dddddddd-dddd-dddd-dddd-dddddddddddd", | |
| "private": false, | |
| "project_preferences": {}, | |
| "root_asset_id": "cccccccc-cccc-cccc-cccc-cccccccccccc", | |
| "team_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "$ref": "#/components/schemas/Project" | |
| } | |
| } | |
| }, | |
| "description": "Project success response" | |
| }, | |
| "ProjectsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": [ | |
| { | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "name": "My Project", | |
| "owner_id": "dddddddd-dddd-dddd-dddd-dddddddddddd", | |
| "private": false, | |
| "project_preferences": {}, | |
| "root_asset_id": "cccccccc-cccc-cccc-cccc-cccccccccccc", | |
| "team_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb" | |
| } | |
| ] | |
| } | |
| }, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Project" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Paginated projects success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "ReviewLinkItemsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/ReviewLinkItem" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLinkItems success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "ReviewLinkResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "$ref": "#/components/schemas/ReviewLink" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLink success response" | |
| }, | |
| "ReviewLinksResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": {}, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/ReviewLink" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "ReviewLink success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "TeamMemberResonse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "role": "team_manager", | |
| "user_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "properties": { | |
| "role": { | |
| "type": "string" | |
| }, | |
| "user_id": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Team member success response" | |
| }, | |
| "TeamMembershipResonse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "role": "team_manager" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "properties": { | |
| "role": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| } | |
| }, | |
| "description": "Team membership success response" | |
| }, | |
| "TeamsResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": [ | |
| { | |
| "access": "public", | |
| "collaborator_count": 3, | |
| "file_count": 1, | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "name": "My Team", | |
| "project_count": 2, | |
| "storage": 123456 | |
| } | |
| ] | |
| } | |
| }, | |
| "schema": { | |
| "items": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "type": "array" | |
| } | |
| } | |
| }, | |
| "description": "Paginated teams success response", | |
| "headers": { | |
| "link": { | |
| "description": "Pagination links", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| "page-number": { | |
| "description": "Current page of results", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "per-page": { | |
| "description": "Number of entries per page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total": { | |
| "description": "Total entries across all pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| "total-pages": { | |
| "description": "Number of pages", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "Unauthorized": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "code": 401, | |
| "errors": [ | |
| { | |
| "code": 401, | |
| "detail": "You are not allowed to access that resource", | |
| "status": 401, | |
| "title": "Not Authorized" | |
| } | |
| ], | |
| "message": "Not Authorized" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "$ref": "#/components/schemas/HTTPError" | |
| } | |
| } | |
| }, | |
| "description": "Unauthorized response" | |
| }, | |
| "UserResponse": { | |
| "content": { | |
| "application/json": { | |
| "examples": { | |
| "response": { | |
| "value": { | |
| "account_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb", | |
| "email": "jane@frame.io", | |
| "id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa", | |
| "name": "Jane Doe" | |
| } | |
| } | |
| }, | |
| "schema": { | |
| "$ref": "#/components/schemas/User" | |
| } | |
| } | |
| }, | |
| "description": "User success response" | |
| } | |
| }, | |
| "schemas": { | |
| "AnonymousUser": { | |
| "properties": { | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "notification_preferences": { | |
| "$ref": "#/components/schemas/ProjectPreferences" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "user_default_color": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Asset": { | |
| "properties": { | |
| "asset_type": { | |
| "enum": [ | |
| "stream", | |
| "image", | |
| "document" | |
| ], | |
| "type": "string" | |
| }, | |
| "creator": { | |
| "$ref": "#/components/schemas/User" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "label": { | |
| "enum": [ | |
| "approved", | |
| "needs_review", | |
| "in_progress" | |
| ], | |
| "type": "string" | |
| }, | |
| "metadata": { | |
| "type": "object" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "original": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "type": "object" | |
| }, | |
| "required_transcodes": { | |
| "$ref": "#/components/schemas/RequiredTranscodes" | |
| }, | |
| "type": { | |
| "enum": [ | |
| "file", | |
| "folder" | |
| ], | |
| "type": "string" | |
| }, | |
| "view_count": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "AssetSearch": { | |
| "properties": { | |
| "account_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "include": { | |
| "type": "string" | |
| }, | |
| "page": { | |
| "description": "The page to retrieve", | |
| "type": "integer" | |
| }, | |
| "page_size": { | |
| "description": "The number of results to include in the page", | |
| "type": "integer" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "type": "object" | |
| }, | |
| "shared_projects": { | |
| "type": "boolean" | |
| }, | |
| "team_id": { | |
| "oneOf": [ | |
| { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| { | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| ] | |
| }, | |
| "type": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "AssetSource": { | |
| "properties": { | |
| "url": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Audit": { | |
| "properties": { | |
| "account_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "action": { | |
| "type": "string" | |
| }, | |
| "actor": { | |
| "oneOf": [ | |
| { | |
| "$ref": "#/components/schemas/User" | |
| }, | |
| { | |
| "$ref": "#/components/schemas/AnonymousUser" | |
| } | |
| ] | |
| }, | |
| "actor_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "application_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "ip_address": { | |
| "type": "string" | |
| }, | |
| "item_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "item_type": { | |
| "type": "string" | |
| }, | |
| "request_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "resource": { | |
| "type": "object" | |
| }, | |
| "team_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Collaborator": { | |
| "properties": { | |
| "_type": { | |
| "enum": [ | |
| "collaborator", | |
| "pending_collaborator" | |
| ], | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "user": { | |
| "$ref": "#/components/schemas/User" | |
| }, | |
| "user_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Comment": { | |
| "properties": { | |
| "annotation": { | |
| "type": "string" | |
| }, | |
| "completed_at": { | |
| "type": "string" | |
| }, | |
| "completer_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "has_replies": { | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "like_count": { | |
| "type": "integer" | |
| }, | |
| "owner": { | |
| "$ref": "#/components/schemas/User" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "text": { | |
| "type": "string" | |
| }, | |
| "timestamp": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "HTTPError": { | |
| "properties": { | |
| "code": { | |
| "type": "integer" | |
| }, | |
| "errors": { | |
| "items": { | |
| "properties": { | |
| "code": { | |
| "type": "integer" | |
| }, | |
| "detail": { | |
| "type": "string" | |
| }, | |
| "status": { | |
| "type": "integer" | |
| }, | |
| "title": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "type": "array" | |
| }, | |
| "message": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Presentation": { | |
| "properties": { | |
| "asset": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "assets": { | |
| "items": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "type": "array" | |
| }, | |
| "autoplay": { | |
| "type": "boolean" | |
| }, | |
| "available_features": { | |
| "type": "object" | |
| }, | |
| "background_color": { | |
| "type": "string" | |
| }, | |
| "can_download": { | |
| "type": "boolean" | |
| }, | |
| "color": { | |
| "type": "string" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "description": { | |
| "type": "string" | |
| }, | |
| "enabled": { | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "format": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "include_ext": { | |
| "type": "boolean" | |
| }, | |
| "include_upload_date": { | |
| "type": "boolean" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "layout": { | |
| "enum": [ | |
| "blog", | |
| "reel" | |
| ], | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "presentation_items": { | |
| "items": { | |
| "$ref": "#/components/schemas/PresentationItem" | |
| }, | |
| "type": "array" | |
| }, | |
| "project": { | |
| "$ref": "#/components/schemas/Project" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "secure": { | |
| "type": "boolean" | |
| }, | |
| "short_url": { | |
| "type": "string" | |
| }, | |
| "style": { | |
| "type": "string" | |
| }, | |
| "team": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "text_color": { | |
| "type": "string" | |
| }, | |
| "title": { | |
| "type": "string" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "vanity": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "PresentationItem": { | |
| "properties": { | |
| "asset": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "index": { | |
| "type": "integer" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "presentation": { | |
| "$ref": "#/components/schemas/Presentation" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Project": { | |
| "properties": { | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "private": { | |
| "type": "boolean" | |
| }, | |
| "project_preferences": { | |
| "$ref": "#/components/schemas/ProjectPreferences" | |
| }, | |
| "root_asset": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "root_asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "team_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ProjectMembership": { | |
| "properties": { | |
| "collaborator": { | |
| "type": "boolean" | |
| }, | |
| "owner": { | |
| "type": "boolean" | |
| }, | |
| "team_member": { | |
| "type": "boolean" | |
| }, | |
| "team_role": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ProjectPreferences": { | |
| "properties": { | |
| "collaborator_can_download": { | |
| "type": "boolean" | |
| }, | |
| "collaborator_can_invite": { | |
| "type": "boolean" | |
| }, | |
| "collaborator_can_share": { | |
| "type": "boolean" | |
| }, | |
| "notify_on_new_asset": { | |
| "type": "boolean" | |
| }, | |
| "notify_on_new_collaborator": { | |
| "type": "boolean" | |
| }, | |
| "notify_on_new_comment": { | |
| "type": "boolean" | |
| }, | |
| "notify_on_updated_label": { | |
| "type": "boolean" | |
| }, | |
| "notify_slack": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "RequiredTranscodes": { | |
| "properties": { | |
| "cover": { | |
| "type": "boolean" | |
| }, | |
| "finalized": { | |
| "items": { | |
| "enum": [ | |
| "thumb", | |
| "thumb_540", | |
| "thumb_scrub", | |
| "image_full", | |
| "image_high", | |
| "cover", | |
| "h264_360", | |
| "h264_540", | |
| "h264_720", | |
| "h264_1080_best", | |
| "h264_2160", | |
| "page_proxy" | |
| ], | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| }, | |
| "h264_1080_best": { | |
| "type": "boolean" | |
| }, | |
| "h264_2160": { | |
| "type": "boolean" | |
| }, | |
| "h264_360": { | |
| "type": "boolean" | |
| }, | |
| "h264_540": { | |
| "type": "boolean" | |
| }, | |
| "h264_720": { | |
| "type": "boolean" | |
| }, | |
| "image_full": { | |
| "type": "boolean" | |
| }, | |
| "image_high": { | |
| "type": "boolean" | |
| }, | |
| "page_proxy": { | |
| "type": "boolean" | |
| }, | |
| "thumb": { | |
| "type": "boolean" | |
| }, | |
| "thumb_540": { | |
| "type": "boolean" | |
| }, | |
| "thumb_scrub": { | |
| "type": "boolean" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ReviewLink": { | |
| "properties": { | |
| "allow_approvals": { | |
| "default": true, | |
| "type": "boolean" | |
| }, | |
| "available_features": { | |
| "type": "object" | |
| }, | |
| "current_version_only": { | |
| "default": false, | |
| "type": "boolean" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "enable_downloading": { | |
| "default": true, | |
| "type": "boolean" | |
| }, | |
| "expires_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "has_password": { | |
| "type": "boolean" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "is_active": { | |
| "default": true, | |
| "type": "boolean" | |
| }, | |
| "item_count": { | |
| "default": 0, | |
| "type": "integer" | |
| }, | |
| "items": { | |
| "items": { | |
| "$ref": "#/components/schemas/ReviewLinkItem" | |
| }, | |
| "type": "array" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "notify_on_view": { | |
| "default": true, | |
| "type": "boolean" | |
| }, | |
| "owner": { | |
| "$ref": "#/components/schemas/User" | |
| }, | |
| "owner_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "password": { | |
| "type": "string" | |
| }, | |
| "project": { | |
| "$ref": "#/components/schemas/Project" | |
| }, | |
| "project_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "short_url": { | |
| "type": "string" | |
| }, | |
| "team": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "view_count": { | |
| "default": 0, | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "ReviewLinkItem": { | |
| "properties": { | |
| "asset": { | |
| "$ref": "#/components/schemas/Asset" | |
| }, | |
| "asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "deleted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "index": { | |
| "type": "integer" | |
| }, | |
| "inserted_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| }, | |
| "review_link": { | |
| "$ref": "#/components/schemas/ReviewLink" | |
| }, | |
| "review_link_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "updated_at": { | |
| "format": "date-time", | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "Team": { | |
| "properties": { | |
| "access": { | |
| "enum": [ | |
| "public", | |
| "private" | |
| ], | |
| "type": "string" | |
| }, | |
| "collaborator_count": { | |
| "type": "integer" | |
| }, | |
| "file_count": { | |
| "type": "integer" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| }, | |
| "project_count": { | |
| "type": "integer" | |
| }, | |
| "storage": { | |
| "type": "integer" | |
| } | |
| }, | |
| "type": "object" | |
| }, | |
| "User": { | |
| "properties": { | |
| "account_id": { | |
| "type": "string" | |
| }, | |
| "email": { | |
| "type": "string" | |
| }, | |
| "id": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "name": { | |
| "type": "string" | |
| } | |
| }, | |
| "type": "object" | |
| } | |
| }, | |
| "securitySchemes": { | |
| "JWTAuth": { | |
| "bearerFormat": "JWT", | |
| "scheme": "bearer", | |
| "type": "http" | |
| }, | |
| "OAuth": { | |
| "flows": { | |
| "authorizationCode": { | |
| "authorizationUrl": "https://applications.frame.io/oauth2/auth", | |
| "refreshUrl": "https://applications.frame.io/oauth2/token", | |
| "scopes": { | |
| "account.read": "read accounts", | |
| "asset.create": "create assets", | |
| "asset.delete": "delete assets", | |
| "asset.read": "read assets", | |
| "asset.update": "modify assets", | |
| "auditlog.read": "read audit logs", | |
| "comment.create": "create comments", | |
| "comment.delete": "delete comments", | |
| "comment.read": "read comments", | |
| "comment.update": "modify comments", | |
| "offline": "generate refresh tokens", | |
| "presentation.create": "create presentations", | |
| "presentation.delete": "delete presentations", | |
| "presentation.read": "read presentations", | |
| "presentation.update": "modify presentations", | |
| "project.create": "create projects", | |
| "project.delete": "delete projects", | |
| "project.read": "read projects", | |
| "project.update": "modify projects", | |
| "reviewlink.create": "create review links", | |
| "reviewlink.delete": "delete review links", | |
| "reviewlink.read": "read review links", | |
| "reviewlink.update": "modify review links", | |
| "team.read": "read teams", | |
| "team.update": "modify teams" | |
| }, | |
| "tokenUrl": "https://applications.frame.io/oauth2/token" | |
| }, | |
| "implicit": { | |
| "authorizationUrl": "https://applications.frame.io/oauth2/auth", | |
| "scopes": { | |
| "account.read": "read accounts", | |
| "asset.create": "create assets", | |
| "asset.delete": "delete assets", | |
| "asset.read": "read assets", | |
| "asset.update": "modify assets", | |
| "auditlog.read": "read audit logs", | |
| "comment.create": "create comments", | |
| "comment.delete": "delete comments", | |
| "comment.read": "read comments", | |
| "comment.update": "modify comments", | |
| "offline": "generate refresh tokens", | |
| "presentation.create": "create presentations", | |
| "presentation.delete": "delete presentations", | |
| "presentation.read": "read presentations", | |
| "presentation.update": "modify presentations", | |
| "project.create": "create projects", | |
| "project.delete": "delete projects", | |
| "project.read": "read projects", | |
| "project.update": "modify projects", | |
| "reviewlink.create": "create review links", | |
| "reviewlink.delete": "delete review links", | |
| "reviewlink.read": "read review links", | |
| "reviewlink.update": "modify review links", | |
| "team.read": "read teams", | |
| "team.update": "modify teams" | |
| } | |
| } | |
| }, | |
| "type": "oauth2" | |
| }, | |
| "SecretTokenAuth": { | |
| "scheme": "token", | |
| "type": "http" | |
| }, | |
| "UserTokenAuth": { | |
| "scheme": "bearer", | |
| "type": "http" | |
| } | |
| } | |
| }, | |
| "info": { | |
| "description": "Documentation for the Frame.io API", | |
| "title": "Frame.io v2 API", | |
| "version": "2.0.0" | |
| }, | |
| "openapi": "3.0.0", | |
| "paths": { | |
| "/v2/accounts/{account_id}/audit_logs": { | |
| "get": { | |
| "operationId": "getAuditLogs", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "account_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AuditsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "auditlog.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get Audit Logs for an Account", | |
| "tags": [ | |
| "Audit Logs" | |
| ] | |
| } | |
| }, | |
| "/v2/accounts/{account_id}/teams": { | |
| "get": { | |
| "operationId": "getTeamsByAccount", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "account_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/TeamsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "team.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get teams for user or account", | |
| "tags": [ | |
| "Teams" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{asset_id}/children": { | |
| "get": { | |
| "operationId": "getAssets", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "include_deleted", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Gets an Asset's children", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "createAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/AssetCreateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Create an asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{asset_id}/comments": { | |
| "get": { | |
| "operationId": "getComments", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get comments by asset or get replies by comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "createComment", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/CommentRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Create a comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{asset_id}/presentations": { | |
| "get": { | |
| "operationId": "getAssetPresentations", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Gets a paginated list of presentations", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "createPresentation", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/PresentationCreateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Create an asset presentation", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{asset_id}/unversion": { | |
| "delete": { | |
| "operationId": "unversionAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Unversion an Asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{asset_id}/version": { | |
| "post": { | |
| "operationId": "addVersionToAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "asset_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "properties": { | |
| "next_asset_id": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| "required": [ | |
| "next_asset_id" | |
| ], | |
| "type": "object" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Add a version to an Asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| } | |
| }, | |
| "/v2/assets/{id}": { | |
| "delete": { | |
| "operationId": "deleteAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.delete" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Delete an asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| }, | |
| "get": { | |
| "operationId": "getAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "include_deleted", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get an asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "updateAsset", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/AssetUpdateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Update an asset", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| } | |
| }, | |
| "/v2/comments/{comment_id}/replies": { | |
| "get": { | |
| "operationId": "getReplies", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "comment_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get comments by asset or get replies by comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "createReply", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "comment_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/CommentRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Create a comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| } | |
| }, | |
| "/v2/comments/{id}": { | |
| "delete": { | |
| "operationId": "deleteComment", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.delete" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Deletes a comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| }, | |
| "get": { | |
| "operationId": "getComment", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get a comment by id.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "updateComment", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/CommentRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CommentResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "comment.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Update a comment.", | |
| "tags": [ | |
| "Comments" | |
| ] | |
| } | |
| }, | |
| "/v2/me": { | |
| "get": { | |
| "operationId": "getMe", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/UserResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get the current authenticated user.", | |
| "tags": [ | |
| "Users" | |
| ] | |
| } | |
| }, | |
| "/v2/presentations": { | |
| "get": { | |
| "operationId": "getUserPresentations", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Gets a paginated list of presentations", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| } | |
| }, | |
| "/v2/presentations/{id}": { | |
| "delete": { | |
| "operationId": "deletePresentation", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.delete" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Delete a presentation", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| }, | |
| "get": { | |
| "operationId": "showPresentation", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Show a presentation", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "updatePresentation", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/PresentationUpdateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Update a presentation", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| } | |
| }, | |
| "/v2/projects/{id}": { | |
| "delete": { | |
| "operationId": "deleteProject", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.delete" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Delete project by ID", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| }, | |
| "get": { | |
| "operationId": "getProject", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get project by id", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "updateProject", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/ProjectRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Update a project", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| } | |
| }, | |
| "/v2/projects/{project_id}/collaborators": { | |
| "post": { | |
| "operationId": "addCollaboratorToProject", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "project_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/CollaboratorRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/CollaboratorResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Add a collaborator to a project", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| } | |
| }, | |
| "/v2/projects/{project_id}/membership": { | |
| "get": { | |
| "operationId": "getProjectMembership", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "project_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "user_id", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectMembershipResonse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get user(s) membership for project", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| } | |
| }, | |
| "/v2/projects/{project_id}/presentations": { | |
| "get": { | |
| "operationId": "getProjectPresentations", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "project_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/PresentationsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "presentation.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Gets a paginated list of presentations", | |
| "tags": [ | |
| "Presentations" | |
| ] | |
| } | |
| }, | |
| "/v2/projects/{project_id}/review_links": { | |
| "get": { | |
| "operationId": "reviewLinksList", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "project_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinksResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get a review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "reviewLinkCreate", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "project_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/ReviewLinkCreateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Creates a new review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| } | |
| }, | |
| "/v2/review_links/{id}": { | |
| "delete": { | |
| "operationId": "reviewLinkDelete", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.delete" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Delete a review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| }, | |
| "get": { | |
| "operationId": "reviewLinkGet", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "include", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get a review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| }, | |
| "put": { | |
| "operationId": "reviewLinkUpdate", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/ReviewLinkUpdateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Update a review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| } | |
| }, | |
| "/v2/review_links/{review_link_id}/assets": { | |
| "post": { | |
| "operationId": "reviewLinkItemCreate", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "review_link_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/ReviewLinkItemCreateRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Add an Asset to a Review Link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| } | |
| }, | |
| "/v2/review_links/{review_link_id}/items": { | |
| "get": { | |
| "operationId": "reviewLinkItemsList", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "review_link_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "include", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ReviewLinkItemsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "reviewlink.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get the items in a review link", | |
| "tags": [ | |
| "Review Links" | |
| ] | |
| } | |
| }, | |
| "/v2/search/assets": { | |
| "get": { | |
| "operationId": "assetSearchGet", | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "account_id", | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "include", | |
| "schema": { | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "description": "The page to retrieve", | |
| "in": "query", | |
| "name": "page", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| { | |
| "description": "The number of results to include in the page", | |
| "in": "query", | |
| "name": "page_size", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "project_id", | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "properties", | |
| "schema": { | |
| "type": "object" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "shared_projects", | |
| "schema": { | |
| "type": "boolean" | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "team_id", | |
| "schema": { | |
| "oneOf": [ | |
| { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| { | |
| "items": { | |
| "format": "uuid", | |
| "type": "string" | |
| }, | |
| "type": "array" | |
| } | |
| ] | |
| } | |
| }, | |
| { | |
| "in": "query", | |
| "name": "type", | |
| "schema": { | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Search for Assets", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "assetSearchPost", | |
| "parameters": [], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/AssetSearchRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/AssetsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "asset.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Search for Assets", | |
| "tags": [ | |
| "Assets" | |
| ] | |
| } | |
| }, | |
| "/v2/teams": { | |
| "get": { | |
| "operationId": "getTeams", | |
| "parameters": [], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/TeamsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "team.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get teams for user or account", | |
| "tags": [ | |
| "Teams" | |
| ] | |
| } | |
| }, | |
| "/v2/teams/{team_id}/members": { | |
| "post": { | |
| "operationId": "addTeamMember", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "team_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/TeamMemberRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/TeamMemberResonse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "team.update" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Add a team member", | |
| "tags": [ | |
| "Teams" | |
| ] | |
| } | |
| }, | |
| "/v2/teams/{team_id}/membership": { | |
| "get": { | |
| "operationId": "getMembershipByTeam", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "team_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/TeamMembershipResonse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "team.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get user membership for team", | |
| "tags": [ | |
| "Teams" | |
| ] | |
| } | |
| }, | |
| "/v2/teams/{team_id}/projects": { | |
| "get": { | |
| "operationId": "getProjectsByTeam", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "team_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectsResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.read" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Get projects by team", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| }, | |
| "post": { | |
| "operationId": "createProject", | |
| "parameters": [ | |
| { | |
| "in": "path", | |
| "name": "team_id", | |
| "required": true, | |
| "schema": { | |
| "format": "uuid", | |
| "type": "string" | |
| } | |
| } | |
| ], | |
| "requestBody": { | |
| "$ref": "#/components/requestBodies/ProjectRequest" | |
| }, | |
| "responses": { | |
| "200": { | |
| "$ref": "#/components/responses/ProjectResponse" | |
| }, | |
| "401": { | |
| "$ref": "#/components/responses/Unauthorized" | |
| } | |
| }, | |
| "security": [ | |
| { | |
| "JWTAuth": [] | |
| }, | |
| { | |
| "OAuth": [ | |
| "project.create" | |
| ] | |
| }, | |
| { | |
| "UserTokenAuth": [] | |
| } | |
| ], | |
| "summary": "Create a project", | |
| "tags": [ | |
| "Projects" | |
| ] | |
| } | |
| } | |
| }, | |
| "servers": [ | |
| { | |
| "url": "https://api.frame.io" | |
| } | |
| ] | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment