Scott Ai github-links API
The github-links API from Scott Ai — 3 operation(s) for github-links.
The github-links API from Scott Ai — 3 operation(s) for github-links.
openapi: 3.1.0
info:
title: One-Shot access github-links API
version: 1.0.0
tags:
- name: github-links
paths:
/github/workspaces/{workspace_id}/linkable-nodes:
get:
tags:
- github-links
summary: List Linkable Nodes
operationId: list_linkable_nodes
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
title: Workspace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/LinkableNodesResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/github/workspaces/{workspace_id}/pr-links:
get:
tags:
- github-links
summary: List Workspace Pr Links
operationId: list_workspace_pr_links
security:
- HTTPBearer: []
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
title: Workspace Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WorkspacePrLinksResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/github/pr-links:
get:
tags:
- github-links
summary: Get Pr Links
operationId: get_pr_links
security:
- HTTPBearer: []
parameters:
- name: repo
in: query
required: true
schema:
type: string
title: Repo
- name: pr_number
in: query
required: true
schema:
type: integer
title: Pr Number
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/PrLinksResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
post:
tags:
- github-links
summary: Write Pr Links
operationId: write_pr_links
security:
- HTTPBearer: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WriteLinksRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/WriteLinksResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
LinkableNodesResponse:
properties:
nodes:
items:
$ref: '#/components/schemas/LinkableNode'
type: array
title: Nodes
type: object
required:
- nodes
title: LinkableNodesResponse
WriteLinksResponse:
properties:
linked_snapshot_ids:
items:
type: string
type: array
title: Linked Snapshot Ids
comment_patched:
type: boolean
title: Comment Patched
type: object
required:
- linked_snapshot_ids
- comment_patched
title: WriteLinksResponse
WorkspacePrLink:
properties:
pr_number:
type: integer
title: Pr Number
repo_full_name:
type: string
title: Repo Full Name
pr_html_url:
type: string
title: Pr Html Url
linked_at:
anyOf:
- type: string
- type: 'null'
title: Linked At
linked_by_user_id:
type: string
title: Linked By User Id
type: object
required:
- pr_number
- repo_full_name
- pr_html_url
- linked_at
- linked_by_user_id
title: WorkspacePrLink
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
PrLinksResponse:
properties:
snapshot_ids:
items:
type: string
type: array
title: Snapshot Ids
type: object
required:
- snapshot_ids
title: PrLinksResponse
LinkableNode:
properties:
snapshot_id:
type: string
title: Snapshot Id
name:
anyOf:
- type: string
- type: 'null'
title: Name
created_at:
anyOf:
- type: string
- type: 'null'
title: Created At
approval_state:
type: string
title: Approval State
type: object
required:
- snapshot_id
- name
- created_at
- approval_state
title: LinkableNode
WriteLinksRequest:
properties:
repo:
type: string
title: Repo
pr_number:
type: integer
title: Pr Number
installation_id:
type: integer
title: Installation Id
workspace_id:
type: string
title: Workspace Id
snapshot_ids:
items:
type: string
type: array
title: Snapshot Ids
type: object
required:
- repo
- pr_number
- installation_id
- workspace_id
- snapshot_ids
title: WriteLinksRequest
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
WorkspacePrLinksResponse:
properties:
links:
additionalProperties:
items:
$ref: '#/components/schemas/WorkspacePrLink'
type: array
type: object
title: Links
type: object
required:
- links
title: WorkspacePrLinksResponse
securitySchemes:
HTTPBearer:
type: http
scheme: bearer