From 115baa4775c3f8cb60b4accde70a6c49730554ee Mon Sep 17 00:00:00 2001 From: Madison Ehlers Date: Mon, 29 Apr 2024 15:35:30 -0500 Subject: [PATCH 1/2] v0.22.5 --- client/version.ts | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/client/version.ts b/client/version.ts index 2bc5073..38efc50 100644 --- a/client/version.ts +++ b/client/version.ts @@ -1 +1 @@ -export const version = '0.22.4'; +export const version = '0.22.5'; diff --git a/package.json b/package.json index 1544601..e30759b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@vertexvis/api-client-node", - "version": "0.22.4", + "version": "0.22.5", "description": "The Vertex REST API client for Node.js.", "license": "MIT", "author": "Vertex Developers (https://developer.vertexvis.com)", From 4d763a13949585db59394d1cece24e9f2d42e050 Mon Sep 17 00:00:00 2001 From: Madison Ehlers Date: Mon, 29 Apr 2024 15:35:50 -0500 Subject: [PATCH 2/2] [PLAT-4296] Release Latest Version --- api.ts | 80 ++++++++++++++++++++++++++++++++----- spec.yml | 117 +++++++++++++++++++++++++++++++++++++++++++------------ 2 files changed, 163 insertions(+), 34 deletions(-) diff --git a/api.ts b/api.ts index 2ea0aad..b526948 100644 --- a/api.ts +++ b/api.ts @@ -1404,11 +1404,11 @@ export interface CreateSceneAnnotationRequestData { */ export interface CreateSceneAnnotationRequestDataAttributes { /** - * A JSON string that describes the annotation type and its data. JSON data is limited to 16kb. - * @type {string} + * The data describing how to render this annotation. + * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType} * @memberof CreateSceneAnnotationRequestDataAttributes */ - data: string; + data: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType; /** * A customer provided ID used for correlation. * @type {string} @@ -4333,6 +4333,68 @@ export interface SceneAnnotation { */ links?: { [key: string]: Link }; } +/** + * A type that describes a callout annotation. + * @export + * @interface SceneAnnotationCalloutDataType + */ +export interface SceneAnnotationCalloutDataType { + /** + * The type of annotation. + * @type {string} + * @memberof SceneAnnotationCalloutDataType + */ + type: string; + /** + * + * @type {Vector3} + * @memberof SceneAnnotationCalloutDataType + */ + position: Vector3; + /** + * An optional icon to display for this annotation. See [documentation](https://github.com/Vertexvis/vertex-web-sdk/tree/master/packages/viewer/src/components/viewer-icon#properties) for possible values. + * @type {string} + * @memberof SceneAnnotationCalloutDataType + */ + icon?: string; + /** + * A hex color value. + * @type {string} + * @memberof SceneAnnotationCalloutDataType + */ + primaryColor?: string; + /** + * A hex color value. + * @type {string} + * @memberof SceneAnnotationCalloutDataType + */ + accentColor?: string; +} +/** + * A type that describes a custom user provided annotation. + * @export + * @interface SceneAnnotationCustomDataType + */ +export interface SceneAnnotationCustomDataType { + /** + * The type of annotation. + * @type {string} + * @memberof SceneAnnotationCustomDataType + */ + type: string; + /** + * The type of annotation. + * @type {string} + * @memberof SceneAnnotationCustomDataType + */ + jsonType: string; + /** + * An encoded JSON string associated with the custom annotation. + * @type {string} + * @memberof SceneAnnotationCustomDataType + */ + json: string; +} /** * * @export @@ -4383,11 +4445,11 @@ export interface SceneAnnotationDataAttributes { */ modifiedAt: string; /** - * A JSON string that describes the annotation type and its data. JSON data is limited to 16kb. - * @type {string} + * The data describing how to render this annotation. + * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType} * @memberof SceneAnnotationDataAttributes */ - data: string; + data: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType; /** * * @type {string} @@ -6081,11 +6143,11 @@ export interface UpdateSceneAnnotationRequestData { */ export interface UpdateSceneAnnotationRequestDataAttributes { /** - * A JSON string that describes the annotation type and its data. JSON data is limited to 16kb. - * @type {string} + * The data describing how to render this annotation. + * @type {SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType} * @memberof UpdateSceneAnnotationRequestDataAttributes */ - data?: string; + data?: SceneAnnotationCalloutDataType | SceneAnnotationCustomDataType; /** * A customer provided ID used for correlation. * @type {string} diff --git a/spec.yml b/spec.yml index 8680fb1..6ccc988 100644 --- a/spec.yml +++ b/spec.yml @@ -9741,13 +9741,64 @@ components: - id - type type: object - SceneAnnotationJson: - description: - A JSON string that describes the annotation type and its data. - JSON data is limited to 16kb. - example: '{"type":"my-annotation","anchor":{"x":0,"y":0,"z":0}}' - maxLength: 16384 - type: string + SceneAnnotationCalloutDataType: + description: A type that describes a callout annotation. + properties: + type: + description: The type of annotation. + example: callout + maxLength: 32 + type: string + position: + $ref: '#/components/schemas/Vector3' + icon: + description: | + An optional icon to display for this annotation. See [documentation](https://github.com/Vertexvis/vertex-web-sdk/tree/master/packages/viewer/src/components/viewer-icon#properties) for possible values. + example: comment-show + maxLength: 64 + type: string + primaryColor: + description: A hex color value. + example: '#FFFFFF' + maxLength: 7 + minLength: 7 + pattern: ^#[0-9a-fA-F]{6}$ + type: string + accentColor: + description: A hex color value. + example: '#FFFFFF' + maxLength: 7 + minLength: 7 + pattern: ^#[0-9a-fA-F]{6}$ + type: string + required: + - position + - type + type: object + SceneAnnotationCustomDataType: + additionalProperties: false + description: A type that describes a custom user provided annotation. + properties: + type: + description: The type of annotation. + example: custom + maxLength: 32 + type: string + jsonType: + description: The type of annotation. + example: my-annotation-type + maxLength: 32 + type: string + json: + description: An encoded JSON string associated with the custom annotation. + example: '{"label":"my annotation","anchor":{"x":0,"y":0,"z":0}}' + maxLength: 16384 + type: string + required: + - json + - jsonType + - type + type: object SceneAnnotationData: additionalProperties: false properties: @@ -10507,6 +10558,13 @@ components: - color - width type: object + HexColor: + description: A hex color value. + example: '#FFFFFF' + maxLength: 7 + minLength: 7 + pattern: ^#[0-9a-fA-F]{6}$ + type: string ExportConfig: description: Describes the options for configuring a file export. discriminator: @@ -11704,12 +11762,15 @@ components: CreateSceneAnnotationRequest_data_attributes: properties: data: - description: - A JSON string that describes the annotation type and its data. - JSON data is limited to 16kb. - example: '{"type":"my-annotation","anchor":{"x":0,"y":0,"z":0}}' - maxLength: 16384 - type: string + description: The data describing how to render this annotation. + discriminator: + mapping: + callout: '#/components/schemas/SceneAnnotationCalloutDataType' + custom: '#/components/schemas/SceneAnnotationCustomDataType' + propertyName: type + oneOf: + - $ref: '#/components/schemas/SceneAnnotationCalloutDataType' + - $ref: '#/components/schemas/SceneAnnotationCustomDataType' suppliedId: description: A customer provided ID used for correlation. example: PN12345 @@ -11734,12 +11795,15 @@ components: UpdateSceneAnnotationRequest_data_attributes: properties: data: - description: - A JSON string that describes the annotation type and its data. - JSON data is limited to 16kb. - example: '{"type":"my-annotation","anchor":{"x":0,"y":0,"z":0}}' - maxLength: 16384 - type: string + description: The data describing how to render this annotation. + discriminator: + mapping: + callout: '#/components/schemas/SceneAnnotationCalloutDataType' + custom: '#/components/schemas/SceneAnnotationCustomDataType' + propertyName: type + oneOf: + - $ref: '#/components/schemas/SceneAnnotationCalloutDataType' + - $ref: '#/components/schemas/SceneAnnotationCustomDataType' suppliedId: description: A customer provided ID used for correlation. example: PN12345 @@ -12610,12 +12674,15 @@ components: format: date-time type: string data: - description: - A JSON string that describes the annotation type and its data. - JSON data is limited to 16kb. - example: '{"type":"my-annotation","anchor":{"x":0,"y":0,"z":0}}' - maxLength: 16384 - type: string + description: The data describing how to render this annotation. + discriminator: + mapping: + callout: '#/components/schemas/SceneAnnotationCalloutDataType' + custom: '#/components/schemas/SceneAnnotationCustomDataType' + propertyName: type + oneOf: + - $ref: '#/components/schemas/SceneAnnotationCalloutDataType' + - $ref: '#/components/schemas/SceneAnnotationCustomDataType' suppliedId: example: some-string maxLength: 1024