Skip to content
This repository has been archived by the owner on Dec 6, 2021. It is now read-only.

Commit

Permalink
updated specs, fixes #10, #11, #12, #14, #15, #16
Browse files Browse the repository at this point in the history
  • Loading branch information
didimitrie committed Mar 29, 2018
1 parent 16b5be4 commit a6332b6
Showing 1 changed file with 68 additions and 4 deletions.
72 changes: 68 additions & 4 deletions SpeckleV1OpenApiSpecs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ swagger: '2.0'
info:
version: 1.0.0-beta
title: Speckle OpenApi Specs
description: Documentation & specifications for the Speckle Server & Speckle Objects.
description: |-
Documentation & specifications for the Speckle Server & Speckle Objects.
contact:
name: SpeckleWorks
url: 'https://speckle.works'
Expand Down Expand Up @@ -318,7 +319,7 @@ paths:
schema:
$ref: '#/definitions/ResponseBase'

'/project/{projectId}':
'/projects/{projectId}':
put:
tags: [ "Projects" ]
summary: ProjectUpdate
Expand Down Expand Up @@ -813,11 +814,19 @@ paths:
required: false
type: string
description: Specifiy which fields to retrieve, filters, limits, etc. For example, `?fields=type,properties,hash&type=Circle`
- name: object
in: body
description: An object that holds the keys you want to modify or add.
required: true
schema:
type: array
items:
type: string
responses:
'200':
description: All good!
schema:
$ref: '#/definitions/ResponseBase'
$ref: '#/definitions/ResponseObject'
'400':
description: Fail whale.
schema:
Expand Down Expand Up @@ -1460,6 +1469,18 @@ definitions:
$ref: '#/definitions/SpeckleInterval'
zSize:
$ref: '#/definitions/SpeckleInterval'

SpeckleLine:
allOf:
- $ref: '#/definitions/SpeckleObject'
- type: object
properties:
type:
default: Line
value:
type: array
items:
type: number

SpecklePolyline:
allOf:
Expand All @@ -1468,6 +1489,8 @@ definitions:
properties:
type:
default: Polyline
closed:
type: boolean
value:
type: array
items:
Expand Down Expand Up @@ -1526,6 +1549,11 @@ definitions:
items:
type: number
description: If any, the colours per vertex.
textureCoordinates:
type: array
items:
type: number
description: The faces array.

SpeckleBrep:
allOf:
Expand All @@ -1542,4 +1570,40 @@ definitions:
description: A short prefix of where the base64 comes from.
displayValue:
$ref: '#/definitions/SpeckleMesh'
description: Contains a speckle mesh representation of this brep.
description: Contains a speckle mesh representation of this brep.

SpeckleExtrusion:
allOf:
- $ref: '#/definitions/SpeckleObject'
- type: object
properties:
capped:
type: boolean
profile:
$ref: '#/definitions/SpeckleObject'
pathStart:
$ref: '#/definitions/SpecklePoint'
pathEnd:
$ref: '#/definitions/SpecklePoint'
pathCurve:
$ref: '#/definitions/SpeckleObject'

SpeckleAnnotation:
allOf:
- $ref: '#/definitions/SpeckleObject'
- type: object
properties:
text:
type: string
textHeight:
type: number
fontName:
type: string
bold:
type: boolean
italic:
type: boolean
location:
$ref: '#/definitions/SpecklePoint'
plane:
$ref: '#/definitions/SpecklePlane'

0 comments on commit a6332b6

Please sign in to comment.