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

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
163 changes: 2 additions & 161 deletions apps/api-client-go/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2286,106 +2286,6 @@ paths:
summary: Get preview URL for a box port
tags:
- box
/box/{boxIdOrName}/ports/{port}/signed-preview-url:
get:
operationId: getSignedPortPreviewUrl
parameters:
- description: Use with JWT to specify the organization ID
explode: false
in: header
name: X-BoxLite-Organization-ID
required: false
schema:
type: string
style: simple
- description: ID or name of the box
explode: false
in: path
name: boxIdOrName
required: true
schema:
type: string
style: simple
- description: Port number to get signed preview URL for
explode: false
in: path
name: port
required: true
schema:
type: integer
style: simple
- description: "Expiration time in seconds (default: 60 seconds)"
explode: true
in: query
name: expiresInSeconds
required: false
schema:
type: integer
style: form
responses:
"200":
content:
application/json:
schema:
$ref: "#/components/schemas/SignedPortPreviewUrl"
description: Signed preview URL for the specified port
security:
- bearer: []
- oauth2:
- openid
- profile
- email
summary: Get signed preview URL for a box port
tags:
- box
/box/{boxIdOrName}/ports/{port}/signed-preview-url/{token}/expire:
post:
operationId: expireSignedPortPreviewUrl
parameters:
- description: Use with JWT to specify the organization ID
explode: false
in: header
name: X-BoxLite-Organization-ID
required: false
schema:
type: string
style: simple
- description: ID or name of the box
explode: false
in: path
name: boxIdOrName
required: true
schema:
type: string
style: simple
- description: Port number to expire signed preview URL for
explode: false
in: path
name: port
required: true
schema:
type: integer
style: simple
- description: Token to expire signed preview URL for
explode: false
in: path
name: token
required: true
schema:
type: string
style: simple
responses:
"200":
description: Signed preview URL has been expired
security:
- bearer: []
- oauth2:
- openid
- profile
- email
summary: Expire signed preview URL for a box port
tags:
- box
/box/{boxIdOrName}/ssh-access:
delete:
operationId: revokeSshAccess
Expand Down Expand Up @@ -2926,36 +2826,6 @@ paths:
summary: Check if user has access to the box
tags:
- preview
/preview/{signedPreviewToken}/{port}/box-id:
get:
operationId: getBoxIdFromSignedPreviewUrlToken
parameters:
- description: Signed preview URL token
explode: false
in: path
name: signedPreviewToken
required: true
schema:
type: string
style: simple
- description: Port number to get box ID from signed preview URL token
explode: false
in: path
name: port
required: true
schema:
type: number
style: simple
responses:
"200":
content:
application/json:
schema:
type: string
description: Box ID from signed preview URL token
summary: Get box ID from signed preview URL token
tags:
- preview
/volumes:
get:
operationId: listVolumes
Expand Down Expand Up @@ -6702,7 +6572,7 @@ components:
PortPreviewUrl:
example:
boxId: "123456"
url: "https://{port}-{boxId}.{proxyDomain}"
url: "https://{port}-{encodedBoxId}.{proxyDomain}"
token: ul67qtv-jl6wb9z5o3eii-ljqt9qed6l
properties:
boxId:
Expand All @@ -6711,7 +6581,7 @@ components:
type: string
url:
description: Preview url
example: "https://{port}-{boxId}.{proxyDomain}"
example: "https://{port}-{encodedBoxId}.{proxyDomain}"
type: string
token:
description: Access token
Expand All @@ -6722,35 +6592,6 @@ components:
- token
- url
type: object
SignedPortPreviewUrl:
example:
boxId: "123456"
port: 3000
token: jl6wb9z5o3eii
url: "https://{port}-{token}.{proxyDomain}"
properties:
boxId:
description: ID of the box
example: "123456"
type: string
port:
description: Port number of the signed preview URL
example: 3000
type: integer
token:
description: Token of the signed preview URL
example: jl6wb9z5o3eii
type: string
url:
description: Signed preview url
example: "https://{port}-{token}.{proxyDomain}"
type: string
required:
- boxId
- port
- token
- url
type: object
SshAccessDto:
example:
id: 123e4567-e89b-12d3-a456-426614174000
Expand Down
Loading
Loading