{ "components": { "schemas": { "AccessInviteUserBody": { "properties": { "email": { "type": "string" } }, "type": "object" }, "BillingCreateCheckoutSessionBody": { "properties": { "callbackPath": { "type": "string" }, "items": { "items": { "$ref": "#/components/schemas/goliothSubscriptionItem" }, "type": "array" } }, "type": "object" }, "BillingCreateCustomerPortalSessionBody": { "properties": { "callbackPath": { "type": "string" } }, "type": "object" }, "DeviceRemoteProcedureCallRemoteProcedureCallBody": { "properties": { "method": { "type": "string" }, "params": { "items": {}, "type": "array" }, "timeout": { "format": "int64", "type": "integer" } }, "type": "object" }, "DeviceStreamGetDeviceStreamBody": { "properties": { "encodedQuery": { "type": "string" }, "end": { "format": "date-time", "type": "string" }, "interval": { "type": "string" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "query": { "$ref": "#/components/schemas/goliothDeviceStreamQuery" }, "start": { "format": "date-time", "type": "string" } }, "type": "object" }, "DeviceStreamGetProjectStreamBody": { "properties": { "deviceId": { "items": { "type": "string" }, "type": "array" }, "encodedQuery": { "type": "string" }, "end": { "format": "date-time", "type": "string" }, "interval": { "type": "string" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "query": { "$ref": "#/components/schemas/goliothDeviceStreamQuery" }, "start": { "format": "date-time", "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "IntegrationsTestBody": { "properties": { "data": { "type": "object" } }, "type": "object" }, "IntegrationsValidateBody": { "properties": { "configuration": { "type": "object" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "ProvisioningProvisionDeviceBody": { "properties": { "blueprintId": { "title": "string publicKey\nstring encryption", "type": "string" }, "hardwareIds": { "items": { "type": "string" }, "type": "array" }, "identity": { "type": "string" }, "name": { "type": "string" }, "preSharedKey": { "type": "string" }, "tagIds": { "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/goliothCredentialType" } }, "type": "object" }, "comgoliothTag": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "goliothAPIKey": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "key": { "type": "string" }, "keyTags": { "items": { "type": "string" }, "type": "array" }, "policyId": { "type": "string" }, "roles": { "items": { "type": "string" }, "type": "array" }, "secret": { "type": "string" }, "type": { "$ref": "#/components/schemas/goliothAPIKeyType" } }, "type": "object" }, "goliothAPIKeyType": { "default": "API_KEY", "enum": [ "API_KEY", "JWT_KEY" ], "type": "string" }, "goliothAPIKeyUpdate": { "properties": { "keyTags": { "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/goliothAPIKeyType" } }, "type": "object" }, "goliothAPIKeysCreateBody": { "properties": { "keyTags": { "items": { "type": "string" }, "type": "array" }, "type": { "$ref": "#/components/schemas/goliothAPIKeyType" } }, "type": "object" }, "goliothArtifact": { "properties": { "binaryInfo": { "type": "object" }, "blueprintId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "package": { "type": "string" }, "size": { "format": "uint64", "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "goliothArtifactUpdate": { "type": "object" }, "goliothBlueprint": { "properties": { "boardId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "goliothBlueprintUpdate": { "properties": { "boardId": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string" } }, "type": "object" }, "goliothBlueprintsCreateBody": { "properties": { "boardId": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string" } }, "type": "object" }, "goliothBoard": { "properties": { "arch": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "platforms": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "goliothCertificate": { "properties": { "certType": { "type": "string" }, "certificateContent": { "$ref": "#/components/schemas/goliothCertificateContent" }, "createdAt": { "format": "date-time", "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "projectId": { "type": "string" } }, "type": "object" }, "goliothCertificateContent": { "properties": { "issuer": { "type": "string" }, "keyUsages": { "items": { "type": "string" }, "type": "array" }, "notAfter": { "format": "date-time", "type": "string" }, "notBefore": { "format": "date-time", "type": "string" }, "publicKey": { "format": "byte", "type": "string" }, "publicKeyAlgorithm": { "type": "string" }, "serialNumber": { "type": "string" }, "signature": { "format": "byte", "type": "string" }, "signatureAlgorithm": { "type": "string" }, "subject": { "type": "string" }, "version": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothCertificatesCreateBody": { "properties": { "certFile": { "format": "byte", "type": "string" }, "certType": { "type": "string" } }, "type": "object" }, "goliothConditionalMap": { "properties": { "tags": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "goliothCreateAPIKeyResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothAPIKey" } }, "type": "object" }, "goliothCreateArtifactRequest": { "properties": { "blueprintId": { "type": "string" }, "content": { "format": "byte", "type": "string" }, "package": { "type": "string" }, "projectId": { "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "goliothCreateArtifactResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothArtifact" } }, "type": "object" }, "goliothCreateBlueprintResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothBlueprint" } }, "type": "object" }, "goliothCreateCertificateResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothCertificate" } }, "type": "object" }, "goliothCreateCheckoutSessionResponse": { "properties": { "url": { "type": "string" } }, "type": "object" }, "goliothCreateCredentialResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothCredential" } }, "type": "object" }, "goliothCreateCustomerPortalResponse": { "properties": { "url": { "type": "string" } }, "type": "object" }, "goliothCreateDeviceResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothDevice" } }, "type": "object" }, "goliothCreateIntegrationResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothIntegration" } }, "type": "object" }, "goliothCreateOrganizationRequest": { "properties": { "name": { "type": "string" }, "website": { "type": "string" } }, "type": "object" }, "goliothCreateOrganizationResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothOrganization" } }, "type": "object" }, "goliothCreateProjectRequest": { "properties": { "name": { "type": "string" }, "organizationId": { "type": "string" } }, "type": "object" }, "goliothCreateProjectResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothProject" } }, "type": "object" }, "goliothCreateReleaseResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothRelease" } }, "type": "object" }, "goliothCreateSettingResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothSetting" } }, "type": "object" }, "goliothCreateTagResponse": { "properties": { "data": { "$ref": "#/components/schemas/comgoliothTag" } }, "type": "object" }, "goliothCredential": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "identity": { "type": "string" }, "preSharedKey": { "type": "string" }, "type": { "$ref": "#/components/schemas/goliothCredentialType" } }, "type": "object" }, "goliothCredentialType": { "default": "PRE_SHARED_KEY", "enum": [ "PRE_SHARED_KEY", "ASYMMETRIC_KEY_PAIR" ], "type": "string" }, "goliothCredentialsCreateBody": { "properties": { "deviceId": { "type": "string" }, "identity": { "type": "string" }, "preSharedKey": { "type": "string" }, "type": { "$ref": "#/components/schemas/goliothCredentialType" } }, "type": "object" }, "goliothDeleteAPIKeyResponse": { "type": "object" }, "goliothDeleteArtifactResponse": { "type": "object" }, "goliothDeleteBlueprintResponse": { "type": "object" }, "goliothDeleteCertificateResponse": { "type": "object" }, "goliothDeleteCredentialResponse": { "type": "object" }, "goliothDeleteDeviceResponse": { "type": "object" }, "goliothDeleteDeviceStateResponse": { "type": "object" }, "goliothDeleteIntegrationResponse": { "type": "object" }, "goliothDeletePolicyResponse": { "type": "object" }, "goliothDeleteProjectResponse": { "type": "object" }, "goliothDeleteReleaseResponse": { "type": "object" }, "goliothDeleteSettingResponse": { "type": "object" }, "goliothDeleteTagResponse": { "type": "object" }, "goliothDevice": { "properties": { "blueprintId": { "type": "string" }, "certificateId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "data": { "type": "object" }, "enabled": { "type": "boolean" }, "hardwareIds": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "lastReport": { "format": "date-time", "type": "string" }, "metadata": { "$ref": "#/components/schemas/goliothDeviceMetadata" }, "name": { "type": "string" }, "status": { "type": "string" }, "tagIds": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "goliothDeviceActivityLog": { "properties": { "deviceId": { "type": "string" }, "deviceName": { "type": "string" }, "id": { "type": "string" }, "lastReport": { "format": "date-time", "type": "string" }, "lastSeenOffline": { "format": "date-time", "type": "string" }, "lastSeenOnline": { "format": "date-time", "type": "string" }, "status": { "type": "string" } }, "type": "object" }, "goliothDeviceLogEntry": { "description": "Event generated when a device sends logs.", "example": { "device_id": "612d3cecf3ee17d321adbec6", "level": 2, "message": "Hello", "metadata": {}, "module": "default", "project_id": "esp32-test", "timestamp": { "nanos": 250818000, "seconds": 1642796612 } }, "properties": { "deviceId": { "type": "string" }, "level": { "$ref": "#/components/schemas/goliothDeviceLogLevel" }, "message": { "type": "string" }, "metadata": { "type": "object" }, "module": { "type": "string" }, "moduleId": { "type": "string" }, "timestamp": { "format": "date-time", "type": "string" }, "type": { "$ref": "#/components/schemas/goliothDeviceLogType" } }, "type": "object" }, "goliothDeviceLogLevel": { "default": "NONE", "enum": [ "NONE", "DEBUG", "INFO", "WARN", "ERROR" ], "type": "string" }, "goliothDeviceLogType": { "default": "LOGGING", "enum": [ "LOGGING", "DIAGNOSTICS", "METRICS" ], "type": "string" }, "goliothDeviceMetadata": { "properties": { "lastReport": { "format": "date-time", "type": "string" }, "lastSeenOffline": { "format": "date-time", "type": "string" }, "lastSeenOnline": { "format": "date-time", "type": "string" }, "lastSettingsStatus": { "$ref": "#/components/schemas/goliothSettingsStatus" }, "status": { "type": "string" }, "update": { "type": "object" } }, "type": "object" }, "goliothDeviceStreamQuery": { "properties": { "fields": { "items": { "$ref": "#/components/schemas/goliothQueryField" }, "type": "array" }, "filters": { "items": { "$ref": "#/components/schemas/goliothQueryFilter" }, "type": "array" }, "timeBucket": { "type": "string" } }, "type": "object" }, "goliothDeviceUpdate": { "properties": { "addHardwareId": { "items": { "type": "string" }, "type": "array" }, "addTagId": { "items": { "type": "string" }, "type": "array" }, "blueprintId": { "type": "string" }, "enabled": { "type": "boolean" }, "hardwareIds": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "removeHardwareId": { "items": { "type": "string" }, "type": "array" }, "removeTagId": { "items": { "type": "string" }, "type": "array" }, "tagIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "goliothDevicesCreateBody": { "properties": { "blueprintId": { "type": "string" }, "hardwareIds": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "tagIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "goliothFirmwareLogEntry": { "properties": { "deviceId": { "type": "string" }, "package": { "type": "string" }, "reason": { "type": "string" }, "reasonCode": { "type": "string" }, "state": { "type": "string" }, "stateCode": { "type": "string" }, "target": { "type": "string" }, "time": { "format": "date-time", "type": "string" }, "version": { "type": "string" } }, "type": "object" }, "goliothGetArtifactResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothArtifact" } }, "type": "object" }, "goliothGetBlueprintResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothBlueprint" } }, "type": "object" }, "goliothGetBoardsResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothBoard" } }, "type": "object" }, "goliothGetCertificateResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothCertificate" } }, "type": "object" }, "goliothGetDeviceResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothDevice" } }, "type": "object" }, "goliothGetDeviceStateResponse": { "properties": { "data": {} }, "type": "object" }, "goliothGetDeviceStreamResponse": { "properties": { "list": { "items": {}, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothGetIntegrationResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothIntegration" } }, "type": "object" }, "goliothGetLatestDeviceActivityLogsResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothDeviceActivityLog" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothGetLogsResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothDeviceLogEntry" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothGetOrganizationQuotaResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothOrganizationQuota" } }, "type": "object" }, "goliothGetOrganizationResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothOrganization" } }, "type": "object" }, "goliothGetPolicyResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothPolicy" } }, "type": "object" }, "goliothGetProjectResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothProject" } }, "type": "object" }, "goliothGetProjectStreamResponse": { "properties": { "list": { "items": {}, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothGetReleaseResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothRelease" } }, "type": "object" }, "goliothGetSettingResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothSetting" }, "type": "array" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothGetTagResponse": { "properties": { "data": { "$ref": "#/components/schemas/comgoliothTag" } }, "type": "object" }, "goliothIntegration": { "properties": { "configuration": { "type": "object" }, "createdAt": { "format": "date-time", "type": "string" }, "enabled": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "goliothIntegrationType": { "properties": { "attributes": { "items": { "$ref": "#/components/schemas/goliothIntegrationTypeAttribute" }, "type": "array" }, "description": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "goliothIntegrationTypeAttribute": { "properties": { "description": { "type": "string" }, "displayName": { "type": "string" }, "name": { "type": "string" }, "required": { "type": "boolean" }, "type": { "type": "string" } }, "type": "object" }, "goliothIntegrationUpdate": { "properties": { "configuration": { "type": "object" }, "enabled": { "type": "boolean" }, "name": { "type": "string" } }, "type": "object" }, "goliothIntegrationValidationResponse": { "type": "object" }, "goliothIntegrationsCreateBody": { "properties": { "configuration": { "type": "object" }, "enabled": { "type": "boolean" }, "name": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "goliothInviteUserResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothPolicy" } }, "type": "object" }, "goliothListAPIKeyResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothAPIKey" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListAllowedSettingsDataTypesResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothSettingDataType" }, "type": "array" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListArtifactResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothArtifact" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListBlueprintResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothBlueprint" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListBoardsResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothBoard" }, "type": "array" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListCertificateResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothCertificate" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListCredentialResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothCredential" }, "type": "array" } }, "type": "object" }, "goliothListDeviceResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothDevice" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListFirmwareLogsResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothFirmwareLogEntry" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListIntegrationResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothIntegration" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListIntegrationTypesResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothIntegrationType" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListOrganizationResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothOrganization" }, "type": "array" } }, "type": "object" }, "goliothListPermissionResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothPermission" }, "type": "array" } }, "type": "object" }, "goliothListPolicyResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothPolicy" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListProjectResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothProject" }, "type": "array" } }, "type": "object" }, "goliothListReleaseResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothRelease" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListRoleResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothRole" }, "type": "array" } }, "type": "object" }, "goliothListSettingResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothSetting" }, "type": "array" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListTagResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/comgoliothTag" }, "type": "array" }, "page": { "format": "int64", "type": "integer" }, "perPage": { "format": "int64", "type": "integer" }, "total": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothListUsageResponse": { "properties": { "dates": { "additionalProperties": { "$ref": "#/components/schemas/goliothUsageSummaries" }, "type": "object" }, "unit": { "$ref": "#/components/schemas/goliothUsageUnit" } }, "type": "object" }, "goliothListUsersResponse": { "properties": { "list": { "items": { "$ref": "#/components/schemas/goliothUser" }, "type": "array" } }, "type": "object" }, "goliothOrganization": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "paymentStatus": { "type": "string" }, "roles": { "items": { "type": "string" }, "type": "array" }, "tier": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "website": { "type": "string" } }, "type": "object" }, "goliothOrganizationQuota": { "properties": { "quotas": { "additionalProperties": { "$ref": "#/components/schemas/goliothQuota" }, "type": "object" } }, "type": "object" }, "goliothOrganizationUpdate": { "properties": { "name": { "type": "string" }, "website": { "type": "string" } }, "type": "object" }, "goliothPaymentWebhookResponse": { "type": "object" }, "goliothPermission": { "properties": { "action": { "type": "string" }, "resource": { "type": "string" } }, "type": "object" }, "goliothPolicy": { "properties": { "conditionals": { "$ref": "#/components/schemas/goliothConditionalMap" }, "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "resourceId": { "type": "string" }, "resourceType": { "type": "string" }, "roles": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" }, "userId": { "type": "string" } }, "type": "object" }, "goliothPolicyUpdate": { "properties": { "addRoles": { "items": { "type": "string" }, "type": "array" }, "addTags": { "items": { "type": "string" }, "type": "array" }, "removeRoles": { "items": { "type": "string" }, "type": "array" }, "removeTags": { "items": { "type": "string" }, "type": "array" }, "roles": { "items": { "type": "string" }, "type": "array" }, "tagIds": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "goliothProject": { "properties": { "createdAt": { "format": "date-time", "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "organizationId": { "type": "string" }, "roles": { "items": { "type": "string" }, "type": "array" }, "updatedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "goliothProjectUpdate": { "properties": { "name": { "type": "string" } }, "type": "object" }, "goliothProvisionData": { "properties": { "deviceId": { "type": "string" } }, "type": "object" }, "goliothProvisionDeviceResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothProvisionData" } }, "type": "object" }, "goliothQueryField": { "properties": { "agg": { "type": "string" }, "alias": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "type": "object" }, "goliothQueryFilter": { "properties": { "filters": { "items": { "$ref": "#/components/schemas/goliothQueryFilter" }, "type": "array" }, "op": { "type": "string" }, "path": { "type": "string" }, "value": {} }, "type": "object" }, "goliothQuota": { "properties": { "current": { "format": "int32", "type": "integer" }, "max": { "format": "int32", "type": "integer" } }, "type": "object" }, "goliothRelease": { "properties": { "artifactIds": { "items": { "type": "string" }, "type": "array" }, "blueprintId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "deviceTagIds": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "releaseTags": { "items": { "type": "string" }, "type": "array" }, "rollout": { "type": "boolean" }, "sequenceNumber": { "format": "int64", "type": "string" }, "suitManifest": { "type": "object" }, "updatedAt": { "format": "date-time", "type": "string" } }, "type": "object" }, "goliothReleaseUpdate": { "properties": { "addDeviceTagId": { "items": { "type": "string" }, "type": "array" }, "addReleaseTag": { "items": { "type": "string" }, "type": "array" }, "deviceTagIds": { "items": { "type": "string" }, "type": "array" }, "releaseTags": { "items": { "type": "string" }, "type": "array" }, "removeDeviceTagId": { "items": { "type": "string" }, "type": "array" }, "removeReleaseTag": { "items": { "type": "string" }, "type": "array" }, "rollout": { "type": "boolean" } }, "type": "object" }, "goliothReleasesCreateBody": { "properties": { "artifactIds": { "items": { "type": "string" }, "type": "array" }, "deviceTagIds": { "items": { "type": "string" }, "type": "array" }, "releaseTags": { "items": { "type": "string" }, "type": "array" }, "rollout": { "type": "boolean" } }, "type": "object" }, "goliothRemoteProcedureCallResponse": { "properties": { "detail": {}, "statusCode": { "format": "int64", "type": "integer" } }, "type": "object" }, "goliothRole": { "properties": { "children": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "name": { "type": "string" }, "permissions": { "items": { "$ref": "#/components/schemas/goliothPermission" }, "type": "array" }, "type": { "type": "string" } }, "type": "object" }, "goliothSetting": { "properties": { "blueprintId": { "type": "string" }, "createdAt": { "format": "date-time", "type": "string" }, "dataType": { "type": "string" }, "deviceId": { "type": "string" }, "id": { "type": "string" }, "key": { "type": "string" }, "projectId": { "type": "string" }, "updatedAt": { "format": "date-time", "type": "string" }, "value": {} }, "type": "object" }, "goliothSettingDataType": { "properties": { "type": { "type": "string" } }, "type": "object" }, "goliothSettingError": { "properties": { "code": { "format": "int64", "type": "integer" }, "codeDescription": { "type": "string" }, "deviceDetails": { "type": "string" }, "key": { "type": "string" } }, "type": "object" }, "goliothSettingUpdate": { "properties": { "value": {} }, "type": "object" }, "goliothSettingsCreateBody": { "properties": { "blueprintId": { "type": "string" }, "dataType": { "type": "string" }, "deviceId": { "type": "string" }, "key": { "type": "string" }, "value": {} }, "type": "object" }, "goliothSettingsStatus": { "properties": { "errors": { "items": { "$ref": "#/components/schemas/goliothSettingError" }, "type": "array" }, "reportedVersion": { "type": "string" }, "status": { "type": "string" }, "statusDetail": { "type": "string" }, "syncTime": { "format": "date-time", "type": "string" } }, "type": "object" }, "goliothSubscriptionItem": { "properties": { "lookupKey": { "type": "string" }, "quantity": { "format": "int64", "type": "string" } }, "type": "object" }, "goliothTagUpdate": { "properties": { "name": { "type": "string" } }, "type": "object" }, "goliothTagsCreateBody": { "properties": { "name": { "type": "string" } }, "type": "object" }, "goliothTestIntegrationResponse": { "properties": { "result": { "type": "string" } }, "type": "object" }, "goliothUpdateAPIKeyResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothAPIKey" } }, "type": "object" }, "goliothUpdateArtifactResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothArtifact" } }, "type": "object" }, "goliothUpdateBlueprintResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothBlueprint" } }, "type": "object" }, "goliothUpdateDeviceResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothDevice" } }, "type": "object" }, "goliothUpdateDeviceStateResponse": { "properties": { "data": {} }, "type": "object" }, "goliothUpdateIntegrationResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothIntegration" } }, "type": "object" }, "goliothUpdateOrganizationResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothOrganization" } }, "type": "object" }, "goliothUpdatePolicyResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothPolicy" } }, "type": "object" }, "goliothUpdateProjectResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothProject" } }, "type": "object" }, "goliothUpdateReleaseResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothRelease" } }, "type": "object" }, "goliothUpdateSettingResponse": { "properties": { "data": { "$ref": "#/components/schemas/goliothSetting" } }, "type": "object" }, "goliothUpdateTagResponse": { "properties": { "data": { "$ref": "#/components/schemas/comgoliothTag" } }, "type": "object" }, "goliothUsageSummaries": { "properties": { "summaries": { "items": { "$ref": "#/components/schemas/goliothUsageSummary" }, "type": "array" } }, "type": "object" }, "goliothUsageSummary": { "properties": { "projectId": { "type": "string" }, "quantity": { "format": "uint64", "type": "string" }, "service": { "type": "string" } }, "type": "object" }, "goliothUsageUnit": { "default": "KILOBYTES", "enum": [ "KILOBYTES" ], "type": "string" }, "goliothUser": { "properties": { "email": { "type": "string" }, "emailVerified": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "policyId": { "type": "string" }, "profileUrl": { "type": "string" }, "roles": { "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "protobufAny": { "additionalProperties": {}, "properties": { "@type": { "type": "string" } }, "type": "object" }, "protobufNullValue": { "default": "NULL_VALUE", "description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\nThe JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value.", "enum": [ "NULL_VALUE" ], "type": "string" }, "rpcStatus": { "properties": { "code": { "format": "int32", "type": "integer" }, "details": { "items": { "$ref": "#/components/schemas/protobufAny" }, "type": "array" }, "message": { "type": "string" } }, "type": "object" } }, "securitySchemes": { "API Key": { "in": "header", "name": "x-api-key", "type": "apiKey" }, "Bearer": { "in": "header", "name": "Authorization", "type": "apiKey" } } }, "externalDocs": { "description": "golioth API", "url": "https://docs.golioth.io" }, "info": { "title": "golioth API", "version": "1.0" }, "openapi": "3.0.3", "paths": { "/v1/artifacts": { "post": { "operationId": "Artifacts_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateArtifactRequest" } } }, "description": " (streaming inputs)", "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateArtifactResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Artifacts" ] } }, "/v1/billing/webhook": { "post": { "operationId": "Billing_PaymentWebhook", "requestBody": { "content": { "application/json": { "schema": { "format": "byte", "type": "string" } } }, "required": true, "x-originalParamName": "raw" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothPaymentWebhookResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Billing" ] } }, "/v1/boards": { "get": { "operationId": "Boards_List", "parameters": [ { "in": "query", "name": "id", "schema": { "type": "string" } }, { "in": "query", "name": "platform", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListBoardsResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Boards" ] } }, "/v1/boards/{id}": { "get": { "operationId": "Boards_Get", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetBoardsResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Boards" ] } }, "/v1/integration-types": { "get": { "operationId": "Integrations_ListIntegrationTypes", "parameters": [ { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListIntegrationTypesResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Integrations" ] } }, "/v1/organizations": { "get": { "operationId": "Organizations_List", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListOrganizationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Organizations" ] }, "post": { "operationId": "Organizations_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateOrganizationRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateOrganizationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Organizations" ] } }, "/v1/organizations/{organizationId}": { "get": { "operationId": "Organizations_Get", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetOrganizationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Organizations" ] }, "patch": { "operationId": "Organizations_Update2", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothOrganizationUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateOrganizationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Organizations" ] }, "put": { "operationId": "Organizations_Update", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothOrganizationUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateOrganizationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Organizations" ] } }, "/v1/organizations/{organizationId}/checkout_sessions": { "post": { "operationId": "Billing_CreateCheckoutSession", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCreateCheckoutSessionBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateCheckoutSessionResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Billing" ] } }, "/v1/organizations/{organizationId}/customer_portal_sessions": { "post": { "operationId": "Billing_CreateCustomerPortalSession", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingCreateCustomerPortalSessionBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateCustomerPortalResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Billing" ] } }, "/v1/organizations/{organizationId}/quotas": { "get": { "operationId": "Organizations_GetQuota", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetOrganizationQuotaResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Organizations" ] } }, "/v1/organizations/{organizationId}/usage": { "get": { "operationId": "Usage_List", "parameters": [ { "in": "path", "name": "organizationId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "end", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListUsageResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Usage" ] } }, "/v1/projects": { "get": { "operationId": "Projects_List", "parameters": [ { "in": "query", "name": "organizationId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListProjectResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Projects" ] }, "post": { "operationId": "Projects_Create", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateProjectRequest" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateProjectResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Projects" ] } }, "/v1/projects/{projectId}": { "delete": { "operationId": "Projects_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteProjectResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Projects" ] }, "get": { "operationId": "Projects_Get", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetProjectResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Projects" ] }, "patch": { "operationId": "Projects_Update2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothProjectUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateProjectResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Projects" ] }, "put": { "operationId": "Projects_Update", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothProjectUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateProjectResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Projects" ] } }, "/v1/projects/{projectId}/apikeys": { "get": { "operationId": "APIKeys_List", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListAPIKeyResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "API Keys" ] }, "post": { "operationId": "APIKeys_Create", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothAPIKeysCreateBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateAPIKeyResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "API Keys" ] } }, "/v1/projects/{projectId}/apikeys/{apikeyId}": { "delete": { "operationId": "APIKeys_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "apikeyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteAPIKeyResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "API Keys" ] }, "patch": { "operationId": "APIKeys_Update", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "apikeyId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothAPIKeyUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateAPIKeyResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "API Keys" ] } }, "/v1/projects/{projectId}/artifacts": { "get": { "operationId": "Artifacts_List", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "version", "schema": { "type": "string" } }, { "in": "query", "name": "blueprintId", "schema": { "type": "string" } }, { "in": "query", "name": "package", "schema": { "type": "string" } }, { "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListArtifactResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Artifacts" ] } }, "/v1/projects/{projectId}/artifacts/{artifactId}": { "delete": { "operationId": "Artifacts_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "artifactId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteArtifactResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Artifacts" ] }, "get": { "operationId": "Artifacts_Get", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "artifactId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetArtifactResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Artifacts" ] }, "patch": { "operationId": "Artifacts_Update2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "artifactId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothArtifactUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateArtifactResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Artifacts" ] }, "put": { "operationId": "Artifacts_Update", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "artifactId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothArtifactUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateArtifactResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Artifacts" ] } }, "/v1/projects/{projectId}/blueprints": { "get": { "operationId": "Blueprints_List", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "blueprintName", "schema": { "type": "string" } }, { "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "boardId", "schema": { "type": "string" } }, { "in": "query", "name": "platform", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListBlueprintResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Blueprints" ] }, "post": { "operationId": "Blueprints_Create", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothBlueprintsCreateBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateBlueprintResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Blueprints" ] } }, "/v1/projects/{projectId}/blueprints/{blueprintId}": { "delete": { "operationId": "Blueprints_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "blueprintId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteBlueprintResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Blueprints" ] }, "get": { "operationId": "Blueprints_Get", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "blueprintId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetBlueprintResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Blueprints" ] }, "patch": { "operationId": "Blueprints_Update2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "blueprintId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothBlueprintUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateBlueprintResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Blueprints" ] }, "put": { "operationId": "Blueprints_Update", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "blueprintId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothBlueprintUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateBlueprintResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Blueprints" ] } }, "/v1/projects/{projectId}/certificates": { "get": { "operationId": "Certificates_List", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "description": "TODO: filter by: device_id, enabled/disabled, start/end expiration date, cert type, may increase filters in the future", "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListCertificateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Certificates" ] }, "post": { "operationId": "Certificates_Create", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCertificatesCreateBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateCertificateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Certificates" ] } }, "/v1/projects/{projectId}/certificates/{certificateId}": { "delete": { "operationId": "Certificates_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "certificateId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteCertificateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Certificates" ] }, "get": { "operationId": "Certificates_Get", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "certificateId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetCertificateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Certificates" ] } }, "/v1/projects/{projectId}/credentials": { "post": { "operationId": "Credentials_Create2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCredentialsCreateBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateCredentialResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Credentials" ] } }, "/v1/projects/{projectId}/credentials/{credentialId}": { "delete": { "operationId": "Credentials_Delete2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "credentialId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "deviceId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteCredentialResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Credentials" ] } }, "/v1/projects/{projectId}/device-activity-logs": { "get": { "operationId": "Logs_GetLatestDeviceActivityLogs", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetLatestDeviceActivityLogsResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Logs" ] } }, "/v1/projects/{projectId}/devices": { "get": { "operationId": "Devices_List", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "deviceName", "schema": { "type": "string" } }, { "in": "query", "name": "hardwareId", "schema": { "type": "string" } }, { "in": "query", "name": "tags", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "blueprintId", "schema": { "type": "string" } }, { "in": "query", "name": "statePath", "schema": { "type": "string" } }, { "in": "query", "name": "streamPath", "schema": { "type": "string" } }, { "in": "query", "name": "updatePath", "schema": { "type": "string" } }, { "in": "query", "name": "term", "schema": { "type": "string" } }, { "in": "query", "name": "enabled", "schema": { "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListDeviceResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Devices" ] }, "post": { "operationId": "Devices_Create", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDevicesCreateBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateDeviceResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Devices" ] } }, "/v1/projects/{projectId}/devices/{deviceId}": { "delete": { "operationId": "Devices_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteDeviceResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Devices" ] }, "get": { "operationId": "Devices_Get", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetDeviceResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Devices" ] }, "patch": { "operationId": "Devices_Update2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeviceUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateDeviceResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Devices" ] }, "put": { "operationId": "Devices_Update", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeviceUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateDeviceResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Devices" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/credentials": { "get": { "operationId": "Credentials_List", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListCredentialResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Credentials" ] }, "post": { "operationId": "Credentials_Create", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCredentialsCreateBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateCredentialResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Credentials" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/credentials/{credentialId}": { "delete": { "operationId": "Credentials_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "credentialId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteCredentialResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Credentials" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/data/{path}": { "delete": { "operationId": "DeviceState_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "pattern": ".+", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteDeviceStateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB" ] }, "get": { "operationId": "DeviceState_Get", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "pattern": ".+", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetDeviceStateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB" ] }, "patch": { "operationId": "DeviceState_Update2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "pattern": ".+", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true, "x-originalParamName": "value" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateDeviceStateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB" ] }, "post": { "operationId": "DeviceState_Update3", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "pattern": ".+", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true, "x-originalParamName": "value" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateDeviceStateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB" ] }, "put": { "operationId": "DeviceState_Update", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "pattern": ".+", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true, "x-originalParamName": "value" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateDeviceStateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/provisioning": { "post": { "operationId": "Provisioning_ProvisionDevice2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisioningProvisionDeviceBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothProvisionDeviceResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Provisioning" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/rpc": { "post": { "operationId": "DeviceRemoteProcedureCall_RemoteProcedureCall", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceRemoteProcedureCallRemoteProcedureCallBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothRemoteProcedureCallResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Remote Procedure Call" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/settings": { "get": { "operationId": "Settings_Get", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetSettingResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Settings" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/stream": { "get": { "operationId": "DeviceStream_GetDeviceStream", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "end", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "interval", "schema": { "type": "string" } }, { "in": "query", "name": "encodedQuery", "schema": { "type": "string" } }, { "in": "query", "name": "query.timeBucket", "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetDeviceStreamResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB Stream" ] }, "post": { "operationId": "DeviceStream_GetDeviceStream2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceStreamGetDeviceStreamBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetDeviceStreamResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB Stream" ] } }, "/v1/projects/{projectId}/devices/{deviceId}/stream/latest/{path}": { "get": { "operationId": "DeviceStream_GetLatestStream", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "deviceId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "pattern": ".+", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetDeviceStateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB Stream" ] } }, "/v1/projects/{projectId}/devicesByTag/{tag}/data/{path}": { "delete": { "operationId": "DeviceState_DeleteByTag", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tag", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "pattern": ".+", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteDeviceStateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB" ] }, "patch": { "operationId": "DeviceState_UpdateByTag2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tag", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "pattern": ".+", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true, "x-originalParamName": "value" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateDeviceStateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB" ] }, "post": { "operationId": "DeviceState_UpdateByTag3", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tag", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "pattern": ".+", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true, "x-originalParamName": "value" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateDeviceStateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB" ] }, "put": { "operationId": "DeviceState_UpdateByTag", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tag", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "path", "required": true, "schema": { "pattern": ".+", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": {} } }, "required": true, "x-originalParamName": "value" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateDeviceStateResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB" ] } }, "/v1/projects/{projectId}/firmware/logs": { "get": { "operationId": "Firmwares_Logs", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "version", "schema": { "type": "string" } }, { "in": "query", "name": "target", "schema": { "type": "string" } }, { "in": "query", "name": "state", "schema": { "type": "string" } }, { "in": "query", "name": "reason", "schema": { "type": "string" } }, { "in": "query", "name": "deviceId", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "start", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "end", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListFirmwareLogsResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Firmware" ] } }, "/v1/projects/{projectId}/integrations": { "get": { "operationId": "Integrations_List", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "name", "schema": { "type": "string" } }, { "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "type", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListIntegrationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Integrations" ] }, "post": { "operationId": "Integrations_Create", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothIntegrationsCreateBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateIntegrationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Integrations" ] } }, "/v1/projects/{projectId}/integrations/validate": { "post": { "operationId": "Integrations_Validate", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsValidateBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothIntegrationValidationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Integrations" ] } }, "/v1/projects/{projectId}/integrations/{integrationId}": { "delete": { "operationId": "Integrations_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "integrationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteIntegrationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Integrations" ] }, "get": { "operationId": "Integrations_Get", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "integrationId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetIntegrationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Integrations" ] }, "patch": { "operationId": "Integrations_Update2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "integrationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothIntegrationUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateIntegrationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Integrations" ] }, "put": { "operationId": "Integrations_Update", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "integrationId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothIntegrationUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateIntegrationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Integrations" ] } }, "/v1/projects/{projectId}/integrations/{integrationId}/test": { "post": { "operationId": "Integrations_Test", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "integrationId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationsTestBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothTestIntegrationResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Integrations" ] } }, "/v1/projects/{projectId}/logs": { "get": { "operationId": "Logs_GetLogs", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "deviceId", "schema": { "type": "string" } }, { "in": "query", "name": "start", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "end", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "module", "schema": { "type": "string" } }, { "in": "query", "name": "level", "schema": { "default": "NONE", "enum": [ "NONE", "DEBUG", "INFO", "WARN", "ERROR" ], "type": "string" } }, { "in": "query", "name": "term", "schema": { "type": "string" } }, { "in": "query", "name": "tags", "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetLogsResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Logs" ] } }, "/v1/projects/{projectId}/permissions": { "get": { "operationId": "Access_ListPermissions", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListPermissionResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Access" ] } }, "/v1/projects/{projectId}/policies": { "get": { "operationId": "Access_List", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "userId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListPolicyResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Access" ] } }, "/v1/projects/{projectId}/policies/{policyId}": { "delete": { "operationId": "Access_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "policyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeletePolicyResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Access" ] }, "get": { "operationId": "Access_Get", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "policyId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetPolicyResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Access" ] }, "patch": { "operationId": "Access_Update2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "policyId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothPolicyUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdatePolicyResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Access" ] }, "put": { "operationId": "Access_Update", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "policyId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothPolicyUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdatePolicyResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Access" ] } }, "/v1/projects/{projectId}/provisioning": { "post": { "operationId": "Provisioning_ProvisionDevice", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisioningProvisionDeviceBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothProvisionDeviceResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Provisioning" ] } }, "/v1/projects/{projectId}/releases": { "get": { "operationId": "Releases_List", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "releaseTags", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "deviceTags", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "rollout", "schema": { "type": "boolean" } }, { "in": "query", "name": "blueprintId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListReleaseResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Releases" ] }, "post": { "operationId": "Releases_Create", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothReleasesCreateBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateReleaseResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Releases" ] } }, "/v1/projects/{projectId}/releases/{releaseId}": { "delete": { "operationId": "Releases_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "releaseId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteReleaseResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Releases" ] }, "get": { "operationId": "Releases_Get", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "releaseId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetReleaseResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Releases" ] }, "patch": { "operationId": "Releases_Update2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "releaseId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothReleaseUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateReleaseResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Releases" ] }, "put": { "operationId": "Releases_Update", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "releaseId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothReleaseUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateReleaseResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Releases" ] } }, "/v1/projects/{projectId}/settings": { "get": { "operationId": "Settings_List", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "blueprintId", "schema": { "type": "string" } }, { "in": "query", "name": "deviceId", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListSettingResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Settings" ] }, "post": { "operationId": "Settings_Create", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothSettingsCreateBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateSettingResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Settings" ] } }, "/v1/projects/{projectId}/settings/{settingId}": { "delete": { "operationId": "Settings_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "settingId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteSettingResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Settings" ] }, "patch": { "operationId": "Settings_Update2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "settingId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothSettingUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateSettingResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Settings" ] }, "put": { "operationId": "Settings_Update", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "settingId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothSettingUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateSettingResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Settings" ] } }, "/v1/projects/{projectId}/stream": { "get": { "operationId": "DeviceStream_GetProjectStream", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "start", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "end", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "interval", "schema": { "type": "string" } }, { "in": "query", "name": "encodedQuery", "schema": { "type": "string" } }, { "in": "query", "name": "query.timeBucket", "schema": { "type": "string" } }, { "in": "query", "name": "deviceId", "schema": { "items": { "type": "string" }, "type": "array" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "tags", "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetProjectStreamResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB Stream" ] }, "post": { "operationId": "DeviceStream_GetProjectStream2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeviceStreamGetProjectStreamBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetProjectStreamResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "LightDB Stream" ] } }, "/v1/projects/{projectId}/tags": { "get": { "operationId": "Tags_List", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "perPage", "schema": { "format": "int64", "type": "integer" } }, { "in": "query", "name": "tagName", "schema": { "type": "string" } }, { "in": "query", "name": "ids", "schema": { "items": { "type": "string" }, "type": "array" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListTagResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Tags" ] }, "post": { "operationId": "Tags_Create", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothTagsCreateBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothCreateTagResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Tags" ] } }, "/v1/projects/{projectId}/tags/{tagId}": { "delete": { "operationId": "Tags_Delete", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothDeleteTagResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Tags" ] }, "get": { "operationId": "Tags_Get", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothGetTagResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Tags" ] }, "patch": { "operationId": "Tags_Update2", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothTagUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateTagResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Tags" ] }, "put": { "operationId": "Tags_Update", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "tagId", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "updateMask", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothTagUpdate" } } }, "required": true, "x-originalParamName": "update" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothUpdateTagResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Tags" ] } }, "/v1/projects/{projectId}/users": { "get": { "operationId": "Access_ListUsers", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListUsersResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Access" ] } }, "/v1/projects/{projectId}/users/invitation": { "post": { "operationId": "Access_InviteUser", "parameters": [ { "in": "path", "name": "projectId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessInviteUserBody" } } }, "required": true, "x-originalParamName": "body" }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothInviteUserResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Access" ] } }, "/v1/roles": { "get": { "operationId": "Access_ListRoles", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListRoleResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Access" ] } }, "/v1/settings-data-types": { "get": { "operationId": "Settings_ListAllowedSettingsDataTypes", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goliothListAllowedSettingsDataTypesResponse" } } }, "description": "A successful response." }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/rpcStatus" } } }, "description": "An unexpected error response." } }, "tags": [ "Settings" ] } } }, "security": [ { "API Key": [], "Bearer": [] } ], "servers": [ { "url": "https://api.golioth.io" } ] }