Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 20 additions & 10 deletions dist/api_types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -504,7 +504,7 @@ export type HasExportSettingsTrait = {
export type HasGeometryTrait = MinimalFillsTrait &
MinimalStrokesTrait & {
/**
* Map from ID to PaintOverride for looking up fill overrides. To see which regions are overriden,
* Map from ID to PaintOverride for looking up fill overrides. To see which regions are overridden,
* you must use the `geometry=paths` option. Each path returned may have an `overrideID` which maps
* to this table.
*/
Expand Down Expand Up @@ -2232,7 +2232,7 @@ export type BaseTypeStyle = {
/**
* Text casing applied to the node, default is the original casing.
*/
textCase?: 'UPPER' | 'LOWER' | 'TITLE' | 'SMALL_CAPS' | 'SMALL_CAPS_FORCED'
textCase?: 'ORIGINAL' | 'UPPER' | 'LOWER' | 'TITLE' | 'SMALL_CAPS' | 'SMALL_CAPS_FORCED'

/**
* Horizontal text alignment as string enum.
Expand Down Expand Up @@ -3960,7 +3960,7 @@ export type ActivityLogFileEntity = {
/**
* Access policy for users who have the link to the file.
*/
link_access: 'view' | 'edit' | 'org_view' | 'org_edit' | 'inherit'
link_access: LinkAccess

/**
* Access policy for users who have the link to the file's prototype.
Expand Down Expand Up @@ -4418,7 +4418,7 @@ export type LocalVariable = {
/**
* The resolved type of the variable.
*/
resolvedType: 'BOOLEAN' | 'FLOAT' | 'STRING' | 'COLOR'
resolvedType: VariableResolvedDataType

/**
* The values for each mode of this variable.
Expand Down Expand Up @@ -4531,7 +4531,7 @@ export type PublishedVariable = {
/**
* The resolved type of the variable.
*/
resolvedDataType: 'BOOLEAN' | 'FLOAT' | 'STRING' | 'COLOR'
resolvedDataType: VariableResolvedDataType

/**
* The UTC ISO 8601 time at which the variable was last updated.
Expand Down Expand Up @@ -4711,7 +4711,7 @@ export type VariableCreate = {
/**
* The resolved type of the variable.
*/
resolvedType: 'BOOLEAN' | 'FLOAT' | 'STRING' | 'COLOR'
resolvedType: VariableResolvedDataType

/**
* The description of this variable.
Expand Down Expand Up @@ -5305,6 +5305,16 @@ export type ErrorResponsePayloadWithErrorBoolean = {
message: string
}

/**
* Access policy for users who have the link to the resource.
*/
export type LinkAccess = 'view' | 'edit' | 'org_view' | 'org_edit' | 'inherit'

/**
* The role of the user making the API request in relation to the resource.
*/
export type Role = 'owner' | 'editor' | 'viewer'

/**
* Response from the GET /v1/files/{file_key} endpoint.
*/
Expand All @@ -5317,7 +5327,7 @@ export type GetFileResponse = {
/**
* The role of the user making the API request in relation to the file.
*/
role: 'owner' | 'editor' | 'viewer'
role: Role

/**
* The UTC ISO 8601 time at which the file was last modified.
Expand Down Expand Up @@ -5410,7 +5420,7 @@ export type GetFileNodesResponse = {
/**
* The role of the user making the API request in relation to the file.
*/
role: 'owner' | 'editor' | 'viewer'
role: Role

/**
* The UTC ISO 8601 time at which the file was last modified.
Expand Down Expand Up @@ -5542,12 +5552,12 @@ export type GetFileMetaResponse = {
/**
* The role of the user making the API request in relation to the file.
*/
role?: 'owner' | 'editor' | 'viewer'
role?: Role

/**
* Access policy for users who have the link to the file.
*/
link_access?: 'view' | 'edit' | 'org_view' | 'org_edit' | 'inherit'
link_access?: LinkAccess

/**
* The URL of the file.
Expand Down
76 changes: 27 additions & 49 deletions openapi/openapi.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.1.0
info:
title: Figma API
version: 0.33.0
version: 0.34.0
description: |-
This is the OpenAPI specification for the [Figma REST API](https://www.figma.com/developers/api).

Expand Down Expand Up @@ -3185,7 +3185,7 @@ components:
- $ref: "#/components/schemas/PaintOverride"
- type: "null"
description: Map from ID to PaintOverride for looking up fill overrides. To see
which regions are overriden, you must use the `geometry=paths`
which regions are overridden, you must use the `geometry=paths`
option. Each path returned may have an `overrideID` which maps
to this table.
fillGeometry:
Expand Down Expand Up @@ -5269,6 +5269,7 @@ components:
type: string
description: Text casing applied to the node, default is the original casing.
enum:
- ORIGINAL
- UPPER
- LOWER
- TITLE
Expand Down Expand Up @@ -7214,14 +7215,8 @@ components:
- figma
- figjam
link_access:
type: string
$ref: "#/components/schemas/LinkAccess"
description: Access policy for users who have the link to the file.
enum:
- view
- edit
- org_view
- org_edit
- inherit
proto_link_access:
type: string
description: Access policy for users who have the link to the file's prototype.
Expand Down Expand Up @@ -7705,13 +7700,8 @@ components:
type: string
description: The id of the variable collection that contains this variable.
resolvedType:
type: string
$ref: "#/components/schemas/VariableResolvedDataType"
description: The resolved type of the variable.
enum:
- BOOLEAN
- FLOAT
- STRING
- COLOR
valuesByMode:
type: object
description: The values for each mode of this variable.
Expand Down Expand Up @@ -7816,13 +7806,8 @@ components:
type: string
description: The id of the variable collection that contains this variable.
resolvedDataType:
type: string
$ref: "#/components/schemas/VariableResolvedDataType"
description: The resolved type of the variable.
enum:
- BOOLEAN
- FLOAT
- STRING
- COLOR
updatedAt:
type: string
format: date-time
Expand Down Expand Up @@ -8003,13 +7988,8 @@ components:
description: The variable collection that will contain the variable. You can use
the temporary id of a variable collection.
resolvedType:
type: string
$ref: "#/components/schemas/VariableResolvedDataType"
description: The resolved type of the variable.
enum:
- BOOLEAN
- FLOAT
- STRING
- COLOR
description:
type: string
description: The description of this variable.
Expand Down Expand Up @@ -8529,6 +8509,22 @@ components:
- error
- status
- message
LinkAccess:
type: string
description: Access policy for users who have the link to the resource.
enum:
- view
- edit
- org_view
- org_edit
- inherit
Role:
type: string
description: The role of the user making the API request in relation to the resource.
enum:
- owner
- editor
- viewer
responses:
GetFileResponse:
description: Response from the GET /v1/files/{file_key} endpoint.
Expand All @@ -8541,11 +8537,7 @@ components:
type: string
description: The name of the file as it appears in the editor.
role:
type: string
enum:
- owner
- editor
- viewer
$ref: "#/components/schemas/Role"
description: The role of the user making the API request in relation to the
file.
lastModified:
Expand Down Expand Up @@ -8640,11 +8632,7 @@ components:
type: string
description: The name of the file as it appears in the editor.
role:
type: string
enum:
- owner
- editor
- viewer
$ref: "#/components/schemas/Role"
description: The role of the user making the API request in relation to the
file.
lastModified:
Expand Down Expand Up @@ -8798,21 +8786,11 @@ components:
- make
description: The type of editor associated with this file.
role:
type: string
enum:
- owner
- editor
- viewer
$ref: "#/components/schemas/Role"
description: The role of the user making the API request in relation to the
file.
link_access:
type: string
enum:
- view
- edit
- org_view
- org_edit
- inherit
$ref: "#/components/schemas/LinkAccess"
description: Access policy for users who have the link to the file.
url:
type: string
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@figma/rest-api-spec",
"version": "0.33.0",
"version": "0.34.0",
"description": "Typings for the Figma REST API",
"main": "dist/api_types.ts",
"repository": {
Expand Down