@giveitsmaller/contracts 0.5.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/asyncapi/events.yaml +278 -4
- package/availability/availability.json +190 -12
- package/dist/asyncapi/AnonymousSchema_253.d.ts +5 -0
- package/dist/asyncapi/AnonymousSchema_253.js +6 -0
- package/dist/asyncapi/LongFormJobMessage.d.ts +10 -0
- package/dist/asyncapi/LongFormJobMessage.js +1 -0
- package/dist/asyncapi/index.d.ts +2 -0
- package/dist/asyncapi/index.js +1 -0
- package/dist/openapi/models/AudioWatermarkDecodeRequest.d.ts +2 -2
- package/dist/openapi/models/AudioWatermarkDecodeRequest.js +2 -2
- package/dist/openapi/models/AudioWatermarkDecodeResponse.d.ts +2 -2
- package/dist/openapi/models/AudioWatermarkDecodeResponse.js +2 -2
- package/dist/openapi/models/AuthErrorResponse.d.ts +9 -6
- package/dist/openapi/models/AuthErrorResponse.js +2 -2
- package/dist/openapi/models/AuthErrorType.d.ts +2 -2
- package/dist/openapi/models/AuthErrorType.js +2 -2
- package/dist/openapi/models/AvailabilityValue.d.ts +2 -2
- package/dist/openapi/models/AvailabilityValue.js +2 -2
- package/dist/openapi/models/BalanceExhaustedResponse.d.ts +2 -2
- package/dist/openapi/models/BalanceExhaustedResponse.js +2 -2
- package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.d.ts +2 -2
- package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.js +2 -2
- package/dist/openapi/models/CallbackEventType.d.ts +2 -2
- package/dist/openapi/models/CallbackEventType.js +2 -2
- package/dist/openapi/models/ConnectionSource.d.ts +2 -2
- package/dist/openapi/models/ConnectionSource.js +2 -2
- package/dist/openapi/models/ContactRequest.d.ts +2 -2
- package/dist/openapi/models/ContactRequest.js +2 -2
- package/dist/openapi/models/ContactSubject.d.ts +2 -2
- package/dist/openapi/models/ContactSubject.js +2 -2
- package/dist/openapi/models/ContactValidationErrorResponse.d.ts +2 -2
- package/dist/openapi/models/ContactValidationErrorResponse.js +2 -2
- package/dist/openapi/models/CreateExternalImport403Response.d.ts +2 -2
- package/dist/openapi/models/CreateExternalImport403Response.js +2 -2
- package/dist/openapi/models/CreateExternalImport422Response.d.ts +2 -2
- package/dist/openapi/models/CreateExternalImport422Response.js +2 -2
- package/dist/openapi/models/CreateWorkflow422Response.d.ts +2 -2
- package/dist/openapi/models/CreateWorkflow422Response.js +2 -2
- package/dist/openapi/models/CreditTransaction.d.ts +2 -2
- package/dist/openapi/models/CreditTransaction.js +2 -2
- package/dist/openapi/models/CreditTransactionSourceBucket.d.ts +2 -2
- package/dist/openapi/models/CreditTransactionSourceBucket.js +2 -2
- package/dist/openapi/models/CreditsBalanceResponse.d.ts +2 -2
- package/dist/openapi/models/CreditsBalanceResponse.js +2 -2
- package/dist/openapi/models/CreditsBalanceSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/CreditsBalanceSuccessEnvelope.js +2 -2
- package/dist/openapi/models/CreditsUsageResponse.d.ts +2 -2
- package/dist/openapi/models/CreditsUsageResponse.js +2 -2
- package/dist/openapi/models/CreditsUsageSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/CreditsUsageSuccessEnvelope.js +2 -2
- package/dist/openapi/models/Delivery.d.ts +16 -3
- package/dist/openapi/models/Delivery.js +2 -2
- package/dist/openapi/models/DeliveryOutputRef.d.ts +2 -2
- package/dist/openapi/models/DeliveryOutputRef.js +2 -2
- package/dist/openapi/models/DeliveryPlan.d.ts +2 -2
- package/dist/openapi/models/DeliveryPlan.js +2 -2
- package/dist/openapi/models/DeliveryPlanOutput.d.ts +2 -2
- package/dist/openapi/models/DeliveryPlanOutput.js +2 -2
- package/dist/openapi/models/DeliveryPlanReason.d.ts +2 -2
- package/dist/openapi/models/DeliveryPlanReason.js +2 -2
- package/dist/openapi/models/DeliverySelection.d.ts +2 -2
- package/dist/openapi/models/DeliverySelection.js +2 -2
- package/dist/openapi/models/EndpointProjection.d.ts +98 -0
- package/dist/openapi/models/EndpointProjection.js +78 -0
- package/dist/openapi/models/ErrorEnvelope.d.ts +9 -6
- package/dist/openapi/models/ErrorEnvelope.js +2 -2
- package/dist/openapi/models/EstimateQuality.d.ts +2 -2
- package/dist/openapi/models/EstimateQuality.js +2 -2
- package/dist/openapi/models/EstimateRange.d.ts +2 -2
- package/dist/openapi/models/EstimateRange.js +2 -2
- package/dist/openapi/models/ExternalDestination.d.ts +2 -2
- package/dist/openapi/models/ExternalDestination.js +2 -2
- package/dist/openapi/models/ExternalImportCreatedResponse.d.ts +2 -2
- package/dist/openapi/models/ExternalImportCreatedResponse.js +2 -2
- package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.js +2 -2
- package/dist/openapi/models/ExternalImportRequest.d.ts +2 -2
- package/dist/openapi/models/ExternalImportRequest.js +2 -2
- package/dist/openapi/models/ExternalImportToken.d.ts +2 -2
- package/dist/openapi/models/ExternalImportToken.js +2 -2
- package/dist/openapi/models/ExternalSource.d.ts +2 -2
- package/dist/openapi/models/ExternalSource.js +2 -2
- package/dist/openapi/models/FeatureNotAvailableResponse.d.ts +9 -6
- package/dist/openapi/models/FeatureNotAvailableResponse.js +2 -2
- package/dist/openapi/models/FeatureTierRestrictedResponse.d.ts +9 -6
- package/dist/openapi/models/FeatureTierRestrictedResponse.js +2 -2
- package/dist/openapi/models/FeatureViolation.d.ts +2 -2
- package/dist/openapi/models/FeatureViolation.js +2 -2
- package/dist/openapi/models/JobDefinition.d.ts +2 -2
- package/dist/openapi/models/JobDefinition.js +2 -2
- package/dist/openapi/models/JobDownload.d.ts +2 -2
- package/dist/openapi/models/JobDownload.js +2 -2
- package/dist/openapi/models/JobInputV2.d.ts +2 -2
- package/dist/openapi/models/JobInputV2.js +2 -2
- package/dist/openapi/models/JobOutputSource.d.ts +2 -2
- package/dist/openapi/models/JobOutputSource.js +2 -2
- package/dist/openapi/models/JobResponse.d.ts +2 -2
- package/dist/openapi/models/JobResponse.js +2 -2
- package/dist/openapi/models/JobStatus.d.ts +2 -2
- package/dist/openapi/models/JobStatus.js +2 -2
- package/dist/openapi/models/JobType.d.ts +2 -2
- package/dist/openapi/models/JobType.js +2 -2
- package/dist/openapi/models/LivenessResponse.d.ts +2 -2
- package/dist/openapi/models/LivenessResponse.js +2 -2
- package/dist/openapi/models/LoginUser200Response.d.ts +2 -2
- package/dist/openapi/models/LoginUser200Response.js +2 -2
- package/dist/openapi/models/LoginUser200ResponseData.d.ts +2 -2
- package/dist/openapi/models/LoginUser200ResponseData.js +2 -2
- package/dist/openapi/models/LoginUser200ResponseDataUser.d.ts +2 -2
- package/dist/openapi/models/LoginUser200ResponseDataUser.js +2 -2
- package/dist/openapi/models/LoginUserRequest.d.ts +2 -2
- package/dist/openapi/models/LoginUserRequest.js +2 -2
- package/dist/openapi/models/LogoutUser200Response.d.ts +2 -2
- package/dist/openapi/models/LogoutUser200Response.js +2 -2
- package/dist/openapi/models/MetadataResponse.d.ts +2 -2
- package/dist/openapi/models/MetadataResponse.js +2 -2
- package/dist/openapi/models/MetadataResponseDimensions.d.ts +2 -2
- package/dist/openapi/models/MetadataResponseDimensions.js +2 -2
- package/dist/openapi/models/MetadataResponseExif.d.ts +2 -2
- package/dist/openapi/models/MetadataResponseExif.js +2 -2
- package/dist/openapi/models/MetadataResponseExifGps.d.ts +2 -2
- package/dist/openapi/models/MetadataResponseExifGps.js +2 -2
- package/dist/openapi/models/MetadataSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/MetadataSuccessEnvelope.js +2 -2
- package/dist/openapi/models/MimeGroupSchema.d.ts +2 -2
- package/dist/openapi/models/MimeGroupSchema.js +2 -2
- package/dist/openapi/models/MultipartCompleteRequest.d.ts +2 -2
- package/dist/openapi/models/MultipartCompleteRequest.js +2 -2
- package/dist/openapi/models/MultipartCompleteRequestPartsInner.d.ts +2 -2
- package/dist/openapi/models/MultipartCompleteRequestPartsInner.js +2 -2
- package/dist/openapi/models/MultipartCompleteResponse.d.ts +2 -2
- package/dist/openapi/models/MultipartCompleteResponse.js +2 -2
- package/dist/openapi/models/MultipartCompleteSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/MultipartCompleteSuccessEnvelope.js +2 -2
- package/dist/openapi/models/MultipartInitiateRequestMetadataHint.d.ts +2 -2
- package/dist/openapi/models/MultipartInitiateRequestMetadataHint.js +2 -2
- package/dist/openapi/models/MultipartInitiateResponse.d.ts +2 -2
- package/dist/openapi/models/MultipartInitiateResponse.js +2 -2
- package/dist/openapi/models/MultipartInitiateSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/MultipartInitiateSuccessEnvelope.js +2 -2
- package/dist/openapi/models/MultipartKeepaliveResponse.d.ts +2 -2
- package/dist/openapi/models/MultipartKeepaliveResponse.js +2 -2
- package/dist/openapi/models/MultipartKeepaliveSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/MultipartKeepaliveSuccessEnvelope.js +2 -2
- package/dist/openapi/models/MultipartPartListing.d.ts +2 -2
- package/dist/openapi/models/MultipartPartListing.js +2 -2
- package/dist/openapi/models/MultipartPresignRequest.d.ts +2 -2
- package/dist/openapi/models/MultipartPresignRequest.js +2 -2
- package/dist/openapi/models/MultipartPresignResponse.d.ts +2 -2
- package/dist/openapi/models/MultipartPresignResponse.js +2 -2
- package/dist/openapi/models/MultipartPresignSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/MultipartPresignSuccessEnvelope.js +2 -2
- package/dist/openapi/models/MultipartStatusResponse.d.ts +2 -2
- package/dist/openapi/models/MultipartStatusResponse.js +2 -2
- package/dist/openapi/models/MultipartStatusSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/MultipartStatusSuccessEnvelope.js +2 -2
- package/dist/openapi/models/OperationDefinition.d.ts +2 -2
- package/dist/openapi/models/OperationDefinition.js +2 -2
- package/dist/openapi/models/OperationDownload.d.ts +2 -2
- package/dist/openapi/models/OperationDownload.js +2 -2
- package/dist/openapi/models/OperationInputModel.d.ts +2 -2
- package/dist/openapi/models/OperationInputModel.js +2 -2
- package/dist/openapi/models/OperationResponse.d.ts +2 -2
- package/dist/openapi/models/OperationResponse.js +2 -2
- package/dist/openapi/models/OperationResult.d.ts +2 -2
- package/dist/openapi/models/OperationResult.js +2 -2
- package/dist/openapi/models/OperationResultMetrics.d.ts +21 -2
- package/dist/openapi/models/OperationResultMetrics.js +7 -2
- package/dist/openapi/models/OperationSchemaDefinition.d.ts +2 -2
- package/dist/openapi/models/OperationSchemaDefinition.js +2 -2
- package/dist/openapi/models/OperationStatus.d.ts +2 -2
- package/dist/openapi/models/OperationStatus.js +2 -2
- package/dist/openapi/models/OperationType.d.ts +2 -2
- package/dist/openapi/models/OperationType.js +2 -2
- package/dist/openapi/models/OperationsSchemaResponse.d.ts +30 -2
- package/dist/openapi/models/OperationsSchemaResponse.js +5 -2
- package/dist/openapi/models/OptionSchema.d.ts +23 -2
- package/dist/openapi/models/OptionSchema.js +6 -3
- package/dist/openapi/models/PerRoleCardinalityEntry.d.ts +2 -2
- package/dist/openapi/models/PerRoleCardinalityEntry.js +2 -2
- package/dist/openapi/models/PerValueAvailabilityEntry.d.ts +2 -2
- package/dist/openapi/models/PerValueAvailabilityEntry.js +2 -2
- package/dist/openapi/models/PresignedUrlPart.d.ts +2 -2
- package/dist/openapi/models/PresignedUrlPart.js +2 -2
- package/dist/openapi/models/ProbePendingResponse.d.ts +9 -6
- package/dist/openapi/models/ProbePendingResponse.js +2 -2
- package/dist/openapi/models/ProcessingClass.d.ts +2 -2
- package/dist/openapi/models/ProcessingClass.js +2 -2
- package/dist/openapi/models/ProcessingClassBandViolation.d.ts +2 -2
- package/dist/openapi/models/ProcessingClassBandViolation.js +2 -2
- package/dist/openapi/models/ProcessingClassExceedsBandResponse.d.ts +9 -6
- package/dist/openapi/models/ProcessingClassExceedsBandResponse.js +2 -2
- package/dist/openapi/models/ProcessingClassHint.d.ts +2 -2
- package/dist/openapi/models/ProcessingClassHint.js +2 -2
- package/dist/openapi/models/ProcessingClassReason.d.ts +2 -2
- package/dist/openapi/models/ProcessingClassReason.js +2 -2
- package/dist/openapi/models/ProcessingClassRejectReason.d.ts +2 -2
- package/dist/openapi/models/ProcessingClassRejectReason.js +2 -2
- package/dist/openapi/models/ProcessingPlan.d.ts +2 -2
- package/dist/openapi/models/ProcessingPlan.js +2 -2
- package/dist/openapi/models/ProcessingPlanJob.d.ts +2 -2
- package/dist/openapi/models/ProcessingPlanJob.js +2 -2
- package/dist/openapi/models/ReEncodeDecision.d.ts +38 -0
- package/dist/openapi/models/ReEncodeDecision.js +56 -0
- package/dist/openapi/models/ReadinessResponse.d.ts +2 -2
- package/dist/openapi/models/ReadinessResponse.js +2 -2
- package/dist/openapi/models/ResponseEnvelope.d.ts +2 -2
- package/dist/openapi/models/ResponseEnvelope.js +2 -2
- package/dist/openapi/models/RetryResponse.d.ts +2 -2
- package/dist/openapi/models/RetryResponse.js +2 -2
- package/dist/openapi/models/RetrySuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/RetrySuccessEnvelope.js +2 -2
- package/dist/openapi/models/SseCompletionBase.d.ts +63 -0
- package/dist/openapi/models/SseCompletionBase.js +50 -0
- package/dist/openapi/models/SseEventType.d.ts +2 -2
- package/dist/openapi/models/SseEventType.js +2 -2
- package/dist/openapi/models/SseJobCompletedData.d.ts +2 -2
- package/dist/openapi/models/SseJobCompletedData.js +2 -2
- package/dist/openapi/models/SseJobFailedData.d.ts +2 -2
- package/dist/openapi/models/SseJobFailedData.js +2 -2
- package/dist/openapi/models/SseMultiOutputCompletion.d.ts +2 -2
- package/dist/openapi/models/SseMultiOutputCompletion.js +2 -2
- package/dist/openapi/models/SseMultiOutputCompletionMetrics.d.ts +2 -2
- package/dist/openapi/models/SseMultiOutputCompletionMetrics.js +2 -2
- package/dist/openapi/models/SseMultiOutputCompletionWithKind.d.ts +6 -8
- package/dist/openapi/models/SseMultiOutputCompletionWithKind.js +2 -2
- package/dist/openapi/models/SseMultiOutputResultEntry.d.ts +2 -2
- package/dist/openapi/models/SseMultiOutputResultEntry.js +2 -2
- package/dist/openapi/models/SseOperationCompletedData.d.ts +2 -2
- package/dist/openapi/models/SseOperationCompletedData.js +2 -2
- package/dist/openapi/models/SseOperationCompletionResult.d.ts +42 -2
- package/dist/openapi/models/SseOperationCompletionResult.js +2 -2
- package/dist/openapi/models/SseOperationFailedData.d.ts +2 -2
- package/dist/openapi/models/SseOperationFailedData.js +2 -2
- package/dist/openapi/models/SseOperationProgressData.d.ts +2 -2
- package/dist/openapi/models/SseOperationProgressData.js +2 -2
- package/dist/openapi/models/SseSingleOutputCompletion.d.ts +6 -9
- package/dist/openapi/models/SseSingleOutputCompletion.js +2 -2
- package/dist/openapi/models/SseWorkflowTerminalData.d.ts +2 -2
- package/dist/openapi/models/SseWorkflowTerminalData.js +2 -2
- package/dist/openapi/models/TierRestrictionKind.d.ts +2 -2
- package/dist/openapi/models/TierRestrictionKind.js +2 -2
- package/dist/openapi/models/TierRestrictionResponse.d.ts +9 -6
- package/dist/openapi/models/TierRestrictionResponse.js +2 -2
- package/dist/openapi/models/UploadConstraintsApplied.d.ts +2 -2
- package/dist/openapi/models/UploadConstraintsApplied.js +2 -2
- package/dist/openapi/models/UploadDurationExceedsTierResponse.d.ts +9 -6
- package/dist/openapi/models/UploadDurationExceedsTierResponse.js +2 -2
- package/dist/openapi/models/UploadFile403Response.d.ts +2 -2
- package/dist/openapi/models/UploadFile403Response.js +2 -2
- package/dist/openapi/models/UploadFile422Response.d.ts +2 -2
- package/dist/openapi/models/UploadFile422Response.js +2 -2
- package/dist/openapi/models/UploadProbeMediaMetadata.d.ts +16 -5
- package/dist/openapi/models/UploadProbeMediaMetadata.js +2 -2
- package/dist/openapi/models/UploadProbeProcessingClass.d.ts +2 -2
- package/dist/openapi/models/UploadProbeProcessingClass.js +2 -2
- package/dist/openapi/models/UploadProbeResponse.d.ts +2 -2
- package/dist/openapi/models/UploadProbeResponse.js +2 -2
- package/dist/openapi/models/UploadProbeStatus.d.ts +2 -2
- package/dist/openapi/models/UploadProbeStatus.js +2 -2
- package/dist/openapi/models/UploadProbeSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/UploadProbeSuccessEnvelope.js +2 -2
- package/dist/openapi/models/UploadResponse.d.ts +2 -2
- package/dist/openapi/models/UploadResponse.js +2 -2
- package/dist/openapi/models/UploadSizeExceedsTierResponse.d.ts +9 -6
- package/dist/openapi/models/UploadSizeExceedsTierResponse.js +2 -2
- package/dist/openapi/models/UploadSource.d.ts +2 -2
- package/dist/openapi/models/UploadSource.js +2 -2
- package/dist/openapi/models/UploadSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/UploadSuccessEnvelope.js +2 -2
- package/dist/openapi/models/UploadThresholds.d.ts +2 -2
- package/dist/openapi/models/UploadThresholds.js +2 -2
- package/dist/openapi/models/UserTier.d.ts +2 -2
- package/dist/openapi/models/UserTier.js +2 -2
- package/dist/openapi/models/ValidationErrorEnvelope.d.ts +6 -3
- package/dist/openapi/models/ValidationErrorEnvelope.js +2 -2
- package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.d.ts +2 -2
- package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.js +2 -2
- package/dist/openapi/models/WarningType.d.ts +2 -2
- package/dist/openapi/models/WarningType.js +2 -2
- package/dist/openapi/models/WebhookOperationContext.d.ts +2 -2
- package/dist/openapi/models/WebhookOperationContext.js +2 -2
- package/dist/openapi/models/WebhookPayload.d.ts +2 -2
- package/dist/openapi/models/WebhookPayload.js +2 -2
- package/dist/openapi/models/WorkflowCancelBillingEffect.d.ts +2 -2
- package/dist/openapi/models/WorkflowCancelBillingEffect.js +2 -2
- package/dist/openapi/models/WorkflowCancelResponse.d.ts +2 -2
- package/dist/openapi/models/WorkflowCancelResponse.js +2 -2
- package/dist/openapi/models/WorkflowCancelSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/WorkflowCancelSuccessEnvelope.js +2 -2
- package/dist/openapi/models/WorkflowCreateRequest.d.ts +2 -2
- package/dist/openapi/models/WorkflowCreateRequest.js +2 -2
- package/dist/openapi/models/WorkflowCreateResponse.d.ts +2 -2
- package/dist/openapi/models/WorkflowCreateResponse.js +2 -2
- package/dist/openapi/models/WorkflowCreateSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/WorkflowCreateSuccessEnvelope.js +2 -2
- package/dist/openapi/models/WorkflowDownloadResponse.d.ts +2 -2
- package/dist/openapi/models/WorkflowDownloadResponse.js +2 -2
- package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.js +2 -2
- package/dist/openapi/models/WorkflowEdge.d.ts +2 -2
- package/dist/openapi/models/WorkflowEdge.js +2 -2
- package/dist/openapi/models/WorkflowExpiredResponse.d.ts +9 -6
- package/dist/openapi/models/WorkflowExpiredResponse.js +2 -2
- package/dist/openapi/models/WorkflowPauseRequiredAction.d.ts +2 -2
- package/dist/openapi/models/WorkflowPauseRequiredAction.js +2 -2
- package/dist/openapi/models/WorkflowPausedDetail.d.ts +2 -2
- package/dist/openapi/models/WorkflowPausedDetail.js +2 -2
- package/dist/openapi/models/WorkflowPausedDetailLinks.d.ts +2 -2
- package/dist/openapi/models/WorkflowPausedDetailLinks.js +2 -2
- package/dist/openapi/models/WorkflowProcessing.d.ts +2 -2
- package/dist/openapi/models/WorkflowProcessing.js +2 -2
- package/dist/openapi/models/WorkflowResumeResponse.d.ts +2 -2
- package/dist/openapi/models/WorkflowResumeResponse.js +2 -2
- package/dist/openapi/models/WorkflowResumeSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/WorkflowResumeSuccessEnvelope.js +2 -2
- package/dist/openapi/models/WorkflowSource.d.ts +2 -2
- package/dist/openapi/models/WorkflowSource.js +2 -2
- package/dist/openapi/models/WorkflowStatus.d.ts +2 -2
- package/dist/openapi/models/WorkflowStatus.js +2 -2
- package/dist/openapi/models/WorkflowStatusResponse.d.ts +2 -2
- package/dist/openapi/models/WorkflowStatusResponse.js +2 -2
- package/dist/openapi/models/WorkflowStatusSuccessEnvelope.d.ts +2 -2
- package/dist/openapi/models/WorkflowStatusSuccessEnvelope.js +2 -2
- package/dist/openapi/models/WorkflowWarning.d.ts +2 -2
- package/dist/openapi/models/WorkflowWarning.js +2 -2
- package/dist/openapi/models/WorkflowWarningSeverity.d.ts +2 -2
- package/dist/openapi/models/WorkflowWarningSeverity.js +2 -2
- package/dist/openapi/models/index.d.ts +3 -0
- package/dist/openapi/models/index.js +3 -0
- package/dist/openapi/runtime.d.ts +2 -2
- package/dist/openapi/runtime.js +2 -2
- package/openapi/api.yaml +429 -49
- package/operations/schemas/compress.yaml +0 -3
- package/operations/schemas/convert.yaml +14 -1
- package/operations/schemas/merge.yaml +14 -10
- package/package.json +1 -1
package/asyncapi/events.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
asyncapi: 3.0.0
|
|
2
2
|
info:
|
|
3
3
|
title: GISL Compression Events
|
|
4
|
-
version: 3.
|
|
4
|
+
version: 3.3.0
|
|
5
5
|
description: |
|
|
6
6
|
Asynchronous event contracts for the GISL (Give It Smaller) compression service.
|
|
7
7
|
|
|
@@ -1112,6 +1112,79 @@ channels:
|
|
|
1112
1112
|
region:
|
|
1113
1113
|
description: AWS region abbreviation (euw1, use1, etc.)
|
|
1114
1114
|
|
|
1115
|
+
# ============================================
|
|
1116
|
+
# LONG-FORM CLAIM-CHECK QUEUES (direct-to-SQS, Fargate-processed)
|
|
1117
|
+
# ============================================
|
|
1118
|
+
# Distinct delivery mechanism from the SNS-fanout jobs/ops families:
|
|
1119
|
+
# the API publishes a LongFormJobMessage claim-check DIRECTLY to these
|
|
1120
|
+
# per-op-class SQS queues (no SNS topic, no filter routing). A
|
|
1121
|
+
# terraform-owned launcher (EventBridge Pipe, filter=none) consumes
|
|
1122
|
+
# and forks a Fargate task. Two classes are live (compress, merge);
|
|
1123
|
+
# split-video-longform (queue provisioned, publisher deferred per
|
|
1124
|
+
# rcwvUKhI) and audio-overlay-longform (reserve-name-only, no queue)
|
|
1125
|
+
# are NOT modeled as channels — they carry no traffic yet.
|
|
1126
|
+
|
|
1127
|
+
longformCompressVideo:
|
|
1128
|
+
address: gisl-{env}-{region}-ops-compress-video-longform
|
|
1129
|
+
description: |
|
|
1130
|
+
SQS queue for long-form video compression jobs (`compress.video.long_form`,
|
|
1131
|
+
`availability: beta`). The API publishes a `LongFormJobMessage` claim-check
|
|
1132
|
+
here directly (NOT via SNS); a terraform-owned launcher reads the spec from
|
|
1133
|
+
S3 (`pointer`) and runs a Fargate task. `max_receive_count = 2` (ADR-0007).
|
|
1134
|
+
|
|
1135
|
+
On this queue the publisher always sets `operation_type: compress`. The
|
|
1136
|
+
shared `LongFormJobMessage` enum permits `{compress, merge}` (mirroring the
|
|
1137
|
+
shared `JobRequestMessage` across the per-media `jobs-*` queues); per-queue
|
|
1138
|
+
`operation_type` is a publisher invariant documented here, not a separate
|
|
1139
|
+
message schema.
|
|
1140
|
+
parameters:
|
|
1141
|
+
env:
|
|
1142
|
+
description: Environment (local, stg, prod)
|
|
1143
|
+
region:
|
|
1144
|
+
description: AWS region abbreviation (euw1, use1, etc.)
|
|
1145
|
+
messages:
|
|
1146
|
+
longFormJob:
|
|
1147
|
+
$ref: '#/components/messages/LongFormJobMessage'
|
|
1148
|
+
|
|
1149
|
+
longformCompressVideoDlq:
|
|
1150
|
+
address: gisl-{env}-{region}-ops-compress-video-longform-dlq
|
|
1151
|
+
description: DLQ for failed long-form video compression jobs. Messages land here after 2 failed processing attempts (ADR-0007).
|
|
1152
|
+
parameters:
|
|
1153
|
+
env:
|
|
1154
|
+
description: Environment (local, stg, prod)
|
|
1155
|
+
region:
|
|
1156
|
+
description: AWS region abbreviation (euw1, use1, etc.)
|
|
1157
|
+
|
|
1158
|
+
longformMergeVideoReencode:
|
|
1159
|
+
address: gisl-{env}-{region}-ops-merge-video-longform-reencode
|
|
1160
|
+
description: |
|
|
1161
|
+
SQS queue for long-form merge re-encode jobs (`merge.video.long_form_re_encode`,
|
|
1162
|
+
`availability: beta`). The API publishes a `LongFormJobMessage` claim-check
|
|
1163
|
+
here directly (NOT via SNS); a terraform-owned launcher reads the spec from
|
|
1164
|
+
S3 (`pointer`) and runs a Fargate task. `max_receive_count = 2` (ADR-0007).
|
|
1165
|
+
|
|
1166
|
+
On this queue the publisher always sets `operation_type: merge` (shared
|
|
1167
|
+
`LongFormJobMessage` enum permits `{compress, merge}`; per-queue
|
|
1168
|
+
`operation_type` is a publisher invariant documented here, not a separate
|
|
1169
|
+
schema).
|
|
1170
|
+
parameters:
|
|
1171
|
+
env:
|
|
1172
|
+
description: Environment (local, stg, prod)
|
|
1173
|
+
region:
|
|
1174
|
+
description: AWS region abbreviation (euw1, use1, etc.)
|
|
1175
|
+
messages:
|
|
1176
|
+
longFormJob:
|
|
1177
|
+
$ref: '#/components/messages/LongFormJobMessage'
|
|
1178
|
+
|
|
1179
|
+
longformMergeVideoReencodeDlq:
|
|
1180
|
+
address: gisl-{env}-{region}-ops-merge-video-longform-reencode-dlq
|
|
1181
|
+
description: DLQ for failed long-form merge re-encode jobs. Messages land here after 2 failed processing attempts (ADR-0007).
|
|
1182
|
+
parameters:
|
|
1183
|
+
env:
|
|
1184
|
+
description: Environment (local, stg, prod)
|
|
1185
|
+
region:
|
|
1186
|
+
description: AWS region abbreviation (euw1, use1, etc.)
|
|
1187
|
+
|
|
1115
1188
|
operations:
|
|
1116
1189
|
# ============================================
|
|
1117
1190
|
# PUBLISH OPERATIONS (API -> SNS)
|
|
@@ -1606,6 +1679,64 @@ operations:
|
|
|
1606
1679
|
messages:
|
|
1607
1680
|
- $ref: '#/channels/uploadProbeCompletionsQueue/messages/uploadProbeCompletion'
|
|
1608
1681
|
|
|
1682
|
+
# ============================================
|
|
1683
|
+
# LONG-FORM CLAIM-CHECK PRODUCERS (API -> SQS, direct)
|
|
1684
|
+
# ============================================
|
|
1685
|
+
|
|
1686
|
+
publishLongFormCompressVideo:
|
|
1687
|
+
action: send
|
|
1688
|
+
channel:
|
|
1689
|
+
$ref: '#/channels/longformCompressVideo'
|
|
1690
|
+
summary: Publish a long-form video compression claim-check.
|
|
1691
|
+
description: |
|
|
1692
|
+
The API (`SqsLongFormOperationPublisherAdapter`) writes the full job
|
|
1693
|
+
spec to S3 and publishes a `LongFormJobMessage` claim-check **directly**
|
|
1694
|
+
to this SQS queue (NOT via SNS — no message attributes). `operation_type`
|
|
1695
|
+
is `compress`, `processing_class` is `long_form`.
|
|
1696
|
+
messages:
|
|
1697
|
+
- $ref: '#/channels/longformCompressVideo/messages/longFormJob'
|
|
1698
|
+
|
|
1699
|
+
publishLongFormMergeVideoReencode:
|
|
1700
|
+
action: send
|
|
1701
|
+
channel:
|
|
1702
|
+
$ref: '#/channels/longformMergeVideoReencode'
|
|
1703
|
+
summary: Publish a long-form merge re-encode claim-check.
|
|
1704
|
+
description: |
|
|
1705
|
+
As `publishLongFormCompressVideo`, for `operation_type = merge`
|
|
1706
|
+
(`merge.video.long_form_re_encode`). Direct-to-SQS claim-check; no SNS.
|
|
1707
|
+
messages:
|
|
1708
|
+
- $ref: '#/channels/longformMergeVideoReencode/messages/longFormJob'
|
|
1709
|
+
|
|
1710
|
+
# ============================================
|
|
1711
|
+
# LONG-FORM CLAIM-CHECK CONSUMERS (launcher -> Fargate)
|
|
1712
|
+
# ============================================
|
|
1713
|
+
|
|
1714
|
+
consumeLongFormCompressVideo:
|
|
1715
|
+
action: receive
|
|
1716
|
+
channel:
|
|
1717
|
+
$ref: '#/channels/longformCompressVideo'
|
|
1718
|
+
summary: Consume a long-form video compression claim-check.
|
|
1719
|
+
description: |
|
|
1720
|
+
A terraform-owned launcher (EventBridge Pipe, filter=none -> launcher
|
|
1721
|
+
Lambda) reads the `LongFormJobMessage` from this queue, resolves the
|
|
1722
|
+
full job spec from S3 via `pointer`, and runs a Fargate task. The
|
|
1723
|
+
launcher forks on `operation_type` (`compress`) + `processing_class`
|
|
1724
|
+
(`long_form`). Failures redrive to the DLQ after `max_receive_count = 2`.
|
|
1725
|
+
messages:
|
|
1726
|
+
- $ref: '#/channels/longformCompressVideo/messages/longFormJob'
|
|
1727
|
+
|
|
1728
|
+
consumeLongFormMergeVideoReencode:
|
|
1729
|
+
action: receive
|
|
1730
|
+
channel:
|
|
1731
|
+
$ref: '#/channels/longformMergeVideoReencode'
|
|
1732
|
+
summary: Consume a long-form merge re-encode claim-check.
|
|
1733
|
+
description: |
|
|
1734
|
+
As `consumeLongFormCompressVideo`, for `operation_type = merge`
|
|
1735
|
+
(`merge.video.long_form_re_encode`). The launcher resolves the spec
|
|
1736
|
+
from S3 via `pointer` and runs the merge-re-encode Fargate task.
|
|
1737
|
+
messages:
|
|
1738
|
+
- $ref: '#/channels/longformMergeVideoReencode/messages/longFormJob'
|
|
1739
|
+
|
|
1609
1740
|
components:
|
|
1610
1741
|
messages:
|
|
1611
1742
|
# ============================================
|
|
@@ -1912,6 +2043,48 @@ components:
|
|
|
1912
2043
|
options:
|
|
1913
2044
|
format: "zip"
|
|
1914
2045
|
|
|
2046
|
+
# ============================================
|
|
2047
|
+
# LONG-FORM CLAIM-CHECK JOB MESSAGE (direct-to-SQS, no SNS)
|
|
2048
|
+
# ============================================
|
|
2049
|
+
|
|
2050
|
+
LongFormJobMessage:
|
|
2051
|
+
name: LongFormJob
|
|
2052
|
+
title: Long-Form Claim-Check Job Message
|
|
2053
|
+
summary: Claim-check job message for long-form (Fargate) operations
|
|
2054
|
+
description: |
|
|
2055
|
+
Published by the API **directly to a per-op-class long-form SQS queue**
|
|
2056
|
+
(not via SNS) and consumed by a terraform-owned launcher (EventBridge
|
|
2057
|
+
Pipe, filter=none -> launcher Lambda -> ECS RunTask). The launcher reads
|
|
2058
|
+
the message body, resolves the full job spec from S3 via `pointer`, and
|
|
2059
|
+
forks the Fargate task on `operation_type` + `processing_class`.
|
|
2060
|
+
|
|
2061
|
+
**No SNS message attributes / headers** — long-form does not flow
|
|
2062
|
+
through an SNS topic, so unlike `JobRequestMessage` /
|
|
2063
|
+
`OperationRequestMessage` this message carries no `headers` block.
|
|
2064
|
+
|
|
2065
|
+
See the `LongFormJobMessage` schema for the claim-check field set and
|
|
2066
|
+
the `processing_class` ratification rationale.
|
|
2067
|
+
contentType: application/json
|
|
2068
|
+
payload:
|
|
2069
|
+
$ref: '#/components/schemas/LongFormJobMessage'
|
|
2070
|
+
examples:
|
|
2071
|
+
- name: Long-form video compression
|
|
2072
|
+
summary: compress.video.long_form claim-check
|
|
2073
|
+
payload:
|
|
2074
|
+
pointer: "job-specs/018f9c42-5d6b-7481-b3df-9fd0a0a5e112.json"
|
|
2075
|
+
job_id: "018f9c42-5d6b-7481-b3df-9fd0a0a5e112"
|
|
2076
|
+
operation_id: "018f9c42-5d6b-7481-b3df-9fd0a0a5e200"
|
|
2077
|
+
operation_type: "compress"
|
|
2078
|
+
processing_class: "long_form"
|
|
2079
|
+
- name: Long-form merge re-encode
|
|
2080
|
+
summary: merge.video.long_form_re_encode claim-check
|
|
2081
|
+
payload:
|
|
2082
|
+
pointer: "job-specs/018f9c42-5d6b-7481-b3df-9fd0a0a5e113.json"
|
|
2083
|
+
job_id: "018f9c42-5d6b-7481-b3df-9fd0a0a5e113"
|
|
2084
|
+
operation_id: "018f9c42-5d6b-7481-b3df-9fd0a0a5e201"
|
|
2085
|
+
operation_type: "merge"
|
|
2086
|
+
processing_class: "long_form"
|
|
2087
|
+
|
|
1915
2088
|
# ============================================
|
|
1916
2089
|
# OPERATION PROGRESS MESSAGE
|
|
1917
2090
|
# ============================================
|
|
@@ -2795,6 +2968,93 @@ components:
|
|
|
2795
2968
|
Not used in V1 — all outputs go to GISL-managed S3 buckets.
|
|
2796
2969
|
additionalProperties: true
|
|
2797
2970
|
|
|
2971
|
+
LongFormJobMessage:
|
|
2972
|
+
type: object
|
|
2973
|
+
description: |
|
|
2974
|
+
Claim-check job message for long-form (Fargate-processed) operations.
|
|
2975
|
+
Emitted by the API **directly to the per-op-class long-form SQS queues**
|
|
2976
|
+
(NOT via SNS) — see the `longformCompressVideo` / `longformMergeVideoReencode`
|
|
2977
|
+
channels. The full job spec is written to S3 and this message carries only
|
|
2978
|
+
a `pointer` (the claim check) plus routing/identity fields; the consumer
|
|
2979
|
+
(a terraform-owned launcher Lambda fronting a Fargate worker, invoked via
|
|
2980
|
+
an EventBridge Pipe with no filter) reads the spec from S3 and forks the
|
|
2981
|
+
task on `operation_type` + `processing_class`.
|
|
2982
|
+
|
|
2983
|
+
Distinct from `OperationRequest` (the SNS-routed short-form payload):
|
|
2984
|
+
long-form has its own dedicated SQS queues, carries no SNS message
|
|
2985
|
+
attributes/headers, and uses a claim-check body. `processing_class` is
|
|
2986
|
+
ratified here — and ONLY here — as the logical long-form discriminator
|
|
2987
|
+
(per [ADR-0014](../docs/decisions/0014-split-operation.md) §D10 and
|
|
2988
|
+
`schemas/FORMAT.md` §F8). The physical worker / `execution_pool` /
|
|
2989
|
+
backend-dotted form (e.g. `compress.video.long_form`) is deliberately
|
|
2990
|
+
NOT on the wire — the launcher mints it internally.
|
|
2991
|
+
|
|
2992
|
+
**Live `operation_type` subset: `compress`, `merge`** — the two
|
|
2993
|
+
long-form classes flipped to `availability: beta` (CON-1). `split`
|
|
2994
|
+
long-form (queue provisioned, publisher deferred —
|
|
2995
|
+
[`rcwvUKhI`](https://trello.com/c/rcwvUKhI)) and `audio_overlay`
|
|
2996
|
+
long-form (reserve-name-only, no queue) are NOT yet produced and are
|
|
2997
|
+
therefore absent from this enum; they get added when their publishers
|
|
2998
|
+
ship.
|
|
2999
|
+
|
|
3000
|
+
**Scope: the API producer's first-publish.** This schema models the
|
|
3001
|
+
message the API publishes to the long-form queues — the 5 fields above.
|
|
3002
|
+
It is intentionally an **open object** (no `additionalProperties: false`):
|
|
3003
|
+
these queues may also carry downstream-produced messages (e.g. a
|
|
3004
|
+
`FargateRunner` retry republish of chained long-form ops) whose body
|
|
3005
|
+
shape is owned by the worker/lambdas contract, NOT this schema. Those
|
|
3006
|
+
are out of scope here and are not constrained by `LongFormJobMessage`;
|
|
3007
|
+
consumers validating against this schema MUST tolerate additional or
|
|
3008
|
+
differently-shaped redriven messages. The producer contract this schema
|
|
3009
|
+
pins is the **required** set.
|
|
3010
|
+
required:
|
|
3011
|
+
- pointer
|
|
3012
|
+
- job_id
|
|
3013
|
+
- operation_id
|
|
3014
|
+
- operation_type
|
|
3015
|
+
- processing_class
|
|
3016
|
+
properties:
|
|
3017
|
+
pointer:
|
|
3018
|
+
type: string
|
|
3019
|
+
pattern: '^job-specs/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\.json$'
|
|
3020
|
+
description: |
|
|
3021
|
+
Claim-check pointer to the full job spec: an S3 object **key**
|
|
3022
|
+
(NOT a full `s3://` URI, NOT a `{bucket,key}` object), resolved
|
|
3023
|
+
relative to the **input bucket** — the bucket is not encoded in
|
|
3024
|
+
the pointer; the consumer resolves it from its own input-bucket
|
|
3025
|
+
config. Const prefix `job-specs/`; the object is `<jobId>.json`
|
|
3026
|
+
(UUID v7).
|
|
3027
|
+
example: "job-specs/018f9c42-5d6b-7481-b3df-9fd0a0a5e112.json"
|
|
3028
|
+
job_id:
|
|
3029
|
+
type: string
|
|
3030
|
+
format: uuid
|
|
3031
|
+
description: Parent job identifier (UUID v7).
|
|
3032
|
+
example: "018f9c42-5d6b-7481-b3df-9fd0a0a5e112"
|
|
3033
|
+
operation_id:
|
|
3034
|
+
type: string
|
|
3035
|
+
format: uuid
|
|
3036
|
+
description: Unique operation identifier (UUID v7).
|
|
3037
|
+
example: "018f9c42-5d6b-7481-b3df-9fd0a0a5e200"
|
|
3038
|
+
operation_type:
|
|
3039
|
+
type: string
|
|
3040
|
+
enum:
|
|
3041
|
+
- compress
|
|
3042
|
+
- merge
|
|
3043
|
+
description: |
|
|
3044
|
+
Coarse operation verb for the long-form job. Deliberately a
|
|
3045
|
+
call-site subset of `OperationType` — only the long-form classes
|
|
3046
|
+
the API actually publishes today (`compress`, `merge`). NOT the
|
|
3047
|
+
full `OperationType` enum (which would over-promise the wire).
|
|
3048
|
+
processing_class:
|
|
3049
|
+
type: string
|
|
3050
|
+
const: long_form
|
|
3051
|
+
description: |
|
|
3052
|
+
Logical processing class — always the literal `long_form` on this
|
|
3053
|
+
wire (never `short_form` / `blocked`; those exist only on the
|
|
3054
|
+
upload-probe response and HTTP plan surfaces). The launcher forks
|
|
3055
|
+
on this field; do not confuse it with the backend worker identity,
|
|
3056
|
+
which stays off the wire per `schemas/FORMAT.md` §F8.
|
|
3057
|
+
|
|
2798
3058
|
SourceEntry:
|
|
2799
3059
|
type: object
|
|
2800
3060
|
description: |
|
|
@@ -3567,12 +3827,22 @@ components:
|
|
|
3567
3827
|
description: Container-reported duration (audio + video).
|
|
3568
3828
|
width:
|
|
3569
3829
|
type: integer
|
|
3830
|
+
format: int64
|
|
3570
3831
|
minimum: 1
|
|
3571
|
-
description:
|
|
3832
|
+
description: |
|
|
3833
|
+
Pixel width (image + video; best-effort document). Declared
|
|
3834
|
+
`int64` so Rust SDK generators emit `i64` instead of the
|
|
3835
|
+
default `i32`; `i32` is fine for everything ffmpeg/libcaesium
|
|
3836
|
+
handles today but the format hint keeps the door open for
|
|
3837
|
+
scientific / RAW imagery without future SDK churn (per
|
|
3838
|
+
ticket [`0sTmbUsc`](https://trello.com/c/0sTmbUsc)).
|
|
3572
3839
|
height:
|
|
3573
3840
|
type: integer
|
|
3841
|
+
format: int64
|
|
3574
3842
|
minimum: 1
|
|
3575
|
-
description:
|
|
3843
|
+
description: |
|
|
3844
|
+
Pixel height (image + video; best-effort document). See
|
|
3845
|
+
`width` for the `format: int64` rationale.
|
|
3576
3846
|
codec:
|
|
3577
3847
|
type: string
|
|
3578
3848
|
description: |
|
|
@@ -3607,12 +3877,16 @@ components:
|
|
|
3607
3877
|
`29.97`, `23.976`).
|
|
3608
3878
|
bitrate_bps:
|
|
3609
3879
|
type: integer
|
|
3880
|
+
format: int64
|
|
3610
3881
|
minimum: 0
|
|
3611
3882
|
description: |
|
|
3612
3883
|
Overall stream bitrate, **bits per second**. Units in
|
|
3613
3884
|
the field name, mirroring `duration_seconds`, so SDKs
|
|
3614
3885
|
avoid the kbps-vs-bps guessing trap. Container-reported
|
|
3615
|
-
for video + audio.
|
|
3886
|
+
for video + audio. Declared `int64` so Rust SDK
|
|
3887
|
+
generators emit `i64` instead of `i32`; `i32` caps at
|
|
3888
|
+
~2.1 Gbps which is tight for future 4K/8K/RAW workloads
|
|
3889
|
+
(per ticket [`0sTmbUsc`](https://trello.com/c/0sTmbUsc)).
|
|
3616
3890
|
audio_layout:
|
|
3617
3891
|
type: string
|
|
3618
3892
|
description: |
|
|
@@ -1,5 +1,182 @@
|
|
|
1
1
|
{
|
|
2
|
-
"capabilities_version":
|
|
2
|
+
"capabilities_version": 53,
|
|
3
|
+
"endpoints": {
|
|
4
|
+
"GET /api/operations/schema": {
|
|
5
|
+
"auth": "optional",
|
|
6
|
+
"availability": "stable",
|
|
7
|
+
"identity_scoped": false,
|
|
8
|
+
"operation_id": "getOperationsSchema",
|
|
9
|
+
"required_tier": null
|
|
10
|
+
},
|
|
11
|
+
"GET /api/uploads/multipart/{uploadId}/status": {
|
|
12
|
+
"auth": "required",
|
|
13
|
+
"availability": "stable",
|
|
14
|
+
"identity_scoped": true,
|
|
15
|
+
"operation_id": "multipartStatus",
|
|
16
|
+
"required_tier": null
|
|
17
|
+
},
|
|
18
|
+
"GET /api/uploads/{id}/metadata": {
|
|
19
|
+
"auth": "optional",
|
|
20
|
+
"availability": "stable",
|
|
21
|
+
"identity_scoped": true,
|
|
22
|
+
"operation_id": "getUploadMetadata",
|
|
23
|
+
"required_tier": null
|
|
24
|
+
},
|
|
25
|
+
"GET /api/v2/credits/balance": {
|
|
26
|
+
"auth": "required",
|
|
27
|
+
"availability": "stable",
|
|
28
|
+
"identity_scoped": true,
|
|
29
|
+
"operation_id": "getCreditsBalance",
|
|
30
|
+
"required_tier": null
|
|
31
|
+
},
|
|
32
|
+
"GET /api/v2/credits/usage": {
|
|
33
|
+
"auth": "required",
|
|
34
|
+
"availability": "stable",
|
|
35
|
+
"identity_scoped": true,
|
|
36
|
+
"operation_id": "getCreditsUsage",
|
|
37
|
+
"required_tier": null
|
|
38
|
+
},
|
|
39
|
+
"GET /api/workflows/{id}/downloads": {
|
|
40
|
+
"auth": "optional",
|
|
41
|
+
"availability": "stable",
|
|
42
|
+
"identity_scoped": true,
|
|
43
|
+
"operation_id": "getWorkflowDownloads",
|
|
44
|
+
"required_tier": null
|
|
45
|
+
},
|
|
46
|
+
"GET /api/workflows/{id}/events": {
|
|
47
|
+
"auth": "optional",
|
|
48
|
+
"availability": "stable",
|
|
49
|
+
"identity_scoped": true,
|
|
50
|
+
"operation_id": "streamWorkflowEvents",
|
|
51
|
+
"required_tier": null
|
|
52
|
+
},
|
|
53
|
+
"GET /api/workflows/{id}/status": {
|
|
54
|
+
"auth": "optional",
|
|
55
|
+
"availability": "stable",
|
|
56
|
+
"identity_scoped": true,
|
|
57
|
+
"operation_id": "getWorkflowStatus",
|
|
58
|
+
"required_tier": null
|
|
59
|
+
},
|
|
60
|
+
"GET /healthz": {
|
|
61
|
+
"auth": "anonymous",
|
|
62
|
+
"availability": "stable",
|
|
63
|
+
"identity_scoped": false,
|
|
64
|
+
"operation_id": "liveness",
|
|
65
|
+
"required_tier": null
|
|
66
|
+
},
|
|
67
|
+
"GET /readyz": {
|
|
68
|
+
"auth": "anonymous",
|
|
69
|
+
"availability": "stable",
|
|
70
|
+
"identity_scoped": false,
|
|
71
|
+
"operation_id": "readiness",
|
|
72
|
+
"required_tier": null
|
|
73
|
+
},
|
|
74
|
+
"POST /api/audio-watermark/decode": {
|
|
75
|
+
"auth": "required",
|
|
76
|
+
"availability": "stable",
|
|
77
|
+
"identity_scoped": false,
|
|
78
|
+
"operation_id": "decodeAudioWatermark",
|
|
79
|
+
"required_tier": null
|
|
80
|
+
},
|
|
81
|
+
"POST /api/auth/login": {
|
|
82
|
+
"auth": "anonymous",
|
|
83
|
+
"availability": "stable",
|
|
84
|
+
"identity_scoped": false,
|
|
85
|
+
"operation_id": "loginUser",
|
|
86
|
+
"required_tier": null
|
|
87
|
+
},
|
|
88
|
+
"POST /api/auth/logout": {
|
|
89
|
+
"auth": "required",
|
|
90
|
+
"availability": "stable",
|
|
91
|
+
"identity_scoped": true,
|
|
92
|
+
"operation_id": "logoutUser",
|
|
93
|
+
"required_tier": null
|
|
94
|
+
},
|
|
95
|
+
"POST /api/contact": {
|
|
96
|
+
"auth": "anonymous",
|
|
97
|
+
"availability": "stable",
|
|
98
|
+
"identity_scoped": false,
|
|
99
|
+
"operation_id": "submitContact",
|
|
100
|
+
"required_tier": null
|
|
101
|
+
},
|
|
102
|
+
"POST /api/external-imports": {
|
|
103
|
+
"auth": "required",
|
|
104
|
+
"availability": "stable",
|
|
105
|
+
"identity_scoped": false,
|
|
106
|
+
"operation_id": "createExternalImport",
|
|
107
|
+
"required_tier": null
|
|
108
|
+
},
|
|
109
|
+
"POST /api/operations/{id}/retry": {
|
|
110
|
+
"auth": "optional",
|
|
111
|
+
"availability": "stable",
|
|
112
|
+
"identity_scoped": true,
|
|
113
|
+
"operation_id": "retryOperation",
|
|
114
|
+
"required_tier": null
|
|
115
|
+
},
|
|
116
|
+
"POST /api/uploads": {
|
|
117
|
+
"auth": "optional",
|
|
118
|
+
"availability": "stable",
|
|
119
|
+
"identity_scoped": false,
|
|
120
|
+
"operation_id": "uploadFile",
|
|
121
|
+
"required_tier": null
|
|
122
|
+
},
|
|
123
|
+
"POST /api/uploads/multipart/complete": {
|
|
124
|
+
"auth": "optional",
|
|
125
|
+
"availability": "stable",
|
|
126
|
+
"identity_scoped": true,
|
|
127
|
+
"operation_id": "multipartComplete",
|
|
128
|
+
"required_tier": null
|
|
129
|
+
},
|
|
130
|
+
"POST /api/uploads/multipart/initiate": {
|
|
131
|
+
"auth": "optional",
|
|
132
|
+
"availability": "stable",
|
|
133
|
+
"identity_scoped": false,
|
|
134
|
+
"operation_id": "multipartInitiate",
|
|
135
|
+
"required_tier": null
|
|
136
|
+
},
|
|
137
|
+
"POST /api/uploads/multipart/{uploadId}/keepalive": {
|
|
138
|
+
"auth": "required",
|
|
139
|
+
"availability": "stable",
|
|
140
|
+
"identity_scoped": true,
|
|
141
|
+
"operation_id": "multipartKeepalive",
|
|
142
|
+
"required_tier": null
|
|
143
|
+
},
|
|
144
|
+
"POST /api/uploads/multipart/{uploadId}/presign": {
|
|
145
|
+
"auth": "required",
|
|
146
|
+
"availability": "stable",
|
|
147
|
+
"identity_scoped": true,
|
|
148
|
+
"operation_id": "multipartPresign",
|
|
149
|
+
"required_tier": null
|
|
150
|
+
},
|
|
151
|
+
"POST /api/uploads/{id}/probe": {
|
|
152
|
+
"auth": "required",
|
|
153
|
+
"availability": "stable",
|
|
154
|
+
"identity_scoped": true,
|
|
155
|
+
"operation_id": "probeUpload",
|
|
156
|
+
"required_tier": null
|
|
157
|
+
},
|
|
158
|
+
"POST /api/workflows": {
|
|
159
|
+
"auth": "optional",
|
|
160
|
+
"availability": "stable",
|
|
161
|
+
"identity_scoped": true,
|
|
162
|
+
"operation_id": "createWorkflow",
|
|
163
|
+
"required_tier": null
|
|
164
|
+
},
|
|
165
|
+
"POST /api/workflows/{id}/cancel": {
|
|
166
|
+
"auth": "required",
|
|
167
|
+
"availability": "stable",
|
|
168
|
+
"identity_scoped": true,
|
|
169
|
+
"operation_id": "cancelWorkflow",
|
|
170
|
+
"required_tier": null
|
|
171
|
+
},
|
|
172
|
+
"POST /api/workflows/{id}/resume": {
|
|
173
|
+
"auth": "required",
|
|
174
|
+
"availability": "stable",
|
|
175
|
+
"identity_scoped": true,
|
|
176
|
+
"operation_id": "resumeWorkflow",
|
|
177
|
+
"required_tier": null
|
|
178
|
+
}
|
|
179
|
+
},
|
|
3
180
|
"environment": "baseline",
|
|
4
181
|
"generated_at": null,
|
|
5
182
|
"operations": {
|
|
@@ -781,10 +958,7 @@
|
|
|
781
958
|
"image/webp",
|
|
782
959
|
"image/svg+xml",
|
|
783
960
|
"image/tiff",
|
|
784
|
-
"image/
|
|
785
|
-
"image/vnd.microsoft.icon",
|
|
786
|
-
"image/avif",
|
|
787
|
-
"image/heic"
|
|
961
|
+
"image/avif"
|
|
788
962
|
],
|
|
789
963
|
"options": {
|
|
790
964
|
"auto_orient": {
|
|
@@ -1118,7 +1292,7 @@
|
|
|
1118
1292
|
},
|
|
1119
1293
|
"pages": {
|
|
1120
1294
|
"default": "1",
|
|
1121
|
-
"description": "Page selection (e.g. '1-5,8'). Each page produces a
|
|
1295
|
+
"description": "Page selection (e.g. '1-5,8'). Each resolved page produces a\nseparate output file. **Maximum 200 resolved entries per\nrequest** \u2014 aligns with the `OperationResult.outputs[]`\n`maxItems: 200` cap per ADR-0009 \u00a7D5\n(`docs/decisions/0009-multi-output-result-envelope.md`).\nExpressions resolving to more than 200 entries (e.g.\n`'1-201'`, `'1-100,102-205'`) are out of contract.\nDuplicate or overlapping entries (e.g. `'1,1'`,\n`'1-100,50-150'`) are counted toward the cap as parsed;\ndeduplication, if any, is a runtime concern and is NOT part\nof this contract. Enforcement at the API edge validator and\nthe Lambda runtime is tracked under WgCqnMRa follow-ups\n(cross-repo: API + Lambdas `bFlEXizR`).\n",
|
|
1122
1296
|
"type": "string"
|
|
1123
1297
|
}
|
|
1124
1298
|
}
|
|
@@ -1780,7 +1954,14 @@
|
|
|
1780
1954
|
"always"
|
|
1781
1955
|
]
|
|
1782
1956
|
},
|
|
1783
|
-
"description": "CRF (quality-targeted) vs target_size (two-pass to fixed file size).\n`target_size` is currently `codec=h264` only \u2014 libx265 / libvpx-vp9 / libsvtav1 each\nrequire a different two-pass invocation and are tracked as separate per-codec\nLambda follow-ups. The
|
|
1957
|
+
"description": "CRF (quality-targeted) vs target_size (two-pass to fixed file size).\n`target_size` is currently `codec=h264` only \u2014 libx265 / libvpx-vp9 / libsvtav1 each\nrequire a different two-pass invocation and are tracked as separate per-codec\nLambda follow-ups. The `per_value_depends_on` block above gates\n`encoding_mode=target_size` itself on `codec \u2208 [h264]`, so a request with\n`encoding_mode=target_size + codec \u2208 {h265, vp9, av1}` is rejected as\n`invalid_options` regardless of whether `target_size_bytes` is supplied \u2014\nclosing the gap left by the previous option-level `depends_on` (which only\ntriggered when `target_size_bytes` was present in the payload). Per ticket\n[`bsV3FWM5`](https://trello.com/c/bsV3FWM5).\n",
|
|
1958
|
+
"per_value_depends_on": {
|
|
1959
|
+
"target_size": {
|
|
1960
|
+
"codec": [
|
|
1961
|
+
"h264"
|
|
1962
|
+
]
|
|
1963
|
+
}
|
|
1964
|
+
},
|
|
1784
1965
|
"type": "enum",
|
|
1785
1966
|
"values": [
|
|
1786
1967
|
"crf",
|
|
@@ -1845,16 +2026,13 @@
|
|
|
1845
2026
|
},
|
|
1846
2027
|
"target_size_bytes": {
|
|
1847
2028
|
"depends_on": {
|
|
1848
|
-
"codec": [
|
|
1849
|
-
"h264"
|
|
1850
|
-
],
|
|
1851
2029
|
"encoding_mode": "target_size",
|
|
1852
2030
|
"re_encode_mode": [
|
|
1853
2031
|
"auto",
|
|
1854
2032
|
"always"
|
|
1855
2033
|
]
|
|
1856
2034
|
},
|
|
1857
|
-
"description": "Two-pass target file size in bytes (minimum 1 MiB). Required when\n`encoding_mode=target_size`. h264-only
|
|
2035
|
+
"description": "Two-pass target file size in bytes (minimum 1 MiB). Required when\n`encoding_mode=target_size`. h264-only \u2014 the codec gate now lives on\n`encoding_mode.per_value_depends_on.target_size.codec` (per ticket\n[`bsV3FWM5`](https://trello.com/c/bsV3FWM5)); this option's own\n`depends_on` no longer duplicates it.\n\nPractical floor: a ~100 kbps post-AAC video bitrate (i.e. `target_size_bytes`\ncorresponding to less than ~100 kbps of video after subtracting the 160 kbps\nAAC audio track over the merged duration) is silently floored by libx264 and\nthe resulting file will not honour the requested `target_size_bytes`.\nPublishers targeting very small outputs should size accordingly.\n",
|
|
1858
2036
|
"min": 1048576,
|
|
1859
2037
|
"type": "integer"
|
|
1860
2038
|
},
|
|
@@ -2892,7 +3070,7 @@
|
|
|
2892
3070
|
}
|
|
2893
3071
|
}
|
|
2894
3072
|
},
|
|
2895
|
-
"schema_version": "2.
|
|
3073
|
+
"schema_version": "2.21.0",
|
|
2896
3074
|
"source_commit": null,
|
|
2897
3075
|
"user_tier": null
|
|
2898
3076
|
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import AnonymousSchema_253 from './AnonymousSchema_253.js';
|
|
2
|
+
interface LongFormJobMessage {
|
|
3
|
+
'pointer': string;
|
|
4
|
+
'job_id': string;
|
|
5
|
+
'operation_id': string;
|
|
6
|
+
'operation_type': AnonymousSchema_253;
|
|
7
|
+
'processing_class': 'long_form';
|
|
8
|
+
'additionalProperties'?: Record<string, any>;
|
|
9
|
+
}
|
|
10
|
+
export default LongFormJobMessage;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
package/dist/asyncapi/index.d.ts
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
+
export { default as AnonymousSchema_253 } from './AnonymousSchema_253.js';
|
|
1
2
|
export { default as ErrorCode } from './ErrorCode.js';
|
|
2
3
|
export { default as Failure } from './Failure.js';
|
|
3
4
|
export { default as JobInputRole } from './JobInputRole.js';
|
|
5
|
+
export { default as LongFormJobMessage } from './LongFormJobMessage.js';
|
|
4
6
|
export { default as MergeOutputType } from './MergeOutputType.js';
|
|
5
7
|
export { default as MultiOutputCompletion } from './MultiOutputCompletion.js';
|
|
6
8
|
export { default as NotificationsOperationsQueue } from './NotificationsOperationsQueue.js';
|
package/dist/asyncapi/index.js
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* GISL Compression API
|
|
3
|
-
* REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag/Last-Modified revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body. **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings. The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17). **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).** Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value negotiation supported). The server selects the best-match locale from its supported list; falls back to `en-GB` when no match
|
|
3
|
+
* REST API for the GISL (Give It Smaller) file compression and processing service. **Architecture:** - Upload files to get a `file_id` - Create workflows referencing uploaded files with operations (compress, thumbnail, image_watermark, text_watermark, merge, archive, convert, custom_luma, audio_overlay, audio_watermark) - Poll status, stream SSE events, or receive webhook callbacks - Download results per operation output **Response envelope:** All mutation and query endpoints return `{ success: true, data: {...} }` on success and `{ success: false, error: \"...\", details: [...] }` on failure. Exceptions: `GET /api/operations/schema` returns raw JSON (per-tier private caching with ETag/Last-Modified revalidation per ADR-0002 + I3), health probes return flat objects, and `POST /api/contact` returns 204 with no body. **Availability metadata.** This spec uses the `x-availability` vendor extension as **decorative documentation only**. Per [ADR-0001](../docs/decisions/0001-contract-first-availability.md) §1.5, the runtime endpoint `GET /api/operations/schema` (ticket I3) is the authoritative source; the sidecar `availability.json` (ticket I3b) is the authoritative companion (generated, never hand-edited; CI cross-checks runtime ⇄ sidecar). SDKs MUST NOT depend on `x-availability` reaching generated code — code-generators that surface vendor extensions may emit it as documentation, but consumers read availability from the runtime endpoint, not from the generated bindings. The 5-value vocabulary (`stable | beta | experimental | planned | deprecated`) is defined in the `AvailabilityValue` schema. See `schemas/FORMAT.md` §Availability Taxonomy for the operational rules (parser obligation: absent = stable; per-enum-value granularity is the `per_value_availability` primitive landed via ticket I17). **Localisation (per ticket [I26](https://trello.com/c/rcnqwgI4)).** Error responses + paused/blocked workflow statuses carry a localised human-readable `message` alongside a stable, never-localised `message_key`. Machine-readable fields (`error`, enum values, status codes) stay canonical English. - **Currently committed locales:** `en-GB` only (per ticket [`4GKyuYo6`](https://trello.com/c/4GKyuYo6)). The I26 carrier shape (`Accept-Language` + `Content-Language` + `Vary` headers + `locale` envelope field + `message_key` + `message_params`) is stable and exercised; the **catalog** of translated `message` strings is en-GB-only at runtime today. Additional locales (e.g. `pt-PT`) will be advertised by name when their catalogs ship — the request/response carrier shape does NOT change when a new locale lands. Treat unrequested locales as \"machine-code + `message_key` path is committed; localised `message` prose is not\" until this prose enumerates them by name. - **Request:** `Accept-Language` header per RFC 9110 §12.5.4 (q-value negotiation supported). The server selects the best-match locale from its supported list; falls back to `en-GB` when no match — which, until additional catalogs land, is every non-`en-GB` `Accept-Language`. - **Response:** `Content-Language: <locale>` echo on every localised response; `Vary: Accept-Language` on every response (CDN/cache correctness — different `Accept-Language` requests produce different responses). `Vary` is emitted unconditionally so the header contract does not flip when a second locale ships. - **Fallback locale:** `en-GB` (also the canonical locale for `message_key` translations and English `message` prose). - **SDK guidance:** switch on `error` (machine code) for typed error branches; surface `message_key` to client-side i18n catalogs (SDK companion work tracked at X19, cross-repo); display `message` for end-user UI; **never parse `message` for control flow** — it changes per locale. Carrier shape lives on `ErrorEnvelope` (envelope-level optional `message_key` + `message` + `locale` + `message_params`) and `ValidationErrorEnvelope` (also per-`details[]` entry). Existing 402 / 403 / 422 envelopes (`BalanceExhaustedResponse`, `FeatureNotAvailableResponse`, `FeatureTierRestrictedResponse`, `WorkflowPausedDetail`) inherit the convention. **Upload thresholds (per tickets [u0ar7Yye](https://trello.com/c/u0ar7Yye) + [58nBQLWQ](https://trello.com/c/58nBQLWQ)).** Canonical upload constants (single-shot cap, multipart chunk size, multipart concurrency default, multipart first-chunk size) live on the `UploadThresholds` schema with `const:`-pinned values. SDK generators emit these as typed binding constants so frontend / API / SDKs reference one source of truth instead of hardcoding magic numbers. A runtime `GET /api/uploads/limits` endpoint for dynamic discovery (per-tier / per-environment overrides) is a deferred follow-up.
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 2.
|
|
5
|
+
* The version of the OpenAPI document: 2.21.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|