Zeplin Screens API

The Screens API from Zeplin — 17 operation(s) for screens.

OpenAPI Specification

zeplin-screens-api-openapi.yml Raw ↑
openapi: 3.0.2
info:
  title: Zeplin Authorization Screens API
  description: Access your resources in Zeplin
  version: 1.38.0
  contact:
    name: Zeplin
    url: https://zeplin.io
    email: support@zeplin.io
servers:
- url: https://api.zeplin.dev
security:
- PersonalAccessToken: []
- OAuth2: []
tags:
- name: Screens
paths:
  /v1/projects/{project_id}/screens:
    get:
      tags:
      - Screens
      summary: Get project screens
      description: List all screens of the project
      operationId: GetProjectScreens
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/filter_by_section_id'
      - $ref: '#/components/parameters/sort_screens'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Screen'
              examples:
                Screens:
                  value:
                  - $ref: '#/components/examples/screen/value'
        '404':
          $ref: '#/components/responses/projectNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    post:
      tags:
      - Screens
      summary: Create a new screen
      description: Create a new screen in the project
      operationId: CreateScreen
      parameters:
      - $ref: '#/components/parameters/project_id'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ScreenCreateBody'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityReference'
              examples:
                response:
                  $ref: '#/components/examples/entityReference'
        '403':
          $ref: '#/components/responses/cannotCreateAScreen'
        '404':
          $ref: '#/components/responses/projectOrScreenSectionNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchivedOrScreenExists'
  /v1/projects/{project_id}/screens/{screen_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen
      description: Get a single screen by id
      operationId: GetScreen
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Screen'
              examples:
                response:
                  $ref: '#/components/examples/screen'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    patch:
      tags:
      - Screens
      summary: Update a screen
      description: Update a screen's description
      operationId: UpdateScreen
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenUpdateBody'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '403':
          $ref: '#/components/responses/cannotUpdateScreen'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchivedOrTagIsLocked'
  /v1/projects/{project_id}/screens/{screen_id}/components:
    get:
      tags:
      - Screens
      summary: Get screen components
      description: List all components in the screen
      operationId: GetScreenComponents
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      - $ref: '#/components/parameters/include_latest_version'
      - $ref: '#/components/parameters/include_linked_styleguides'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Component'
              examples:
                response:
                  value:
                  - $ref: '#/components/examples/component/value'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screens/{screen_id}/notes:
    get:
      tags:
      - Screens
      summary: Get screen notes
      description: List all notes in the screen
      operationId: GetScreenNotes
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenNote'
              examples:
                Screen Notes:
                  value:
                  - $ref: '#/components/examples/screenNote/value'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    post:
      tags:
      - Screens
      summary: Create a note
      description: Create a note on the screen
      operationId: CreateScreenNote
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenNoteCreateBody'
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityReference'
              examples:
                response:
                  $ref: '#/components/examples/entityReference'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
  /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen note
      description: Get a screen note by id
      operationId: GetScreenNote
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenNote'
              examples:
                response:
                  $ref: '#/components/examples/screenNote'
        '404':
          $ref: '#/components/responses/projectScreenOrNoteNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    patch:
      tags:
      - Screens
      summary: Update a note
      description: Update a note on the screen
      operationId: UpdateScreenNote
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenNoteUpdateBody'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenOrNoteNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
    delete:
      tags:
      - Screens
      summary: Delete a note
      description: Delete a note on the screen
      operationId: DeleteScreenNote
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenOrNoteNotFound'
        '422':
          $ref: '#/components/responses/notNoteCreatorOrProjectArchived'
  /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments:
    post:
      tags:
      - Screens
      summary: Create a comment
      description: Create comment on the screen note
      operationId: CreateScreenComment
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentCreateBody'
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityReference'
              examples:
                response:
                  $ref: '#/components/examples/entityReference'
        '404':
          $ref: '#/components/responses/projectScreenOrNoteNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
  /v1/projects/{project_id}/screens/{screen_id}/notes/{note_id}/comments/{comment_id}:
    patch:
      tags:
      - Screens
      summary: Update comment
      description: Update comments on the screen note
      operationId: UpdateScreenComment
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      - $ref: '#/components/parameters/screen_comment_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentUpdateBody'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenNoteOrCommentNotFound'
        '422':
          $ref: '#/components/responses/unproccessableEntityUpdateComment'
    delete:
      tags:
      - Screens
      summary: Delete comment
      description: Delete a comment on the screen note
      operationId: DeleteScreenComment
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_note_id'
      - $ref: '#/components/parameters/screen_comment_id'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenNoteOrCommentNotFound'
        '422':
          $ref: '#/components/responses/notCommentAuthorOrProjectArchived'
  /v1/projects/{project_id}/screens/{screen_id}/annotations:
    get:
      tags:
      - Screens
      summary: Get screen annotations
      description: List all annotations in the screen
      operationId: GetScreenAnnotations
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenAnnotation'
              examples:
                Screen Annotations:
                  value:
                  - $ref: '#/components/examples/screenAnnotation/value'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    post:
      tags:
      - Screens
      summary: Create an annotation
      description: Create an annotation on the screen
      operationId: CreateScreenAnnotation
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenAnnotationCreateBody'
      responses:
        '201':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityReference'
              examples:
                response:
                  $ref: '#/components/examples/entityReference'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
  /v1/projects/{project_id}/screens/{screen_id}/annotations/{annotation_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen annotation
      description: Get a screen annotation by id
      operationId: GetScreenAnnotation
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_annotation_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenAnnotation'
              examples:
                response:
                  $ref: '#/components/examples/screenAnnotation'
        '404':
          $ref: '#/components/responses/projectScreenOrAnnotationNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    patch:
      tags:
      - Screens
      summary: Update an annotation
      description: Update an annotation on the screen
      operationId: UpdateScreenAnnotation
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_annotation_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScreenAnnotationUpdateBody'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenOrAnnotationNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
    delete:
      tags:
      - Screens
      summary: Delete an annotation
      description: Delete an annotation on the screen
      operationId: DeleteScreenAnnotation
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_annotation_id'
      responses:
        '204':
          $ref: '#/components/responses/noContent'
        '404':
          $ref: '#/components/responses/projectScreenOrAnnotationNotFound'
        '422':
          $ref: '#/components/responses/notAnnotationCreatorOrProjectArchived'
  /v1/projects/{project_id}/annotations/note_types:
    get:
      tags:
      - Screens
      summary: Get screen annotation note types
      description: List all annotation note types in the project
      operationId: GetScreenAnnotationsNoteTypes
      parameters:
      - $ref: '#/components/parameters/project_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenAnnotationNoteType'
              examples:
                Screen Annotation Note Types:
                  value:
                  - $ref: '#/components/examples/screenAnnotationNoteType/value'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screens/{screen_id}/versions:
    get:
      tags:
      - Screens
      summary: Get screen versions
      description: List all versions of the screen in a project
      operationId: GetScreenVersions
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenVersionSummary'
              examples:
                Screen Versions:
                  value:
                  - $ref: '#/components/examples/screenVersionSummary/value'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
    post:
      tags:
      - Screens
      summary: Create a new screen version
      description: Create a new screen version in the project
      operationId: CreateScreenVersion
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ScreenVersionCreateBody'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EntityReference'
              examples:
                response:
                  $ref: '#/components/examples/entityReference'
        '403':
          $ref: '#/components/responses/cannotCreateAScreenVersion'
        '404':
          $ref: '#/components/responses/projectOrScreenNotFound'
        '422':
          $ref: '#/components/responses/notAProjectMemberOrArchived'
  /v1/projects/{project_id}/screens/{screen_id}/versions/{version_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen version
      description: Get details of the screen version
      operationId: GetScreenVersion
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      - $ref: '#/components/parameters/screen_version_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenVersion'
              examples:
                response:
                  $ref: '#/components/examples/screenVersion'
        '403':
          $ref: '#/components/responses/cannotGetVersionInProject'
        '404':
          $ref: '#/components/responses/projectScreenOrVersionNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screens/{screen_id}/versions/latest:
    get:
      tags:
      - Screens
      summary: Get the latest screen version
      description: Get details of the latest version
      operationId: GetLatestScreenVersion
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenVersion'
              examples:
                response:
                  $ref: '#/components/examples/screenVersion'
        '403':
          $ref: '#/components/responses/cannotGetVersionInProject'
        '404':
          $ref: '#/components/responses/projectScreenOrVersionNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screen_sections:
    get:
      tags:
      - Screens
      summary: Get screen sections
      description: List all screen sections of the project
      operationId: GetScreenSections
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenSection'
              examples:
                Screen Sections:
                  value:
                  - $ref: '#/components/examples/screenSection/value'
        '404':
          $ref: '#/components/responses/projectNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screen_sections/{section_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen section
      description: Get a screen section by id
      operationId: GetScreenSection
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_section_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenSection'
              examples:
                response:
                  $ref: '#/components/examples/screenSection'
  /v1/projects/{project_id}/screen_variants:
    get:
      tags:
      - Screens
      summary: Get screen variants
      description: List all screen variants of the project
      operationId: GetScreenVariants
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/limit'
      - $ref: '#/components/parameters/offset'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScreenVariantGroup'
              examples:
                Screen Variants:
                  value:
                  - $ref: '#/components/examples/screenVariantGroup/value'
        '404':
          $ref: '#/components/responses/projectNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
  /v1/projects/{project_id}/screen_variants/{variant_id}:
    get:
      tags:
      - Screens
      summary: Get a single screen variant
      description: Get a screen variant by id
      operationId: GetScreenVariant
      parameters:
      - $ref: '#/components/parameters/project_id'
      - $ref: '#/components/parameters/screen_variant_id'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScreenVariantGroup'
              examples:
                response:
                  $ref: '#/components/examples/screenVariantGroup'
        '404':
          $ref: '#/components/responses/projectOrScreenVariantNotFound'
        '422':
          $ref: '#/components/responses/projectArchived'
components:
  examples:
    screenNoteComment:
      summary: Screen Note Comment
      value:
        id: 5dbad85a89ea51c1f35bcffe
        author:
          $ref: '#/components/examples/user/value'
        content: Hey ho! Let's go!
        updated: 1572347818
        reactions:
        - $ref: '#/components/examples/reaction/value'
        screen_version_id: 5dbad85a89ea51c1f35bcfff
    textStyleData:
      summary: Layer Text Style
      value:
        postscript_name: HelveticaNeue-Bold
        font_family: HelveticaNeue
        font_size: 24
        font_weight: 700
        font_style: normal
        line_height: 24
        font_stretch: 1
        text_align: left
        color:
          $ref: '#/components/examples/colorData/value'
    boundingRectangle:
      summary: Bounding Rectangle
      value:
        x: 0
        y: 0
        width: 40
        height: 40
        absolute:
          $ref: '#/components/examples/layerPosition/value'
    resourceStyleguideSource:
      summary: Source Styleguide
      value:
        id: 5db981be9df2b3e1bfa19ef2
        name: Discovery 1
        platform: web
        parent:
          id: 5db981be9df2b3e1bfa19ef2
    grid:
      summary: Grid
      value:
        horizontal_offset: 0
        vertical_offset: 0
        vertical:
          $ref: '#/components/examples/verticalGrid/value'
        horizontal:
          $ref: '#/components/examples/horizontalGrid/value'
    resourceSourceForProject:
      summary: Source for Project
      value:
        project:
          $ref: '#/components/examples/resourceProjectSource/value'
    colorData:
      summary: Color Data
      value:
        source_id: 0BEBFEB3-A107-4D1D-A3B0-77D1FBD35F01
        r: 143
        g: 152
        b: 5
        a: 1
    resourceProjectSource:
      summary: Source Project
      value:
        id: 5db81e73e1e36ee19f138c1a
        name: HAL 9000
        platform: web
        linked_styleguide:
          id: 5db981be9df2b3e1bfa19ef2
    thumbnails:
      summary: Thumbnails
      value:
        small: http://placekitten.com/256/256
        medium: http://placekitten.com/512/512
        large: http://placekitten.com/1024/1024
    screen:
      summary: Screen
      value:
        id: 5dbad85a76ea51c1f35b6f69
        name: Login
        description: Login screen for HAL 9000
        tags:
        - mobile
        - login
        image:
          $ref: '#/components/examples/snapshotImage/value'
        created: 1517184000
        updated: 1572347818
        number_of_notes: 7
        number_of_versions: 4
        number_of_annotations: 2
        section:
          id: 5db81e6e6a4462065f04d932
        variant:
          value: Default
          group:
            id: 607437cd62d37a0bc869fc63
            name: Login
    componentVariantProperty:
      summary: Component Variant Property
      value:
        id: 60422281c96b47c3be1a912f
        name: Type
        value: Primary
    componentSectionReference:
      summary: Component
      value:
        id: 5db81e6e6a4462065f04d932
        group:
          id: 507f1f77bcf86cd799439011
    screenNotePosition:
      value:
        x: 0.93
        y: 0.1
        x_start: 0.9
        y_start: 0.05
    asset:
      summary: Asset
      value:
        layer_source_id: 55CC0025-C3C1-429E-92B2-610D56368473
        display_name: rectangle
        layer_name: Rectangle
        contents:
        - $ref: '#/components/examples/assetContent/value'
    snapshotImage:
      summary: Snapshot Image
      value:
        width: 2560
        height: 1920
        original_url: http://placekitten.com/2560/1920
        thumbnails:
          $ref: '#/components/examples/thumbnails/value'
    horizontalGrid:
      summary: Horizontal Grid
      value:
        number_of_rows: 6
        gutter_height: 12
        row_height: 60
    error:
      summary: Error
      value:
        message: Project is not found
    screenVariantGroup:
      summary: Screen Variant Group
      value:
        id: 607437cd62d37a0bc869fc63
        name: Login
        variants:
        - screen_id: 5dbad85a76ea51c1f35b6f69
          value: Default
        - screen_id: 6074389b7bf31ebf66c8f09d
          value: Loading
        - screen_id: 607438a0351a38c53598671c
          value: Error
    layerFill:
      summary: Layer Fill
      value:
        type: color
        color:
          $ref: '#/components/examples/colorData/value'
    screenNote:
      summary: Screen Note
      value:
        id: 5dbad85a76ea51c1f35b6f69
        created: 1572347818
        order: 1
        status: open
        position:
          $ref: '#/components/examples/screenNotePosition/value'
        color:
          name: yellow
          r: 254
          g: 207
          b: 51
          a: 1
        creator:
          $ref: '#/components/examples/user/value'
        comments:
        - $ref: '#/components/examples/screenNoteComment/value'
    versionCommitColor:
      summary: Version Commit Color
      value:
        r: 145
        g: 223
        b: 33
        a: 1
    assetContent:
      summary: Asset Content
      value:
        url: http://placekitten.com/100/200
        format: png
        density: 1
    me:
      summary: My user
      value:
        id: 5d9caaecb4a3fa9bc9718686
        email: zo@zeplin.io
        username: zozo
        emotar: 🍎
        avatar: http://placekitten.com/200/300
        last_seen: 1616739240
    layer:
      summary: Layer
      value:
        id: 5db81e73e1e36ee19f138c1a
        source_id: 2FF14739-F1CD-4221-A9C1-0EA296C67AD1
        type: shape
        name: First rectangle in group
        rect:
          x: 0
          y: 0
          width: 40
          height: 40
          absolute:
            x: 0
            y: 0
        fills:
        - $ref: '#/components/examples/layerFill/value'
        borders:
        - thickness: 1
          position: inside
          fill:
            $ref: '#/components/examples/layerFill/value'
        opacity: 1
        blend_mode: normal
        border_radius: 0
        rotation: 0
        exportable: false
    versionCommit:
      summary: Version Commit
      value:
        message: Update paddings
        author:
          $ref: '#/components/examples/user/value'
        color:
          $ref: '#/components/examples/versionCommitColor/value'
    screenNoteColor:
      summary: Screen Note Color
      value:
        name: yellow
        r: 254
        g: 207
        b: 51
        a: 1
    layerBlur:
      summary: Layer Blur
      value:
        type: gaussian
        radius: 10
    link:
      summary: Link
      value:
        rect:
          x: 0
          y: 0
          width: 40
          height: 40
        destination:
          $ref: '#/components/examples/linkDestination/value'
    resourceSourceForStyleguide:
      summary: Source for Styleguide
      value:
        styleguide:
          $ref: '#/components/examples/resourceStyleguideSource/value'
    reaction:
      summary: Reaction
      value:
        id: 5dbad85a89ea51c1f35bcffe
        short_code: thumbsup
        unicode: 👍
        users:
        - $ref: '#/components/examples/user/value'
    verticalGrid:
      summary: Vertical Grid
      value:
        column_width: 60
        number_of_cols: 12
        gutters_on_outside: true
        gutter_width: 20
    component:
      summary: Component
      value:
        id: 5dbad85a76ea51c1f35b6f69
        name: Button
        description: Generic button for HAL 9000
        image:
          $ref: '#/components/examples/snapshotImage/value'
        created: 1517184000
        updated: 1572347818
        section:
          $ref: '#/components/examples/componentSectionReference/value'
        source:
          $ref: '#/components/examples/resourceSourceForProject/value'
        variant_properties:
        - $ref: '#/components/examples/componentVariantProperty/value'
    screenVersionSummary:
      summary: Screen Version Summary
      value:
        id: 5dbad85a76ea51c1f35b6f69
        creator:
          $ref: '#/components/examples/user/value'
        commit:
          $ref: '#/components/examples/versionCommit/value'
        image_url: http://placekitten.com/2560/1920
        thumbnails:
          $ref: '#/components/examples/thumbnails/value'
        width: 2560
        height: 1920
        density_scale: 2
        source: sketch/value
        source_file_url: https://www.sketch.com/s/shareId
        background_color:
          $ref: '#/components/examples/colorData/value'
        links:
        - $ref: '#/component

# --- truncated at 32 KB (91 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zeplin/refs/heads/main/openapi/zeplin-screens-api-openapi.yml