@giveitsmaller/contracts 0.42.0 → 0.44.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/accepted-options/accepted-options.json +1 -1
- package/accepted-options/image-output-routes.json +1 -1
- package/availability/availability.json +1 -1
- package/dist/openapi/models/AccountLimitEntry.d.ts +1 -1
- package/dist/openapi/models/AccountLimitEntry.js +1 -1
- package/dist/openapi/models/AccountLimits.d.ts +1 -1
- package/dist/openapi/models/AccountLimits.js +1 -1
- package/dist/openapi/models/AccountLimitsLimits.d.ts +1 -1
- package/dist/openapi/models/AccountLimitsLimits.js +1 -1
- package/dist/openapi/models/AccountLimitsSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/AccountLimitsSuccessEnvelope.js +1 -1
- package/dist/openapi/models/AudioWatermarkDecodeRequest.d.ts +1 -1
- package/dist/openapi/models/AudioWatermarkDecodeRequest.js +1 -1
- package/dist/openapi/models/AudioWatermarkDecodeResponse.d.ts +1 -1
- package/dist/openapi/models/AudioWatermarkDecodeResponse.js +1 -1
- package/dist/openapi/models/AuthErrorResponse.d.ts +1 -1
- package/dist/openapi/models/AuthErrorResponse.js +1 -1
- package/dist/openapi/models/AuthErrorType.d.ts +1 -1
- package/dist/openapi/models/AuthErrorType.js +1 -1
- package/dist/openapi/models/AuthRejectionEnvelope.d.ts +1 -1
- package/dist/openapi/models/AuthRejectionEnvelope.js +1 -1
- package/dist/openapi/models/AvailabilityValue.d.ts +1 -1
- package/dist/openapi/models/AvailabilityValue.js +1 -1
- package/dist/openapi/models/BalanceExhaustedResponse.d.ts +1 -1
- package/dist/openapi/models/BalanceExhaustedResponse.js +1 -1
- package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.d.ts +1 -1
- package/dist/openapi/models/BalanceExhaustedResponseAllOfLinks.js +1 -1
- package/dist/openapi/models/CallbackEventType.d.ts +1 -1
- package/dist/openapi/models/CallbackEventType.js +1 -1
- package/dist/openapi/models/CapabilityCondition.d.ts +38 -0
- package/dist/openapi/models/CapabilityCondition.js +86 -0
- package/dist/openapi/models/CapabilityConditionOneOf.d.ts +33 -0
- package/dist/openapi/models/CapabilityConditionOneOf.js +44 -0
- package/dist/openapi/models/CapabilityConditionOneOf1.d.ts +33 -0
- package/dist/openapi/models/CapabilityConditionOneOf1.js +44 -0
- package/dist/openapi/models/CapabilityConditionOneOf2.d.ts +33 -0
- package/dist/openapi/models/CapabilityConditionOneOf2.js +44 -0
- package/dist/openapi/models/CapabilityConditionOneOf3.d.ts +38 -0
- package/dist/openapi/models/CapabilityConditionOneOf3.js +47 -0
- package/dist/openapi/models/CapabilityConditionOneOf4.d.ts +38 -0
- package/dist/openapi/models/CapabilityConditionOneOf4.js +47 -0
- package/dist/openapi/models/CapabilityConditionOneOf5.d.ts +47 -0
- package/dist/openapi/models/CapabilityConditionOneOf5.js +53 -0
- package/dist/openapi/models/CapabilityConditionOneOf6.d.ts +35 -0
- package/dist/openapi/models/CapabilityConditionOneOf6.js +43 -0
- package/dist/openapi/models/CapabilityConstraint.d.ts +101 -0
- package/dist/openapi/models/CapabilityConstraint.js +78 -0
- package/dist/openapi/models/CapabilityInputSpec.d.ts +84 -0
- package/dist/openapi/models/CapabilityInputSpec.js +64 -0
- package/dist/openapi/models/CapabilityProduces.d.ts +33 -0
- package/dist/openapi/models/CapabilityProduces.js +58 -0
- package/dist/openapi/models/CapabilityProducesOneOf.d.ts +39 -0
- package/dist/openapi/models/CapabilityProducesOneOf.js +49 -0
- package/dist/openapi/models/CapabilityProducesOneOf1.d.ts +32 -0
- package/dist/openapi/models/CapabilityProducesOneOf1.js +43 -0
- package/dist/openapi/models/CapabilityProducesOneOf2.d.ts +32 -0
- package/dist/openapi/models/CapabilityProducesOneOf2.js +43 -0
- package/dist/openapi/models/ChangePasswordRequest.d.ts +1 -1
- package/dist/openapi/models/ChangePasswordRequest.js +1 -1
- package/dist/openapi/models/CompositionPlan.d.ts +1 -1
- package/dist/openapi/models/CompositionPlan.js +1 -1
- package/dist/openapi/models/CompositionPlanJob.d.ts +1 -1
- package/dist/openapi/models/CompositionPlanJob.js +1 -1
- package/dist/openapi/models/CompositionPlanOperation.d.ts +1 -1
- package/dist/openapi/models/CompositionPlanOperation.js +1 -1
- package/dist/openapi/models/ConfirmEmailChange200Response.d.ts +1 -1
- package/dist/openapi/models/ConfirmEmailChange200Response.js +1 -1
- package/dist/openapi/models/ConfirmEmailChange200ResponseData.d.ts +1 -1
- package/dist/openapi/models/ConfirmEmailChange200ResponseData.js +1 -1
- package/dist/openapi/models/ConfirmEmailChangeRequest.d.ts +1 -1
- package/dist/openapi/models/ConfirmEmailChangeRequest.js +1 -1
- package/dist/openapi/models/ConnectionSource.d.ts +1 -1
- package/dist/openapi/models/ConnectionSource.js +1 -1
- package/dist/openapi/models/ContactRequest.d.ts +1 -1
- package/dist/openapi/models/ContactRequest.js +1 -1
- package/dist/openapi/models/ContactSubject.d.ts +1 -1
- package/dist/openapi/models/ContactSubject.js +1 -1
- package/dist/openapi/models/ContactValidationErrorResponse.d.ts +1 -1
- package/dist/openapi/models/ContactValidationErrorResponse.js +1 -1
- package/dist/openapi/models/CreateApiKey201Response.d.ts +1 -1
- package/dist/openapi/models/CreateApiKey201Response.js +1 -1
- package/dist/openapi/models/CreateApiKey201ResponseData.d.ts +1 -1
- package/dist/openapi/models/CreateApiKey201ResponseData.js +1 -1
- package/dist/openapi/models/CreateApiKeyRequest.d.ts +1 -1
- package/dist/openapi/models/CreateApiKeyRequest.js +1 -1
- package/dist/openapi/models/CreateExternalImport403Response.d.ts +1 -1
- package/dist/openapi/models/CreateExternalImport403Response.js +1 -1
- package/dist/openapi/models/CreateExternalImport422Response.d.ts +1 -1
- package/dist/openapi/models/CreateExternalImport422Response.js +1 -1
- package/dist/openapi/models/CreateWorkflow422Response.d.ts +1 -1
- package/dist/openapi/models/CreateWorkflow422Response.js +1 -1
- package/dist/openapi/models/CreditTransaction.d.ts +1 -1
- package/dist/openapi/models/CreditTransaction.js +1 -1
- package/dist/openapi/models/CreditTransactionSourceBucket.d.ts +1 -1
- package/dist/openapi/models/CreditTransactionSourceBucket.js +1 -1
- package/dist/openapi/models/CreditsBalanceResponse.d.ts +1 -1
- package/dist/openapi/models/CreditsBalanceResponse.js +1 -1
- package/dist/openapi/models/CreditsBalanceSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/CreditsBalanceSuccessEnvelope.js +1 -1
- package/dist/openapi/models/CreditsUsageResponse.d.ts +1 -1
- package/dist/openapi/models/CreditsUsageResponse.js +1 -1
- package/dist/openapi/models/CreditsUsageSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/CreditsUsageSuccessEnvelope.js +1 -1
- package/dist/openapi/models/Delivery.d.ts +1 -1
- package/dist/openapi/models/Delivery.js +1 -1
- package/dist/openapi/models/DeliveryOutputRef.d.ts +1 -1
- package/dist/openapi/models/DeliveryOutputRef.js +1 -1
- package/dist/openapi/models/DeliveryPlan.d.ts +1 -1
- package/dist/openapi/models/DeliveryPlan.js +1 -1
- package/dist/openapi/models/DeliveryPlanOutput.d.ts +1 -1
- package/dist/openapi/models/DeliveryPlanOutput.js +1 -1
- package/dist/openapi/models/DeliveryPlanReason.d.ts +1 -1
- package/dist/openapi/models/DeliveryPlanReason.js +1 -1
- package/dist/openapi/models/DeliverySelection.d.ts +1 -1
- package/dist/openapi/models/DeliverySelection.js +1 -1
- package/dist/openapi/models/DownloadBundle.d.ts +1 -1
- package/dist/openapi/models/DownloadBundle.js +1 -1
- package/dist/openapi/models/EmptySuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/EmptySuccessEnvelope.js +1 -1
- package/dist/openapi/models/EndpointProjection.d.ts +1 -1
- package/dist/openapi/models/EndpointProjection.js +1 -1
- package/dist/openapi/models/ErrorEnvelope.d.ts +1 -1
- package/dist/openapi/models/ErrorEnvelope.js +1 -1
- package/dist/openapi/models/EstimateQuality.d.ts +1 -1
- package/dist/openapi/models/EstimateQuality.js +1 -1
- package/dist/openapi/models/EstimateRange.d.ts +1 -1
- package/dist/openapi/models/EstimateRange.js +1 -1
- package/dist/openapi/models/ExternalDestination.d.ts +1 -1
- package/dist/openapi/models/ExternalDestination.js +1 -1
- package/dist/openapi/models/ExternalImportCreatedResponse.d.ts +1 -1
- package/dist/openapi/models/ExternalImportCreatedResponse.js +1 -1
- package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/ExternalImportCreatedSuccessEnvelope.js +1 -1
- package/dist/openapi/models/ExternalImportRequest.d.ts +1 -1
- package/dist/openapi/models/ExternalImportRequest.js +1 -1
- package/dist/openapi/models/ExternalImportToken.d.ts +1 -1
- package/dist/openapi/models/ExternalImportToken.js +1 -1
- package/dist/openapi/models/ExternalSource.d.ts +1 -1
- package/dist/openapi/models/ExternalSource.js +1 -1
- package/dist/openapi/models/FeatureNotAvailableResponse.d.ts +1 -1
- package/dist/openapi/models/FeatureNotAvailableResponse.js +1 -1
- package/dist/openapi/models/FeatureTierRestrictedResponse.d.ts +1 -1
- package/dist/openapi/models/FeatureTierRestrictedResponse.js +1 -1
- package/dist/openapi/models/FeatureViolation.d.ts +1 -1
- package/dist/openapi/models/FeatureViolation.js +1 -1
- package/dist/openapi/models/ForgotPasswordRequest.d.ts +1 -1
- package/dist/openapi/models/ForgotPasswordRequest.js +1 -1
- package/dist/openapi/models/ImageEncodeCapabilities.d.ts +1 -1
- package/dist/openapi/models/ImageEncodeCapabilities.js +1 -1
- package/dist/openapi/models/JobDefinition.d.ts +1 -1
- package/dist/openapi/models/JobDefinition.js +1 -1
- package/dist/openapi/models/JobDownload.d.ts +1 -1
- package/dist/openapi/models/JobDownload.js +1 -1
- package/dist/openapi/models/JobInputV2.d.ts +1 -1
- package/dist/openapi/models/JobInputV2.js +1 -1
- package/dist/openapi/models/JobMediaClass.d.ts +1 -1
- package/dist/openapi/models/JobMediaClass.js +1 -1
- package/dist/openapi/models/JobOutputSource.d.ts +1 -1
- package/dist/openapi/models/JobOutputSource.js +1 -1
- package/dist/openapi/models/JobResponse.d.ts +29 -1
- package/dist/openapi/models/JobResponse.js +5 -1
- package/dist/openapi/models/JobStatus.d.ts +1 -1
- package/dist/openapi/models/JobStatus.js +1 -1
- package/dist/openapi/models/JobType.d.ts +1 -1
- package/dist/openapi/models/JobType.js +1 -1
- package/dist/openapi/models/LivenessResponse.d.ts +1 -1
- package/dist/openapi/models/LivenessResponse.js +1 -1
- package/dist/openapi/models/LoginUser200Response.d.ts +1 -1
- package/dist/openapi/models/LoginUser200Response.js +1 -1
- package/dist/openapi/models/LoginUser200ResponseData.d.ts +1 -1
- package/dist/openapi/models/LoginUser200ResponseData.js +1 -1
- package/dist/openapi/models/LoginUser200ResponseDataUser.d.ts +1 -1
- package/dist/openapi/models/LoginUser200ResponseDataUser.js +1 -1
- package/dist/openapi/models/LoginUserRequest.d.ts +1 -1
- package/dist/openapi/models/LoginUserRequest.js +1 -1
- package/dist/openapi/models/MetadataResponse.d.ts +1 -1
- package/dist/openapi/models/MetadataResponse.js +1 -1
- package/dist/openapi/models/MetadataResponseDimensions.d.ts +1 -1
- package/dist/openapi/models/MetadataResponseDimensions.js +1 -1
- package/dist/openapi/models/MetadataResponseExif.d.ts +1 -1
- package/dist/openapi/models/MetadataResponseExif.js +1 -1
- package/dist/openapi/models/MetadataResponseExifGps.d.ts +1 -1
- package/dist/openapi/models/MetadataResponseExifGps.js +1 -1
- package/dist/openapi/models/MetadataSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MetadataSuccessEnvelope.js +1 -1
- package/dist/openapi/models/MimeGroupSchema.d.ts +1 -1
- package/dist/openapi/models/MimeGroupSchema.js +1 -1
- package/dist/openapi/models/MultiInputSource.d.ts +1 -1
- package/dist/openapi/models/MultiInputSource.js +1 -1
- package/dist/openapi/models/MultipartCompleteRequest.d.ts +1 -1
- package/dist/openapi/models/MultipartCompleteRequest.js +1 -1
- package/dist/openapi/models/MultipartCompleteRequestPartsInner.d.ts +1 -1
- package/dist/openapi/models/MultipartCompleteRequestPartsInner.js +1 -1
- package/dist/openapi/models/MultipartCompleteResponse.d.ts +1 -1
- package/dist/openapi/models/MultipartCompleteResponse.js +1 -1
- package/dist/openapi/models/MultipartCompleteSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MultipartCompleteSuccessEnvelope.js +1 -1
- package/dist/openapi/models/MultipartInitiateRequestMetadataHint.d.ts +1 -1
- package/dist/openapi/models/MultipartInitiateRequestMetadataHint.js +1 -1
- package/dist/openapi/models/MultipartInitiateResponse.d.ts +1 -1
- package/dist/openapi/models/MultipartInitiateResponse.js +1 -1
- package/dist/openapi/models/MultipartInitiateSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MultipartInitiateSuccessEnvelope.js +1 -1
- package/dist/openapi/models/MultipartKeepaliveResponse.d.ts +1 -1
- package/dist/openapi/models/MultipartKeepaliveResponse.js +1 -1
- package/dist/openapi/models/MultipartKeepaliveSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MultipartKeepaliveSuccessEnvelope.js +1 -1
- package/dist/openapi/models/MultipartPartListing.d.ts +1 -1
- package/dist/openapi/models/MultipartPartListing.js +1 -1
- package/dist/openapi/models/MultipartPresignRequest.d.ts +1 -1
- package/dist/openapi/models/MultipartPresignRequest.js +1 -1
- package/dist/openapi/models/MultipartPresignResponse.d.ts +1 -1
- package/dist/openapi/models/MultipartPresignResponse.js +1 -1
- package/dist/openapi/models/MultipartPresignSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MultipartPresignSuccessEnvelope.js +1 -1
- package/dist/openapi/models/MultipartStatusResponse.d.ts +1 -1
- package/dist/openapi/models/MultipartStatusResponse.js +1 -1
- package/dist/openapi/models/MultipartStatusSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/MultipartStatusSuccessEnvelope.js +1 -1
- package/dist/openapi/models/OperationCapability.d.ts +98 -0
- package/dist/openapi/models/OperationCapability.js +59 -0
- package/dist/openapi/models/OperationDefinition.d.ts +1 -1
- package/dist/openapi/models/OperationDefinition.js +1 -1
- package/dist/openapi/models/OperationDownload.d.ts +1 -1
- package/dist/openapi/models/OperationDownload.js +1 -1
- package/dist/openapi/models/OperationInputModel.d.ts +1 -1
- package/dist/openapi/models/OperationInputModel.js +1 -1
- package/dist/openapi/models/OperationResponse.d.ts +1 -1
- package/dist/openapi/models/OperationResponse.js +1 -1
- package/dist/openapi/models/OperationResult.d.ts +1 -1
- package/dist/openapi/models/OperationResult.js +1 -1
- package/dist/openapi/models/OperationResultMetadata.d.ts +1 -1
- package/dist/openapi/models/OperationResultMetadata.js +1 -1
- package/dist/openapi/models/OperationResultMetrics.d.ts +1 -1
- package/dist/openapi/models/OperationResultMetrics.js +1 -1
- package/dist/openapi/models/OperationSchemaDefinition.d.ts +1 -1
- package/dist/openapi/models/OperationSchemaDefinition.js +1 -1
- package/dist/openapi/models/OperationStatus.d.ts +1 -1
- package/dist/openapi/models/OperationStatus.js +1 -1
- package/dist/openapi/models/OperationType.d.ts +1 -1
- package/dist/openapi/models/OperationType.js +1 -1
- package/dist/openapi/models/OperationsSchemaResponse.d.ts +53 -1
- package/dist/openapi/models/OperationsSchemaResponse.js +7 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeatures.d.ts +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeatures.js +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDelivery.d.ts +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDelivery.js +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDeliveryMode.d.ts +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDeliveryMode.js +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDeliverySelection.d.ts +1 -1
- package/dist/openapi/models/OperationsSchemaResponseWorkflowFeaturesDeliverySelection.js +1 -1
- package/dist/openapi/models/OptionSchema.d.ts +1 -1
- package/dist/openapi/models/OptionSchema.js +1 -1
- package/dist/openapi/models/OutputProperties.d.ts +41 -0
- package/dist/openapi/models/OutputProperties.js +48 -0
- package/dist/openapi/models/OutputPropertiesIsAnimated.d.ts +24 -0
- package/dist/openapi/models/OutputPropertiesIsAnimated.js +43 -0
- package/dist/openapi/models/PerRoleCardinalityEntry.d.ts +1 -1
- package/dist/openapi/models/PerRoleCardinalityEntry.js +1 -1
- package/dist/openapi/models/PerValueAvailabilityEntry.d.ts +1 -1
- package/dist/openapi/models/PerValueAvailabilityEntry.js +1 -1
- package/dist/openapi/models/PresignedUrlPart.d.ts +1 -1
- package/dist/openapi/models/PresignedUrlPart.js +1 -1
- package/dist/openapi/models/ProbePendingResponse.d.ts +1 -1
- package/dist/openapi/models/ProbePendingResponse.js +1 -1
- package/dist/openapi/models/ProcessingClass.d.ts +1 -1
- package/dist/openapi/models/ProcessingClass.js +1 -1
- package/dist/openapi/models/ProcessingClassBandViolation.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassBandViolation.js +1 -1
- package/dist/openapi/models/ProcessingClassConstraints.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassConstraints.js +1 -1
- package/dist/openapi/models/ProcessingClassEntry.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassEntry.js +1 -1
- package/dist/openapi/models/ProcessingClassExceedsBandResponse.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassExceedsBandResponse.js +1 -1
- package/dist/openapi/models/ProcessingClassHint.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassHint.js +1 -1
- package/dist/openapi/models/ProcessingClassReason.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassReason.js +1 -1
- package/dist/openapi/models/ProcessingClassRejectReason.d.ts +1 -1
- package/dist/openapi/models/ProcessingClassRejectReason.js +1 -1
- package/dist/openapi/models/ProcessingPlan.d.ts +1 -1
- package/dist/openapi/models/ProcessingPlan.js +1 -1
- package/dist/openapi/models/ProcessingPlanJob.d.ts +1 -1
- package/dist/openapi/models/ProcessingPlanJob.js +1 -1
- package/dist/openapi/models/ReEncodeDecision.d.ts +1 -1
- package/dist/openapi/models/ReEncodeDecision.js +1 -1
- package/dist/openapi/models/ReadinessResponse.d.ts +1 -1
- package/dist/openapi/models/ReadinessResponse.js +1 -1
- package/dist/openapi/models/RegisterUser422Response.d.ts +1 -1
- package/dist/openapi/models/RegisterUser422Response.js +1 -1
- package/dist/openapi/models/RegisterUserRequest.d.ts +1 -1
- package/dist/openapi/models/RegisterUserRequest.js +1 -1
- package/dist/openapi/models/ResetPasswordRequest.d.ts +1 -1
- package/dist/openapi/models/ResetPasswordRequest.js +1 -1
- package/dist/openapi/models/ResponseEnvelope.d.ts +1 -1
- package/dist/openapi/models/ResponseEnvelope.js +1 -1
- package/dist/openapi/models/RetryResponse.d.ts +1 -1
- package/dist/openapi/models/RetryResponse.js +1 -1
- package/dist/openapi/models/RetrySuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/RetrySuccessEnvelope.js +1 -1
- package/dist/openapi/models/SseCompletionBase.d.ts +1 -1
- package/dist/openapi/models/SseCompletionBase.js +1 -1
- package/dist/openapi/models/SseEventType.d.ts +1 -1
- package/dist/openapi/models/SseEventType.js +1 -1
- package/dist/openapi/models/SseJobCompletedData.d.ts +1 -1
- package/dist/openapi/models/SseJobCompletedData.js +1 -1
- package/dist/openapi/models/SseJobFailedData.d.ts +1 -1
- package/dist/openapi/models/SseJobFailedData.js +1 -1
- package/dist/openapi/models/SseMultiOutputCompletion.d.ts +1 -1
- package/dist/openapi/models/SseMultiOutputCompletion.js +1 -1
- package/dist/openapi/models/SseMultiOutputCompletionMetrics.d.ts +1 -1
- package/dist/openapi/models/SseMultiOutputCompletionMetrics.js +1 -1
- package/dist/openapi/models/SseMultiOutputCompletionWithKind.d.ts +1 -1
- package/dist/openapi/models/SseMultiOutputCompletionWithKind.js +1 -1
- package/dist/openapi/models/SseMultiOutputResultEntry.d.ts +1 -1
- package/dist/openapi/models/SseMultiOutputResultEntry.js +1 -1
- package/dist/openapi/models/SseOperationCompletedData.d.ts +1 -1
- package/dist/openapi/models/SseOperationCompletedData.js +1 -1
- package/dist/openapi/models/SseOperationCompletionResult.d.ts +1 -1
- package/dist/openapi/models/SseOperationCompletionResult.js +1 -1
- package/dist/openapi/models/SseOperationFailedData.d.ts +1 -1
- package/dist/openapi/models/SseOperationFailedData.js +1 -1
- package/dist/openapi/models/SseOperationProgressData.d.ts +1 -1
- package/dist/openapi/models/SseOperationProgressData.js +1 -1
- package/dist/openapi/models/SseSingleOutputCompletion.d.ts +1 -1
- package/dist/openapi/models/SseSingleOutputCompletion.js +1 -1
- package/dist/openapi/models/SseWorkflowTerminalData.d.ts +1 -1
- package/dist/openapi/models/SseWorkflowTerminalData.js +1 -1
- package/dist/openapi/models/TierRestrictionKind.d.ts +1 -1
- package/dist/openapi/models/TierRestrictionKind.js +1 -1
- package/dist/openapi/models/TierRestrictionResponse.d.ts +1 -1
- package/dist/openapi/models/TierRestrictionResponse.js +1 -1
- package/dist/openapi/models/UpdateProfile200Response.d.ts +1 -1
- package/dist/openapi/models/UpdateProfile200Response.js +1 -1
- package/dist/openapi/models/UpdateProfile200ResponseData.d.ts +1 -1
- package/dist/openapi/models/UpdateProfile200ResponseData.js +1 -1
- package/dist/openapi/models/UpdateProfile422Response.d.ts +1 -1
- package/dist/openapi/models/UpdateProfile422Response.js +1 -1
- package/dist/openapi/models/UpdateProfileRequest.d.ts +1 -1
- package/dist/openapi/models/UpdateProfileRequest.js +1 -1
- package/dist/openapi/models/UploadConstraintsApplied.d.ts +1 -1
- package/dist/openapi/models/UploadConstraintsApplied.js +1 -1
- package/dist/openapi/models/UploadDurationExceedsTierResponse.d.ts +1 -1
- package/dist/openapi/models/UploadDurationExceedsTierResponse.js +1 -1
- package/dist/openapi/models/UploadFile403Response.d.ts +1 -1
- package/dist/openapi/models/UploadFile403Response.js +1 -1
- package/dist/openapi/models/UploadFile422Response.d.ts +1 -1
- package/dist/openapi/models/UploadFile422Response.js +1 -1
- package/dist/openapi/models/UploadProbeMediaMetadata.d.ts +1 -1
- package/dist/openapi/models/UploadProbeMediaMetadata.js +1 -1
- package/dist/openapi/models/UploadProbeProcessingClass.d.ts +1 -1
- package/dist/openapi/models/UploadProbeProcessingClass.js +1 -1
- package/dist/openapi/models/UploadProbeResponse.d.ts +1 -1
- package/dist/openapi/models/UploadProbeResponse.js +1 -1
- package/dist/openapi/models/UploadProbeStatus.d.ts +1 -1
- package/dist/openapi/models/UploadProbeStatus.js +1 -1
- package/dist/openapi/models/UploadProbeSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/UploadProbeSuccessEnvelope.js +1 -1
- package/dist/openapi/models/UploadResponse.d.ts +1 -1
- package/dist/openapi/models/UploadResponse.js +1 -1
- package/dist/openapi/models/UploadSizeExceedsTierResponse.d.ts +1 -1
- package/dist/openapi/models/UploadSizeExceedsTierResponse.js +1 -1
- package/dist/openapi/models/UploadSource.d.ts +1 -1
- package/dist/openapi/models/UploadSource.js +1 -1
- package/dist/openapi/models/UploadSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/UploadSuccessEnvelope.js +1 -1
- package/dist/openapi/models/UploadThresholds.d.ts +1 -1
- package/dist/openapi/models/UploadThresholds.js +1 -1
- package/dist/openapi/models/UserTier.d.ts +1 -1
- package/dist/openapi/models/UserTier.js +1 -1
- package/dist/openapi/models/ValidationErrorEnvelope.d.ts +1 -1
- package/dist/openapi/models/ValidationErrorEnvelope.js +1 -1
- package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.d.ts +1 -1
- package/dist/openapi/models/ValidationErrorEnvelopeDetailsInner.js +1 -1
- package/dist/openapi/models/VerifyEmailRequest.d.ts +1 -1
- package/dist/openapi/models/VerifyEmailRequest.js +1 -1
- package/dist/openapi/models/WarningType.d.ts +1 -1
- package/dist/openapi/models/WarningType.js +1 -1
- package/dist/openapi/models/WebhookOperationContext.d.ts +1 -1
- package/dist/openapi/models/WebhookOperationContext.js +1 -1
- package/dist/openapi/models/WebhookPayload.d.ts +1 -1
- package/dist/openapi/models/WebhookPayload.js +1 -1
- package/dist/openapi/models/WorkflowCancelBillingEffect.d.ts +1 -1
- package/dist/openapi/models/WorkflowCancelBillingEffect.js +1 -1
- package/dist/openapi/models/WorkflowCancelResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowCancelResponse.js +1 -1
- package/dist/openapi/models/WorkflowCancelSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowCancelSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowCreateRequest.d.ts +1 -1
- package/dist/openapi/models/WorkflowCreateRequest.js +1 -1
- package/dist/openapi/models/WorkflowCreateResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowCreateResponse.js +1 -1
- package/dist/openapi/models/WorkflowCreateSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowCreateSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowDownloadResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowDownloadResponse.js +1 -1
- package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowDownloadSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowEdge.d.ts +1 -1
- package/dist/openapi/models/WorkflowEdge.js +1 -1
- package/dist/openapi/models/WorkflowExpiredResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowExpiredResponse.js +1 -1
- package/dist/openapi/models/WorkflowListResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowListResponse.js +1 -1
- package/dist/openapi/models/WorkflowListSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowListSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowPauseRequiredAction.d.ts +1 -1
- package/dist/openapi/models/WorkflowPauseRequiredAction.js +1 -1
- package/dist/openapi/models/WorkflowPausedDetail.d.ts +1 -1
- package/dist/openapi/models/WorkflowPausedDetail.js +1 -1
- package/dist/openapi/models/WorkflowPausedDetailLinks.d.ts +1 -1
- package/dist/openapi/models/WorkflowPausedDetailLinks.js +1 -1
- package/dist/openapi/models/WorkflowProcessing.d.ts +1 -1
- package/dist/openapi/models/WorkflowProcessing.js +1 -1
- package/dist/openapi/models/WorkflowResumeResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowResumeResponse.js +1 -1
- package/dist/openapi/models/WorkflowResumeSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowResumeSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowSource.d.ts +1 -1
- package/dist/openapi/models/WorkflowSource.js +1 -1
- package/dist/openapi/models/WorkflowStatus.d.ts +1 -1
- package/dist/openapi/models/WorkflowStatus.js +1 -1
- package/dist/openapi/models/WorkflowStatusResponse.d.ts +1 -1
- package/dist/openapi/models/WorkflowStatusResponse.js +1 -1
- package/dist/openapi/models/WorkflowStatusSuccessEnvelope.d.ts +1 -1
- package/dist/openapi/models/WorkflowStatusSuccessEnvelope.js +1 -1
- package/dist/openapi/models/WorkflowSummary.d.ts +1 -1
- package/dist/openapi/models/WorkflowSummary.js +1 -1
- package/dist/openapi/models/WorkflowSummaryJob.d.ts +58 -6
- package/dist/openapi/models/WorkflowSummaryJob.js +10 -1
- package/dist/openapi/models/WorkflowWarning.d.ts +1 -1
- package/dist/openapi/models/WorkflowWarning.js +1 -1
- package/dist/openapi/models/WorkflowWarningSeverity.d.ts +1 -1
- package/dist/openapi/models/WorkflowWarningSeverity.js +1 -1
- package/dist/openapi/models/index.d.ts +17 -0
- package/dist/openapi/models/index.js +17 -0
- package/dist/openapi/runtime.d.ts +1 -1
- package/dist/openapi/runtime.js +1 -1
- package/openapi/api.yaml +404 -6
- package/operation-capabilities/operation-capabilities.json +1 -1
- package/package.json +1 -1
|
@@ -13,6 +13,20 @@ export * from './AvailabilityValue.js';
|
|
|
13
13
|
export * from './BalanceExhaustedResponse.js';
|
|
14
14
|
export * from './BalanceExhaustedResponseAllOfLinks.js';
|
|
15
15
|
export * from './CallbackEventType.js';
|
|
16
|
+
export * from './CapabilityCondition.js';
|
|
17
|
+
export * from './CapabilityConditionOneOf.js';
|
|
18
|
+
export * from './CapabilityConditionOneOf1.js';
|
|
19
|
+
export * from './CapabilityConditionOneOf2.js';
|
|
20
|
+
export * from './CapabilityConditionOneOf3.js';
|
|
21
|
+
export * from './CapabilityConditionOneOf4.js';
|
|
22
|
+
export * from './CapabilityConditionOneOf5.js';
|
|
23
|
+
export * from './CapabilityConditionOneOf6.js';
|
|
24
|
+
export * from './CapabilityConstraint.js';
|
|
25
|
+
export * from './CapabilityInputSpec.js';
|
|
26
|
+
export * from './CapabilityProduces.js';
|
|
27
|
+
export * from './CapabilityProducesOneOf.js';
|
|
28
|
+
export * from './CapabilityProducesOneOf1.js';
|
|
29
|
+
export * from './CapabilityProducesOneOf2.js';
|
|
16
30
|
export * from './ChangePasswordRequest.js';
|
|
17
31
|
export * from './CompositionPlan.js';
|
|
18
32
|
export * from './CompositionPlanJob.js';
|
|
@@ -94,6 +108,7 @@ export * from './MultipartPresignResponse.js';
|
|
|
94
108
|
export * from './MultipartPresignSuccessEnvelope.js';
|
|
95
109
|
export * from './MultipartStatusResponse.js';
|
|
96
110
|
export * from './MultipartStatusSuccessEnvelope.js';
|
|
111
|
+
export * from './OperationCapability.js';
|
|
97
112
|
export * from './OperationDefinition.js';
|
|
98
113
|
export * from './OperationDownload.js';
|
|
99
114
|
export * from './OperationInputModel.js';
|
|
@@ -110,6 +125,8 @@ export * from './OperationsSchemaResponseWorkflowFeaturesDelivery.js';
|
|
|
110
125
|
export * from './OperationsSchemaResponseWorkflowFeaturesDeliveryMode.js';
|
|
111
126
|
export * from './OperationsSchemaResponseWorkflowFeaturesDeliverySelection.js';
|
|
112
127
|
export * from './OptionSchema.js';
|
|
128
|
+
export * from './OutputProperties.js';
|
|
129
|
+
export * from './OutputPropertiesIsAnimated.js';
|
|
113
130
|
export * from './PerRoleCardinalityEntry.js';
|
|
114
131
|
export * from './PerValueAvailabilityEntry.js';
|
|
115
132
|
export * from './PresignedUrlPart.js';
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* GISL Compression API
|
|
3
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 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.126.0
|
|
6
6
|
*
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/openapi/runtime.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* GISL Compression API
|
|
5
5
|
* 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 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.
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 2.
|
|
7
|
+
* The version of the OpenAPI document: 2.126.0
|
|
8
8
|
*
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/openapi/api.yaml
CHANGED
|
@@ -89,7 +89,7 @@ info:
|
|
|
89
89
|
of truth instead of hardcoding magic numbers. A runtime
|
|
90
90
|
`GET /api/uploads/limits` endpoint for dynamic discovery
|
|
91
91
|
(per-tier / per-environment overrides) is a deferred follow-up.
|
|
92
|
-
version: 2.
|
|
92
|
+
version: 2.126.0
|
|
93
93
|
contact:
|
|
94
94
|
name: API Support
|
|
95
95
|
|
|
@@ -9754,11 +9754,17 @@ components:
|
|
|
9754
9754
|
WorkflowSummaryJob:
|
|
9755
9755
|
type: object
|
|
9756
9756
|
description: |
|
|
9757
|
-
|
|
9758
|
-
class) + status
|
|
9759
|
-
|
|
9760
|
-
`
|
|
9761
|
-
|
|
9757
|
+
Per-job entry in a `WorkflowSummary` row. Carries `job_type` (media
|
|
9758
|
+
class) + status plus a lightweight at-a-glance enrichment set —
|
|
9759
|
+
`input_filename`, an input→output byte summary, and the applied
|
|
9760
|
+
`operation_types` — so the list view renders an informative row
|
|
9761
|
+
(e.g. "vacation.jpg · 1.2 MB → 480 KB · compress, thumbnail")
|
|
9762
|
+
WITHOUT an N-row drill-in. Full per-operation detail
|
|
9763
|
+
(`result_metadata`, progress, per-output download URLs) remains the
|
|
9764
|
+
drill-in `GET /api/workflows/{id}/status` + `GET /{id}/downloads`.
|
|
9765
|
+
The enrichment fields are all OPTIONAL (additive): a consumer MUST
|
|
9766
|
+
tolerate their absence, and they are naturally absent for jobs whose
|
|
9767
|
+
input is an upstream `job_output` rather than a user upload.
|
|
9762
9768
|
required:
|
|
9763
9769
|
- job_id
|
|
9764
9770
|
- ref
|
|
@@ -9774,6 +9780,49 @@ components:
|
|
|
9774
9780
|
$ref: '#/components/schemas/JobMediaClass'
|
|
9775
9781
|
status:
|
|
9776
9782
|
$ref: '#/components/schemas/JobStatus'
|
|
9783
|
+
input_filename:
|
|
9784
|
+
type: string
|
|
9785
|
+
maxLength: 1024
|
|
9786
|
+
description: |
|
|
9787
|
+
OPTIONAL. The user's original input file name (e.g.
|
|
9788
|
+
`vacation.jpg`) — what the list row labels the job with, rather
|
|
9789
|
+
than the FE-assigned `ref`. For multi-input jobs (merge,
|
|
9790
|
+
watermark) this is the primary/`base` input's filename. Absent
|
|
9791
|
+
for jobs whose input is an upstream `job_output` (no original
|
|
9792
|
+
upload name) or when the server has not recorded it.
|
|
9793
|
+
example: "vacation.jpg"
|
|
9794
|
+
input_size_bytes:
|
|
9795
|
+
type: integer
|
|
9796
|
+
format: int64
|
|
9797
|
+
minimum: 0
|
|
9798
|
+
description: |
|
|
9799
|
+
OPTIONAL. Original input size in bytes — the left side of the
|
|
9800
|
+
list-row savings readout. For multi-input jobs, the combined
|
|
9801
|
+
size of all source inputs. Pair with `output_size_bytes` to
|
|
9802
|
+
render "1.2 MB → 480 KB (↓60%)" without a drill-in. Absent when
|
|
9803
|
+
not yet known or not applicable.
|
|
9804
|
+
example: 1258291
|
|
9805
|
+
output_size_bytes:
|
|
9806
|
+
type: integer
|
|
9807
|
+
format: int64
|
|
9808
|
+
minimum: 0
|
|
9809
|
+
description: |
|
|
9810
|
+
OPTIONAL. Final job output size in bytes — the right side of the
|
|
9811
|
+
savings readout. The aggregate deliverable size for the job (the
|
|
9812
|
+
authoritative per-output sizes remain on
|
|
9813
|
+
`GET /{id}/downloads`). Absent until the job completes / when not
|
|
9814
|
+
applicable.
|
|
9815
|
+
example: 491520
|
|
9816
|
+
operation_types:
|
|
9817
|
+
type: array
|
|
9818
|
+
description: |
|
|
9819
|
+
OPTIONAL (nice-to-have). The actual operation types applied in
|
|
9820
|
+
this job (e.g. `[compress, thumbnail]`), beyond the media-class
|
|
9821
|
+
`job_type` — lets the list row show what was DONE without a
|
|
9822
|
+
drill-in. Order follows the job's operation chain. Absent when
|
|
9823
|
+
the server does not project it.
|
|
9824
|
+
items:
|
|
9825
|
+
$ref: '#/components/schemas/OperationType'
|
|
9777
9826
|
|
|
9778
9827
|
WorkflowSummary:
|
|
9779
9828
|
type: object
|
|
@@ -9865,6 +9914,33 @@ components:
|
|
|
9865
9914
|
$ref: '#/components/schemas/UuidV7'
|
|
9866
9915
|
status:
|
|
9867
9916
|
$ref: '#/components/schemas/JobStatus'
|
|
9917
|
+
input_filename:
|
|
9918
|
+
type: string
|
|
9919
|
+
maxLength: 1024
|
|
9920
|
+
description: |
|
|
9921
|
+
OPTIONAL. The user's original input file name (e.g.
|
|
9922
|
+
`vacation.jpg`) for this job — the drill-in mirror of
|
|
9923
|
+
`WorkflowSummaryJob.input_filename`. For multi-input jobs
|
|
9924
|
+
(merge, watermark) this is the primary/`base` input's filename.
|
|
9925
|
+
Absent for jobs whose input is an upstream `job_output`, or
|
|
9926
|
+
when the server has not recorded it. Left schema-OPTIONAL (not
|
|
9927
|
+
`required`) because `JobResponse` is also embedded in the
|
|
9928
|
+
`WebhookPayload.workflow` callback payload, where a required
|
|
9929
|
+
addition would break existing webhook consumers (same rationale
|
|
9930
|
+
as `processing_class`).
|
|
9931
|
+
example: "vacation.jpg"
|
|
9932
|
+
input_size_bytes:
|
|
9933
|
+
type: integer
|
|
9934
|
+
format: int64
|
|
9935
|
+
minimum: 0
|
|
9936
|
+
description: |
|
|
9937
|
+
OPTIONAL. Original input size in bytes for this job (combined
|
|
9938
|
+
source size for multi-input jobs). The drill-in mirror of
|
|
9939
|
+
`WorkflowSummaryJob.input_size_bytes`; the input side of the
|
|
9940
|
+
savings readout (output sizes remain on the per-operation
|
|
9941
|
+
`OperationResult.size_bytes` / `GET /{id}/downloads`). OPTIONAL
|
|
9942
|
+
for the same webhook-payload reason as `input_filename`.
|
|
9943
|
+
example: 1258291
|
|
9868
9944
|
processing_class:
|
|
9869
9945
|
$ref: '#/components/schemas/ProcessingClass'
|
|
9870
9946
|
description: |
|
|
@@ -10971,6 +11047,328 @@ components:
|
|
|
10971
11047
|
and its presence from either source. Per ticket
|
|
10972
11048
|
[`kybXQe2S`](https://trello.com/c/kybXQe2S).
|
|
10973
11049
|
$ref: '#/components/schemas/ImageEncodeCapabilities'
|
|
11050
|
+
capabilities:
|
|
11051
|
+
type: object
|
|
11052
|
+
description: |
|
|
11053
|
+
Tier-scoped operation-capability matrix (the
|
|
11054
|
+
[operation-capability constraint model](../operation-capabilities/operation-capabilities.json),
|
|
11055
|
+
ADR-0024) — per operation type: `accepts` (media classes),
|
|
11056
|
+
`input` (cardinality), `produces`, `availability`, `sole_op`,
|
|
11057
|
+
and the three constraint families (`excludes` / `requires` /
|
|
11058
|
+
`option_conflicts`). Consumers use it to pre-validate
|
|
11059
|
+
operation composition (compatibility, ordering, output
|
|
11060
|
+
propagation) without hardcoding pairwise rules.
|
|
11061
|
+
|
|
11062
|
+
Each `OperationCapability` is left OPEN (no
|
|
11063
|
+
`additionalProperties: false`) so future capability families
|
|
11064
|
+
ride through untyped — consumers MUST tolerate extra keys.
|
|
11065
|
+
|
|
11066
|
+
**Optional in the wire envelope** (same incremental-mirroring
|
|
11067
|
+
stance as `endpoints` / `workflow_features` /
|
|
11068
|
+
`image_encode_capabilities`): the runtime
|
|
11069
|
+
`GET /api/operations/schema` emits it (API ticket
|
|
11070
|
+
`uneE8Yoz`); the committed sidecar MAY mirror it once the
|
|
11071
|
+
generator catches up. Consumers MUST tolerate its absence
|
|
11072
|
+
and its presence from either source. Per ticket
|
|
11073
|
+
[`9E3oqGNK`](https://trello.com/c/9E3oqGNK).
|
|
11074
|
+
additionalProperties:
|
|
11075
|
+
$ref: '#/components/schemas/OperationCapability'
|
|
11076
|
+
output_properties:
|
|
11077
|
+
type: object
|
|
11078
|
+
description: |
|
|
11079
|
+
Output-format property table (`output_format` → media facts)
|
|
11080
|
+
backing the capability model's forward output-propagation:
|
|
11081
|
+
`hasAudioTrack` (does this format carry an audio stream) and
|
|
11082
|
+
`isAnimated` (single-frame vs animated; `"maybe"` for formats
|
|
11083
|
+
that can be either, e.g. GIF/WebP). Consumers use it to reason
|
|
11084
|
+
about what a chained operation's output can feed downstream.
|
|
11085
|
+
|
|
11086
|
+
**Tier-invariant** — a fixed codec fact, not an entitlement
|
|
11087
|
+
(carries no `availability`).
|
|
11088
|
+
|
|
11089
|
+
**Optional in the wire envelope** (same incremental-mirroring
|
|
11090
|
+
stance as the sibling blocks above). Per ticket
|
|
11091
|
+
[`9E3oqGNK`](https://trello.com/c/9E3oqGNK).
|
|
11092
|
+
additionalProperties:
|
|
11093
|
+
$ref: '#/components/schemas/OutputProperties'
|
|
11094
|
+
|
|
11095
|
+
OperationCapability:
|
|
11096
|
+
type: object
|
|
11097
|
+
description: |
|
|
11098
|
+
One operation type's capability entry in the `capabilities`
|
|
11099
|
+
matrix (ADR-0024 operation-capability constraint model). The
|
|
11100
|
+
object is deliberately OPEN (no `additionalProperties: false`)
|
|
11101
|
+
so future capability families ride through untyped — consumers
|
|
11102
|
+
MUST tolerate extra keys. The per-op `input` cardinality block
|
|
11103
|
+
is typed via `CapabilityInputSpec` (added once the API began
|
|
11104
|
+
surfacing it, ticket `L7ykrIX3` / API `03Qg3Ms7`).
|
|
11105
|
+
properties:
|
|
11106
|
+
accepts:
|
|
11107
|
+
type: array
|
|
11108
|
+
description: |
|
|
11109
|
+
Media classes this operation accepts as input (e.g.
|
|
11110
|
+
`image`, `video`, `audio`, `document`, or `*` for
|
|
11111
|
+
media-agnostic). Coarse media-class tokens, not MIME types —
|
|
11112
|
+
per-MIME applicability lives in `operations.*.mime_groups`.
|
|
11113
|
+
items:
|
|
11114
|
+
type: string
|
|
11115
|
+
input:
|
|
11116
|
+
$ref: '#/components/schemas/CapabilityInputSpec'
|
|
11117
|
+
availability:
|
|
11118
|
+
$ref: '#/components/schemas/AvailabilityValue'
|
|
11119
|
+
sole_op:
|
|
11120
|
+
type: boolean
|
|
11121
|
+
description: |
|
|
11122
|
+
True when the operation must be the only operation in its job
|
|
11123
|
+
(bypasses chain validation; ADR-0025). False/absent ⇒ chainable.
|
|
11124
|
+
produces:
|
|
11125
|
+
$ref: '#/components/schemas/CapabilityProduces'
|
|
11126
|
+
excludes:
|
|
11127
|
+
type: array
|
|
11128
|
+
description: |
|
|
11129
|
+
Hard-incompatibility constraints — when the `when` condition
|
|
11130
|
+
holds the operation/option combination is rejected with the
|
|
11131
|
+
constraint's `wire_code`.
|
|
11132
|
+
items:
|
|
11133
|
+
$ref: '#/components/schemas/CapabilityConstraint'
|
|
11134
|
+
requires:
|
|
11135
|
+
type: array
|
|
11136
|
+
description: |
|
|
11137
|
+
Co-requirement constraints — when `when` holds, the
|
|
11138
|
+
`requires_field` MUST be present (else `wire_code`,
|
|
11139
|
+
typically `invalid_options`).
|
|
11140
|
+
items:
|
|
11141
|
+
$ref: '#/components/schemas/CapabilityConstraint'
|
|
11142
|
+
option_conflicts:
|
|
11143
|
+
type: array
|
|
11144
|
+
description: |
|
|
11145
|
+
Mutually-exclusive option constraints within the operation.
|
|
11146
|
+
items:
|
|
11147
|
+
$ref: '#/components/schemas/CapabilityConstraint'
|
|
11148
|
+
|
|
11149
|
+
CapabilityInputSpec:
|
|
11150
|
+
type: object
|
|
11151
|
+
additionalProperties: false
|
|
11152
|
+
required: [model]
|
|
11153
|
+
description: |
|
|
11154
|
+
Per-operation input cardinality — the `capabilities.<op>.input`
|
|
11155
|
+
block surfaced by the API (ticket `03Qg3Ms7` / PR #477),
|
|
11156
|
+
round-tripped verbatim from the operation-capability model. It
|
|
11157
|
+
mirrors the operation's `input_model` / `min_inputs` /
|
|
11158
|
+
`max_inputs` / `per_role_cardinality` (the `operations.*` map
|
|
11159
|
+
carries the same facts under those keys; this is the
|
|
11160
|
+
`capabilities` projection). `model` is always present; `min` /
|
|
11161
|
+
`max` accompany multi-input ops; `roles` is added only by
|
|
11162
|
+
role-based multis. A single-input op emits just
|
|
11163
|
+
`{ model: single }`; a role-less multi emits
|
|
11164
|
+
`{ model: multi, min, max }`; a role-based multi adds `roles`.
|
|
11165
|
+
properties:
|
|
11166
|
+
model:
|
|
11167
|
+
type: string
|
|
11168
|
+
enum: [single, multi]
|
|
11169
|
+
description: |
|
|
11170
|
+
`single` — one input. `multi` — multiple inputs (with `min` /
|
|
11171
|
+
`max`, and `roles` for role-based ops).
|
|
11172
|
+
min:
|
|
11173
|
+
type: integer
|
|
11174
|
+
description: Minimum number of inputs (multi-input ops).
|
|
11175
|
+
max:
|
|
11176
|
+
type: integer
|
|
11177
|
+
description: Maximum number of inputs (multi-input ops).
|
|
11178
|
+
roles:
|
|
11179
|
+
type: array
|
|
11180
|
+
description: |
|
|
11181
|
+
Declared input roles for role-based multi-input ops. Omitted
|
|
11182
|
+
entirely for role-less multi-input ops — NOT synthesised.
|
|
11183
|
+
Mirrors the `JobInputRole` vocabulary (the request `role`
|
|
11184
|
+
enum); keep in sync if that enum widens.
|
|
11185
|
+
items:
|
|
11186
|
+
type: string
|
|
11187
|
+
enum: [base, overlay, transition_mask]
|
|
11188
|
+
|
|
11189
|
+
CapabilityProduces:
|
|
11190
|
+
description: |
|
|
11191
|
+
How an operation derives its output media type, for forward
|
|
11192
|
+
output-propagation through a chain. Exactly one form:
|
|
11193
|
+
- `same_as_input: true` — output mirrors the input format
|
|
11194
|
+
(e.g. watermark, passthrough).
|
|
11195
|
+
- `from_option: <option>` — output format is taken from the
|
|
11196
|
+
named option's resolved value (e.g. `output_format`,
|
|
11197
|
+
`output_type`, `format`).
|
|
11198
|
+
- `fixed: <format>` — output is always this concrete format
|
|
11199
|
+
(e.g. `audio_to_video` always produces `mp4`).
|
|
11200
|
+
oneOf:
|
|
11201
|
+
- type: object
|
|
11202
|
+
additionalProperties: false
|
|
11203
|
+
required: [same_as_input]
|
|
11204
|
+
properties:
|
|
11205
|
+
same_as_input:
|
|
11206
|
+
type: boolean
|
|
11207
|
+
enum: [true]
|
|
11208
|
+
- type: object
|
|
11209
|
+
additionalProperties: false
|
|
11210
|
+
required: [from_option]
|
|
11211
|
+
properties:
|
|
11212
|
+
from_option:
|
|
11213
|
+
type: string
|
|
11214
|
+
- type: object
|
|
11215
|
+
additionalProperties: false
|
|
11216
|
+
required: [fixed]
|
|
11217
|
+
properties:
|
|
11218
|
+
fixed:
|
|
11219
|
+
type: string
|
|
11220
|
+
|
|
11221
|
+
CapabilityConstraint:
|
|
11222
|
+
type: object
|
|
11223
|
+
description: |
|
|
11224
|
+
A single capability constraint (member of `excludes` /
|
|
11225
|
+
`requires` / `option_conflicts`). The `when` condition is
|
|
11226
|
+
evaluated against the resolved operation + sibling-operation
|
|
11227
|
+
context; when it holds, the constraint fires.
|
|
11228
|
+
required:
|
|
11229
|
+
- constraint_id
|
|
11230
|
+
- message
|
|
11231
|
+
- wire_code
|
|
11232
|
+
- when
|
|
11233
|
+
properties:
|
|
11234
|
+
constraint_id:
|
|
11235
|
+
type: string
|
|
11236
|
+
description: Stable identifier for the constraint (for logs / docs / tests).
|
|
11237
|
+
message:
|
|
11238
|
+
type: string
|
|
11239
|
+
description: |
|
|
11240
|
+
Human-readable rejection message. MAY contain `{placeholder}`
|
|
11241
|
+
tokens (e.g. `{output_format}`) the API interpolates at
|
|
11242
|
+
evaluation time.
|
|
11243
|
+
wire_code:
|
|
11244
|
+
type: string
|
|
11245
|
+
description: |
|
|
11246
|
+
Error code emitted when the constraint fires. Aligns with the
|
|
11247
|
+
error envelope `error_code` vocabulary.
|
|
11248
|
+
enum:
|
|
11249
|
+
- feature_not_available
|
|
11250
|
+
- invalid_options
|
|
11251
|
+
- INVALID_OPERATION_ORDER
|
|
11252
|
+
- OPERATION_NOT_VALID_FOR_OUTPUT
|
|
11253
|
+
when:
|
|
11254
|
+
$ref: '#/components/schemas/CapabilityCondition'
|
|
11255
|
+
availability:
|
|
11256
|
+
$ref: '#/components/schemas/AvailabilityValue'
|
|
11257
|
+
eval_scope:
|
|
11258
|
+
type: string
|
|
11259
|
+
description: |
|
|
11260
|
+
Where the constraint is evaluated. `api` marks constraints the
|
|
11261
|
+
API create-path enforces (vs purely-advisory ones consumers
|
|
11262
|
+
mirror for UX). Absent ⇒ unscoped/advisory.
|
|
11263
|
+
enum: [api]
|
|
11264
|
+
requires_field:
|
|
11265
|
+
type: string
|
|
11266
|
+
description: |
|
|
11267
|
+
Only on `requires` constraints — the field path that must be
|
|
11268
|
+
present when `when` holds (e.g. `compress.target_size_bytes`).
|
|
11269
|
+
|
|
11270
|
+
CapabilityCondition:
|
|
11271
|
+
description: |
|
|
11272
|
+
Recursive condition node (the `Cond` field-token model, ADR-0024
|
|
11273
|
+
§2). Exactly ONE form per node — a boolean combinator (`all` /
|
|
11274
|
+
`any` / `not`) OR a single leaf test. A leaf tests one `field`
|
|
11275
|
+
token with exactly one operator (`equals` / `in` / `isSet`),
|
|
11276
|
+
except `opSelected` which is a standalone leaf asserting a
|
|
11277
|
+
sibling operation of that type is present in the job. Consumers
|
|
11278
|
+
compute field tokens locally from the resolved request (no new
|
|
11279
|
+
wire field). Modelled as a `oneOf` of the valid forms (each
|
|
11280
|
+
`additionalProperties: false`) so the grammar is enforced rather
|
|
11281
|
+
than advertised as a loose bag of optional keys.
|
|
11282
|
+
oneOf:
|
|
11283
|
+
- type: object
|
|
11284
|
+
additionalProperties: false
|
|
11285
|
+
required: [all]
|
|
11286
|
+
properties:
|
|
11287
|
+
all:
|
|
11288
|
+
type: array
|
|
11289
|
+
description: All sub-conditions must hold (logical AND).
|
|
11290
|
+
items:
|
|
11291
|
+
$ref: '#/components/schemas/CapabilityCondition'
|
|
11292
|
+
- type: object
|
|
11293
|
+
additionalProperties: false
|
|
11294
|
+
required: [any]
|
|
11295
|
+
properties:
|
|
11296
|
+
any:
|
|
11297
|
+
type: array
|
|
11298
|
+
description: At least one sub-condition must hold (logical OR).
|
|
11299
|
+
items:
|
|
11300
|
+
$ref: '#/components/schemas/CapabilityCondition'
|
|
11301
|
+
- type: object
|
|
11302
|
+
additionalProperties: false
|
|
11303
|
+
required: [not]
|
|
11304
|
+
properties:
|
|
11305
|
+
not:
|
|
11306
|
+
$ref: '#/components/schemas/CapabilityCondition'
|
|
11307
|
+
- type: object
|
|
11308
|
+
additionalProperties: false
|
|
11309
|
+
required: [field, equals]
|
|
11310
|
+
properties:
|
|
11311
|
+
field:
|
|
11312
|
+
type: string
|
|
11313
|
+
description: Field token under test (e.g. `output_format`, `compress.encoding_mode`).
|
|
11314
|
+
equals:
|
|
11315
|
+
description: Leaf test — `field` equals this value (string or boolean).
|
|
11316
|
+
- type: object
|
|
11317
|
+
additionalProperties: false
|
|
11318
|
+
required: [field, in]
|
|
11319
|
+
properties:
|
|
11320
|
+
field:
|
|
11321
|
+
type: string
|
|
11322
|
+
description: Field token under test.
|
|
11323
|
+
in:
|
|
11324
|
+
type: array
|
|
11325
|
+
description: Leaf test — `field` is one of these values.
|
|
11326
|
+
items: {}
|
|
11327
|
+
- type: object
|
|
11328
|
+
additionalProperties: false
|
|
11329
|
+
required: [field, isSet]
|
|
11330
|
+
properties:
|
|
11331
|
+
field:
|
|
11332
|
+
type: string
|
|
11333
|
+
description: Field token under test.
|
|
11334
|
+
isSet:
|
|
11335
|
+
type: boolean
|
|
11336
|
+
enum: [true]
|
|
11337
|
+
description: |
|
|
11338
|
+
Leaf test — asserts `field` is present/set. Only the
|
|
11339
|
+
positive form is used; negate via a wrapping `not` node.
|
|
11340
|
+
- type: object
|
|
11341
|
+
additionalProperties: false
|
|
11342
|
+
required: [opSelected]
|
|
11343
|
+
properties:
|
|
11344
|
+
opSelected:
|
|
11345
|
+
type: string
|
|
11346
|
+
description: |
|
|
11347
|
+
Standalone leaf — true when a sibling operation of this
|
|
11348
|
+
type is selected in the same job (e.g. `compress`,
|
|
11349
|
+
`convert`).
|
|
11350
|
+
|
|
11351
|
+
OutputProperties:
|
|
11352
|
+
type: object
|
|
11353
|
+
description: |
|
|
11354
|
+
Media facts for one output format, backing forward
|
|
11355
|
+
output-propagation in the capability model.
|
|
11356
|
+
required:
|
|
11357
|
+
- hasAudioTrack
|
|
11358
|
+
- isAnimated
|
|
11359
|
+
properties:
|
|
11360
|
+
hasAudioTrack:
|
|
11361
|
+
type: boolean
|
|
11362
|
+
description: Whether this format carries an audio stream.
|
|
11363
|
+
isAnimated:
|
|
11364
|
+
description: |
|
|
11365
|
+
Whether output of this format is animated. `true` / `false`
|
|
11366
|
+
for formats that are always one or the other; `"maybe"` for
|
|
11367
|
+
formats that can be either (e.g. GIF, WebP).
|
|
11368
|
+
oneOf:
|
|
11369
|
+
- type: boolean
|
|
11370
|
+
- type: string
|
|
11371
|
+
enum: [maybe]
|
|
10974
11372
|
|
|
10975
11373
|
EndpointProjection:
|
|
10976
11374
|
type: object
|