diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index e6d1ed0d..1f360ba2 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -3,11 +3,14 @@ LICENSE.txt Makefile README.md +docs/AboutApi.md docs/ActiveEventData.md docs/ActiveEventSSE.md docs/ActiveEventSSEEvent.md +docs/AltEmbeddedVersionIKfservingResponseV2.md +docs/AltEmbeddedVersionIPlugResponseV2.md +docs/AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2.md docs/AltVersionHALLink.md -docs/AnyFunctionResponse.md docs/AnyJobForFunction.md docs/AnyJobResult.md docs/AnyJobStatus.md @@ -16,17 +19,10 @@ docs/ArchiveFormat.md docs/AssetCondition.md docs/AssetConditionContentType.md docs/AssetConditionPattern.md -docs/AssetPathParamsV2.md docs/AssetRole.md -docs/AssetSummary.md docs/AssetSummaryWithHALLink.md docs/AssetSummaryWithHALLinkLinks.md docs/AssetsConditions.md -docs/AsyncDeployQuery.md -docs/AsyncDeployQueryV1.md -docs/AsyncQueryDefaultFalse.md -docs/AsyncQueryDefaultTrue.md -docs/AsyncVerifyQuery.md docs/Batch.md docs/BatchArgs.md docs/BatchJobStatus.md @@ -44,13 +40,8 @@ docs/CompiledRuntimeVersion.md docs/CompletedEventData.md docs/CompletedEventSSE.md docs/CompletedEventSSEEvent.md -docs/ContentQueryV2.md docs/ContentValidationListing.md -docs/CreateFunctionQueryV2.md -docs/CreateKFServingAsyncResponse.md -docs/CreatePlugAsyncResponse.md -docs/CreateWebscriptAsyncResponse.md -docs/DefaultApi.md +docs/CreateWebscriptsCopyParameter.md docs/DelayedEventData.md docs/DelayedEventSSE.md docs/DelayedEventSSEEvent.md @@ -58,74 +49,44 @@ docs/Deploy.md docs/Deploy1.md docs/DeployArgs.md docs/DeployArgsDeploySpecOverrides.md -docs/DeployAttributesFilter.md docs/DeployJobStatus.md docs/DeployResult.md docs/DeploySpec.md docs/DeploySpecOpenfaasSpec.md docs/DeployType.md docs/DeprecatePreviousPolicy.md -docs/DeprecatePreviousQuery.md -docs/DeprecatedDraftFilter.md docs/Documentation.md docs/DocumentationProperty.md -docs/DryRunQuery.md -docs/EntityResponse.md -docs/ErrorAndStatusResponse.md -docs/ErrorResponse.md +docs/EntityWithLinksIKfservingResponseV2.md +docs/EntityWithLinksIPlugResponseV2.md +docs/EntityWithLinksIWebscriptResponseWithInvokeLinkV2.md docs/EventAck.md docs/EventClose.md docs/EventKeepAlive.md -docs/EventSSE.md -docs/EventTypeSSE.md docs/EventWithCloseSSE.md +docs/ExampleReference.md docs/ExposedOpenfaasDeploySpec.md docs/FailedEventData.md docs/FailedEventSSE.md docs/FailedEventSSEEvent.md docs/FailureReason.md docs/FileUpload.md -docs/ForceDeleteQueryV1.md -docs/FunctionDeleteQuery.md -docs/FunctionDeployOverrides.md docs/FunctionDeployOverridesType.md -docs/FunctionEntityQuery.md -docs/FunctionJobArgs.md -docs/FunctionManifest.md docs/FunctionMeta.md -docs/FunctionNameVersion.md docs/FunctionRef.md -docs/FunctionSpec.md docs/FunctionType.md -docs/FunctionVersionQuery.md -docs/GetContentParamsV2.md -docs/GetInvokableWebscriptQuery.md docs/GetModelResponseV2.md docs/GetPlugResponseV2.md docs/GetPlugResponseV2Links.md docs/GetPlugResponseV2LinksDraft.md docs/GetPlugResponseV2LinksPublished.md -docs/GetRuntimeByNameAndVersionQuery.md -docs/GetRuntimeByNameQuery.md -docs/GetRuntimeExampleQuery.md -docs/GetRuntimeVersionsQuery.md docs/GetWebscriptResponseV2.md docs/GetWebscriptResponseV2Links.md docs/HALLink.md -docs/InvokableWebscriptResponse.md -docs/InvokableWebscriptResponseEntity.md -docs/InvokableWebscriptResponseEntityWebscript.md docs/InvokeHALLink.md -docs/InvokeInternalHALLink.md docs/JobAndFunctionHALLink.md docs/JobCause.md docs/JobCauses.md -docs/JobEventPayloadActiveEventData.md -docs/JobEventPayloadCompletedEventData.md -docs/JobEventPayloadDelayedEventData.md -docs/JobEventPayloadFailedEventData.md -docs/JobEventPayloadWaitingChildrenEventData.md -docs/JobEventPayloadWaitingEventData.md docs/JobEventResponseActiveEventData.md docs/JobEventResponseCompletedEventData.md docs/JobEventResponseDelayedEventData.md @@ -134,12 +95,9 @@ docs/JobEventResponseWaitingChildrenEventData.md docs/JobEventResponseWaitingEventData.md docs/JobEventSSE.md docs/JobEventsAndFunctionHALLink.md -docs/JobEventsFilterQuery.md docs/JobEventsHALLink.md docs/JobHALLinks.md -docs/JobQuery.md docs/JobReference.md -docs/JobReferenceParams.md docs/JobResponse.md docs/JobState.md docs/JobStateActive.md @@ -155,11 +113,11 @@ docs/JobStatus.md docs/JobStatusAndEntityHALLinks.md docs/JobStatusHALLink.md docs/JobStatusProgress.md -docs/JobSubmittedResponse.md docs/JobType.md docs/JobTypeBatch.md docs/JobTypeBuild.md docs/JobTypeDeploy.md +docs/JobTypeNotify.md docs/JobTypeScale.md docs/JobTypeSchema.md docs/JobTypeUndeploy.md @@ -171,118 +129,37 @@ docs/JobsForPlugResponseV2.md docs/JobsForPlugResponseV2Links.md docs/JobsForWebscriptResponseV2.md docs/JobsForWebscriptResponseV2Links.md -docs/JobsHALLink.md docs/JobsResponse.md -docs/KFServingDeleteMultipleResponse.md -docs/KFServingDeleteMultipleWithJobResponse.md -docs/KFServingDeleteQueryV1.md -docs/KFServingDeleteQueryV2.md -docs/KFServingDeleteResponse.md -docs/KFServingDeleteWithJobResponse.md -docs/KFServingLatestVersionQueryV2.md -docs/KFServingLatestVersionsQueryV1.md -docs/KFServingLatestVersionsQueryV2.md docs/KFServingManifest.md -docs/KFServingModelsResponse.md -docs/KFServingResponse.md -docs/KFServingVersionsQueryV1.md docs/KeepAliveEventSSE.md docs/KfservingResponseV2.md docs/LanguageRelease.md -docs/LatestFunctionVersionsQuery.md -docs/LatestFunctionsQuery.md docs/LatestModelsResponseV2.md -docs/LatestModelsResponseV2EntitiesInner.md -docs/LatestPlugQuery.md -docs/LatestPlugVersionQueryV2.md -docs/LatestPlugVersionsQuery.md -docs/LatestPlugVersionsQueryV2.md -docs/LatestPlugsQuery.md docs/LatestPlugsResponseV2.md -docs/LatestPlugsResponseV2EntitiesInner.md docs/LatestVersionLevel.md docs/LatestWebscriptsResponseV2.md -docs/LatestWebscriptsResponseV2EntitiesInner.md -docs/LegacyConfigurationObject.md -docs/LegacyConfigurationObjectFormat.md -docs/LegacyConfigurationResponseObject.md -docs/LegacyCreateDebugResponse.md -docs/LegacyDebugPlugManifest.md -docs/LegacyDebugPlugRequest.md -docs/LegacyDocumentation.md -docs/LegacyDocumentationRequest.md -docs/LegacyFunctionMeta.md -docs/LegacyPlugCreateQuery.md -docs/LegacyPlugCreateRequest.md -docs/LegacyPlugCreateResponse.md -docs/LegacyPlugMetaRequest.md -docs/LegacyPlugQuery.md -docs/LegacyPlugRequest.md -docs/LegacyPlugRequestMetadata.md -docs/LegacyPlugRequestMetadataDocumentation.md -docs/LegacyPlugRequestMetadataDocumentationAnyOf.md -docs/LegacyPlugRequestMetadataRawDataInner.md -docs/LegacyPlugResponse.md -docs/LegacyPlugResponseMetadata.md -docs/LegacyPlugScriptMeta.md -docs/LegacyPlugScriptMetaRawDataInner.md -docs/LegacyPlugScriptResponse.md -docs/LegacyRequiredPropertiesInner.md -docs/LegacyRequiredPropertyObject.md -docs/LimitQuery.md -docs/MediaType.md -docs/MessageAndStatusResponse.md -docs/MessageResponse.md docs/Model.md docs/Model1.md docs/Model2.md -docs/ModelFunctionsApi.md docs/ModelVersionsResponseV2.md -docs/MultipartFileUpload.md -docs/Name.md -docs/NameAndVersion.md -docs/NamedFunctionVersionsQuery.md -docs/NamedKFServingVersionsQueryV2.md -docs/NamedParametersTypeofAsJobReference.md -docs/NamedParametersTypeofAsJobReferenceJobStatus.md -docs/NamedParametersTypeofFromLegacy.md -docs/NamedParametersTypeofFromLegacyDocumentation.md -docs/NamedParametersTypeofIsNotLegacy.md -docs/NamedPlugVersionsQueryV2.md -docs/NamedVersionsFilter.md -docs/NamedWebscriptVersionsQueryV2.md -docs/OpenfaasDeployArgs.md -docs/OpenfaasFunctionRef.md +docs/ModelsApi.md +docs/NotifyResult.md docs/Operation.md -docs/Operation.md -docs/OperationStatus.md -docs/OperationStatusError.md -docs/PagingQuery.md -docs/PagingResponse.md docs/ParentKeys.md -docs/PatchInterfaceQuery.md -docs/PatchMetadataQuery.md -docs/PatchPlugRequestV1.md docs/Plug.md docs/Plug1.md docs/Plug2.md -docs/PlugDeleteForceQuery.md -docs/PlugDeleteQuery.md -docs/PlugFunctionsApi.md docs/PlugInterface.md -docs/PlugListingAndQueryResponse.md -docs/PlugListingResponse.md docs/PlugManifest.md docs/PlugMeta.md docs/PlugProperty.md docs/PlugPropertyDataType.md docs/PlugPropertyFormat.md docs/PlugPropertyFormatType.md -docs/PlugResponse.md docs/PlugResponseV2.md docs/PlugType.md -docs/PlugTypeQuery.md docs/PlugVersionsResponseV2.md +docs/PlugsApi.md docs/PostModelJobAsyncResponseV2.md docs/PostModelJobSyncResponseV2.md docs/PostPlugJobAsyncResponseV2.md @@ -290,64 +167,41 @@ docs/PostPlugJobSyncResponseV2.md docs/PostWebscriptJobAsyncResponseV2.md docs/PostWebscriptJobSyncResponseV2.md docs/ProvidedDependency.md -docs/PublishFunctionQuery.md docs/QueueEvents.md -docs/RebuildComputedResponse.md docs/RebuildModelAsyncResponseV2.md docs/RebuildModelSyncResponseV2.md docs/RebuildPlugAsyncResponseV2.md docs/RebuildPlugSyncResponseV2.md docs/RebuildPolicy.md -docs/RebuildQueryParams.md -docs/RebuildQueryV2.md -docs/RebuildSubmittedResponse.md docs/RebuildWebscriptAsyncResponseV2.md docs/RebuildWebscriptSyncResponseV2.md -docs/RemoveFunctionQueryV2.md -docs/RemovePlugQueryV2.md +docs/RegistryErrorResponse.md docs/RequestOperation.md docs/ResourceLimits.md docs/RootPageResponse.md docs/RuntimeAttributes.md -docs/RuntimeInfo.md -docs/RuntimeNameQuery.md -docs/RuntimeParams.md -docs/RuntimeQuery.md -docs/RuntimeReference.md -docs/RuntimeSpecification.md docs/RuntimeSummary.md -docs/RuntimeSummaryAttrs.md docs/RuntimeSummaryResponse.md -docs/RuntimeVersionAndPathParams.md docs/RuntimeVersionInfo.md -docs/RuntimeVersionParams.md -docs/RuntimeVersionQuery.md docs/RuntimeVersionResponse.md -docs/RuntimeVersionSpecification.md -docs/RuntimeVersionStatus.md -docs/RuntimeVersionSummary.md docs/RuntimesApi.md docs/Scale.md docs/Scale1.md docs/ScaleArgs.md docs/ScaleJobStatus.md docs/ScaleType.md -docs/SchemaByIdParams.md -docs/SchemaParams.md docs/SchemasApi.md docs/SemanticVersionRange.md +docs/ShowRelatedType.md docs/Status.md docs/StatusAny.md +docs/StatusExclude.md docs/StatusFilter.md docs/StatusInclude.md -docs/StatusResponse.md docs/StreamClosing.md docs/StreamReady.md -docs/SupportedEvents.md docs/Tag.md -docs/TagQuery.md docs/TagsFilter.md -docs/TagsQuery.md docs/TimestampAbsolute.md docs/TimestampAge.md docs/TimestampSpec.md @@ -359,27 +213,17 @@ docs/UndeployResult.md docs/UndeploySubmittedResponseV2.md docs/UndeployType.md docs/UndeployedResponseV2.md -docs/UnhealthyInvokableWebscriptError.md -docs/UpdateComment.md -docs/UpdateDraftQuery.md -docs/UpdateMetadataRequestV1.md docs/UpdateMetadataRequestV2.md docs/UpdateRecord.md -docs/UserPlugMeta.md docs/Verify.md docs/Verify1.md docs/VerifyArgs.md docs/VerifyJobStatus.md docs/VerifyModelSyncResponseV2.md docs/VerifyPlugSyncResponseV2.md -docs/VerifyQueryV1.md docs/VerifyResult.md docs/VerifyType.md docs/VerifyWebscriptSyncResponseV2.md -docs/VersionIncludes.md -docs/VersionsQuery.md -docs/VersionsQueryV2.md -docs/VersionsResponseV2.md docs/WaitingChildrenEventSSE.md docs/WaitingChildrenEventSSEEvent.md docs/WaitingEventData.md @@ -388,38 +232,32 @@ docs/WaitingEventSSEEvent.md docs/Webscript.md docs/Webscript1.md docs/Webscript2.md -docs/WebscriptFunctionsApi.md -docs/WebscriptLatestVersionQueryV2.md -docs/WebscriptLatestVersionsQueryV1.md -docs/WebscriptLatestVersionsQueryV2.md docs/WebscriptManifest.md -docs/WebscriptResponse.md docs/WebscriptResponseV2.md docs/WebscriptResponseWithInvokeLinkV2.md docs/WebscriptVersionsResponseV2.md -docs/WithAssetHALLink.md -docs/WithEntityAttributes.md -docs/WithLimit.md -docs/WithPaging.md +docs/WebscriptsApi.md pyproject.toml requirements.txt test/__init__.py test/api/__init__.py -test/api/default_api_test.py +test/api/about_api_test.py test/api/jobs_api_test.py -test/api/model_functions_api_test.py -test/api/plug_functions_api_test.py +test/api/models_api_test.py +test/api/plugs_api_test.py test/api/runtimes_api_test.py test/api/schemas_api_test.py -test/api/webscript_functions_api_test.py +test/api/webscripts_api_test.py test/conftest.py test/openapi.py test/types/__init__.py test/types/active_event_data_stub.py test/types/active_event_sse_event_stub.py test/types/active_event_sse_stub.py +test/types/alt_embedded_version_i_kfserving_response_v2_stub.py +test/types/alt_embedded_version_i_plug_response_v2_stub.py +test/types/alt_embedded_version_i_webscript_response_with_invoke_link_v2_stub.py test/types/alt_version_hal_link_stub.py -test/types/any_function_response_stub.py test/types/any_job_for_function_stub.py test/types/any_job_result_stub.py test/types/any_job_status_stub.py @@ -428,17 +266,10 @@ test/types/archive_format_stub.py test/types/asset_condition_content_type_stub.py test/types/asset_condition_pattern_stub.py test/types/asset_condition_stub.py -test/types/asset_path_params_v2_stub.py test/types/asset_role_stub.py -test/types/asset_summary_stub.py test/types/asset_summary_with_hal_link_links_stub.py test/types/asset_summary_with_hal_link_stub.py test/types/assets_conditions_stub.py -test/types/async_deploy_query_stub.py -test/types/async_deploy_query_v1_stub.py -test/types/async_query_default_false_stub.py -test/types/async_query_default_true_stub.py -test/types/async_verify_query_stub.py test/types/batch_args_stub.py test/types/batch_job_status_stub.py test/types/batch_job_status_type_stub.py @@ -456,19 +287,14 @@ test/types/compiled_runtime_version_stub.py test/types/completed_event_data_stub.py test/types/completed_event_sse_event_stub.py test/types/completed_event_sse_stub.py -test/types/content_query_v2_stub.py test/types/content_validation_listing_stub.py -test/types/create_function_query_v2_stub.py -test/types/create_kf_serving_async_response_stub.py -test/types/create_plug_async_response_stub.py -test/types/create_webscript_async_response_stub.py +test/types/create_webscripts_copy_parameter_stub.py test/types/delayed_event_data_stub.py test/types/delayed_event_sse_event_stub.py test/types/delayed_event_sse_stub.py test/types/deploy1_stub.py test/types/deploy_args_deploy_spec_overrides_stub.py test/types/deploy_args_stub.py -test/types/deploy_attributes_filter_stub.py test/types/deploy_job_status_stub.py test/types/deploy_result_stub.py test/types/deploy_spec_openfaas_spec_stub.py @@ -476,67 +302,38 @@ test/types/deploy_spec_stub.py test/types/deploy_stub.py test/types/deploy_type_stub.py test/types/deprecate_previous_policy_stub.py -test/types/deprecate_previous_query_stub.py -test/types/deprecated_draft_filter_stub.py test/types/documentation_property_stub.py test/types/documentation_stub.py -test/types/dry_run_query_stub.py -test/types/entity_response_stub.py -test/types/error_and_status_response_stub.py -test/types/error_response_stub.py +test/types/entity_with_links_i_kfserving_response_v2_stub.py +test/types/entity_with_links_i_plug_response_v2_stub.py +test/types/entity_with_links_i_webscript_response_with_invoke_link_v2_stub.py test/types/event_ack_stub.py test/types/event_close_stub.py test/types/event_keep_alive_stub.py -test/types/event_sse_stub.py -test/types/event_type_sse_stub.py test/types/event_with_close_sse_stub.py +test/types/example_reference_stub.py test/types/exposed_openfaas_deploy_spec_stub.py test/types/failed_event_data_stub.py test/types/failed_event_sse_event_stub.py test/types/failed_event_sse_stub.py test/types/failure_reason_stub.py test/types/file_upload_stub.py -test/types/force_delete_query_v1_stub.py -test/types/function_delete_query_stub.py -test/types/function_deploy_overrides_stub.py test/types/function_deploy_overrides_type_stub.py -test/types/function_entity_query_stub.py -test/types/function_job_args_stub.py -test/types/function_manifest_stub.py test/types/function_meta_stub.py -test/types/function_name_version_stub.py test/types/function_ref_stub.py -test/types/function_spec_stub.py test/types/function_type_stub.py -test/types/function_version_query_stub.py -test/types/get_content_params_v2_stub.py -test/types/get_invokable_webscript_query_stub.py test/types/get_model_response_v2_stub.py test/types/get_plug_response_v2_links_draft_stub.py test/types/get_plug_response_v2_links_published_stub.py test/types/get_plug_response_v2_links_stub.py test/types/get_plug_response_v2_stub.py -test/types/get_runtime_by_name_and_version_query_stub.py -test/types/get_runtime_by_name_query_stub.py -test/types/get_runtime_example_query_stub.py -test/types/get_runtime_versions_query_stub.py test/types/get_webscript_response_v2_links_stub.py test/types/get_webscript_response_v2_stub.py test/types/hal_link_stub.py -test/types/invokable_webscript_response_entity_stub.py -test/types/invokable_webscript_response_entity_webscript_stub.py -test/types/invokable_webscript_response_stub.py test/types/invoke_hal_link_stub.py -test/types/invoke_internal_hal_link_stub.py test/types/job_and_function_hal_link_stub.py test/types/job_cause_stub.py test/types/job_causes_stub.py -test/types/job_event_payload_active_event_data_stub.py -test/types/job_event_payload_completed_event_data_stub.py -test/types/job_event_payload_delayed_event_data_stub.py -test/types/job_event_payload_failed_event_data_stub.py -test/types/job_event_payload_waiting_children_event_data_stub.py -test/types/job_event_payload_waiting_event_data_stub.py test/types/job_event_response_active_event_data_stub.py test/types/job_event_response_completed_event_data_stub.py test/types/job_event_response_delayed_event_data_stub.py @@ -545,11 +342,8 @@ test/types/job_event_response_waiting_children_event_data_stub.py test/types/job_event_response_waiting_event_data_stub.py test/types/job_event_sse_stub.py test/types/job_events_and_function_hal_link_stub.py -test/types/job_events_filter_query_stub.py test/types/job_events_hal_link_stub.py test/types/job_hal_links_stub.py -test/types/job_query_stub.py -test/types/job_reference_params_stub.py test/types/job_reference_stub.py test/types/job_response_stub.py test/types/job_state_active_stub.py @@ -566,10 +360,10 @@ test/types/job_status_and_entity_hal_links_stub.py test/types/job_status_hal_link_stub.py test/types/job_status_progress_stub.py test/types/job_status_stub.py -test/types/job_submitted_response_stub.py test/types/job_type_batch_stub.py test/types/job_type_build_stub.py test/types/job_type_deploy_stub.py +test/types/job_type_notify_stub.py test/types/job_type_scale_stub.py test/types/job_type_schema_stub.py test/types/job_type_stub.py @@ -581,113 +375,32 @@ test/types/jobs_for_plug_response_v2_links_stub.py test/types/jobs_for_plug_response_v2_stub.py test/types/jobs_for_webscript_response_v2_links_stub.py test/types/jobs_for_webscript_response_v2_stub.py -test/types/jobs_hal_link_stub.py test/types/jobs_response_stub.py test/types/keep_alive_event_sse_stub.py -test/types/kf_serving_delete_multiple_response_stub.py -test/types/kf_serving_delete_multiple_with_job_response_stub.py -test/types/kf_serving_delete_query_v1_stub.py -test/types/kf_serving_delete_query_v2_stub.py -test/types/kf_serving_delete_response_stub.py -test/types/kf_serving_delete_with_job_response_stub.py -test/types/kf_serving_latest_version_query_v2_stub.py -test/types/kf_serving_latest_versions_query_v1_stub.py -test/types/kf_serving_latest_versions_query_v2_stub.py test/types/kf_serving_manifest_stub.py -test/types/kf_serving_models_response_stub.py -test/types/kf_serving_response_stub.py -test/types/kf_serving_versions_query_v1_stub.py test/types/kfserving_response_v2_stub.py test/types/language_release_stub.py -test/types/latest_function_versions_query_stub.py -test/types/latest_functions_query_stub.py -test/types/latest_models_response_v2_entities_inner_stub.py test/types/latest_models_response_v2_stub.py -test/types/latest_plug_query_stub.py -test/types/latest_plug_version_query_v2_stub.py -test/types/latest_plug_versions_query_stub.py -test/types/latest_plug_versions_query_v2_stub.py -test/types/latest_plugs_query_stub.py -test/types/latest_plugs_response_v2_entities_inner_stub.py test/types/latest_plugs_response_v2_stub.py test/types/latest_version_level_stub.py -test/types/latest_webscripts_response_v2_entities_inner_stub.py test/types/latest_webscripts_response_v2_stub.py -test/types/legacy_configuration_object_format_stub.py -test/types/legacy_configuration_object_stub.py -test/types/legacy_configuration_response_object_stub.py -test/types/legacy_create_debug_response_stub.py -test/types/legacy_debug_plug_manifest_stub.py -test/types/legacy_debug_plug_request_stub.py -test/types/legacy_documentation_request_stub.py -test/types/legacy_documentation_stub.py -test/types/legacy_function_meta_stub.py -test/types/legacy_plug_create_query_stub.py -test/types/legacy_plug_create_request_stub.py -test/types/legacy_plug_create_response_stub.py -test/types/legacy_plug_meta_request_stub.py -test/types/legacy_plug_query_stub.py -test/types/legacy_plug_request_metadata_documentation_any_of_stub.py -test/types/legacy_plug_request_metadata_documentation_stub.py -test/types/legacy_plug_request_metadata_raw_data_inner_stub.py -test/types/legacy_plug_request_metadata_stub.py -test/types/legacy_plug_request_stub.py -test/types/legacy_plug_response_metadata_stub.py -test/types/legacy_plug_response_stub.py -test/types/legacy_plug_script_meta_raw_data_inner_stub.py -test/types/legacy_plug_script_meta_stub.py -test/types/legacy_plug_script_response_stub.py -test/types/legacy_required_properties_inner_stub.py -test/types/legacy_required_property_object_stub.py -test/types/limit_query_stub.py -test/types/media_type_stub.py -test/types/message_and_status_response_stub.py -test/types/message_response_stub.py test/types/model1_stub.py test/types/model2_stub.py test/types/model_stub.py test/types/model_versions_response_v2_stub.py -test/types/multipart_file_upload_stub.py -test/types/name_and_version_stub.py -test/types/name_stub.py -test/types/named_function_versions_query_stub.py -test/types/named_kf_serving_versions_query_v2_stub.py -test/types/named_parameters_typeof_as_job_reference_job_status_stub.py -test/types/named_parameters_typeof_as_job_reference_stub.py -test/types/named_parameters_typeof_from_legacy_documentation_stub.py -test/types/named_parameters_typeof_from_legacy_stub.py -test/types/named_parameters_typeof_is_not_legacy_stub.py -test/types/named_plug_versions_query_v2_stub.py -test/types/named_versions_filter_stub.py -test/types/named_webscript_versions_query_v2_stub.py -test/types/openfaas_deploy_args_stub.py -test/types/openfaas_function_ref_stub.py -test/types/operation_status_error_stub.py -test/types/operation_status_stub.py -test/types/operation_stub.py -test/types/paging_query_stub.py -test/types/paging_response_stub.py +test/types/notify_result_stub.py test/types/parent_keys_stub.py -test/types/patch_interface_query_stub.py -test/types/patch_metadata_query_stub.py -test/types/patch_plug_request_v1_stub.py test/types/plug1_stub.py test/types/plug2_stub.py -test/types/plug_delete_force_query_stub.py -test/types/plug_delete_query_stub.py test/types/plug_interface_stub.py -test/types/plug_listing_and_query_response_stub.py -test/types/plug_listing_response_stub.py test/types/plug_manifest_stub.py test/types/plug_meta_stub.py test/types/plug_property_data_type_stub.py test/types/plug_property_format_stub.py test/types/plug_property_format_type_stub.py test/types/plug_property_stub.py -test/types/plug_response_stub.py test/types/plug_response_v2_stub.py test/types/plug_stub.py -test/types/plug_type_query_stub.py test/types/plug_type_stub.py test/types/plug_versions_response_v2_stub.py test/types/post_model_job_async_response_v2_stub.py @@ -697,62 +410,39 @@ test/types/post_plug_job_sync_response_v2_stub.py test/types/post_webscript_job_async_response_v2_stub.py test/types/post_webscript_job_sync_response_v2_stub.py test/types/provided_dependency_stub.py -test/types/publish_function_query_stub.py test/types/queue_events_stub.py -test/types/rebuild_computed_response_stub.py test/types/rebuild_model_async_response_v2_stub.py test/types/rebuild_model_sync_response_v2_stub.py test/types/rebuild_plug_async_response_v2_stub.py test/types/rebuild_plug_sync_response_v2_stub.py test/types/rebuild_policy_stub.py -test/types/rebuild_query_params_stub.py -test/types/rebuild_query_v2_stub.py -test/types/rebuild_submitted_response_stub.py test/types/rebuild_webscript_async_response_v2_stub.py test/types/rebuild_webscript_sync_response_v2_stub.py -test/types/remove_function_query_v2_stub.py -test/types/remove_plug_query_v2_stub.py +test/types/registry_error_response_stub.py test/types/request_operation_stub.py test/types/resource_limits_stub.py test/types/root_page_response_stub.py test/types/runtime_attributes_stub.py -test/types/runtime_info_stub.py -test/types/runtime_name_query_stub.py -test/types/runtime_params_stub.py -test/types/runtime_query_stub.py -test/types/runtime_reference_stub.py -test/types/runtime_specification_stub.py -test/types/runtime_summary_attrs_stub.py test/types/runtime_summary_response_stub.py test/types/runtime_summary_stub.py -test/types/runtime_version_and_path_params_stub.py test/types/runtime_version_info_stub.py -test/types/runtime_version_params_stub.py -test/types/runtime_version_query_stub.py test/types/runtime_version_response_stub.py -test/types/runtime_version_specification_stub.py -test/types/runtime_version_status_stub.py -test/types/runtime_version_summary_stub.py test/types/scale1_stub.py test/types/scale_args_stub.py test/types/scale_job_status_stub.py test/types/scale_stub.py test/types/scale_type_stub.py -test/types/schema_by_id_params_stub.py -test/types/schema_params_stub.py test/types/semantic_version_range_stub.py +test/types/show_related_type_stub.py test/types/status_any_stub.py +test/types/status_exclude_stub.py test/types/status_filter_stub.py test/types/status_include_stub.py -test/types/status_response_stub.py test/types/status_stub.py test/types/stream_closing_stub.py test/types/stream_ready_stub.py -test/types/supported_events_stub.py -test/types/tag_query_stub.py test/types/tag_stub.py test/types/tags_filter_stub.py -test/types/tags_query_stub.py test/types/timestamp_absolute_stub.py test/types/timestamp_age_stub.py test/types/timestamp_spec_stub.py @@ -764,27 +454,17 @@ test/types/undeploy_stub.py test/types/undeploy_submitted_response_v2_stub.py test/types/undeploy_type_stub.py test/types/undeployed_response_v2_stub.py -test/types/unhealthy_invokable_webscript_error_stub.py -test/types/update_comment_stub.py -test/types/update_draft_query_stub.py -test/types/update_metadata_request_v1_stub.py test/types/update_metadata_request_v2_stub.py test/types/update_record_stub.py -test/types/user_plug_meta_stub.py test/types/verify1_stub.py test/types/verify_args_stub.py test/types/verify_job_status_stub.py test/types/verify_model_sync_response_v2_stub.py test/types/verify_plug_sync_response_v2_stub.py -test/types/verify_query_v1_stub.py test/types/verify_result_stub.py test/types/verify_stub.py test/types/verify_type_stub.py test/types/verify_webscript_sync_response_v2_stub.py -test/types/version_includes_stub.py -test/types/versions_query_stub.py -test/types/versions_query_v2_stub.py -test/types/versions_response_v2_stub.py test/types/waiting_children_event_sse_event_stub.py test/types/waiting_children_event_sse_stub.py test/types/waiting_event_data_stub.py @@ -792,18 +472,10 @@ test/types/waiting_event_sse_event_stub.py test/types/waiting_event_sse_stub.py test/types/webscript1_stub.py test/types/webscript2_stub.py -test/types/webscript_latest_version_query_v2_stub.py -test/types/webscript_latest_versions_query_v1_stub.py -test/types/webscript_latest_versions_query_v2_stub.py test/types/webscript_manifest_stub.py -test/types/webscript_response_stub.py test/types/webscript_response_v2_stub.py test/types/webscript_response_with_invoke_link_v2_stub.py test/types/webscript_stub.py test/types/webscript_versions_response_v2_stub.py -test/types/with_asset_hal_link_stub.py -test/types/with_entity_attributes_stub.py -test/types/with_limit_stub.py -test/types/with_paging_stub.py waylay-sdk-registry-types/README.md waylay-sdk-registry/README.md diff --git a/README.md b/README.md index 47e20af4..1c16a20d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ V2 API to build and deploy Waylay functions (plugs, webscripts, BYOML models). This Python package is automatically generated based on the -Waylay Registry OpenAPI specification (API version: 2.12.4) +Waylay Registry OpenAPI specification (API version: 2.13.0) For more information, please visit [the openapi specification](https://docs.waylay.io/openapi/public/redocly/registry.html). It consists of two sub-packages that are both plugins for the waylay-sdk-core package. @@ -34,22 +34,16 @@ from waylay.sdk.api.api_exceptions import ApiError waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed -from waylay.services.registry.models.function_type import FunctionType -from waylay.services.registry.models.job_state_result import JobStateResult -from waylay.services.registry.models.job_type_schema import JobTypeSchema -from waylay.services.registry.models.jobs_response import JobsResponse +from waylay.services.registry.models.root_page_response import RootPageResponse try: - # List Jobs - # calls `GET /registry/v2/jobs/` - api_response = await waylay_client.registry.jobs.list( - # query parameters: - query = { - }, + # Get Service Status + # calls `GET /registry/v2/` + api_response = await waylay_client.registry.about.get( ) - print("The response of registry.jobs.list:\n") + print("The response of registry.about.get:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.jobs.list: %s\n" % e) + print("Exception when calling registry.about.get: %s\n" % e) ``` @@ -61,44 +55,45 @@ All URIs are relative to *https://api.waylay.io* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- +*AboutApi* | [**get**](docs/AboutApi.md#get) | **GET** /registry/v2/ | Get Service Status *JobsApi* | [**events**](docs/JobsApi.md#events) | **GET** /registry/v2/jobs/events | Stream Events *JobsApi* | [**get**](docs/JobsApi.md#get) | **GET** /registry/v2/jobs/{type}/{id} | Get Job *JobsApi* | [**list**](docs/JobsApi.md#list) | **GET** /registry/v2/jobs/ | List Jobs -*ModelFunctionsApi* | [**create**](docs/ModelFunctionsApi.md#create) | **POST** /registry/v2/models/ | Create Model -*ModelFunctionsApi* | [**delete_asset**](docs/ModelFunctionsApi.md#delete_asset) | **DELETE** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Delete Model Asset -*ModelFunctionsApi* | [**get_archive**](docs/ModelFunctionsApi.md#get_archive) | **GET** /registry/v2/models/{name}/versions/{version}/content | Get Model Archive -*ModelFunctionsApi* | [**get_asset**](docs/ModelFunctionsApi.md#get_asset) | **GET** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Get File From Model Archive -*ModelFunctionsApi* | [**get_latest**](docs/ModelFunctionsApi.md#get_latest) | **GET** /registry/v2/models/{name} | Get Latest Model Version -*ModelFunctionsApi* | [**get**](docs/ModelFunctionsApi.md#get) | **GET** /registry/v2/models/{name}/versions/{version} | Get Model Version -*ModelFunctionsApi* | [**jobs**](docs/ModelFunctionsApi.md#jobs) | **GET** /registry/v2/models/{name}/versions/{version}/jobs | List Model Jobs -*ModelFunctionsApi* | [**list**](docs/ModelFunctionsApi.md#list) | **GET** /registry/v2/models/ | List Models -*ModelFunctionsApi* | [**list_versions**](docs/ModelFunctionsApi.md#list_versions) | **GET** /registry/v2/models/{name}/versions | List Model Versions -*ModelFunctionsApi* | [**patch_metadata**](docs/ModelFunctionsApi.md#patch_metadata) | **PATCH** /registry/v2/models/{name}/versions/{version}/metadata | Patch Model Metadata -*ModelFunctionsApi* | [**publish**](docs/ModelFunctionsApi.md#publish) | **POST** /registry/v2/models/{name}/versions/{version}/publish | Publish Draft Model -*ModelFunctionsApi* | [**rebuild**](docs/ModelFunctionsApi.md#rebuild) | **POST** /registry/v2/models/{name}/versions/{version}/rebuild | Rebuild Model -*ModelFunctionsApi* | [**remove_version**](docs/ModelFunctionsApi.md#remove_version) | **DELETE** /registry/v2/models/{name}/versions/{version} | Remove Model Version -*ModelFunctionsApi* | [**remove_versions**](docs/ModelFunctionsApi.md#remove_versions) | **DELETE** /registry/v2/models/{name} | Remove Model -*ModelFunctionsApi* | [**update_asset**](docs/ModelFunctionsApi.md#update_asset) | **PUT** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Update Model Asset -*ModelFunctionsApi* | [**update_assets**](docs/ModelFunctionsApi.md#update_assets) | **PUT** /registry/v2/models/{name}/versions/{version}/content | Update Model Assets -*ModelFunctionsApi* | [**verify**](docs/ModelFunctionsApi.md#verify) | **POST** /registry/v2/models/{name}/versions/{version}/verify | Verify Health Of Model -*PlugFunctionsApi* | [**create**](docs/PlugFunctionsApi.md#create) | **POST** /registry/v2/plugs/ | Create Plug -*PlugFunctionsApi* | [**delete_asset**](docs/PlugFunctionsApi.md#delete_asset) | **DELETE** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Delete Plug Asset -*PlugFunctionsApi* | [**get_archive**](docs/PlugFunctionsApi.md#get_archive) | **GET** /registry/v2/plugs/{name}/versions/{version}/content | Get Plug Archive -*PlugFunctionsApi* | [**get_asset**](docs/PlugFunctionsApi.md#get_asset) | **GET** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Get File From Plug Archive -*PlugFunctionsApi* | [**get_latest**](docs/PlugFunctionsApi.md#get_latest) | **GET** /registry/v2/plugs/{name} | Get Latest Plug Version -*PlugFunctionsApi* | [**get**](docs/PlugFunctionsApi.md#get) | **GET** /registry/v2/plugs/{name}/versions/{version} | Get Plug Version -*PlugFunctionsApi* | [**jobs**](docs/PlugFunctionsApi.md#jobs) | **GET** /registry/v2/plugs/{name}/versions/{version}/jobs | List Plug Jobs -*PlugFunctionsApi* | [**list**](docs/PlugFunctionsApi.md#list) | **GET** /registry/v2/plugs/ | List Plugs -*PlugFunctionsApi* | [**list_versions**](docs/PlugFunctionsApi.md#list_versions) | **GET** /registry/v2/plugs/{name}/versions | List Plug Versions -*PlugFunctionsApi* | [**patch_interface**](docs/PlugFunctionsApi.md#patch_interface) | **PATCH** /registry/v2/plugs/{name}/versions/{version}/interface | Patch Plug Interface -*PlugFunctionsApi* | [**patch_metadata**](docs/PlugFunctionsApi.md#patch_metadata) | **PATCH** /registry/v2/plugs/{name}/versions/{version}/metadata | Patch Plug Metadata -*PlugFunctionsApi* | [**publish**](docs/PlugFunctionsApi.md#publish) | **POST** /registry/v2/plugs/{name}/versions/{version}/publish | Publish Draft Plug -*PlugFunctionsApi* | [**rebuild**](docs/PlugFunctionsApi.md#rebuild) | **POST** /registry/v2/plugs/{name}/versions/{version}/rebuild | Rebuild Plug -*PlugFunctionsApi* | [**remove_version**](docs/PlugFunctionsApi.md#remove_version) | **DELETE** /registry/v2/plugs/{name}/versions/{version} | Remove Plug Version -*PlugFunctionsApi* | [**remove_versions**](docs/PlugFunctionsApi.md#remove_versions) | **DELETE** /registry/v2/plugs/{name} | Remove Plug -*PlugFunctionsApi* | [**update_asset**](docs/PlugFunctionsApi.md#update_asset) | **PUT** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Update Plug Asset -*PlugFunctionsApi* | [**update_assets**](docs/PlugFunctionsApi.md#update_assets) | **PUT** /registry/v2/plugs/{name}/versions/{version}/content | Update Plug Assets -*PlugFunctionsApi* | [**verify**](docs/PlugFunctionsApi.md#verify) | **POST** /registry/v2/plugs/{name}/versions/{version}/verify | Verify Health Of Plug +*ModelsApi* | [**create**](docs/ModelsApi.md#create) | **POST** /registry/v2/models/ | Create Model +*ModelsApi* | [**delete_asset**](docs/ModelsApi.md#delete_asset) | **DELETE** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Delete Model Asset +*ModelsApi* | [**get_archive**](docs/ModelsApi.md#get_archive) | **GET** /registry/v2/models/{name}/versions/{version}/content | Get Model Archive +*ModelsApi* | [**get_asset**](docs/ModelsApi.md#get_asset) | **GET** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Get File From Model Archive +*ModelsApi* | [**get_latest**](docs/ModelsApi.md#get_latest) | **GET** /registry/v2/models/{name} | Get Latest Model Version +*ModelsApi* | [**get**](docs/ModelsApi.md#get) | **GET** /registry/v2/models/{name}/versions/{version} | Get Model Version +*ModelsApi* | [**jobs**](docs/ModelsApi.md#jobs) | **GET** /registry/v2/models/{name}/versions/{version}/jobs | List Model Jobs +*ModelsApi* | [**list**](docs/ModelsApi.md#list) | **GET** /registry/v2/models/ | List Models +*ModelsApi* | [**list_versions**](docs/ModelsApi.md#list_versions) | **GET** /registry/v2/models/{name}/versions | List Model Versions +*ModelsApi* | [**patch_metadata**](docs/ModelsApi.md#patch_metadata) | **PATCH** /registry/v2/models/{name}/versions/{version}/metadata | Patch Model Metadata +*ModelsApi* | [**publish**](docs/ModelsApi.md#publish) | **POST** /registry/v2/models/{name}/versions/{version}/publish | Publish Draft Model +*ModelsApi* | [**rebuild**](docs/ModelsApi.md#rebuild) | **POST** /registry/v2/models/{name}/versions/{version}/rebuild | Rebuild Model +*ModelsApi* | [**remove_version**](docs/ModelsApi.md#remove_version) | **DELETE** /registry/v2/models/{name}/versions/{version} | Remove Model Version +*ModelsApi* | [**remove_versions**](docs/ModelsApi.md#remove_versions) | **DELETE** /registry/v2/models/{name} | Remove Model +*ModelsApi* | [**update_asset**](docs/ModelsApi.md#update_asset) | **PUT** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Update Model Asset +*ModelsApi* | [**update_assets**](docs/ModelsApi.md#update_assets) | **PUT** /registry/v2/models/{name}/versions/{version}/content | Update Model Assets +*ModelsApi* | [**verify**](docs/ModelsApi.md#verify) | **POST** /registry/v2/models/{name}/versions/{version}/verify | Verify Health Of Model +*PlugsApi* | [**create**](docs/PlugsApi.md#create) | **POST** /registry/v2/plugs/ | Create Plug +*PlugsApi* | [**delete_asset**](docs/PlugsApi.md#delete_asset) | **DELETE** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Delete Plug Asset +*PlugsApi* | [**get_archive**](docs/PlugsApi.md#get_archive) | **GET** /registry/v2/plugs/{name}/versions/{version}/content | Get Plug Archive +*PlugsApi* | [**get_asset**](docs/PlugsApi.md#get_asset) | **GET** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Get File From Plug Archive +*PlugsApi* | [**get_latest**](docs/PlugsApi.md#get_latest) | **GET** /registry/v2/plugs/{name} | Get Latest Plug Version +*PlugsApi* | [**get**](docs/PlugsApi.md#get) | **GET** /registry/v2/plugs/{name}/versions/{version} | Get Plug Version +*PlugsApi* | [**jobs**](docs/PlugsApi.md#jobs) | **GET** /registry/v2/plugs/{name}/versions/{version}/jobs | List Plug Jobs +*PlugsApi* | [**list**](docs/PlugsApi.md#list) | **GET** /registry/v2/plugs/ | List Plugs +*PlugsApi* | [**list_versions**](docs/PlugsApi.md#list_versions) | **GET** /registry/v2/plugs/{name}/versions | List Plug Versions +*PlugsApi* | [**patch_interface**](docs/PlugsApi.md#patch_interface) | **PATCH** /registry/v2/plugs/{name}/versions/{version}/interface | Patch Plug Interface +*PlugsApi* | [**patch_metadata**](docs/PlugsApi.md#patch_metadata) | **PATCH** /registry/v2/plugs/{name}/versions/{version}/metadata | Patch Plug Metadata +*PlugsApi* | [**publish**](docs/PlugsApi.md#publish) | **POST** /registry/v2/plugs/{name}/versions/{version}/publish | Publish Draft Plug +*PlugsApi* | [**rebuild**](docs/PlugsApi.md#rebuild) | **POST** /registry/v2/plugs/{name}/versions/{version}/rebuild | Rebuild Plug +*PlugsApi* | [**remove_version**](docs/PlugsApi.md#remove_version) | **DELETE** /registry/v2/plugs/{name}/versions/{version} | Remove Plug Version +*PlugsApi* | [**remove_versions**](docs/PlugsApi.md#remove_versions) | **DELETE** /registry/v2/plugs/{name} | Remove Plug +*PlugsApi* | [**update_asset**](docs/PlugsApi.md#update_asset) | **PUT** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Update Plug Asset +*PlugsApi* | [**update_assets**](docs/PlugsApi.md#update_assets) | **PUT** /registry/v2/plugs/{name}/versions/{version}/content | Update Plug Assets +*PlugsApi* | [**verify**](docs/PlugsApi.md#verify) | **POST** /registry/v2/plugs/{name}/versions/{version}/verify | Verify Health Of Plug *RuntimesApi* | [**example_archive**](docs/RuntimesApi.md#example_archive) | **GET** /registry/v2/runtimes/{name}/versions/{version}/example | Get Runtime Example Archive *RuntimesApi* | [**get_example_asset**](docs/RuntimesApi.md#get_example_asset) | **GET** /registry/v2/runtimes/{name}/versions/{version}/example/{wildcard} | Get File From Runtime Example Archive *RuntimesApi* | [**get_latest**](docs/RuntimesApi.md#get_latest) | **GET** /registry/v2/runtimes/{name} | Get Latest Runtime Version @@ -107,24 +102,23 @@ Class | Method | HTTP request | Description *RuntimesApi* | [**list_versions**](docs/RuntimesApi.md#list_versions) | **GET** /registry/v2/runtimes/{name}/versions | List Runtime Versions *SchemasApi* | [**get_by_role**](docs/SchemasApi.md#get_by_role) | **GET** /registry/v2/schemas/{functionType}/{role}/schema | Get Asset Schema *SchemasApi* | [**get**](docs/SchemasApi.md#get) | **GET** /registry/v2/schemas/{schemaId} | Get Asset Schema -*WebscriptFunctionsApi* | [**create**](docs/WebscriptFunctionsApi.md#create) | **POST** /registry/v2/webscripts/ | Create Webscript Version -*WebscriptFunctionsApi* | [**delete_asset**](docs/WebscriptFunctionsApi.md#delete_asset) | **DELETE** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Delete Webscript Asset -*WebscriptFunctionsApi* | [**get_archive**](docs/WebscriptFunctionsApi.md#get_archive) | **GET** /registry/v2/webscripts/{name}/versions/{version}/content | Get Webscript Archive -*WebscriptFunctionsApi* | [**get_asset**](docs/WebscriptFunctionsApi.md#get_asset) | **GET** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Get File From Webscript Archive -*WebscriptFunctionsApi* | [**get_latest**](docs/WebscriptFunctionsApi.md#get_latest) | **GET** /registry/v2/webscripts/{name} | Get Latest Webscript Version -*WebscriptFunctionsApi* | [**get**](docs/WebscriptFunctionsApi.md#get) | **GET** /registry/v2/webscripts/{name}/versions/{version} | Get Webscript Version -*WebscriptFunctionsApi* | [**jobs**](docs/WebscriptFunctionsApi.md#jobs) | **GET** /registry/v2/webscripts/{name}/versions/{version}/jobs | List Webscript Jobs -*WebscriptFunctionsApi* | [**list_versions**](docs/WebscriptFunctionsApi.md#list_versions) | **GET** /registry/v2/webscripts/{name}/versions | List Webscript Versions -*WebscriptFunctionsApi* | [**list**](docs/WebscriptFunctionsApi.md#list) | **GET** /registry/v2/webscripts/ | List Webscripts -*WebscriptFunctionsApi* | [**patch_metadata**](docs/WebscriptFunctionsApi.md#patch_metadata) | **PATCH** /registry/v2/webscripts/{name}/versions/{version}/metadata | Patch Webscript Metadata -*WebscriptFunctionsApi* | [**publish**](docs/WebscriptFunctionsApi.md#publish) | **POST** /registry/v2/webscripts/{name}/versions/{version}/publish | Publish Draft Webscript -*WebscriptFunctionsApi* | [**rebuild**](docs/WebscriptFunctionsApi.md#rebuild) | **POST** /registry/v2/webscripts/{name}/versions/{version}/rebuild | Rebuild Webscript -*WebscriptFunctionsApi* | [**remove_version**](docs/WebscriptFunctionsApi.md#remove_version) | **DELETE** /registry/v2/webscripts/{name}/versions/{version} | Remove Webscript Version -*WebscriptFunctionsApi* | [**remove_versions**](docs/WebscriptFunctionsApi.md#remove_versions) | **DELETE** /registry/v2/webscripts/{name} | Remove Webscript -*WebscriptFunctionsApi* | [**update_asset**](docs/WebscriptFunctionsApi.md#update_asset) | **PUT** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Update Webscript Asset -*WebscriptFunctionsApi* | [**update_assets**](docs/WebscriptFunctionsApi.md#update_assets) | **PUT** /registry/v2/webscripts/{name}/versions/{version}/content | Update Webscript Assets -*WebscriptFunctionsApi* | [**verify**](docs/WebscriptFunctionsApi.md#verify) | **POST** /registry/v2/webscripts/{name}/versions/{version}/verify | Verify Health Of Webscript -*DefaultApi* | [**get**](docs/DefaultApi.md#get) | **GET** /registry/v2/ | Version +*WebscriptsApi* | [**create**](docs/WebscriptsApi.md#create) | **POST** /registry/v2/webscripts/ | Create Webscript Version +*WebscriptsApi* | [**delete_asset**](docs/WebscriptsApi.md#delete_asset) | **DELETE** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Delete Webscript Asset +*WebscriptsApi* | [**get_archive**](docs/WebscriptsApi.md#get_archive) | **GET** /registry/v2/webscripts/{name}/versions/{version}/content | Get Webscript Archive +*WebscriptsApi* | [**get_asset**](docs/WebscriptsApi.md#get_asset) | **GET** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Get File From Webscript Archive +*WebscriptsApi* | [**get_latest**](docs/WebscriptsApi.md#get_latest) | **GET** /registry/v2/webscripts/{name} | Get Latest Webscript Version +*WebscriptsApi* | [**get**](docs/WebscriptsApi.md#get) | **GET** /registry/v2/webscripts/{name}/versions/{version} | Get Webscript Version +*WebscriptsApi* | [**jobs**](docs/WebscriptsApi.md#jobs) | **GET** /registry/v2/webscripts/{name}/versions/{version}/jobs | List Webscript Jobs +*WebscriptsApi* | [**list_versions**](docs/WebscriptsApi.md#list_versions) | **GET** /registry/v2/webscripts/{name}/versions | List Webscript Versions +*WebscriptsApi* | [**list**](docs/WebscriptsApi.md#list) | **GET** /registry/v2/webscripts/ | List Webscripts +*WebscriptsApi* | [**patch_metadata**](docs/WebscriptsApi.md#patch_metadata) | **PATCH** /registry/v2/webscripts/{name}/versions/{version}/metadata | Patch Webscript Metadata +*WebscriptsApi* | [**publish**](docs/WebscriptsApi.md#publish) | **POST** /registry/v2/webscripts/{name}/versions/{version}/publish | Publish Draft Webscript +*WebscriptsApi* | [**rebuild**](docs/WebscriptsApi.md#rebuild) | **POST** /registry/v2/webscripts/{name}/versions/{version}/rebuild | Rebuild Webscript +*WebscriptsApi* | [**remove_version**](docs/WebscriptsApi.md#remove_version) | **DELETE** /registry/v2/webscripts/{name}/versions/{version} | Remove Webscript Version +*WebscriptsApi* | [**remove_versions**](docs/WebscriptsApi.md#remove_versions) | **DELETE** /registry/v2/webscripts/{name} | Remove Webscript +*WebscriptsApi* | [**update_asset**](docs/WebscriptsApi.md#update_asset) | **PUT** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Update Webscript Asset +*WebscriptsApi* | [**update_assets**](docs/WebscriptsApi.md#update_assets) | **PUT** /registry/v2/webscripts/{name}/versions/{version}/content | Update Webscript Assets +*WebscriptsApi* | [**verify**](docs/WebscriptsApi.md#verify) | **POST** /registry/v2/webscripts/{name}/versions/{version}/verify | Verify Health Of Webscript ## Documentation For Models @@ -132,8 +126,10 @@ Class | Method | HTTP request | Description - [ActiveEventData](docs/ActiveEventData.md) - [ActiveEventSSE](docs/ActiveEventSSE.md) - [ActiveEventSSEEvent](docs/ActiveEventSSEEvent.md) + - [AltEmbeddedVersionIKfservingResponseV2](docs/AltEmbeddedVersionIKfservingResponseV2.md) + - [AltEmbeddedVersionIPlugResponseV2](docs/AltEmbeddedVersionIPlugResponseV2.md) + - [AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2](docs/AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2.md) - [AltVersionHALLink](docs/AltVersionHALLink.md) - - [AnyFunctionResponse](docs/AnyFunctionResponse.md) - [AnyJobForFunction](docs/AnyJobForFunction.md) - [AnyJobResult](docs/AnyJobResult.md) - [AnyJobStatus](docs/AnyJobStatus.md) @@ -142,17 +138,10 @@ Class | Method | HTTP request | Description - [AssetCondition](docs/AssetCondition.md) - [AssetConditionContentType](docs/AssetConditionContentType.md) - [AssetConditionPattern](docs/AssetConditionPattern.md) - - [AssetPathParamsV2](docs/AssetPathParamsV2.md) - [AssetRole](docs/AssetRole.md) - - [AssetSummary](docs/AssetSummary.md) - [AssetSummaryWithHALLink](docs/AssetSummaryWithHALLink.md) - [AssetSummaryWithHALLinkLinks](docs/AssetSummaryWithHALLinkLinks.md) - [AssetsConditions](docs/AssetsConditions.md) - - [AsyncDeployQuery](docs/AsyncDeployQuery.md) - - [AsyncDeployQueryV1](docs/AsyncDeployQueryV1.md) - - [AsyncQueryDefaultFalse](docs/AsyncQueryDefaultFalse.md) - - [AsyncQueryDefaultTrue](docs/AsyncQueryDefaultTrue.md) - - [AsyncVerifyQuery](docs/AsyncVerifyQuery.md) - [Batch](docs/Batch.md) - [BatchArgs](docs/BatchArgs.md) - [BatchJobStatus](docs/BatchJobStatus.md) @@ -170,12 +159,8 @@ Class | Method | HTTP request | Description - [CompletedEventData](docs/CompletedEventData.md) - [CompletedEventSSE](docs/CompletedEventSSE.md) - [CompletedEventSSEEvent](docs/CompletedEventSSEEvent.md) - - [ContentQueryV2](docs/ContentQueryV2.md) - [ContentValidationListing](docs/ContentValidationListing.md) - - [CreateFunctionQueryV2](docs/CreateFunctionQueryV2.md) - - [CreateKFServingAsyncResponse](docs/CreateKFServingAsyncResponse.md) - - [CreatePlugAsyncResponse](docs/CreatePlugAsyncResponse.md) - - [CreateWebscriptAsyncResponse](docs/CreateWebscriptAsyncResponse.md) + - [CreateWebscriptsCopyParameter](docs/CreateWebscriptsCopyParameter.md) - [DelayedEventData](docs/DelayedEventData.md) - [DelayedEventSSE](docs/DelayedEventSSE.md) - [DelayedEventSSEEvent](docs/DelayedEventSSEEvent.md) @@ -183,74 +168,44 @@ Class | Method | HTTP request | Description - [Deploy1](docs/Deploy1.md) - [DeployArgs](docs/DeployArgs.md) - [DeployArgsDeploySpecOverrides](docs/DeployArgsDeploySpecOverrides.md) - - [DeployAttributesFilter](docs/DeployAttributesFilter.md) - [DeployJobStatus](docs/DeployJobStatus.md) - [DeployResult](docs/DeployResult.md) - [DeploySpec](docs/DeploySpec.md) - [DeploySpecOpenfaasSpec](docs/DeploySpecOpenfaasSpec.md) - [DeployType](docs/DeployType.md) - [DeprecatePreviousPolicy](docs/DeprecatePreviousPolicy.md) - - [DeprecatePreviousQuery](docs/DeprecatePreviousQuery.md) - - [DeprecatedDraftFilter](docs/DeprecatedDraftFilter.md) - [Documentation](docs/Documentation.md) - [DocumentationProperty](docs/DocumentationProperty.md) - - [DryRunQuery](docs/DryRunQuery.md) - - [EntityResponse](docs/EntityResponse.md) - - [ErrorAndStatusResponse](docs/ErrorAndStatusResponse.md) - - [ErrorResponse](docs/ErrorResponse.md) + - [EntityWithLinksIKfservingResponseV2](docs/EntityWithLinksIKfservingResponseV2.md) + - [EntityWithLinksIPlugResponseV2](docs/EntityWithLinksIPlugResponseV2.md) + - [EntityWithLinksIWebscriptResponseWithInvokeLinkV2](docs/EntityWithLinksIWebscriptResponseWithInvokeLinkV2.md) - [EventAck](docs/EventAck.md) - [EventClose](docs/EventClose.md) - [EventKeepAlive](docs/EventKeepAlive.md) - - [EventSSE](docs/EventSSE.md) - - [EventTypeSSE](docs/EventTypeSSE.md) - [EventWithCloseSSE](docs/EventWithCloseSSE.md) + - [ExampleReference](docs/ExampleReference.md) - [ExposedOpenfaasDeploySpec](docs/ExposedOpenfaasDeploySpec.md) - [FailedEventData](docs/FailedEventData.md) - [FailedEventSSE](docs/FailedEventSSE.md) - [FailedEventSSEEvent](docs/FailedEventSSEEvent.md) - [FailureReason](docs/FailureReason.md) - [FileUpload](docs/FileUpload.md) - - [ForceDeleteQueryV1](docs/ForceDeleteQueryV1.md) - - [FunctionDeleteQuery](docs/FunctionDeleteQuery.md) - - [FunctionDeployOverrides](docs/FunctionDeployOverrides.md) - [FunctionDeployOverridesType](docs/FunctionDeployOverridesType.md) - - [FunctionEntityQuery](docs/FunctionEntityQuery.md) - - [FunctionJobArgs](docs/FunctionJobArgs.md) - - [FunctionManifest](docs/FunctionManifest.md) - [FunctionMeta](docs/FunctionMeta.md) - - [FunctionNameVersion](docs/FunctionNameVersion.md) - [FunctionRef](docs/FunctionRef.md) - - [FunctionSpec](docs/FunctionSpec.md) - [FunctionType](docs/FunctionType.md) - - [FunctionVersionQuery](docs/FunctionVersionQuery.md) - - [GetContentParamsV2](docs/GetContentParamsV2.md) - - [GetInvokableWebscriptQuery](docs/GetInvokableWebscriptQuery.md) - [GetModelResponseV2](docs/GetModelResponseV2.md) - [GetPlugResponseV2](docs/GetPlugResponseV2.md) - [GetPlugResponseV2Links](docs/GetPlugResponseV2Links.md) - [GetPlugResponseV2LinksDraft](docs/GetPlugResponseV2LinksDraft.md) - [GetPlugResponseV2LinksPublished](docs/GetPlugResponseV2LinksPublished.md) - - [GetRuntimeByNameAndVersionQuery](docs/GetRuntimeByNameAndVersionQuery.md) - - [GetRuntimeByNameQuery](docs/GetRuntimeByNameQuery.md) - - [GetRuntimeExampleQuery](docs/GetRuntimeExampleQuery.md) - - [GetRuntimeVersionsQuery](docs/GetRuntimeVersionsQuery.md) - [GetWebscriptResponseV2](docs/GetWebscriptResponseV2.md) - [GetWebscriptResponseV2Links](docs/GetWebscriptResponseV2Links.md) - [HALLink](docs/HALLink.md) - - [InvokableWebscriptResponse](docs/InvokableWebscriptResponse.md) - - [InvokableWebscriptResponseEntity](docs/InvokableWebscriptResponseEntity.md) - - [InvokableWebscriptResponseEntityWebscript](docs/InvokableWebscriptResponseEntityWebscript.md) - [InvokeHALLink](docs/InvokeHALLink.md) - - [InvokeInternalHALLink](docs/InvokeInternalHALLink.md) - [JobAndFunctionHALLink](docs/JobAndFunctionHALLink.md) - [JobCause](docs/JobCause.md) - [JobCauses](docs/JobCauses.md) - - [JobEventPayloadActiveEventData](docs/JobEventPayloadActiveEventData.md) - - [JobEventPayloadCompletedEventData](docs/JobEventPayloadCompletedEventData.md) - - [JobEventPayloadDelayedEventData](docs/JobEventPayloadDelayedEventData.md) - - [JobEventPayloadFailedEventData](docs/JobEventPayloadFailedEventData.md) - - [JobEventPayloadWaitingChildrenEventData](docs/JobEventPayloadWaitingChildrenEventData.md) - - [JobEventPayloadWaitingEventData](docs/JobEventPayloadWaitingEventData.md) - [JobEventResponseActiveEventData](docs/JobEventResponseActiveEventData.md) - [JobEventResponseCompletedEventData](docs/JobEventResponseCompletedEventData.md) - [JobEventResponseDelayedEventData](docs/JobEventResponseDelayedEventData.md) @@ -259,12 +214,9 @@ Class | Method | HTTP request | Description - [JobEventResponseWaitingEventData](docs/JobEventResponseWaitingEventData.md) - [JobEventSSE](docs/JobEventSSE.md) - [JobEventsAndFunctionHALLink](docs/JobEventsAndFunctionHALLink.md) - - [JobEventsFilterQuery](docs/JobEventsFilterQuery.md) - [JobEventsHALLink](docs/JobEventsHALLink.md) - [JobHALLinks](docs/JobHALLinks.md) - - [JobQuery](docs/JobQuery.md) - [JobReference](docs/JobReference.md) - - [JobReferenceParams](docs/JobReferenceParams.md) - [JobResponse](docs/JobResponse.md) - [JobState](docs/JobState.md) - [JobStateActive](docs/JobStateActive.md) @@ -280,11 +232,11 @@ Class | Method | HTTP request | Description - [JobStatusAndEntityHALLinks](docs/JobStatusAndEntityHALLinks.md) - [JobStatusHALLink](docs/JobStatusHALLink.md) - [JobStatusProgress](docs/JobStatusProgress.md) - - [JobSubmittedResponse](docs/JobSubmittedResponse.md) - [JobType](docs/JobType.md) - [JobTypeBatch](docs/JobTypeBatch.md) - [JobTypeBuild](docs/JobTypeBuild.md) - [JobTypeDeploy](docs/JobTypeDeploy.md) + - [JobTypeNotify](docs/JobTypeNotify.md) - [JobTypeScale](docs/JobTypeScale.md) - [JobTypeSchema](docs/JobTypeSchema.md) - [JobTypeUndeploy](docs/JobTypeUndeploy.md) @@ -295,114 +247,33 @@ Class | Method | HTTP request | Description - [JobsForPlugResponseV2Links](docs/JobsForPlugResponseV2Links.md) - [JobsForWebscriptResponseV2](docs/JobsForWebscriptResponseV2.md) - [JobsForWebscriptResponseV2Links](docs/JobsForWebscriptResponseV2Links.md) - - [JobsHALLink](docs/JobsHALLink.md) - [JobsResponse](docs/JobsResponse.md) - - [KFServingDeleteMultipleResponse](docs/KFServingDeleteMultipleResponse.md) - - [KFServingDeleteMultipleWithJobResponse](docs/KFServingDeleteMultipleWithJobResponse.md) - - [KFServingDeleteQueryV1](docs/KFServingDeleteQueryV1.md) - - [KFServingDeleteQueryV2](docs/KFServingDeleteQueryV2.md) - - [KFServingDeleteResponse](docs/KFServingDeleteResponse.md) - - [KFServingDeleteWithJobResponse](docs/KFServingDeleteWithJobResponse.md) - - [KFServingLatestVersionQueryV2](docs/KFServingLatestVersionQueryV2.md) - - [KFServingLatestVersionsQueryV1](docs/KFServingLatestVersionsQueryV1.md) - - [KFServingLatestVersionsQueryV2](docs/KFServingLatestVersionsQueryV2.md) - [KFServingManifest](docs/KFServingManifest.md) - - [KFServingModelsResponse](docs/KFServingModelsResponse.md) - - [KFServingResponse](docs/KFServingResponse.md) - - [KFServingVersionsQueryV1](docs/KFServingVersionsQueryV1.md) - [KeepAliveEventSSE](docs/KeepAliveEventSSE.md) - [KfservingResponseV2](docs/KfservingResponseV2.md) - [LanguageRelease](docs/LanguageRelease.md) - - [LatestFunctionVersionsQuery](docs/LatestFunctionVersionsQuery.md) - - [LatestFunctionsQuery](docs/LatestFunctionsQuery.md) - [LatestModelsResponseV2](docs/LatestModelsResponseV2.md) - - [LatestModelsResponseV2EntitiesInner](docs/LatestModelsResponseV2EntitiesInner.md) - - [LatestPlugQuery](docs/LatestPlugQuery.md) - - [LatestPlugVersionQueryV2](docs/LatestPlugVersionQueryV2.md) - - [LatestPlugVersionsQuery](docs/LatestPlugVersionsQuery.md) - - [LatestPlugVersionsQueryV2](docs/LatestPlugVersionsQueryV2.md) - - [LatestPlugsQuery](docs/LatestPlugsQuery.md) - [LatestPlugsResponseV2](docs/LatestPlugsResponseV2.md) - - [LatestPlugsResponseV2EntitiesInner](docs/LatestPlugsResponseV2EntitiesInner.md) - [LatestVersionLevel](docs/LatestVersionLevel.md) - [LatestWebscriptsResponseV2](docs/LatestWebscriptsResponseV2.md) - - [LatestWebscriptsResponseV2EntitiesInner](docs/LatestWebscriptsResponseV2EntitiesInner.md) - - [LegacyConfigurationObject](docs/LegacyConfigurationObject.md) - - [LegacyConfigurationObjectFormat](docs/LegacyConfigurationObjectFormat.md) - - [LegacyConfigurationResponseObject](docs/LegacyConfigurationResponseObject.md) - - [LegacyCreateDebugResponse](docs/LegacyCreateDebugResponse.md) - - [LegacyDebugPlugManifest](docs/LegacyDebugPlugManifest.md) - - [LegacyDebugPlugRequest](docs/LegacyDebugPlugRequest.md) - - [LegacyDocumentation](docs/LegacyDocumentation.md) - - [LegacyDocumentationRequest](docs/LegacyDocumentationRequest.md) - - [LegacyFunctionMeta](docs/LegacyFunctionMeta.md) - - [LegacyPlugCreateQuery](docs/LegacyPlugCreateQuery.md) - - [LegacyPlugCreateRequest](docs/LegacyPlugCreateRequest.md) - - [LegacyPlugCreateResponse](docs/LegacyPlugCreateResponse.md) - - [LegacyPlugMetaRequest](docs/LegacyPlugMetaRequest.md) - - [LegacyPlugQuery](docs/LegacyPlugQuery.md) - - [LegacyPlugRequest](docs/LegacyPlugRequest.md) - - [LegacyPlugRequestMetadata](docs/LegacyPlugRequestMetadata.md) - - [LegacyPlugRequestMetadataDocumentation](docs/LegacyPlugRequestMetadataDocumentation.md) - - [LegacyPlugRequestMetadataDocumentationAnyOf](docs/LegacyPlugRequestMetadataDocumentationAnyOf.md) - - [LegacyPlugRequestMetadataRawDataInner](docs/LegacyPlugRequestMetadataRawDataInner.md) - - [LegacyPlugResponse](docs/LegacyPlugResponse.md) - - [LegacyPlugResponseMetadata](docs/LegacyPlugResponseMetadata.md) - - [LegacyPlugScriptMeta](docs/LegacyPlugScriptMeta.md) - - [LegacyPlugScriptMetaRawDataInner](docs/LegacyPlugScriptMetaRawDataInner.md) - - [LegacyPlugScriptResponse](docs/LegacyPlugScriptResponse.md) - - [LegacyRequiredPropertiesInner](docs/LegacyRequiredPropertiesInner.md) - - [LegacyRequiredPropertyObject](docs/LegacyRequiredPropertyObject.md) - - [LimitQuery](docs/LimitQuery.md) - - [MediaType](docs/MediaType.md) - - [MessageAndStatusResponse](docs/MessageAndStatusResponse.md) - - [MessageResponse](docs/MessageResponse.md) - [Model](docs/Model.md) - [Model1](docs/Model1.md) - [Model2](docs/Model2.md) - [ModelVersionsResponseV2](docs/ModelVersionsResponseV2.md) - - [MultipartFileUpload](docs/MultipartFileUpload.md) - - [Name](docs/Name.md) - - [NameAndVersion](docs/NameAndVersion.md) - - [NamedFunctionVersionsQuery](docs/NamedFunctionVersionsQuery.md) - - [NamedKFServingVersionsQueryV2](docs/NamedKFServingVersionsQueryV2.md) - - [NamedParametersTypeofAsJobReference](docs/NamedParametersTypeofAsJobReference.md) - - [NamedParametersTypeofAsJobReferenceJobStatus](docs/NamedParametersTypeofAsJobReferenceJobStatus.md) - - [NamedParametersTypeofFromLegacy](docs/NamedParametersTypeofFromLegacy.md) - - [NamedParametersTypeofFromLegacyDocumentation](docs/NamedParametersTypeofFromLegacyDocumentation.md) - - [NamedParametersTypeofIsNotLegacy](docs/NamedParametersTypeofIsNotLegacy.md) - - [NamedPlugVersionsQueryV2](docs/NamedPlugVersionsQueryV2.md) - - [NamedVersionsFilter](docs/NamedVersionsFilter.md) - - [NamedWebscriptVersionsQueryV2](docs/NamedWebscriptVersionsQueryV2.md) - - [OpenfaasDeployArgs](docs/OpenfaasDeployArgs.md) - - [OpenfaasFunctionRef](docs/OpenfaasFunctionRef.md) - - [Operation](docs/Operation.md) - - [OperationStatus](docs/OperationStatus.md) - - [OperationStatusError](docs/OperationStatusError.md) - - [PagingQuery](docs/PagingQuery.md) - - [PagingResponse](docs/PagingResponse.md) + - [NotifyResult](docs/NotifyResult.md) - [ParentKeys](docs/ParentKeys.md) - - [PatchInterfaceQuery](docs/PatchInterfaceQuery.md) - - [PatchMetadataQuery](docs/PatchMetadataQuery.md) - - [PatchPlugRequestV1](docs/PatchPlugRequestV1.md) - [Plug](docs/Plug.md) - [Plug1](docs/Plug1.md) - [Plug2](docs/Plug2.md) - - [PlugDeleteForceQuery](docs/PlugDeleteForceQuery.md) - - [PlugDeleteQuery](docs/PlugDeleteQuery.md) - [PlugInterface](docs/PlugInterface.md) - - [PlugListingAndQueryResponse](docs/PlugListingAndQueryResponse.md) - - [PlugListingResponse](docs/PlugListingResponse.md) - [PlugManifest](docs/PlugManifest.md) - [PlugMeta](docs/PlugMeta.md) - [PlugProperty](docs/PlugProperty.md) - [PlugPropertyDataType](docs/PlugPropertyDataType.md) - [PlugPropertyFormat](docs/PlugPropertyFormat.md) - [PlugPropertyFormatType](docs/PlugPropertyFormatType.md) - - [PlugResponse](docs/PlugResponse.md) - [PlugResponseV2](docs/PlugResponseV2.md) - [PlugType](docs/PlugType.md) - - [PlugTypeQuery](docs/PlugTypeQuery.md) - [PlugVersionsResponseV2](docs/PlugVersionsResponseV2.md) - [PostModelJobAsyncResponseV2](docs/PostModelJobAsyncResponseV2.md) - [PostModelJobSyncResponseV2](docs/PostModelJobSyncResponseV2.md) @@ -411,62 +282,39 @@ Class | Method | HTTP request | Description - [PostWebscriptJobAsyncResponseV2](docs/PostWebscriptJobAsyncResponseV2.md) - [PostWebscriptJobSyncResponseV2](docs/PostWebscriptJobSyncResponseV2.md) - [ProvidedDependency](docs/ProvidedDependency.md) - - [PublishFunctionQuery](docs/PublishFunctionQuery.md) - [QueueEvents](docs/QueueEvents.md) - - [RebuildComputedResponse](docs/RebuildComputedResponse.md) - [RebuildModelAsyncResponseV2](docs/RebuildModelAsyncResponseV2.md) - [RebuildModelSyncResponseV2](docs/RebuildModelSyncResponseV2.md) - [RebuildPlugAsyncResponseV2](docs/RebuildPlugAsyncResponseV2.md) - [RebuildPlugSyncResponseV2](docs/RebuildPlugSyncResponseV2.md) - [RebuildPolicy](docs/RebuildPolicy.md) - - [RebuildQueryParams](docs/RebuildQueryParams.md) - - [RebuildQueryV2](docs/RebuildQueryV2.md) - - [RebuildSubmittedResponse](docs/RebuildSubmittedResponse.md) - [RebuildWebscriptAsyncResponseV2](docs/RebuildWebscriptAsyncResponseV2.md) - [RebuildWebscriptSyncResponseV2](docs/RebuildWebscriptSyncResponseV2.md) - - [RemoveFunctionQueryV2](docs/RemoveFunctionQueryV2.md) - - [RemovePlugQueryV2](docs/RemovePlugQueryV2.md) + - [RegistryErrorResponse](docs/RegistryErrorResponse.md) - [RequestOperation](docs/RequestOperation.md) - [ResourceLimits](docs/ResourceLimits.md) - [RootPageResponse](docs/RootPageResponse.md) - [RuntimeAttributes](docs/RuntimeAttributes.md) - - [RuntimeInfo](docs/RuntimeInfo.md) - - [RuntimeNameQuery](docs/RuntimeNameQuery.md) - - [RuntimeParams](docs/RuntimeParams.md) - - [RuntimeQuery](docs/RuntimeQuery.md) - - [RuntimeReference](docs/RuntimeReference.md) - - [RuntimeSpecification](docs/RuntimeSpecification.md) - [RuntimeSummary](docs/RuntimeSummary.md) - - [RuntimeSummaryAttrs](docs/RuntimeSummaryAttrs.md) - [RuntimeSummaryResponse](docs/RuntimeSummaryResponse.md) - - [RuntimeVersionAndPathParams](docs/RuntimeVersionAndPathParams.md) - [RuntimeVersionInfo](docs/RuntimeVersionInfo.md) - - [RuntimeVersionParams](docs/RuntimeVersionParams.md) - - [RuntimeVersionQuery](docs/RuntimeVersionQuery.md) - [RuntimeVersionResponse](docs/RuntimeVersionResponse.md) - - [RuntimeVersionSpecification](docs/RuntimeVersionSpecification.md) - - [RuntimeVersionStatus](docs/RuntimeVersionStatus.md) - - [RuntimeVersionSummary](docs/RuntimeVersionSummary.md) - [Scale](docs/Scale.md) - [Scale1](docs/Scale1.md) - [ScaleArgs](docs/ScaleArgs.md) - [ScaleJobStatus](docs/ScaleJobStatus.md) - [ScaleType](docs/ScaleType.md) - - [SchemaByIdParams](docs/SchemaByIdParams.md) - - [SchemaParams](docs/SchemaParams.md) - [SemanticVersionRange](docs/SemanticVersionRange.md) + - [ShowRelatedType](docs/ShowRelatedType.md) - [Status](docs/Status.md) - [StatusAny](docs/StatusAny.md) + - [StatusExclude](docs/StatusExclude.md) - [StatusFilter](docs/StatusFilter.md) - [StatusInclude](docs/StatusInclude.md) - - [StatusResponse](docs/StatusResponse.md) - [StreamClosing](docs/StreamClosing.md) - [StreamReady](docs/StreamReady.md) - - [SupportedEvents](docs/SupportedEvents.md) - [Tag](docs/Tag.md) - - [TagQuery](docs/TagQuery.md) - [TagsFilter](docs/TagsFilter.md) - - [TagsQuery](docs/TagsQuery.md) - [TimestampAbsolute](docs/TimestampAbsolute.md) - [TimestampAge](docs/TimestampAge.md) - [TimestampSpec](docs/TimestampSpec.md) @@ -478,27 +326,17 @@ Class | Method | HTTP request | Description - [UndeploySubmittedResponseV2](docs/UndeploySubmittedResponseV2.md) - [UndeployType](docs/UndeployType.md) - [UndeployedResponseV2](docs/UndeployedResponseV2.md) - - [UnhealthyInvokableWebscriptError](docs/UnhealthyInvokableWebscriptError.md) - - [UpdateComment](docs/UpdateComment.md) - - [UpdateDraftQuery](docs/UpdateDraftQuery.md) - - [UpdateMetadataRequestV1](docs/UpdateMetadataRequestV1.md) - [UpdateMetadataRequestV2](docs/UpdateMetadataRequestV2.md) - [UpdateRecord](docs/UpdateRecord.md) - - [UserPlugMeta](docs/UserPlugMeta.md) - [Verify](docs/Verify.md) - [Verify1](docs/Verify1.md) - [VerifyArgs](docs/VerifyArgs.md) - [VerifyJobStatus](docs/VerifyJobStatus.md) - [VerifyModelSyncResponseV2](docs/VerifyModelSyncResponseV2.md) - [VerifyPlugSyncResponseV2](docs/VerifyPlugSyncResponseV2.md) - - [VerifyQueryV1](docs/VerifyQueryV1.md) - [VerifyResult](docs/VerifyResult.md) - [VerifyType](docs/VerifyType.md) - [VerifyWebscriptSyncResponseV2](docs/VerifyWebscriptSyncResponseV2.md) - - [VersionIncludes](docs/VersionIncludes.md) - - [VersionsQuery](docs/VersionsQuery.md) - - [VersionsQueryV2](docs/VersionsQueryV2.md) - - [VersionsResponseV2](docs/VersionsResponseV2.md) - [WaitingChildrenEventSSE](docs/WaitingChildrenEventSSE.md) - [WaitingChildrenEventSSEEvent](docs/WaitingChildrenEventSSEEvent.md) - [WaitingEventData](docs/WaitingEventData.md) @@ -507,16 +345,8 @@ Class | Method | HTTP request | Description - [Webscript](docs/Webscript.md) - [Webscript1](docs/Webscript1.md) - [Webscript2](docs/Webscript2.md) - - [WebscriptLatestVersionQueryV2](docs/WebscriptLatestVersionQueryV2.md) - - [WebscriptLatestVersionsQueryV1](docs/WebscriptLatestVersionsQueryV1.md) - - [WebscriptLatestVersionsQueryV2](docs/WebscriptLatestVersionsQueryV2.md) - [WebscriptManifest](docs/WebscriptManifest.md) - - [WebscriptResponse](docs/WebscriptResponse.md) - [WebscriptResponseV2](docs/WebscriptResponseV2.md) - [WebscriptResponseWithInvokeLinkV2](docs/WebscriptResponseWithInvokeLinkV2.md) - [WebscriptVersionsResponseV2](docs/WebscriptVersionsResponseV2.md) - - [WithAssetHALLink](docs/WithAssetHALLink.md) - - [WithEntityAttributes](docs/WithEntityAttributes.md) - - [WithLimit](docs/WithLimit.md) - - [WithPaging](docs/WithPaging.md) diff --git a/docs/DefaultApi.md b/docs/AboutApi.md similarity index 83% rename from docs/DefaultApi.md rename to docs/AboutApi.md index 5f6028ce..82e14a1f 100644 --- a/docs/DefaultApi.md +++ b/docs/AboutApi.md @@ -1,19 +1,19 @@ -# waylay.services.registry.DefaultApi +# waylay.services.registry.AboutApi All URIs are relative to *https://api.waylay.io* Method | HTTP request | Description ------------- | ------------- | ------------- -[**get**](DefaultApi.md#get) | **GET** /registry/v2/ | Version +[**get**](AboutApi.md#get) | **GET** /registry/v2/ | Get Service Status # **get** > get( > headers > ) -> RootPageResponse -Version +Get Service Status -Get the version of this function registry deployment. +Get the status and version of the function registry service. ### Example @@ -30,14 +30,14 @@ waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed from waylay.services.registry.models.root_page_response import RootPageResponse try: - # Version + # Get Service Status # calls `GET /registry/v2/` - api_response = await waylay_client.registry.default.get( + api_response = await waylay_client.registry.about.get( ) - print("The response of registry.default.get:\n") + print("The response of registry.about.get:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.default.get: %s\n" % e) + print("Exception when calling registry.about.get: %s\n" % e) ``` ### Endpoint diff --git a/docs/AltEmbeddedVersionIKfservingResponseV2.md b/docs/AltEmbeddedVersionIKfservingResponseV2.md new file mode 100644 index 00000000..59d04fad --- /dev/null +++ b/docs/AltEmbeddedVersionIKfservingResponseV2.md @@ -0,0 +1,31 @@ +# AltEmbeddedVersionIKfservingResponseV2 + +Embedded representations of the _latest_ draft/published versions. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**draft** | [**KfservingResponseV2**](KfservingResponseV2.md) | | [optional] +**published** | [**KfservingResponseV2**](KfservingResponseV2.md) | | [optional] + +## Example + +```python +from waylay.services.registry.models.alt_embedded_version_i_kfserving_response_v2 import AltEmbeddedVersionIKfservingResponseV2 + +# TODO update the JSON string below +json = "{}" +# create an instance of AltEmbeddedVersionIKfservingResponseV2 from a JSON string +alt_embedded_version_i_kfserving_response_v2_instance = AltEmbeddedVersionIKfservingResponseV2.from_json(json) +# print the JSON string representation of the object +print AltEmbeddedVersionIKfservingResponseV2.to_json() + +# convert the object into a dict +alt_embedded_version_i_kfserving_response_v2_dict = alt_embedded_version_i_kfserving_response_v2_instance.to_dict() +# create an instance of AltEmbeddedVersionIKfservingResponseV2 from a dict +alt_embedded_version_i_kfserving_response_v2_form_dict = alt_embedded_version_i_kfserving_response_v2.from_dict(alt_embedded_version_i_kfserving_response_v2_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AltEmbeddedVersionIPlugResponseV2.md b/docs/AltEmbeddedVersionIPlugResponseV2.md new file mode 100644 index 00000000..56aba713 --- /dev/null +++ b/docs/AltEmbeddedVersionIPlugResponseV2.md @@ -0,0 +1,31 @@ +# AltEmbeddedVersionIPlugResponseV2 + +Embedded representations of the _latest_ draft/published versions. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**draft** | [**PlugResponseV2**](PlugResponseV2.md) | | [optional] +**published** | [**PlugResponseV2**](PlugResponseV2.md) | | [optional] + +## Example + +```python +from waylay.services.registry.models.alt_embedded_version_i_plug_response_v2 import AltEmbeddedVersionIPlugResponseV2 + +# TODO update the JSON string below +json = "{}" +# create an instance of AltEmbeddedVersionIPlugResponseV2 from a JSON string +alt_embedded_version_i_plug_response_v2_instance = AltEmbeddedVersionIPlugResponseV2.from_json(json) +# print the JSON string representation of the object +print AltEmbeddedVersionIPlugResponseV2.to_json() + +# convert the object into a dict +alt_embedded_version_i_plug_response_v2_dict = alt_embedded_version_i_plug_response_v2_instance.to_dict() +# create an instance of AltEmbeddedVersionIPlugResponseV2 from a dict +alt_embedded_version_i_plug_response_v2_form_dict = alt_embedded_version_i_plug_response_v2.from_dict(alt_embedded_version_i_plug_response_v2_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2.md b/docs/AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2.md new file mode 100644 index 00000000..b43c2a43 --- /dev/null +++ b/docs/AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2.md @@ -0,0 +1,31 @@ +# AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2 + +Embedded representations of the _latest_ draft/published versions. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**draft** | [**WebscriptResponseWithInvokeLinkV2**](WebscriptResponseWithInvokeLinkV2.md) | | [optional] +**published** | [**WebscriptResponseWithInvokeLinkV2**](WebscriptResponseWithInvokeLinkV2.md) | | [optional] + +## Example + +```python +from waylay.services.registry.models.alt_embedded_version_i_webscript_response_with_invoke_link_v2 import AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2 + +# TODO update the JSON string below +json = "{}" +# create an instance of AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2 from a JSON string +alt_embedded_version_i_webscript_response_with_invoke_link_v2_instance = AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2.from_json(json) +# print the JSON string representation of the object +print AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2.to_json() + +# convert the object into a dict +alt_embedded_version_i_webscript_response_with_invoke_link_v2_dict = alt_embedded_version_i_webscript_response_with_invoke_link_v2_instance.to_dict() +# create an instance of AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2 from a dict +alt_embedded_version_i_webscript_response_with_invoke_link_v2_form_dict = alt_embedded_version_i_webscript_response_with_invoke_link_v2.from_dict(alt_embedded_version_i_webscript_response_with_invoke_link_v2_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/AnyJobResult.md b/docs/AnyJobResult.md index 163e4457..ceb5fafc 100644 --- a/docs/AnyJobResult.md +++ b/docs/AnyJobResult.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **registration** | **bool** | | **job_count** | **float** | | [optional] **scheduled_job** | [**JobReference**](JobReference.md) | | [optional] +**operation** | [**RequestOperation**](RequestOperation.md) | | ## Example diff --git a/docs/AssetPathParamsV2.md b/docs/AssetPathParamsV2.md deleted file mode 100644 index bcc36f87..00000000 --- a/docs/AssetPathParamsV2.md +++ /dev/null @@ -1,29 +0,0 @@ -# AssetPathParamsV2 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**wildcard** | **str** | Full path or path prefix of the asset within the archive | - -## Example - -```python -from waylay.services.registry.models.asset_path_params_v2 import AssetPathParamsV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of AssetPathParamsV2 from a JSON string -asset_path_params_v2_instance = AssetPathParamsV2.from_json(json) -# print the JSON string representation of the object -print AssetPathParamsV2.to_json() - -# convert the object into a dict -asset_path_params_v2_dict = asset_path_params_v2_instance.to_dict() -# create an instance of AssetPathParamsV2 from a dict -asset_path_params_v2_form_dict = asset_path_params_v2.from_dict(asset_path_params_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AssetSummary.md b/docs/AssetSummary.md deleted file mode 100644 index e885c619..00000000 --- a/docs/AssetSummary.md +++ /dev/null @@ -1,32 +0,0 @@ -# AssetSummary - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | File name | -**title** | **str** | | [optional] -**description** | **str** | | [optional] -**role** | [**AssetRole**](AssetRole.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.asset_summary import AssetSummary - -# TODO update the JSON string below -json = "{}" -# create an instance of AssetSummary from a JSON string -asset_summary_instance = AssetSummary.from_json(json) -# print the JSON string representation of the object -print AssetSummary.to_json() - -# convert the object into a dict -asset_summary_dict = asset_summary_instance.to_dict() -# create an instance of AssetSummary from a dict -asset_summary_form_dict = asset_summary.from_dict(asset_summary_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AsyncDeployQuery.md b/docs/AsyncDeployQuery.md deleted file mode 100644 index 0176b1a4..00000000 --- a/docs/AsyncDeployQuery.md +++ /dev/null @@ -1,32 +0,0 @@ -# AsyncDeployQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deprecate_previous** | [**DeprecatePreviousPolicy**](DeprecatePreviousPolicy.md) | | [optional] -**dry_run** | **bool** | If set to <code>true</code>, validates the deployment conditions, but does not change anything. | [optional] -**var_async** | **bool** | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to True] -**scale_to_zero** | **bool** | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately. | [optional] [default to False] - -## Example - -```python -from waylay.services.registry.models.async_deploy_query import AsyncDeployQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of AsyncDeployQuery from a JSON string -async_deploy_query_instance = AsyncDeployQuery.from_json(json) -# print the JSON string representation of the object -print AsyncDeployQuery.to_json() - -# convert the object into a dict -async_deploy_query_dict = async_deploy_query_instance.to_dict() -# create an instance of AsyncDeployQuery from a dict -async_deploy_query_form_dict = async_deploy_query.from_dict(async_deploy_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AsyncDeployQueryV1.md b/docs/AsyncDeployQueryV1.md deleted file mode 100644 index d9db3b28..00000000 --- a/docs/AsyncDeployQueryV1.md +++ /dev/null @@ -1,31 +0,0 @@ -# AsyncDeployQueryV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**scale_to_zero** | **bool** | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately. | [optional] [default to False] -**var_async** | **bool** | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to True] -**dry_run** | **bool** | If set to <code>true</code>, validates the deployment conditions, but does not change anything. | [optional] - -## Example - -```python -from waylay.services.registry.models.async_deploy_query_v1 import AsyncDeployQueryV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of AsyncDeployQueryV1 from a JSON string -async_deploy_query_v1_instance = AsyncDeployQueryV1.from_json(json) -# print the JSON string representation of the object -print AsyncDeployQueryV1.to_json() - -# convert the object into a dict -async_deploy_query_v1_dict = async_deploy_query_v1_instance.to_dict() -# create an instance of AsyncDeployQueryV1 from a dict -async_deploy_query_v1_form_dict = async_deploy_query_v1.from_dict(async_deploy_query_v1_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AsyncQueryDefaultFalse.md b/docs/AsyncQueryDefaultFalse.md deleted file mode 100644 index a3374854..00000000 --- a/docs/AsyncQueryDefaultFalse.md +++ /dev/null @@ -1,29 +0,0 @@ -# AsyncQueryDefaultFalse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**var_async** | **bool** | If this is set to <code>true</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. Otherwise, the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to False] - -## Example - -```python -from waylay.services.registry.models.async_query_default_false import AsyncQueryDefaultFalse - -# TODO update the JSON string below -json = "{}" -# create an instance of AsyncQueryDefaultFalse from a JSON string -async_query_default_false_instance = AsyncQueryDefaultFalse.from_json(json) -# print the JSON string representation of the object -print AsyncQueryDefaultFalse.to_json() - -# convert the object into a dict -async_query_default_false_dict = async_query_default_false_instance.to_dict() -# create an instance of AsyncQueryDefaultFalse from a dict -async_query_default_false_form_dict = async_query_default_false.from_dict(async_query_default_false_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AsyncQueryDefaultTrue.md b/docs/AsyncQueryDefaultTrue.md deleted file mode 100644 index ed192c31..00000000 --- a/docs/AsyncQueryDefaultTrue.md +++ /dev/null @@ -1,29 +0,0 @@ -# AsyncQueryDefaultTrue - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**var_async** | **bool** | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to True] - -## Example - -```python -from waylay.services.registry.models.async_query_default_true import AsyncQueryDefaultTrue - -# TODO update the JSON string below -json = "{}" -# create an instance of AsyncQueryDefaultTrue from a JSON string -async_query_default_true_instance = AsyncQueryDefaultTrue.from_json(json) -# print the JSON string representation of the object -print AsyncQueryDefaultTrue.to_json() - -# convert the object into a dict -async_query_default_true_dict = async_query_default_true_instance.to_dict() -# create an instance of AsyncQueryDefaultTrue from a dict -async_query_default_true_form_dict = async_query_default_true.from_dict(async_query_default_true_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/AsyncVerifyQuery.md b/docs/AsyncVerifyQuery.md deleted file mode 100644 index 5d20bd67..00000000 --- a/docs/AsyncVerifyQuery.md +++ /dev/null @@ -1,31 +0,0 @@ -# AsyncVerifyQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comment** | **str** | An optional user-specified comment corresponding to the operation. | [optional] -**var_async** | **bool** | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to True] -**scale_to_zero** | **bool** | Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. | [optional] - -## Example - -```python -from waylay.services.registry.models.async_verify_query import AsyncVerifyQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of AsyncVerifyQuery from a JSON string -async_verify_query_instance = AsyncVerifyQuery.from_json(json) -# print the JSON string representation of the object -print AsyncVerifyQuery.to_json() - -# convert the object into a dict -async_verify_query_dict = async_verify_query_instance.to_dict() -# create an instance of AsyncVerifyQuery from a dict -async_verify_query_form_dict = async_verify_query.from_dict(async_verify_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/BuildArgs.md b/docs/BuildArgs.md index 1d835f3a..68703c80 100644 --- a/docs/BuildArgs.md +++ b/docs/BuildArgs.md @@ -8,7 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **runtime_name** | **str** | | **runtime_version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**revision** | **str** | The revision hash of the current (draft) function revision | [optional] +**revision** | **str** | The revision hash of the current (draft) function revision | **storage_location** | **str** | Location of the function assets. | **image_name** | **str** | Provided (or defaulted) image name to publish the function image. | **args** | **Dict[str, str]** | Parameters to the runtime configuration. | diff --git a/docs/CompletedEventData.md b/docs/CompletedEventData.md index 317a9f3f..cc5a4356 100644 --- a/docs/CompletedEventData.md +++ b/docs/CompletedEventData.md @@ -6,7 +6,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **prev** | [**QueueEvents**](QueueEvents.md) | | [optional] -**return_value** | [**AnyJobResult**](AnyJobResult.md) | | +**returnvalue** | [**AnyJobResult**](AnyJobResult.md) | | ## Example diff --git a/docs/ContentQueryV2.md b/docs/ContentQueryV2.md deleted file mode 100644 index ac80f43e..00000000 --- a/docs/ContentQueryV2.md +++ /dev/null @@ -1,29 +0,0 @@ -# ContentQueryV2 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ls** | **bool** | If set to `true`, the result will be a listing of the files in the asset, annotated with metadata and validation report from the asset conditions of the functions runtime. | [optional] [default to False] - -## Example - -```python -from waylay.services.registry.models.content_query_v2 import ContentQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of ContentQueryV2 from a JSON string -content_query_v2_instance = ContentQueryV2.from_json(json) -# print the JSON string representation of the object -print ContentQueryV2.to_json() - -# convert the object into a dict -content_query_v2_dict = content_query_v2_instance.to_dict() -# create an instance of ContentQueryV2 from a dict -content_query_v2_form_dict = content_query_v2.from_dict(content_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateFunctionQueryV2.md b/docs/CreateFunctionQueryV2.md deleted file mode 100644 index 3d68d4dd..00000000 --- a/docs/CreateFunctionQueryV2.md +++ /dev/null @@ -1,35 +0,0 @@ -# CreateFunctionQueryV2 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deprecate_previous** | [**DeprecatePreviousPolicy**](DeprecatePreviousPolicy.md) | | [optional] -**dry_run** | **bool** | If set to <code>true</code>, validates the deployment conditions, but does not change anything. | [optional] -**var_async** | **bool** | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to True] -**scale_to_zero** | **bool** | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately. | [optional] [default to False] -**version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**name** | **str** | If set, the value will be used as the function name instead of the one specified in the manifest. | [optional] -**draft** | **bool** | If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. | [optional] [default to False] - -## Example - -```python -from waylay.services.registry.models.create_function_query_v2 import CreateFunctionQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of CreateFunctionQueryV2 from a JSON string -create_function_query_v2_instance = CreateFunctionQueryV2.from_json(json) -# print the JSON string representation of the object -print CreateFunctionQueryV2.to_json() - -# convert the object into a dict -create_function_query_v2_dict = create_function_query_v2_instance.to_dict() -# create an instance of CreateFunctionQueryV2 from a dict -create_function_query_v2_form_dict = create_function_query_v2.from_dict(create_function_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateKFServingAsyncResponse.md b/docs/CreateKFServingAsyncResponse.md deleted file mode 100644 index 78932850..00000000 --- a/docs/CreateKFServingAsyncResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -# CreateKFServingAsyncResponse - -Model Deployment Initiated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | -**links** | [**JobHALLinks**](JobHALLinks.md) | | -**entity** | [**KFServingManifest**](KFServingManifest.md) | | - -## Example - -```python -from waylay.services.registry.models.create_kf_serving_async_response import CreateKFServingAsyncResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of CreateKFServingAsyncResponse from a JSON string -create_kf_serving_async_response_instance = CreateKFServingAsyncResponse.from_json(json) -# print the JSON string representation of the object -print CreateKFServingAsyncResponse.to_json() - -# convert the object into a dict -create_kf_serving_async_response_dict = create_kf_serving_async_response_instance.to_dict() -# create an instance of CreateKFServingAsyncResponse from a dict -create_kf_serving_async_response_form_dict = create_kf_serving_async_response.from_dict(create_kf_serving_async_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreatePlugAsyncResponse.md b/docs/CreatePlugAsyncResponse.md deleted file mode 100644 index 4b6197e0..00000000 --- a/docs/CreatePlugAsyncResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -# CreatePlugAsyncResponse - -Successful Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | -**links** | [**JobHALLinks**](JobHALLinks.md) | | -**entity** | [**PlugManifest**](PlugManifest.md) | | - -## Example - -```python -from waylay.services.registry.models.create_plug_async_response import CreatePlugAsyncResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of CreatePlugAsyncResponse from a JSON string -create_plug_async_response_instance = CreatePlugAsyncResponse.from_json(json) -# print the JSON string representation of the object -print CreatePlugAsyncResponse.to_json() - -# convert the object into a dict -create_plug_async_response_dict = create_plug_async_response_instance.to_dict() -# create an instance of CreatePlugAsyncResponse from a dict -create_plug_async_response_form_dict = create_plug_async_response.from_dict(create_plug_async_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateWebscriptAsyncResponse.md b/docs/CreateWebscriptAsyncResponse.md deleted file mode 100644 index 4a605ebf..00000000 --- a/docs/CreateWebscriptAsyncResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -# CreateWebscriptAsyncResponse - -Successful Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | -**links** | [**JobHALLinks**](JobHALLinks.md) | | -**entity** | [**WebscriptManifest**](WebscriptManifest.md) | | - -## Example - -```python -from waylay.services.registry.models.create_webscript_async_response import CreateWebscriptAsyncResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of CreateWebscriptAsyncResponse from a JSON string -create_webscript_async_response_instance = CreateWebscriptAsyncResponse.from_json(json) -# print the JSON string representation of the object -print CreateWebscriptAsyncResponse.to_json() - -# convert the object into a dict -create_webscript_async_response_dict = create_webscript_async_response_instance.to_dict() -# create an instance of CreateWebscriptAsyncResponse from a dict -create_webscript_async_response_form_dict = create_webscript_async_response.from_dict(create_webscript_async_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/CreateWebscriptsCopyParameter.md b/docs/CreateWebscriptsCopyParameter.md new file mode 100644 index 00000000..94ece30f --- /dev/null +++ b/docs/CreateWebscriptsCopyParameter.md @@ -0,0 +1,28 @@ +# CreateWebscriptsCopyParameter + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```python +from waylay.services.registry.models.create_webscripts_copy_parameter import CreateWebscriptsCopyParameter + +# TODO update the JSON string below +json = "{}" +# create an instance of CreateWebscriptsCopyParameter from a JSON string +create_webscripts_copy_parameter_instance = CreateWebscriptsCopyParameter.from_json(json) +# print the JSON string representation of the object +print CreateWebscriptsCopyParameter.to_json() + +# convert the object into a dict +create_webscripts_copy_parameter_dict = create_webscripts_copy_parameter_instance.to_dict() +# create an instance of CreateWebscriptsCopyParameter from a dict +create_webscripts_copy_parameter_form_dict = create_webscripts_copy_parameter.from_dict(create_webscripts_copy_parameter_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/DeployArgs.md b/docs/DeployArgs.md index b21a532e..475acb4d 100644 --- a/docs/DeployArgs.md +++ b/docs/DeployArgs.md @@ -11,7 +11,7 @@ Name | Type | Description | Notes **image_name** | **str** | The image name to use for deploying this function | **runtime_name** | **str** | | **runtime_version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**revision** | **str** | The revision hash of the current (draft) function revision | [optional] +**revision** | **str** | The revision hash of the current (draft) function revision | **deploy_spec_overrides** | [**DeployArgsDeploySpecOverrides**](DeployArgsDeploySpecOverrides.md) | | ## Example diff --git a/docs/DeployAttributesFilter.md b/docs/DeployAttributesFilter.md deleted file mode 100644 index 4b30af9e..00000000 --- a/docs/DeployAttributesFilter.md +++ /dev/null @@ -1,31 +0,0 @@ -# DeployAttributesFilter - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**endpoint** | **str** | Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**image_name** | **str** | Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**storage_location** | **str** | Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] - -## Example - -```python -from waylay.services.registry.models.deploy_attributes_filter import DeployAttributesFilter - -# TODO update the JSON string below -json = "{}" -# create an instance of DeployAttributesFilter from a JSON string -deploy_attributes_filter_instance = DeployAttributesFilter.from_json(json) -# print the JSON string representation of the object -print DeployAttributesFilter.to_json() - -# convert the object into a dict -deploy_attributes_filter_dict = deploy_attributes_filter_instance.to_dict() -# create an instance of DeployAttributesFilter from a dict -deploy_attributes_filter_form_dict = deploy_attributes_filter.from_dict(deploy_attributes_filter_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DeprecatePreviousQuery.md b/docs/DeprecatePreviousQuery.md deleted file mode 100644 index 9bd3543b..00000000 --- a/docs/DeprecatePreviousQuery.md +++ /dev/null @@ -1,29 +0,0 @@ -# DeprecatePreviousQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deprecate_previous** | [**DeprecatePreviousPolicy**](DeprecatePreviousPolicy.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.deprecate_previous_query import DeprecatePreviousQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of DeprecatePreviousQuery from a JSON string -deprecate_previous_query_instance = DeprecatePreviousQuery.from_json(json) -# print the JSON string representation of the object -print DeprecatePreviousQuery.to_json() - -# convert the object into a dict -deprecate_previous_query_dict = deprecate_previous_query_instance.to_dict() -# create an instance of DeprecatePreviousQuery from a dict -deprecate_previous_query_form_dict = deprecate_previous_query.from_dict(deprecate_previous_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DeprecatedDraftFilter.md b/docs/DeprecatedDraftFilter.md deleted file mode 100644 index 48b5c2cd..00000000 --- a/docs/DeprecatedDraftFilter.md +++ /dev/null @@ -1,30 +0,0 @@ -# DeprecatedDraftFilter - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.deprecated_draft_filter import DeprecatedDraftFilter - -# TODO update the JSON string below -json = "{}" -# create an instance of DeprecatedDraftFilter from a JSON string -deprecated_draft_filter_instance = DeprecatedDraftFilter.from_json(json) -# print the JSON string representation of the object -print DeprecatedDraftFilter.to_json() - -# convert the object into a dict -deprecated_draft_filter_dict = deprecated_draft_filter_instance.to_dict() -# create an instance of DeprecatedDraftFilter from a dict -deprecated_draft_filter_form_dict = deprecated_draft_filter.from_dict(deprecated_draft_filter_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/DryRunQuery.md b/docs/DryRunQuery.md deleted file mode 100644 index 9b7f036f..00000000 --- a/docs/DryRunQuery.md +++ /dev/null @@ -1,29 +0,0 @@ -# DryRunQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**dry_run** | **bool** | If set to <code>true</code>, validates the deployment conditions, but does not change anything. | [optional] - -## Example - -```python -from waylay.services.registry.models.dry_run_query import DryRunQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of DryRunQuery from a JSON string -dry_run_query_instance = DryRunQuery.from_json(json) -# print the JSON string representation of the object -print DryRunQuery.to_json() - -# convert the object into a dict -dry_run_query_dict = dry_run_query_instance.to_dict() -# create an instance of DryRunQuery from a dict -dry_run_query_form_dict = dry_run_query.from_dict(dry_run_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EntityResponse.md b/docs/EntityResponse.md deleted file mode 100644 index 3256e96f..00000000 --- a/docs/EntityResponse.md +++ /dev/null @@ -1,41 +0,0 @@ -# EntityResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deploy** | [**FunctionDeployOverridesType**](FunctionDeployOverridesType.md) | | [optional] -**name** | **str** | The logical name for the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**runtime** | **str** | | -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**metadata** | [**FunctionMeta**](FunctionMeta.md) | | -**created_by** | **str** | The user that created this entity. | -**created_at** | **datetime** | The timestamp at which this entity was created. | -**updated_by** | **str** | The user that last updated this entity. | -**updated_at** | **datetime** | The timestamp at which this entity was last updated. | -**status** | [**Status**](Status.md) | | -**failure_reason** | [**FailureReason**](FailureReason.md) | | [optional] -**links** | [**List[JobHALLinks]**](JobHALLinks.md) | Links to related entities. | [optional] - -## Example - -```python -from waylay.services.registry.models.entity_response import EntityResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of EntityResponse from a JSON string -entity_response_instance = EntityResponse.from_json(json) -# print the JSON string representation of the object -print EntityResponse.to_json() - -# convert the object into a dict -entity_response_dict = entity_response_instance.to_dict() -# create an instance of EntityResponse from a dict -entity_response_form_dict = entity_response.from_dict(entity_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LatestModelsResponseV2EntitiesInner.md b/docs/EntityWithLinksIKfservingResponseV2.md similarity index 61% rename from docs/LatestModelsResponseV2EntitiesInner.md rename to docs/EntityWithLinksIKfservingResponseV2.md index 89f5823f..e07382a0 100644 --- a/docs/LatestModelsResponseV2EntitiesInner.md +++ b/docs/EntityWithLinksIKfservingResponseV2.md @@ -1,11 +1,12 @@ -# LatestModelsResponseV2EntitiesInner +# EntityWithLinksIKfservingResponseV2 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**AltVersionHALLink**](AltVersionHALLink.md) | | +**embedded** | [**AltEmbeddedVersionIKfservingResponseV2**](AltEmbeddedVersionIKfservingResponseV2.md) | | [optional] +**links** | [**AltVersionHALLink**](AltVersionHALLink.md) | | [optional] **created_by** | **str** | The user that created this entity. | **created_at** | **datetime** | The timestamp at which this entity was created. | **updated_by** | **str** | The user that last updated this entity. | @@ -21,19 +22,19 @@ Name | Type | Description | Notes ## Example ```python -from waylay.services.registry.models.latest_models_response_v2_entities_inner import LatestModelsResponseV2EntitiesInner +from waylay.services.registry.models.entity_with_links_i_kfserving_response_v2 import EntityWithLinksIKfservingResponseV2 # TODO update the JSON string below json = "{}" -# create an instance of LatestModelsResponseV2EntitiesInner from a JSON string -latest_models_response_v2_entities_inner_instance = LatestModelsResponseV2EntitiesInner.from_json(json) +# create an instance of EntityWithLinksIKfservingResponseV2 from a JSON string +entity_with_links_i_kfserving_response_v2_instance = EntityWithLinksIKfservingResponseV2.from_json(json) # print the JSON string representation of the object -print LatestModelsResponseV2EntitiesInner.to_json() +print EntityWithLinksIKfservingResponseV2.to_json() # convert the object into a dict -latest_models_response_v2_entities_inner_dict = latest_models_response_v2_entities_inner_instance.to_dict() -# create an instance of LatestModelsResponseV2EntitiesInner from a dict -latest_models_response_v2_entities_inner_form_dict = latest_models_response_v2_entities_inner.from_dict(latest_models_response_v2_entities_inner_dict) +entity_with_links_i_kfserving_response_v2_dict = entity_with_links_i_kfserving_response_v2_instance.to_dict() +# create an instance of EntityWithLinksIKfservingResponseV2 from a dict +entity_with_links_i_kfserving_response_v2_form_dict = entity_with_links_i_kfserving_response_v2.from_dict(entity_with_links_i_kfserving_response_v2_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/LatestPlugsResponseV2EntitiesInner.md b/docs/EntityWithLinksIPlugResponseV2.md similarity index 63% rename from docs/LatestPlugsResponseV2EntitiesInner.md rename to docs/EntityWithLinksIPlugResponseV2.md index c4ea63b2..0e4a6f36 100644 --- a/docs/LatestPlugsResponseV2EntitiesInner.md +++ b/docs/EntityWithLinksIPlugResponseV2.md @@ -1,11 +1,12 @@ -# LatestPlugsResponseV2EntitiesInner +# EntityWithLinksIPlugResponseV2 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -**links** | [**AltVersionHALLink**](AltVersionHALLink.md) | | +**embedded** | [**AltEmbeddedVersionIPlugResponseV2**](AltEmbeddedVersionIPlugResponseV2.md) | | [optional] +**links** | [**AltVersionHALLink**](AltVersionHALLink.md) | | [optional] **created_by** | **str** | The user that created this entity. | **created_at** | **datetime** | The timestamp at which this entity was created. | **updated_by** | **str** | The user that last updated this entity. | @@ -21,19 +22,19 @@ Name | Type | Description | Notes ## Example ```python -from waylay.services.registry.models.latest_plugs_response_v2_entities_inner import LatestPlugsResponseV2EntitiesInner +from waylay.services.registry.models.entity_with_links_i_plug_response_v2 import EntityWithLinksIPlugResponseV2 # TODO update the JSON string below json = "{}" -# create an instance of LatestPlugsResponseV2EntitiesInner from a JSON string -latest_plugs_response_v2_entities_inner_instance = LatestPlugsResponseV2EntitiesInner.from_json(json) +# create an instance of EntityWithLinksIPlugResponseV2 from a JSON string +entity_with_links_i_plug_response_v2_instance = EntityWithLinksIPlugResponseV2.from_json(json) # print the JSON string representation of the object -print LatestPlugsResponseV2EntitiesInner.to_json() +print EntityWithLinksIPlugResponseV2.to_json() # convert the object into a dict -latest_plugs_response_v2_entities_inner_dict = latest_plugs_response_v2_entities_inner_instance.to_dict() -# create an instance of LatestPlugsResponseV2EntitiesInner from a dict -latest_plugs_response_v2_entities_inner_form_dict = latest_plugs_response_v2_entities_inner.from_dict(latest_plugs_response_v2_entities_inner_dict) +entity_with_links_i_plug_response_v2_dict = entity_with_links_i_plug_response_v2_instance.to_dict() +# create an instance of EntityWithLinksIPlugResponseV2 from a dict +entity_with_links_i_plug_response_v2_form_dict = entity_with_links_i_plug_response_v2.from_dict(entity_with_links_i_plug_response_v2_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/AnyFunctionResponse.md b/docs/EntityWithLinksIWebscriptResponseWithInvokeLinkV2.md similarity index 58% rename from docs/AnyFunctionResponse.md rename to docs/EntityWithLinksIWebscriptResponseWithInvokeLinkV2.md index c2b197b7..946848cf 100644 --- a/docs/AnyFunctionResponse.md +++ b/docs/EntityWithLinksIWebscriptResponseWithInvokeLinkV2.md @@ -1,10 +1,12 @@ -# AnyFunctionResponse +# EntityWithLinksIWebscriptResponseWithInvokeLinkV2 ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- +**embedded** | [**AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2**](AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2.md) | | [optional] +**links** | [**InvokeHALLink**](InvokeHALLink.md) | | [optional] **created_by** | **str** | The user that created this entity. | **created_at** | **datetime** | The timestamp at which this entity was created. | **updated_by** | **str** | The user that last updated this entity. | @@ -15,27 +17,25 @@ Name | Type | Description | Notes **runtime** | [**RuntimeAttributes**](RuntimeAttributes.md) | | **deprecated** | **bool** | If <code>true</code> this function is deprecated and removed from regular listings. | **draft** | **bool** | If <code>true</code> this function is a draft function and it's assets are still mutable. | -**plug** | [**PlugManifest**](PlugManifest.md) | | -**model** | [**KFServingManifest**](KFServingManifest.md) | | **webscript** | [**WebscriptManifest**](WebscriptManifest.md) | | **secret** | **str** | The secret for this webscript deployment. This is <code>null</code> when <code>allowHmac=false</code> in the webscript specificaton. | [optional] ## Example ```python -from waylay.services.registry.models.any_function_response import AnyFunctionResponse +from waylay.services.registry.models.entity_with_links_i_webscript_response_with_invoke_link_v2 import EntityWithLinksIWebscriptResponseWithInvokeLinkV2 # TODO update the JSON string below json = "{}" -# create an instance of AnyFunctionResponse from a JSON string -any_function_response_instance = AnyFunctionResponse.from_json(json) +# create an instance of EntityWithLinksIWebscriptResponseWithInvokeLinkV2 from a JSON string +entity_with_links_i_webscript_response_with_invoke_link_v2_instance = EntityWithLinksIWebscriptResponseWithInvokeLinkV2.from_json(json) # print the JSON string representation of the object -print AnyFunctionResponse.to_json() +print EntityWithLinksIWebscriptResponseWithInvokeLinkV2.to_json() # convert the object into a dict -any_function_response_dict = any_function_response_instance.to_dict() -# create an instance of AnyFunctionResponse from a dict -any_function_response_form_dict = any_function_response.from_dict(any_function_response_dict) +entity_with_links_i_webscript_response_with_invoke_link_v2_dict = entity_with_links_i_webscript_response_with_invoke_link_v2_instance.to_dict() +# create an instance of EntityWithLinksIWebscriptResponseWithInvokeLinkV2 from a dict +entity_with_links_i_webscript_response_with_invoke_link_v2_form_dict = entity_with_links_i_webscript_response_with_invoke_link_v2.from_dict(entity_with_links_i_webscript_response_with_invoke_link_v2_dict) ``` [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/docs/ErrorAndStatusResponse.md b/docs/ErrorAndStatusResponse.md deleted file mode 100644 index d7bb9a09..00000000 --- a/docs/ErrorAndStatusResponse.md +++ /dev/null @@ -1,30 +0,0 @@ -# ErrorAndStatusResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error** | **str** | | -**status_code** | **float** | | - -## Example - -```python -from waylay.services.registry.models.error_and_status_response import ErrorAndStatusResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of ErrorAndStatusResponse from a JSON string -error_and_status_response_instance = ErrorAndStatusResponse.from_json(json) -# print the JSON string representation of the object -print ErrorAndStatusResponse.to_json() - -# convert the object into a dict -error_and_status_response_dict = error_and_status_response_instance.to_dict() -# create an instance of ErrorAndStatusResponse from a dict -error_and_status_response_form_dict = error_and_status_response.from_dict(error_and_status_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ErrorResponse.md b/docs/ErrorResponse.md deleted file mode 100644 index 48fb88d2..00000000 --- a/docs/ErrorResponse.md +++ /dev/null @@ -1,29 +0,0 @@ -# ErrorResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**error** | **str** | | - -## Example - -```python -from waylay.services.registry.models.error_response import ErrorResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of ErrorResponse from a JSON string -error_response_instance = ErrorResponse.from_json(json) -# print the JSON string representation of the object -print ErrorResponse.to_json() - -# convert the object into a dict -error_response_dict = error_response_instance.to_dict() -# create an instance of ErrorResponse from a dict -error_response_form_dict = error_response.from_dict(error_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EventSSE.md b/docs/EventSSE.md deleted file mode 100644 index 2fcd074c..00000000 --- a/docs/EventSSE.md +++ /dev/null @@ -1,31 +0,0 @@ -# EventSSE - -SSE stream events without closing protocol - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**event** | [**EventKeepAlive**](EventKeepAlive.md) | | -**data** | **str** | A text message acknowledging that events will be forwarded. | - -## Example - -```python -from waylay.services.registry.models.event_sse import EventSSE - -# TODO update the JSON string below -json = "{}" -# create an instance of EventSSE from a JSON string -event_sse_instance = EventSSE.from_json(json) -# print the JSON string representation of the object -print EventSSE.to_json() - -# convert the object into a dict -event_sse_dict = event_sse_instance.to_dict() -# create an instance of EventSSE from a dict -event_sse_form_dict = event_sse.from_dict(event_sse_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/EventTypeSSE.md b/docs/EventTypeSSE.md deleted file mode 100644 index f7c9401b..00000000 --- a/docs/EventTypeSSE.md +++ /dev/null @@ -1,28 +0,0 @@ -# EventTypeSSE - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - -## Example - -```python -from waylay.services.registry.models.event_type_sse import EventTypeSSE - -# TODO update the JSON string below -json = "{}" -# create an instance of EventTypeSSE from a JSON string -event_type_sse_instance = EventTypeSSE.from_json(json) -# print the JSON string representation of the object -print EventTypeSSE.to_json() - -# convert the object into a dict -event_type_sse_dict = event_type_sse_instance.to_dict() -# create an instance of EventTypeSSE from a dict -event_type_sse_form_dict = event_type_sse.from_dict(event_type_sse_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ExampleReference.md b/docs/ExampleReference.md new file mode 100644 index 00000000..182440ed --- /dev/null +++ b/docs/ExampleReference.md @@ -0,0 +1,12 @@ +# ExampleReference + +Example reference. References the example assets from the selected runtime. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/ForceDeleteQueryV1.md b/docs/ForceDeleteQueryV1.md deleted file mode 100644 index cfff89bf..00000000 --- a/docs/ForceDeleteQueryV1.md +++ /dev/null @@ -1,30 +0,0 @@ -# ForceDeleteQueryV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**var_async** | **bool** | If this is set to <code>true</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. Otherwise, the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to False] -**force** | **bool** | If <code>true</code>, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be <code>deprecated</code>, i.e removed from regular listings. | [optional] - -## Example - -```python -from waylay.services.registry.models.force_delete_query_v1 import ForceDeleteQueryV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of ForceDeleteQueryV1 from a JSON string -force_delete_query_v1_instance = ForceDeleteQueryV1.from_json(json) -# print the JSON string representation of the object -print ForceDeleteQueryV1.to_json() - -# convert the object into a dict -force_delete_query_v1_dict = force_delete_query_v1_instance.to_dict() -# create an instance of ForceDeleteQueryV1 from a dict -force_delete_query_v1_form_dict = force_delete_query_v1.from_dict(force_delete_query_v1_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FunctionDeleteQuery.md b/docs/FunctionDeleteQuery.md deleted file mode 100644 index c0d403d9..00000000 --- a/docs/FunctionDeleteQuery.md +++ /dev/null @@ -1,30 +0,0 @@ -# FunctionDeleteQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**force** | **bool** | If <code>true</code>, the function version will be immediately undeployed and removed. Otherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_. | [optional] -**undeploy** | **bool** | If `true`, the `DELETE` operation * undeploys the (openfaas) function: it becomes no longer available for invocation. * does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only. | [optional] - -## Example - -```python -from waylay.services.registry.models.function_delete_query import FunctionDeleteQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of FunctionDeleteQuery from a JSON string -function_delete_query_instance = FunctionDeleteQuery.from_json(json) -# print the JSON string representation of the object -print FunctionDeleteQuery.to_json() - -# convert the object into a dict -function_delete_query_dict = function_delete_query_instance.to_dict() -# create an instance of FunctionDeleteQuery from a dict -function_delete_query_form_dict = function_delete_query.from_dict(function_delete_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FunctionDeployOverrides.md b/docs/FunctionDeployOverrides.md deleted file mode 100644 index d811e4c1..00000000 --- a/docs/FunctionDeployOverrides.md +++ /dev/null @@ -1,29 +0,0 @@ -# FunctionDeployOverrides - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deploy** | [**FunctionDeployOverridesType**](FunctionDeployOverridesType.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.function_deploy_overrides import FunctionDeployOverrides - -# TODO update the JSON string below -json = "{}" -# create an instance of FunctionDeployOverrides from a JSON string -function_deploy_overrides_instance = FunctionDeployOverrides.from_json(json) -# print the JSON string representation of the object -print FunctionDeployOverrides.to_json() - -# convert the object into a dict -function_deploy_overrides_dict = function_deploy_overrides_instance.to_dict() -# create an instance of FunctionDeployOverrides from a dict -function_deploy_overrides_form_dict = function_deploy_overrides.from_dict(function_deploy_overrides_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FunctionEntityQuery.md b/docs/FunctionEntityQuery.md deleted file mode 100644 index 2dd07dee..00000000 --- a/docs/FunctionEntityQuery.md +++ /dev/null @@ -1,32 +0,0 @@ -# FunctionEntityQuery - -Filter on function attributes that do not change across function versions. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.function_entity_query import FunctionEntityQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of FunctionEntityQuery from a JSON string -function_entity_query_instance = FunctionEntityQuery.from_json(json) -# print the JSON string representation of the object -print FunctionEntityQuery.to_json() - -# convert the object into a dict -function_entity_query_dict = function_entity_query_instance.to_dict() -# create an instance of FunctionEntityQuery from a dict -function_entity_query_form_dict = function_entity_query.from_dict(function_entity_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FunctionJobArgs.md b/docs/FunctionJobArgs.md deleted file mode 100644 index 3bf80563..00000000 --- a/docs/FunctionJobArgs.md +++ /dev/null @@ -1,32 +0,0 @@ -# FunctionJobArgs - -Job arguments shared by all function jobs - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**runtime_name** | **str** | | -**runtime_version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**revision** | **str** | The revision hash of the current (draft) function revision | [optional] - -## Example - -```python -from waylay.services.registry.models.function_job_args import FunctionJobArgs - -# TODO update the JSON string below -json = "{}" -# create an instance of FunctionJobArgs from a JSON string -function_job_args_instance = FunctionJobArgs.from_json(json) -# print the JSON string representation of the object -print FunctionJobArgs.to_json() - -# convert the object into a dict -function_job_args_dict = function_job_args_instance.to_dict() -# create an instance of FunctionJobArgs from a dict -function_job_args_form_dict = function_job_args.from_dict(function_job_args_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FunctionManifest.md b/docs/FunctionManifest.md deleted file mode 100644 index becaf9fb..00000000 --- a/docs/FunctionManifest.md +++ /dev/null @@ -1,34 +0,0 @@ -# FunctionManifest - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deploy** | [**FunctionDeployOverridesType**](FunctionDeployOverridesType.md) | | [optional] -**name** | **str** | The logical name for the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**runtime** | **str** | | -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**metadata** | [**FunctionMeta**](FunctionMeta.md) | | - -## Example - -```python -from waylay.services.registry.models.function_manifest import FunctionManifest - -# TODO update the JSON string below -json = "{}" -# create an instance of FunctionManifest from a JSON string -function_manifest_instance = FunctionManifest.from_json(json) -# print the JSON string representation of the object -print FunctionManifest.to_json() - -# convert the object into a dict -function_manifest_dict = function_manifest_instance.to_dict() -# create an instance of FunctionManifest from a dict -function_manifest_form_dict = function_manifest.from_dict(function_manifest_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FunctionNameVersion.md b/docs/FunctionNameVersion.md deleted file mode 100644 index 9f580c5a..00000000 --- a/docs/FunctionNameVersion.md +++ /dev/null @@ -1,30 +0,0 @@ -# FunctionNameVersion - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The logical name for the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | - -## Example - -```python -from waylay.services.registry.models.function_name_version import FunctionNameVersion - -# TODO update the JSON string below -json = "{}" -# create an instance of FunctionNameVersion from a JSON string -function_name_version_instance = FunctionNameVersion.from_json(json) -# print the JSON string representation of the object -print FunctionNameVersion.to_json() - -# convert the object into a dict -function_name_version_dict = function_name_version_instance.to_dict() -# create an instance of FunctionNameVersion from a dict -function_name_version_form_dict = function_name_version.from_dict(function_name_version_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FunctionSpec.md b/docs/FunctionSpec.md deleted file mode 100644 index 236834f0..00000000 --- a/docs/FunctionSpec.md +++ /dev/null @@ -1,31 +0,0 @@ -# FunctionSpec - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The logical name for the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**runtime** | **str** | | - -## Example - -```python -from waylay.services.registry.models.function_spec import FunctionSpec - -# TODO update the JSON string below -json = "{}" -# create an instance of FunctionSpec from a JSON string -function_spec_instance = FunctionSpec.from_json(json) -# print the JSON string representation of the object -print FunctionSpec.to_json() - -# convert the object into a dict -function_spec_dict = function_spec_instance.to_dict() -# create an instance of FunctionSpec from a dict -function_spec_form_dict = function_spec.from_dict(function_spec_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/FunctionVersionQuery.md b/docs/FunctionVersionQuery.md deleted file mode 100644 index b7dec719..00000000 --- a/docs/FunctionVersionQuery.md +++ /dev/null @@ -1,38 +0,0 @@ -# FunctionVersionQuery - -Filter on function attributes that can change across function versions. When these query parameters are used, the query is considered a _function version_ listing and no HAL links to latest (_draft_, _published_) versions are included. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.function_version_query import FunctionVersionQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of FunctionVersionQuery from a JSON string -function_version_query_instance = FunctionVersionQuery.from_json(json) -# print the JSON string representation of the object -print FunctionVersionQuery.to_json() - -# convert the object into a dict -function_version_query_dict = function_version_query_instance.to_dict() -# create an instance of FunctionVersionQuery from a dict -function_version_query_form_dict = function_version_query.from_dict(function_version_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetContentParamsV2.md b/docs/GetContentParamsV2.md deleted file mode 100644 index c96dc64d..00000000 --- a/docs/GetContentParamsV2.md +++ /dev/null @@ -1,31 +0,0 @@ -# GetContentParamsV2 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**wildcard** | **str** | Full path or path prefix of the asset within the archive | -**name** | **str** | The name of the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | - -## Example - -```python -from waylay.services.registry.models.get_content_params_v2 import GetContentParamsV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of GetContentParamsV2 from a JSON string -get_content_params_v2_instance = GetContentParamsV2.from_json(json) -# print the JSON string representation of the object -print GetContentParamsV2.to_json() - -# convert the object into a dict -get_content_params_v2_dict = get_content_params_v2_instance.to_dict() -# create an instance of GetContentParamsV2 from a dict -get_content_params_v2_form_dict = get_content_params_v2.from_dict(get_content_params_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetInvokableWebscriptQuery.md b/docs/GetInvokableWebscriptQuery.md deleted file mode 100644 index 46ffcc0d..00000000 --- a/docs/GetInvokableWebscriptQuery.md +++ /dev/null @@ -1,32 +0,0 @@ -# GetInvokableWebscriptQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | If set, filters on the `status` of the webscript. | [optional] [default to ["running","deployed","unhealthy"]] - -## Example - -```python -from waylay.services.registry.models.get_invokable_webscript_query import GetInvokableWebscriptQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of GetInvokableWebscriptQuery from a JSON string -get_invokable_webscript_query_instance = GetInvokableWebscriptQuery.from_json(json) -# print the JSON string representation of the object -print GetInvokableWebscriptQuery.to_json() - -# convert the object into a dict -get_invokable_webscript_query_dict = get_invokable_webscript_query_instance.to_dict() -# create an instance of GetInvokableWebscriptQuery from a dict -get_invokable_webscript_query_form_dict = get_invokable_webscript_query.from_dict(get_invokable_webscript_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetRuntimeByNameAndVersionQuery.md b/docs/GetRuntimeByNameAndVersionQuery.md deleted file mode 100644 index 723416c5..00000000 --- a/docs/GetRuntimeByNameAndVersionQuery.md +++ /dev/null @@ -1,29 +0,0 @@ -# GetRuntimeByNameAndVersionQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**include_deprecated** | **bool** | If set to `true`, deprecated runtimes will be included in the query. | [optional] [default to True] - -## Example - -```python -from waylay.services.registry.models.get_runtime_by_name_and_version_query import GetRuntimeByNameAndVersionQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of GetRuntimeByNameAndVersionQuery from a JSON string -get_runtime_by_name_and_version_query_instance = GetRuntimeByNameAndVersionQuery.from_json(json) -# print the JSON string representation of the object -print GetRuntimeByNameAndVersionQuery.to_json() - -# convert the object into a dict -get_runtime_by_name_and_version_query_dict = get_runtime_by_name_and_version_query_instance.to_dict() -# create an instance of GetRuntimeByNameAndVersionQuery from a dict -get_runtime_by_name_and_version_query_form_dict = get_runtime_by_name_and_version_query.from_dict(get_runtime_by_name_and_version_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetRuntimeByNameQuery.md b/docs/GetRuntimeByNameQuery.md deleted file mode 100644 index 2f9e54dc..00000000 --- a/docs/GetRuntimeByNameQuery.md +++ /dev/null @@ -1,32 +0,0 @@ -# GetRuntimeByNameQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**include_deprecated** | **bool** | If set to `true`, deprecated runtimes will be included in the query. | [optional] [default to False] -**function_type** | [**List[FunctionType]**](FunctionType.md) | If set, filters on the <code>functionType</code> of a runtime. Uses an exact match. | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | If set, filters on the <code>archiveFormat</code> of a runtime. Uses an exact match. | [optional] - -## Example - -```python -from waylay.services.registry.models.get_runtime_by_name_query import GetRuntimeByNameQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of GetRuntimeByNameQuery from a JSON string -get_runtime_by_name_query_instance = GetRuntimeByNameQuery.from_json(json) -# print the JSON string representation of the object -print GetRuntimeByNameQuery.to_json() - -# convert the object into a dict -get_runtime_by_name_query_dict = get_runtime_by_name_query_instance.to_dict() -# create an instance of GetRuntimeByNameQuery from a dict -get_runtime_by_name_query_form_dict = get_runtime_by_name_query.from_dict(get_runtime_by_name_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetRuntimeExampleQuery.md b/docs/GetRuntimeExampleQuery.md deleted file mode 100644 index 55278f7c..00000000 --- a/docs/GetRuntimeExampleQuery.md +++ /dev/null @@ -1,30 +0,0 @@ -# GetRuntimeExampleQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**ls** | **bool** | If set to `true`, the result will be a listing of the files in the asset, annotated with metadata and validation report from the asset conditions of the functions runtime. | [optional] [default to False] -**include_deprecated** | **bool** | If set to `true`, deprecated runtimes will be included in the query. | [optional] [default to True] - -## Example - -```python -from waylay.services.registry.models.get_runtime_example_query import GetRuntimeExampleQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of GetRuntimeExampleQuery from a JSON string -get_runtime_example_query_instance = GetRuntimeExampleQuery.from_json(json) -# print the JSON string representation of the object -print GetRuntimeExampleQuery.to_json() - -# convert the object into a dict -get_runtime_example_query_dict = get_runtime_example_query_instance.to_dict() -# create an instance of GetRuntimeExampleQuery from a dict -get_runtime_example_query_form_dict = get_runtime_example_query.from_dict(get_runtime_example_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/GetRuntimeVersionsQuery.md b/docs/GetRuntimeVersionsQuery.md deleted file mode 100644 index 0485f169..00000000 --- a/docs/GetRuntimeVersionsQuery.md +++ /dev/null @@ -1,33 +0,0 @@ -# GetRuntimeVersionsQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**latest** | [**LatestVersionLevel**](LatestVersionLevel.md) | | [optional] -**include_deprecated** | **bool** | If set to `true`, deprecated runtimes will be included in the query. | [optional] [default to False] -**function_type** | [**List[FunctionType]**](FunctionType.md) | If set, filters on the <code>functionType</code> of a runtime. Uses an exact match. | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | If set, filters on the <code>archiveFormat</code> of a runtime. Uses an exact match. | [optional] - -## Example - -```python -from waylay.services.registry.models.get_runtime_versions_query import GetRuntimeVersionsQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of GetRuntimeVersionsQuery from a JSON string -get_runtime_versions_query_instance = GetRuntimeVersionsQuery.from_json(json) -# print the JSON string representation of the object -print GetRuntimeVersionsQuery.to_json() - -# convert the object into a dict -get_runtime_versions_query_dict = get_runtime_versions_query_instance.to_dict() -# create an instance of GetRuntimeVersionsQuery from a dict -get_runtime_versions_query_form_dict = get_runtime_versions_query.from_dict(get_runtime_versions_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvokableWebscriptResponse.md b/docs/InvokableWebscriptResponse.md deleted file mode 100644 index 0bddff48..00000000 --- a/docs/InvokableWebscriptResponse.md +++ /dev/null @@ -1,31 +0,0 @@ -# InvokableWebscriptResponse - -Webscript Found - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entity** | [**InvokableWebscriptResponseEntity**](InvokableWebscriptResponseEntity.md) | | -**links** | [**InvokeInternalHALLink**](InvokeInternalHALLink.md) | | - -## Example - -```python -from waylay.services.registry.models.invokable_webscript_response import InvokableWebscriptResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of InvokableWebscriptResponse from a JSON string -invokable_webscript_response_instance = InvokableWebscriptResponse.from_json(json) -# print the JSON string representation of the object -print InvokableWebscriptResponse.to_json() - -# convert the object into a dict -invokable_webscript_response_dict = invokable_webscript_response_instance.to_dict() -# create an instance of InvokableWebscriptResponse from a dict -invokable_webscript_response_form_dict = invokable_webscript_response.from_dict(invokable_webscript_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvokableWebscriptResponseEntity.md b/docs/InvokableWebscriptResponseEntity.md deleted file mode 100644 index fa0fdd5f..00000000 --- a/docs/InvokableWebscriptResponseEntity.md +++ /dev/null @@ -1,32 +0,0 @@ -# InvokableWebscriptResponseEntity - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status** | [**Status**](Status.md) | | -**draft** | **bool** | | -**webscript** | [**InvokableWebscriptResponseEntityWebscript**](InvokableWebscriptResponseEntityWebscript.md) | | -**secret** | **str** | | [optional] - -## Example - -```python -from waylay.services.registry.models.invokable_webscript_response_entity import InvokableWebscriptResponseEntity - -# TODO update the JSON string below -json = "{}" -# create an instance of InvokableWebscriptResponseEntity from a JSON string -invokable_webscript_response_entity_instance = InvokableWebscriptResponseEntity.from_json(json) -# print the JSON string representation of the object -print InvokableWebscriptResponseEntity.to_json() - -# convert the object into a dict -invokable_webscript_response_entity_dict = invokable_webscript_response_entity_instance.to_dict() -# create an instance of InvokableWebscriptResponseEntity from a dict -invokable_webscript_response_entity_form_dict = invokable_webscript_response_entity.from_dict(invokable_webscript_response_entity_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvokableWebscriptResponseEntityWebscript.md b/docs/InvokableWebscriptResponseEntityWebscript.md deleted file mode 100644 index e91302f5..00000000 --- a/docs/InvokableWebscriptResponseEntityWebscript.md +++ /dev/null @@ -1,32 +0,0 @@ -# InvokableWebscriptResponseEntityWebscript - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**private** | **bool** | | -**allow_hmac** | **bool** | | - -## Example - -```python -from waylay.services.registry.models.invokable_webscript_response_entity_webscript import InvokableWebscriptResponseEntityWebscript - -# TODO update the JSON string below -json = "{}" -# create an instance of InvokableWebscriptResponseEntityWebscript from a JSON string -invokable_webscript_response_entity_webscript_instance = InvokableWebscriptResponseEntityWebscript.from_json(json) -# print the JSON string representation of the object -print InvokableWebscriptResponseEntityWebscript.to_json() - -# convert the object into a dict -invokable_webscript_response_entity_webscript_dict = invokable_webscript_response_entity_webscript_instance.to_dict() -# create an instance of InvokableWebscriptResponseEntityWebscript from a dict -invokable_webscript_response_entity_webscript_form_dict = invokable_webscript_response_entity_webscript.from_dict(invokable_webscript_response_entity_webscript_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/InvokeInternalHALLink.md b/docs/InvokeInternalHALLink.md deleted file mode 100644 index ebd72c78..00000000 --- a/docs/InvokeInternalHALLink.md +++ /dev/null @@ -1,29 +0,0 @@ -# InvokeInternalHALLink - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**invoke_internal** | [**HALLink**](HALLink.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.invoke_internal_hal_link import InvokeInternalHALLink - -# TODO update the JSON string below -json = "{}" -# create an instance of InvokeInternalHALLink from a JSON string -invoke_internal_hal_link_instance = InvokeInternalHALLink.from_json(json) -# print the JSON string representation of the object -print InvokeInternalHALLink.to_json() - -# convert the object into a dict -invoke_internal_hal_link_dict = invoke_internal_hal_link_instance.to_dict() -# create an instance of InvokeInternalHALLink from a dict -invoke_internal_hal_link_form_dict = invoke_internal_hal_link.from_dict(invoke_internal_hal_link_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/JobEventPayloadActiveEventData.md b/docs/JobEventPayloadActiveEventData.md deleted file mode 100644 index 5fb294e0..00000000 --- a/docs/JobEventPayloadActiveEventData.md +++ /dev/null @@ -1,31 +0,0 @@ -# JobEventPayloadActiveEventData - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**job** | [**JobReference**](JobReference.md) | | -**data** | [**ActiveEventData**](ActiveEventData.md) | | -**timestamp** | **datetime** | Timestamp of the event | - -## Example - -```python -from waylay.services.registry.models.job_event_payload_active_event_data import JobEventPayloadActiveEventData - -# TODO update the JSON string below -json = "{}" -# create an instance of JobEventPayloadActiveEventData from a JSON string -job_event_payload_active_event_data_instance = JobEventPayloadActiveEventData.from_json(json) -# print the JSON string representation of the object -print JobEventPayloadActiveEventData.to_json() - -# convert the object into a dict -job_event_payload_active_event_data_dict = job_event_payload_active_event_data_instance.to_dict() -# create an instance of JobEventPayloadActiveEventData from a dict -job_event_payload_active_event_data_form_dict = job_event_payload_active_event_data.from_dict(job_event_payload_active_event_data_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/JobEventPayloadCompletedEventData.md b/docs/JobEventPayloadCompletedEventData.md deleted file mode 100644 index 53d0a5bb..00000000 --- a/docs/JobEventPayloadCompletedEventData.md +++ /dev/null @@ -1,31 +0,0 @@ -# JobEventPayloadCompletedEventData - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**job** | [**JobReference**](JobReference.md) | | -**data** | [**CompletedEventData**](CompletedEventData.md) | | -**timestamp** | **datetime** | Timestamp of the event | - -## Example - -```python -from waylay.services.registry.models.job_event_payload_completed_event_data import JobEventPayloadCompletedEventData - -# TODO update the JSON string below -json = "{}" -# create an instance of JobEventPayloadCompletedEventData from a JSON string -job_event_payload_completed_event_data_instance = JobEventPayloadCompletedEventData.from_json(json) -# print the JSON string representation of the object -print JobEventPayloadCompletedEventData.to_json() - -# convert the object into a dict -job_event_payload_completed_event_data_dict = job_event_payload_completed_event_data_instance.to_dict() -# create an instance of JobEventPayloadCompletedEventData from a dict -job_event_payload_completed_event_data_form_dict = job_event_payload_completed_event_data.from_dict(job_event_payload_completed_event_data_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/JobEventPayloadDelayedEventData.md b/docs/JobEventPayloadDelayedEventData.md deleted file mode 100644 index f5273921..00000000 --- a/docs/JobEventPayloadDelayedEventData.md +++ /dev/null @@ -1,31 +0,0 @@ -# JobEventPayloadDelayedEventData - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**job** | [**JobReference**](JobReference.md) | | -**data** | [**DelayedEventData**](DelayedEventData.md) | | -**timestamp** | **datetime** | Timestamp of the event | - -## Example - -```python -from waylay.services.registry.models.job_event_payload_delayed_event_data import JobEventPayloadDelayedEventData - -# TODO update the JSON string below -json = "{}" -# create an instance of JobEventPayloadDelayedEventData from a JSON string -job_event_payload_delayed_event_data_instance = JobEventPayloadDelayedEventData.from_json(json) -# print the JSON string representation of the object -print JobEventPayloadDelayedEventData.to_json() - -# convert the object into a dict -job_event_payload_delayed_event_data_dict = job_event_payload_delayed_event_data_instance.to_dict() -# create an instance of JobEventPayloadDelayedEventData from a dict -job_event_payload_delayed_event_data_form_dict = job_event_payload_delayed_event_data.from_dict(job_event_payload_delayed_event_data_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/JobEventPayloadFailedEventData.md b/docs/JobEventPayloadFailedEventData.md deleted file mode 100644 index 484a84af..00000000 --- a/docs/JobEventPayloadFailedEventData.md +++ /dev/null @@ -1,31 +0,0 @@ -# JobEventPayloadFailedEventData - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**job** | [**JobReference**](JobReference.md) | | -**data** | [**FailedEventData**](FailedEventData.md) | | -**timestamp** | **datetime** | Timestamp of the event | - -## Example - -```python -from waylay.services.registry.models.job_event_payload_failed_event_data import JobEventPayloadFailedEventData - -# TODO update the JSON string below -json = "{}" -# create an instance of JobEventPayloadFailedEventData from a JSON string -job_event_payload_failed_event_data_instance = JobEventPayloadFailedEventData.from_json(json) -# print the JSON string representation of the object -print JobEventPayloadFailedEventData.to_json() - -# convert the object into a dict -job_event_payload_failed_event_data_dict = job_event_payload_failed_event_data_instance.to_dict() -# create an instance of JobEventPayloadFailedEventData from a dict -job_event_payload_failed_event_data_form_dict = job_event_payload_failed_event_data.from_dict(job_event_payload_failed_event_data_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/JobEventPayloadWaitingChildrenEventData.md b/docs/JobEventPayloadWaitingChildrenEventData.md deleted file mode 100644 index 65658d36..00000000 --- a/docs/JobEventPayloadWaitingChildrenEventData.md +++ /dev/null @@ -1,31 +0,0 @@ -# JobEventPayloadWaitingChildrenEventData - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**job** | [**JobReference**](JobReference.md) | | -**data** | **object** | | -**timestamp** | **datetime** | Timestamp of the event | - -## Example - -```python -from waylay.services.registry.models.job_event_payload_waiting_children_event_data import JobEventPayloadWaitingChildrenEventData - -# TODO update the JSON string below -json = "{}" -# create an instance of JobEventPayloadWaitingChildrenEventData from a JSON string -job_event_payload_waiting_children_event_data_instance = JobEventPayloadWaitingChildrenEventData.from_json(json) -# print the JSON string representation of the object -print JobEventPayloadWaitingChildrenEventData.to_json() - -# convert the object into a dict -job_event_payload_waiting_children_event_data_dict = job_event_payload_waiting_children_event_data_instance.to_dict() -# create an instance of JobEventPayloadWaitingChildrenEventData from a dict -job_event_payload_waiting_children_event_data_form_dict = job_event_payload_waiting_children_event_data.from_dict(job_event_payload_waiting_children_event_data_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/JobEventPayloadWaitingEventData.md b/docs/JobEventPayloadWaitingEventData.md deleted file mode 100644 index a50e4d44..00000000 --- a/docs/JobEventPayloadWaitingEventData.md +++ /dev/null @@ -1,31 +0,0 @@ -# JobEventPayloadWaitingEventData - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**job** | [**JobReference**](JobReference.md) | | -**data** | [**WaitingEventData**](WaitingEventData.md) | | -**timestamp** | **datetime** | Timestamp of the event | - -## Example - -```python -from waylay.services.registry.models.job_event_payload_waiting_event_data import JobEventPayloadWaitingEventData - -# TODO update the JSON string below -json = "{}" -# create an instance of JobEventPayloadWaitingEventData from a JSON string -job_event_payload_waiting_event_data_instance = JobEventPayloadWaitingEventData.from_json(json) -# print the JSON string representation of the object -print JobEventPayloadWaitingEventData.to_json() - -# convert the object into a dict -job_event_payload_waiting_event_data_dict = job_event_payload_waiting_event_data_instance.to_dict() -# create an instance of JobEventPayloadWaitingEventData from a dict -job_event_payload_waiting_event_data_form_dict = job_event_payload_waiting_event_data.from_dict(job_event_payload_waiting_event_data_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/JobEventsFilterQuery.md b/docs/JobEventsFilterQuery.md deleted file mode 100644 index 266927ac..00000000 --- a/docs/JobEventsFilterQuery.md +++ /dev/null @@ -1,31 +0,0 @@ -# JobEventsFilterQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**JobType**](JobType.md) | | [optional] -**id** | **str** | The id of the job. | [optional] -**children** | **bool** | If set to <code>true</code>, the event stream will include events of the job's dependants. E.g., when subscribing to a verify job with `children=true`, you will also receive the events of the underlying build and deploy jobs. Defaults to <code>false</code>. | [optional] - -## Example - -```python -from waylay.services.registry.models.job_events_filter_query import JobEventsFilterQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of JobEventsFilterQuery from a JSON string -job_events_filter_query_instance = JobEventsFilterQuery.from_json(json) -# print the JSON string representation of the object -print JobEventsFilterQuery.to_json() - -# convert the object into a dict -job_events_filter_query_dict = job_events_filter_query_instance.to_dict() -# create an instance of JobEventsFilterQuery from a dict -job_events_filter_query_form_dict = job_events_filter_query.from_dict(job_events_filter_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/JobQuery.md b/docs/JobQuery.md deleted file mode 100644 index cc86e8d2..00000000 --- a/docs/JobQuery.md +++ /dev/null @@ -1,34 +0,0 @@ -# JobQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**type** | [**List[JobTypeSchema]**](JobTypeSchema.md) | Filter on job type | [optional] -**state** | [**List[JobStateResult]**](JobStateResult.md) | Filter on job state | [optional] -**function_type** | [**List[FunctionType]**](FunctionType.md) | Filter on function type | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.job_query import JobQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of JobQuery from a JSON string -job_query_instance = JobQuery.from_json(json) -# print the JSON string representation of the object -print JobQuery.to_json() - -# convert the object into a dict -job_query_dict = job_query_instance.to_dict() -# create an instance of JobQuery from a dict -job_query_form_dict = job_query.from_dict(job_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/JobReferenceParams.md b/docs/JobReferenceParams.md deleted file mode 100644 index efc08be3..00000000 --- a/docs/JobReferenceParams.md +++ /dev/null @@ -1,30 +0,0 @@ -# JobReferenceParams - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**JobType**](JobType.md) | | -**id** | **str** | | - -## Example - -```python -from waylay.services.registry.models.job_reference_params import JobReferenceParams - -# TODO update the JSON string below -json = "{}" -# create an instance of JobReferenceParams from a JSON string -job_reference_params_instance = JobReferenceParams.from_json(json) -# print the JSON string representation of the object -print JobReferenceParams.to_json() - -# convert the object into a dict -job_reference_params_dict = job_reference_params_instance.to_dict() -# create an instance of JobReferenceParams from a dict -job_reference_params_form_dict = job_reference_params.from_dict(job_reference_params_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/JobSubmittedResponse.md b/docs/JobSubmittedResponse.md deleted file mode 100644 index 01fe8988..00000000 --- a/docs/JobSubmittedResponse.md +++ /dev/null @@ -1,30 +0,0 @@ -# JobSubmittedResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | -**links** | [**JobHALLinks**](JobHALLinks.md) | | - -## Example - -```python -from waylay.services.registry.models.job_submitted_response import JobSubmittedResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of JobSubmittedResponse from a JSON string -job_submitted_response_instance = JobSubmittedResponse.from_json(json) -# print the JSON string representation of the object -print JobSubmittedResponse.to_json() - -# convert the object into a dict -job_submitted_response_dict = job_submitted_response_instance.to_dict() -# create an instance of JobSubmittedResponse from a dict -job_submitted_response_form_dict = job_submitted_response.from_dict(job_submitted_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/SupportedEvents.md b/docs/JobTypeNotify.md similarity index 79% rename from docs/SupportedEvents.md rename to docs/JobTypeNotify.md index b3dcda76..57a8c69a 100644 --- a/docs/SupportedEvents.md +++ b/docs/JobTypeNotify.md @@ -1,5 +1,6 @@ -# SupportedEvents +# JobTypeNotify +A job to notify that an function version has changed. ## Properties diff --git a/docs/JobsApi.md b/docs/JobsApi.md index 405467ea..dd00b18e 100644 --- a/docs/JobsApi.md +++ b/docs/JobsApi.md @@ -74,7 +74,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: text/eventstream + - **Accept**: text/event-stream ### HTTP response details diff --git a/docs/JobsHALLink.md b/docs/JobsHALLink.md deleted file mode 100644 index 904e0ffb..00000000 --- a/docs/JobsHALLink.md +++ /dev/null @@ -1,29 +0,0 @@ -# JobsHALLink - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**jobs** | [**HALLink**](HALLink.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.jobs_hal_link import JobsHALLink - -# TODO update the JSON string below -json = "{}" -# create an instance of JobsHALLink from a JSON string -jobs_hal_link_instance = JobsHALLink.from_json(json) -# print the JSON string representation of the object -print JobsHALLink.to_json() - -# convert the object into a dict -jobs_hal_link_dict = jobs_hal_link_instance.to_dict() -# create an instance of JobsHALLink from a dict -jobs_hal_link_form_dict = jobs_hal_link.from_dict(jobs_hal_link_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingDeleteMultipleResponse.md b/docs/KFServingDeleteMultipleResponse.md deleted file mode 100644 index 02e433f6..00000000 --- a/docs/KFServingDeleteMultipleResponse.md +++ /dev/null @@ -1,31 +0,0 @@ -# KFServingDeleteMultipleResponse - -Models Deleted - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**versions** | **List[str]** | | - -## Example - -```python -from waylay.services.registry.models.kf_serving_delete_multiple_response import KFServingDeleteMultipleResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingDeleteMultipleResponse from a JSON string -kf_serving_delete_multiple_response_instance = KFServingDeleteMultipleResponse.from_json(json) -# print the JSON string representation of the object -print KFServingDeleteMultipleResponse.to_json() - -# convert the object into a dict -kf_serving_delete_multiple_response_dict = kf_serving_delete_multiple_response_instance.to_dict() -# create an instance of KFServingDeleteMultipleResponse from a dict -kf_serving_delete_multiple_response_form_dict = kf_serving_delete_multiple_response.from_dict(kf_serving_delete_multiple_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingDeleteMultipleWithJobResponse.md b/docs/KFServingDeleteMultipleWithJobResponse.md deleted file mode 100644 index 4b6ebadd..00000000 --- a/docs/KFServingDeleteMultipleWithJobResponse.md +++ /dev/null @@ -1,33 +0,0 @@ -# KFServingDeleteMultipleWithJobResponse - -Model Deletions Initiated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**versions** | **List[str]** | | -**message** | **str** | | -**links** | [**JobHALLinks**](JobHALLinks.md) | | - -## Example - -```python -from waylay.services.registry.models.kf_serving_delete_multiple_with_job_response import KFServingDeleteMultipleWithJobResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingDeleteMultipleWithJobResponse from a JSON string -kf_serving_delete_multiple_with_job_response_instance = KFServingDeleteMultipleWithJobResponse.from_json(json) -# print the JSON string representation of the object -print KFServingDeleteMultipleWithJobResponse.to_json() - -# convert the object into a dict -kf_serving_delete_multiple_with_job_response_dict = kf_serving_delete_multiple_with_job_response_instance.to_dict() -# create an instance of KFServingDeleteMultipleWithJobResponse from a dict -kf_serving_delete_multiple_with_job_response_form_dict = kf_serving_delete_multiple_with_job_response.from_dict(kf_serving_delete_multiple_with_job_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingDeleteQueryV1.md b/docs/KFServingDeleteQueryV1.md deleted file mode 100644 index 6c6ce01e..00000000 --- a/docs/KFServingDeleteQueryV1.md +++ /dev/null @@ -1,45 +0,0 @@ -# KFServingDeleteQueryV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**var_async** | **bool** | If this is set to <code>true</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. Otherwise, the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to False] -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.kf_serving_delete_query_v1 import KFServingDeleteQueryV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingDeleteQueryV1 from a JSON string -kf_serving_delete_query_v1_instance = KFServingDeleteQueryV1.from_json(json) -# print the JSON string representation of the object -print KFServingDeleteQueryV1.to_json() - -# convert the object into a dict -kf_serving_delete_query_v1_dict = kf_serving_delete_query_v1_instance.to_dict() -# create an instance of KFServingDeleteQueryV1 from a dict -kf_serving_delete_query_v1_form_dict = kf_serving_delete_query_v1.from_dict(kf_serving_delete_query_v1_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingDeleteQueryV2.md b/docs/KFServingDeleteQueryV2.md deleted file mode 100644 index 6ffc469f..00000000 --- a/docs/KFServingDeleteQueryV2.md +++ /dev/null @@ -1,32 +0,0 @@ -# KFServingDeleteQueryV2 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comment** | **str** | An optional user-specified comment corresponding to the operation. | [optional] -**force** | **bool** | If <code>true</code>, the function version will be immediately undeployed and removed. Otherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_. | [optional] -**undeploy** | **bool** | If `true`, the `DELETE` operation * undeploys the (openfaas) function: it becomes no longer available for invocation. * does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only. | [optional] -**var_async** | **bool** | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to True] - -## Example - -```python -from waylay.services.registry.models.kf_serving_delete_query_v2 import KFServingDeleteQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingDeleteQueryV2 from a JSON string -kf_serving_delete_query_v2_instance = KFServingDeleteQueryV2.from_json(json) -# print the JSON string representation of the object -print KFServingDeleteQueryV2.to_json() - -# convert the object into a dict -kf_serving_delete_query_v2_dict = kf_serving_delete_query_v2_instance.to_dict() -# create an instance of KFServingDeleteQueryV2 from a dict -kf_serving_delete_query_v2_form_dict = kf_serving_delete_query_v2.from_dict(kf_serving_delete_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingDeleteResponse.md b/docs/KFServingDeleteResponse.md deleted file mode 100644 index b0dd65c1..00000000 --- a/docs/KFServingDeleteResponse.md +++ /dev/null @@ -1,31 +0,0 @@ -# KFServingDeleteResponse - -Model Deleted - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | - -## Example - -```python -from waylay.services.registry.models.kf_serving_delete_response import KFServingDeleteResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingDeleteResponse from a JSON string -kf_serving_delete_response_instance = KFServingDeleteResponse.from_json(json) -# print the JSON string representation of the object -print KFServingDeleteResponse.to_json() - -# convert the object into a dict -kf_serving_delete_response_dict = kf_serving_delete_response_instance.to_dict() -# create an instance of KFServingDeleteResponse from a dict -kf_serving_delete_response_form_dict = kf_serving_delete_response.from_dict(kf_serving_delete_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingDeleteWithJobResponse.md b/docs/KFServingDeleteWithJobResponse.md deleted file mode 100644 index cc6a229a..00000000 --- a/docs/KFServingDeleteWithJobResponse.md +++ /dev/null @@ -1,33 +0,0 @@ -# KFServingDeleteWithJobResponse - -Model Delete Initiated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | -**links** | [**JobHALLinks**](JobHALLinks.md) | | -**name** | **str** | The name of the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | - -## Example - -```python -from waylay.services.registry.models.kf_serving_delete_with_job_response import KFServingDeleteWithJobResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingDeleteWithJobResponse from a JSON string -kf_serving_delete_with_job_response_instance = KFServingDeleteWithJobResponse.from_json(json) -# print the JSON string representation of the object -print KFServingDeleteWithJobResponse.to_json() - -# convert the object into a dict -kf_serving_delete_with_job_response_dict = kf_serving_delete_with_job_response_instance.to_dict() -# create an instance of KFServingDeleteWithJobResponse from a dict -kf_serving_delete_with_job_response_form_dict = kf_serving_delete_with_job_response.from_dict(kf_serving_delete_with_job_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingLatestVersionQueryV2.md b/docs/KFServingLatestVersionQueryV2.md deleted file mode 100644 index e1401947..00000000 --- a/docs/KFServingLatestVersionQueryV2.md +++ /dev/null @@ -1,31 +0,0 @@ -# KFServingLatestVersionQueryV2 - -Named Model latest version query. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] - -## Example - -```python -from waylay.services.registry.models.kf_serving_latest_version_query_v2 import KFServingLatestVersionQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingLatestVersionQueryV2 from a JSON string -kf_serving_latest_version_query_v2_instance = KFServingLatestVersionQueryV2.from_json(json) -# print the JSON string representation of the object -print KFServingLatestVersionQueryV2.to_json() - -# convert the object into a dict -kf_serving_latest_version_query_v2_dict = kf_serving_latest_version_query_v2_instance.to_dict() -# create an instance of KFServingLatestVersionQueryV2 from a dict -kf_serving_latest_version_query_v2_form_dict = kf_serving_latest_version_query_v2.from_dict(kf_serving_latest_version_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingLatestVersionsQueryV1.md b/docs/KFServingLatestVersionsQueryV1.md deleted file mode 100644 index d7200762..00000000 --- a/docs/KFServingLatestVersionsQueryV1.md +++ /dev/null @@ -1,45 +0,0 @@ -# KFServingLatestVersionsQueryV1 - -Model listing query - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.kf_serving_latest_versions_query_v1 import KFServingLatestVersionsQueryV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingLatestVersionsQueryV1 from a JSON string -kf_serving_latest_versions_query_v1_instance = KFServingLatestVersionsQueryV1.from_json(json) -# print the JSON string representation of the object -print KFServingLatestVersionsQueryV1.to_json() - -# convert the object into a dict -kf_serving_latest_versions_query_v1_dict = kf_serving_latest_versions_query_v1_instance.to_dict() -# create an instance of KFServingLatestVersionsQueryV1 from a dict -kf_serving_latest_versions_query_v1_form_dict = kf_serving_latest_versions_query_v1.from_dict(kf_serving_latest_versions_query_v1_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingLatestVersionsQueryV2.md b/docs/KFServingLatestVersionsQueryV2.md deleted file mode 100644 index 649d60ef..00000000 --- a/docs/KFServingLatestVersionsQueryV2.md +++ /dev/null @@ -1,49 +0,0 @@ -# KFServingLatestVersionsQueryV2 - -Latest model versions listing query. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] -**name_version** | **List[str]** | Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] -**latest** | **bool** | When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. | [optional] - -## Example - -```python -from waylay.services.registry.models.kf_serving_latest_versions_query_v2 import KFServingLatestVersionsQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingLatestVersionsQueryV2 from a JSON string -kf_serving_latest_versions_query_v2_instance = KFServingLatestVersionsQueryV2.from_json(json) -# print the JSON string representation of the object -print KFServingLatestVersionsQueryV2.to_json() - -# convert the object into a dict -kf_serving_latest_versions_query_v2_dict = kf_serving_latest_versions_query_v2_instance.to_dict() -# create an instance of KFServingLatestVersionsQueryV2 from a dict -kf_serving_latest_versions_query_v2_form_dict = kf_serving_latest_versions_query_v2.from_dict(kf_serving_latest_versions_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingModelsResponse.md b/docs/KFServingModelsResponse.md deleted file mode 100644 index 3ca978ed..00000000 --- a/docs/KFServingModelsResponse.md +++ /dev/null @@ -1,31 +0,0 @@ -# KFServingModelsResponse - -Successful Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**models** | [**List[KFServingResponse]**](KFServingResponse.md) | | -**paging** | [**PagingResponse**](PagingResponse.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.kf_serving_models_response import KFServingModelsResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingModelsResponse from a JSON string -kf_serving_models_response_instance = KFServingModelsResponse.from_json(json) -# print the JSON string representation of the object -print KFServingModelsResponse.to_json() - -# convert the object into a dict -kf_serving_models_response_dict = kf_serving_models_response_instance.to_dict() -# create an instance of KFServingModelsResponse from a dict -kf_serving_models_response_form_dict = kf_serving_models_response.from_dict(kf_serving_models_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingResponse.md b/docs/KFServingResponse.md deleted file mode 100644 index 83538cb3..00000000 --- a/docs/KFServingResponse.md +++ /dev/null @@ -1,42 +0,0 @@ -# KFServingResponse - -Successful Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deploy** | [**FunctionDeployOverridesType**](FunctionDeployOverridesType.md) | | [optional] -**name** | **str** | The logical name for the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**runtime** | **str** | | -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**metadata** | [**FunctionMeta**](FunctionMeta.md) | | -**created_by** | **str** | The user that created this entity. | -**created_at** | **datetime** | The timestamp at which this entity was created. | -**updated_by** | **str** | The user that last updated this entity. | -**updated_at** | **datetime** | The timestamp at which this entity was last updated. | -**status** | [**Status**](Status.md) | | -**failure_reason** | [**FailureReason**](FailureReason.md) | | [optional] -**links** | [**List[JobHALLinks]**](JobHALLinks.md) | Links to related entities. | [optional] - -## Example - -```python -from waylay.services.registry.models.kf_serving_response import KFServingResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingResponse from a JSON string -kf_serving_response_instance = KFServingResponse.from_json(json) -# print the JSON string representation of the object -print KFServingResponse.to_json() - -# convert the object into a dict -kf_serving_response_dict = kf_serving_response_instance.to_dict() -# create an instance of KFServingResponse from a dict -kf_serving_response_form_dict = kf_serving_response.from_dict(kf_serving_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/KFServingVersionsQueryV1.md b/docs/KFServingVersionsQueryV1.md deleted file mode 100644 index 6e400206..00000000 --- a/docs/KFServingVersionsQueryV1.md +++ /dev/null @@ -1,43 +0,0 @@ -# KFServingVersionsQueryV1 - -Named model versions query - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.kf_serving_versions_query_v1 import KFServingVersionsQueryV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of KFServingVersionsQueryV1 from a JSON string -kf_serving_versions_query_v1_instance = KFServingVersionsQueryV1.from_json(json) -# print the JSON string representation of the object -print KFServingVersionsQueryV1.to_json() - -# convert the object into a dict -kf_serving_versions_query_v1_dict = kf_serving_versions_query_v1_instance.to_dict() -# create an instance of KFServingVersionsQueryV1 from a dict -kf_serving_versions_query_v1_form_dict = kf_serving_versions_query_v1.from_dict(kf_serving_versions_query_v1_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LatestFunctionVersionsQuery.md b/docs/LatestFunctionVersionsQuery.md deleted file mode 100644 index b0f180ee..00000000 --- a/docs/LatestFunctionVersionsQuery.md +++ /dev/null @@ -1,49 +0,0 @@ -# LatestFunctionVersionsQuery - -Latest function versions listing query. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] -**name_version** | **List[str]** | Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] -**latest** | **bool** | When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. | [optional] - -## Example - -```python -from waylay.services.registry.models.latest_function_versions_query import LatestFunctionVersionsQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of LatestFunctionVersionsQuery from a JSON string -latest_function_versions_query_instance = LatestFunctionVersionsQuery.from_json(json) -# print the JSON string representation of the object -print LatestFunctionVersionsQuery.to_json() - -# convert the object into a dict -latest_function_versions_query_dict = latest_function_versions_query_instance.to_dict() -# create an instance of LatestFunctionVersionsQuery from a dict -latest_function_versions_query_form_dict = latest_function_versions_query.from_dict(latest_function_versions_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LatestFunctionsQuery.md b/docs/LatestFunctionsQuery.md deleted file mode 100644 index 3531d366..00000000 --- a/docs/LatestFunctionsQuery.md +++ /dev/null @@ -1,36 +0,0 @@ -# LatestFunctionsQuery - -Request to list latest function versions per named function. A request that only uses these query parameters will include links to the _latest_ draft/published versions. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.latest_functions_query import LatestFunctionsQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of LatestFunctionsQuery from a JSON string -latest_functions_query_instance = LatestFunctionsQuery.from_json(json) -# print the JSON string representation of the object -print LatestFunctionsQuery.to_json() - -# convert the object into a dict -latest_functions_query_dict = latest_functions_query_instance.to_dict() -# create an instance of LatestFunctionsQuery from a dict -latest_functions_query_form_dict = latest_functions_query.from_dict(latest_functions_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LatestModelsResponseV2.md b/docs/LatestModelsResponseV2.md index 8429929e..2175d54a 100644 --- a/docs/LatestModelsResponseV2.md +++ b/docs/LatestModelsResponseV2.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **limit** | **float** | The page size used for this query result. | [optional] **count** | **float** | The total count of matching items, from which this result is one page. | **page** | **float** | The page number of a paged query result. | [optional] -**entities** | [**List[LatestModelsResponseV2EntitiesInner]**](LatestModelsResponseV2EntitiesInner.md) | The specification and deployment status of the queried functions | +**entities** | [**List[EntityWithLinksIKfservingResponseV2]**](EntityWithLinksIKfservingResponseV2.md) | The specification and deployment status of the queried functions | ## Example diff --git a/docs/LatestPlugQuery.md b/docs/LatestPlugQuery.md deleted file mode 100644 index 5cd68372..00000000 --- a/docs/LatestPlugQuery.md +++ /dev/null @@ -1,46 +0,0 @@ -# LatestPlugQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tags** | [**TagsFilter**](TagsFilter.md) | | [optional] -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] -**type** | [**PlugType**](PlugType.md) | | - -## Example - -```python -from waylay.services.registry.models.latest_plug_query import LatestPlugQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of LatestPlugQuery from a JSON string -latest_plug_query_instance = LatestPlugQuery.from_json(json) -# print the JSON string representation of the object -print LatestPlugQuery.to_json() - -# convert the object into a dict -latest_plug_query_dict = latest_plug_query_instance.to_dict() -# create an instance of LatestPlugQuery from a dict -latest_plug_query_form_dict = latest_plug_query.from_dict(latest_plug_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LatestPlugVersionQueryV2.md b/docs/LatestPlugVersionQueryV2.md deleted file mode 100644 index a966720c..00000000 --- a/docs/LatestPlugVersionQueryV2.md +++ /dev/null @@ -1,32 +0,0 @@ -# LatestPlugVersionQueryV2 - -Latest named plug version listing query - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**PlugType**](PlugType.md) | | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] - -## Example - -```python -from waylay.services.registry.models.latest_plug_version_query_v2 import LatestPlugVersionQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of LatestPlugVersionQueryV2 from a JSON string -latest_plug_version_query_v2_instance = LatestPlugVersionQueryV2.from_json(json) -# print the JSON string representation of the object -print LatestPlugVersionQueryV2.to_json() - -# convert the object into a dict -latest_plug_version_query_v2_dict = latest_plug_version_query_v2_instance.to_dict() -# create an instance of LatestPlugVersionQueryV2 from a dict -latest_plug_version_query_v2_form_dict = latest_plug_version_query_v2.from_dict(latest_plug_version_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LatestPlugVersionsQuery.md b/docs/LatestPlugVersionsQuery.md deleted file mode 100644 index f2ad246e..00000000 --- a/docs/LatestPlugVersionsQuery.md +++ /dev/null @@ -1,51 +0,0 @@ -# LatestPlugVersionsQuery - -Plug versions listing query. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tags** | [**TagsFilter**](TagsFilter.md) | | [optional] -**type** | [**PlugType**](PlugType.md) | | [optional] -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] -**name_version** | **List[str]** | Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] -**latest** | **bool** | When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. | [optional] - -## Example - -```python -from waylay.services.registry.models.latest_plug_versions_query import LatestPlugVersionsQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of LatestPlugVersionsQuery from a JSON string -latest_plug_versions_query_instance = LatestPlugVersionsQuery.from_json(json) -# print the JSON string representation of the object -print LatestPlugVersionsQuery.to_json() - -# convert the object into a dict -latest_plug_versions_query_dict = latest_plug_versions_query_instance.to_dict() -# create an instance of LatestPlugVersionsQuery from a dict -latest_plug_versions_query_form_dict = latest_plug_versions_query.from_dict(latest_plug_versions_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LatestPlugVersionsQueryV2.md b/docs/LatestPlugVersionsQueryV2.md deleted file mode 100644 index 76546f24..00000000 --- a/docs/LatestPlugVersionsQueryV2.md +++ /dev/null @@ -1,51 +0,0 @@ -# LatestPlugVersionsQueryV2 - -Latest plug versions listing query. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tags** | [**TagsFilter**](TagsFilter.md) | | [optional] -**type** | [**PlugType**](PlugType.md) | | [optional] -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] -**name_version** | **List[str]** | Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] -**latest** | **bool** | When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. | [optional] - -## Example - -```python -from waylay.services.registry.models.latest_plug_versions_query_v2 import LatestPlugVersionsQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of LatestPlugVersionsQueryV2 from a JSON string -latest_plug_versions_query_v2_instance = LatestPlugVersionsQueryV2.from_json(json) -# print the JSON string representation of the object -print LatestPlugVersionsQueryV2.to_json() - -# convert the object into a dict -latest_plug_versions_query_v2_dict = latest_plug_versions_query_v2_instance.to_dict() -# create an instance of LatestPlugVersionsQueryV2 from a dict -latest_plug_versions_query_v2_form_dict = latest_plug_versions_query_v2.from_dict(latest_plug_versions_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LatestPlugsQuery.md b/docs/LatestPlugsQuery.md deleted file mode 100644 index 5b962f5f..00000000 --- a/docs/LatestPlugsQuery.md +++ /dev/null @@ -1,37 +0,0 @@ -# LatestPlugsQuery - -Latest plug versions listing query with latest links. A request that only uses these query parameters will include links to the _latest_ draft/published versions of the plug. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**PlugType**](PlugType.md) | | [optional] -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.latest_plugs_query import LatestPlugsQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of LatestPlugsQuery from a JSON string -latest_plugs_query_instance = LatestPlugsQuery.from_json(json) -# print the JSON string representation of the object -print LatestPlugsQuery.to_json() - -# convert the object into a dict -latest_plugs_query_dict = latest_plugs_query_instance.to_dict() -# create an instance of LatestPlugsQuery from a dict -latest_plugs_query_form_dict = latest_plugs_query.from_dict(latest_plugs_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LatestPlugsResponseV2.md b/docs/LatestPlugsResponseV2.md index faf5491f..4632f8a6 100644 --- a/docs/LatestPlugsResponseV2.md +++ b/docs/LatestPlugsResponseV2.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **limit** | **float** | The page size used for this query result. | [optional] **count** | **float** | The total count of matching items, from which this result is one page. | **page** | **float** | The page number of a paged query result. | [optional] -**entities** | [**List[LatestPlugsResponseV2EntitiesInner]**](LatestPlugsResponseV2EntitiesInner.md) | The specification and deployment status of the queried functions | +**entities** | [**List[EntityWithLinksIPlugResponseV2]**](EntityWithLinksIPlugResponseV2.md) | The specification and deployment status of the queried functions | ## Example diff --git a/docs/LatestWebscriptsResponseV2.md b/docs/LatestWebscriptsResponseV2.md index 5967e272..cac1bb13 100644 --- a/docs/LatestWebscriptsResponseV2.md +++ b/docs/LatestWebscriptsResponseV2.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **limit** | **float** | The page size used for this query result. | [optional] **count** | **float** | The total count of matching items, from which this result is one page. | **page** | **float** | The page number of a paged query result. | [optional] -**entities** | [**List[LatestWebscriptsResponseV2EntitiesInner]**](LatestWebscriptsResponseV2EntitiesInner.md) | The specification and deployment status of the queried functions | +**entities** | [**List[EntityWithLinksIWebscriptResponseWithInvokeLinkV2]**](EntityWithLinksIWebscriptResponseWithInvokeLinkV2.md) | The specification and deployment status of the queried functions | ## Example diff --git a/docs/LatestWebscriptsResponseV2EntitiesInner.md b/docs/LatestWebscriptsResponseV2EntitiesInner.md deleted file mode 100644 index 7122808c..00000000 --- a/docs/LatestWebscriptsResponseV2EntitiesInner.md +++ /dev/null @@ -1,41 +0,0 @@ -# LatestWebscriptsResponseV2EntitiesInner - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**InvokeHALLink**](InvokeHALLink.md) | | -**created_by** | **str** | The user that created this entity. | -**created_at** | **datetime** | The timestamp at which this entity was created. | -**updated_by** | **str** | The user that last updated this entity. | -**updated_at** | **datetime** | The timestamp at which this entity was last updated. | -**updates** | [**List[UpdateRecord]**](UpdateRecord.md) | The audit logs corresponding to the latest modifying operations on this entity. | -**status** | [**Status**](Status.md) | | -**failure_reason** | [**FailureReason**](FailureReason.md) | | [optional] -**runtime** | [**RuntimeAttributes**](RuntimeAttributes.md) | | -**deprecated** | **bool** | If <code>true</code> this function is deprecated and removed from regular listings. | -**draft** | **bool** | If <code>true</code> this function is a draft function and it's assets are still mutable. | -**webscript** | [**WebscriptManifest**](WebscriptManifest.md) | | -**secret** | **str** | The secret for this webscript deployment. This is <code>null</code> when <code>allowHmac=false</code> in the webscript specificaton. | [optional] - -## Example - -```python -from waylay.services.registry.models.latest_webscripts_response_v2_entities_inner import LatestWebscriptsResponseV2EntitiesInner - -# TODO update the JSON string below -json = "{}" -# create an instance of LatestWebscriptsResponseV2EntitiesInner from a JSON string -latest_webscripts_response_v2_entities_inner_instance = LatestWebscriptsResponseV2EntitiesInner.from_json(json) -# print the JSON string representation of the object -print LatestWebscriptsResponseV2EntitiesInner.to_json() - -# convert the object into a dict -latest_webscripts_response_v2_entities_inner_dict = latest_webscripts_response_v2_entities_inner_instance.to_dict() -# create an instance of LatestWebscriptsResponseV2EntitiesInner from a dict -latest_webscripts_response_v2_entities_inner_form_dict = latest_webscripts_response_v2_entities_inner.from_dict(latest_webscripts_response_v2_entities_inner_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyConfigurationObject.md b/docs/LegacyConfigurationObject.md deleted file mode 100644 index 3fd7ff6d..00000000 --- a/docs/LegacyConfigurationObject.md +++ /dev/null @@ -1,33 +0,0 @@ -# LegacyConfigurationObject - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**type** | [**PlugPropertyDataType**](PlugPropertyDataType.md) | | -**mandatory** | **bool** | | [optional] -**format** | [**LegacyConfigurationObjectFormat**](LegacyConfigurationObjectFormat.md) | | [optional] -**default_value** | **object** | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_configuration_object import LegacyConfigurationObject - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyConfigurationObject from a JSON string -legacy_configuration_object_instance = LegacyConfigurationObject.from_json(json) -# print the JSON string representation of the object -print LegacyConfigurationObject.to_json() - -# convert the object into a dict -legacy_configuration_object_dict = legacy_configuration_object_instance.to_dict() -# create an instance of LegacyConfigurationObject from a dict -legacy_configuration_object_form_dict = legacy_configuration_object.from_dict(legacy_configuration_object_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyConfigurationObjectFormat.md b/docs/LegacyConfigurationObjectFormat.md deleted file mode 100644 index 4f06201c..00000000 --- a/docs/LegacyConfigurationObjectFormat.md +++ /dev/null @@ -1,30 +0,0 @@ -# LegacyConfigurationObjectFormat - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**PlugPropertyFormatType**](PlugPropertyFormatType.md) | | [optional] -**values** | **List[object]** | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_configuration_object_format import LegacyConfigurationObjectFormat - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyConfigurationObjectFormat from a JSON string -legacy_configuration_object_format_instance = LegacyConfigurationObjectFormat.from_json(json) -# print the JSON string representation of the object -print LegacyConfigurationObjectFormat.to_json() - -# convert the object into a dict -legacy_configuration_object_format_dict = legacy_configuration_object_format_instance.to_dict() -# create an instance of LegacyConfigurationObjectFormat from a dict -legacy_configuration_object_format_form_dict = legacy_configuration_object_format.from_dict(legacy_configuration_object_format_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyConfigurationResponseObject.md b/docs/LegacyConfigurationResponseObject.md deleted file mode 100644 index 4544cb7b..00000000 --- a/docs/LegacyConfigurationResponseObject.md +++ /dev/null @@ -1,34 +0,0 @@ -# LegacyConfigurationResponseObject - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**type** | [**PlugPropertyDataType**](PlugPropertyDataType.md) | | -**mandatory** | **bool** | | [optional] -**format** | [**LegacyConfigurationObjectFormat**](LegacyConfigurationObjectFormat.md) | | [optional] -**default_value** | **object** | | [optional] -**sensitive** | **bool** | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_configuration_response_object import LegacyConfigurationResponseObject - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyConfigurationResponseObject from a JSON string -legacy_configuration_response_object_instance = LegacyConfigurationResponseObject.from_json(json) -# print the JSON string representation of the object -print LegacyConfigurationResponseObject.to_json() - -# convert the object into a dict -legacy_configuration_response_object_dict = legacy_configuration_response_object_instance.to_dict() -# create an instance of LegacyConfigurationResponseObject from a dict -legacy_configuration_response_object_form_dict = legacy_configuration_response_object.from_dict(legacy_configuration_response_object_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyCreateDebugResponse.md b/docs/LegacyCreateDebugResponse.md deleted file mode 100644 index 23bceeff..00000000 --- a/docs/LegacyCreateDebugResponse.md +++ /dev/null @@ -1,29 +0,0 @@ -# LegacyCreateDebugResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**function_name** | **str** | | - -## Example - -```python -from waylay.services.registry.models.legacy_create_debug_response import LegacyCreateDebugResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyCreateDebugResponse from a JSON string -legacy_create_debug_response_instance = LegacyCreateDebugResponse.from_json(json) -# print the JSON string representation of the object -print LegacyCreateDebugResponse.to_json() - -# convert the object into a dict -legacy_create_debug_response_dict = legacy_create_debug_response_instance.to_dict() -# create an instance of LegacyCreateDebugResponse from a dict -legacy_create_debug_response_form_dict = legacy_create_debug_response.from_dict(legacy_create_debug_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyDebugPlugManifest.md b/docs/LegacyDebugPlugManifest.md deleted file mode 100644 index a38f2951..00000000 --- a/docs/LegacyDebugPlugManifest.md +++ /dev/null @@ -1,37 +0,0 @@ -# LegacyDebugPlugManifest - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deploy** | [**FunctionDeployOverridesType**](FunctionDeployOverridesType.md) | | [optional] -**name** | **str** | The logical name for the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**runtime** | **str** | | -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**metadata** | [**FunctionMeta**](FunctionMeta.md) | | -**tenant** | **str** | | -**dependencies** | **Dict[str, str]** | | [optional] -**script** | **str** | | - -## Example - -```python -from waylay.services.registry.models.legacy_debug_plug_manifest import LegacyDebugPlugManifest - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyDebugPlugManifest from a JSON string -legacy_debug_plug_manifest_instance = LegacyDebugPlugManifest.from_json(json) -# print the JSON string representation of the object -print LegacyDebugPlugManifest.to_json() - -# convert the object into a dict -legacy_debug_plug_manifest_dict = legacy_debug_plug_manifest_instance.to_dict() -# create an instance of LegacyDebugPlugManifest from a dict -legacy_debug_plug_manifest_form_dict = legacy_debug_plug_manifest.from_dict(legacy_debug_plug_manifest_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyDebugPlugRequest.md b/docs/LegacyDebugPlugRequest.md deleted file mode 100644 index 16bf4fff..00000000 --- a/docs/LegacyDebugPlugRequest.md +++ /dev/null @@ -1,32 +0,0 @@ -# LegacyDebugPlugRequest - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**PlugType**](PlugType.md) | | [optional] -**script** | **str** | | -**dependencies** | **Dict[str, str]** | | [optional] -**metadata** | [**FunctionMeta**](FunctionMeta.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_debug_plug_request import LegacyDebugPlugRequest - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyDebugPlugRequest from a JSON string -legacy_debug_plug_request_instance = LegacyDebugPlugRequest.from_json(json) -# print the JSON string representation of the object -print LegacyDebugPlugRequest.to_json() - -# convert the object into a dict -legacy_debug_plug_request_dict = legacy_debug_plug_request_instance.to_dict() -# create an instance of LegacyDebugPlugRequest from a dict -legacy_debug_plug_request_form_dict = legacy_debug_plug_request.from_dict(legacy_debug_plug_request_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyDocumentation.md b/docs/LegacyDocumentation.md deleted file mode 100644 index 40530019..00000000 --- a/docs/LegacyDocumentation.md +++ /dev/null @@ -1,31 +0,0 @@ -# LegacyDocumentation - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**supported_states** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | -**configuration** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | -**raw_data** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | - -## Example - -```python -from waylay.services.registry.models.legacy_documentation import LegacyDocumentation - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyDocumentation from a JSON string -legacy_documentation_instance = LegacyDocumentation.from_json(json) -# print the JSON string representation of the object -print LegacyDocumentation.to_json() - -# convert the object into a dict -legacy_documentation_dict = legacy_documentation_instance.to_dict() -# create an instance of LegacyDocumentation from a dict -legacy_documentation_form_dict = legacy_documentation.from_dict(legacy_documentation_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyDocumentationRequest.md b/docs/LegacyDocumentationRequest.md deleted file mode 100644 index b8f7d0ad..00000000 --- a/docs/LegacyDocumentationRequest.md +++ /dev/null @@ -1,32 +0,0 @@ -# LegacyDocumentationRequest - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**description** | **str** | | [optional] -**supported_states** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | -**configuration** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | -**raw_data** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | - -## Example - -```python -from waylay.services.registry.models.legacy_documentation_request import LegacyDocumentationRequest - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyDocumentationRequest from a JSON string -legacy_documentation_request_instance = LegacyDocumentationRequest.from_json(json) -# print the JSON string representation of the object -print LegacyDocumentationRequest.to_json() - -# convert the object into a dict -legacy_documentation_request_dict = legacy_documentation_request_instance.to_dict() -# create an instance of LegacyDocumentationRequest from a dict -legacy_documentation_request_form_dict = legacy_documentation_request.from_dict(legacy_documentation_request_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyFunctionMeta.md b/docs/LegacyFunctionMeta.md deleted file mode 100644 index db693046..00000000 --- a/docs/LegacyFunctionMeta.md +++ /dev/null @@ -1,34 +0,0 @@ -# LegacyFunctionMeta - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**author** | **str** | | [optional] -**description** | **str** | | [optional] -**category** | **str** | | [optional] -**tags** | [**List[Tag]**](Tag.md) | | [optional] -**icon_url** | **str** | | [optional] -**friendly_name** | **str** | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_function_meta import LegacyFunctionMeta - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyFunctionMeta from a JSON string -legacy_function_meta_instance = LegacyFunctionMeta.from_json(json) -# print the JSON string representation of the object -print LegacyFunctionMeta.to_json() - -# convert the object into a dict -legacy_function_meta_dict = legacy_function_meta_instance.to_dict() -# create an instance of LegacyFunctionMeta from a dict -legacy_function_meta_form_dict = legacy_function_meta.from_dict(legacy_function_meta_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugCreateQuery.md b/docs/LegacyPlugCreateQuery.md deleted file mode 100644 index c27c4831..00000000 --- a/docs/LegacyPlugCreateQuery.md +++ /dev/null @@ -1,31 +0,0 @@ -# LegacyPlugCreateQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**var_async** | **bool** | If this is set to <code>true</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. Otherwise, the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to False] -**dry_run** | **bool** | If set to <code>true</true>, only validates the incoming request. | [optional] -**scale_to_zero** | **bool** | If set to <code>true</true>, scales the function to zero after successful deployment. | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_plug_create_query import LegacyPlugCreateQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugCreateQuery from a JSON string -legacy_plug_create_query_instance = LegacyPlugCreateQuery.from_json(json) -# print the JSON string representation of the object -print LegacyPlugCreateQuery.to_json() - -# convert the object into a dict -legacy_plug_create_query_dict = legacy_plug_create_query_instance.to_dict() -# create an instance of LegacyPlugCreateQuery from a dict -legacy_plug_create_query_form_dict = legacy_plug_create_query.from_dict(legacy_plug_create_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugCreateRequest.md b/docs/LegacyPlugCreateRequest.md deleted file mode 100644 index e3472bb2..00000000 --- a/docs/LegacyPlugCreateRequest.md +++ /dev/null @@ -1,34 +0,0 @@ -# LegacyPlugCreateRequest - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**script** | **str** | | -**dependencies** | **Dict[str, str]** | | [optional] -**metadata** | [**LegacyPlugRequestMetadata**](LegacyPlugRequestMetadata.md) | | -**type** | [**PlugType**](PlugType.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_plug_create_request import LegacyPlugCreateRequest - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugCreateRequest from a JSON string -legacy_plug_create_request_instance = LegacyPlugCreateRequest.from_json(json) -# print the JSON string representation of the object -print LegacyPlugCreateRequest.to_json() - -# convert the object into a dict -legacy_plug_create_request_dict = legacy_plug_create_request_instance.to_dict() -# create an instance of LegacyPlugCreateRequest from a dict -legacy_plug_create_request_form_dict = legacy_plug_create_request.from_dict(legacy_plug_create_request_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugCreateResponse.md b/docs/LegacyPlugCreateResponse.md deleted file mode 100644 index ab74fee1..00000000 --- a/docs/LegacyPlugCreateResponse.md +++ /dev/null @@ -1,31 +0,0 @@ -# LegacyPlugCreateResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status_code** | **float** | | -**uri** | **str** | | -**entity** | [**LegacyPlugScriptResponse**](LegacyPlugScriptResponse.md) | | - -## Example - -```python -from waylay.services.registry.models.legacy_plug_create_response import LegacyPlugCreateResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugCreateResponse from a JSON string -legacy_plug_create_response_instance = LegacyPlugCreateResponse.from_json(json) -# print the JSON string representation of the object -print LegacyPlugCreateResponse.to_json() - -# convert the object into a dict -legacy_plug_create_response_dict = legacy_plug_create_response_instance.to_dict() -# create an instance of LegacyPlugCreateResponse from a dict -legacy_plug_create_response_form_dict = legacy_plug_create_response.from_dict(legacy_plug_create_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugMetaRequest.md b/docs/LegacyPlugMetaRequest.md deleted file mode 100644 index b605da71..00000000 --- a/docs/LegacyPlugMetaRequest.md +++ /dev/null @@ -1,36 +0,0 @@ -# LegacyPlugMetaRequest - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**author** | **str** | | [optional] -**description** | **str** | | [optional] -**category** | **str** | | [optional] -**tags** | [**List[Tag]**](Tag.md) | | [optional] -**icon_url** | **str** | | [optional] -**friendly_name** | **str** | | [optional] -**documentation** | [**LegacyPlugRequestMetadataDocumentation**](LegacyPlugRequestMetadataDocumentation.md) | | [optional] -**documentation_url** | **str** | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_plug_meta_request import LegacyPlugMetaRequest - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugMetaRequest from a JSON string -legacy_plug_meta_request_instance = LegacyPlugMetaRequest.from_json(json) -# print the JSON string representation of the object -print LegacyPlugMetaRequest.to_json() - -# convert the object into a dict -legacy_plug_meta_request_dict = legacy_plug_meta_request_instance.to_dict() -# create an instance of LegacyPlugMetaRequest from a dict -legacy_plug_meta_request_form_dict = legacy_plug_meta_request.from_dict(legacy_plug_meta_request_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugQuery.md b/docs/LegacyPlugQuery.md deleted file mode 100644 index a4fef654..00000000 --- a/docs/LegacyPlugQuery.md +++ /dev/null @@ -1,45 +0,0 @@ -# LegacyPlugQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**tags** | [**TagsFilter**](TagsFilter.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_plug_query import LegacyPlugQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugQuery from a JSON string -legacy_plug_query_instance = LegacyPlugQuery.from_json(json) -# print the JSON string representation of the object -print LegacyPlugQuery.to_json() - -# convert the object into a dict -legacy_plug_query_dict = legacy_plug_query_instance.to_dict() -# create an instance of LegacyPlugQuery from a dict -legacy_plug_query_form_dict = legacy_plug_query.from_dict(legacy_plug_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugRequest.md b/docs/LegacyPlugRequest.md deleted file mode 100644 index 812f6b1f..00000000 --- a/docs/LegacyPlugRequest.md +++ /dev/null @@ -1,34 +0,0 @@ -# LegacyPlugRequest - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**script** | **str** | | -**dependencies** | **Dict[str, str]** | | [optional] -**metadata** | [**LegacyPlugRequestMetadata**](LegacyPlugRequestMetadata.md) | | -**type** | [**PlugType**](PlugType.md) | | - -## Example - -```python -from waylay.services.registry.models.legacy_plug_request import LegacyPlugRequest - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugRequest from a JSON string -legacy_plug_request_instance = LegacyPlugRequest.from_json(json) -# print the JSON string representation of the object -print LegacyPlugRequest.to_json() - -# convert the object into a dict -legacy_plug_request_dict = legacy_plug_request_instance.to_dict() -# create an instance of LegacyPlugRequest from a dict -legacy_plug_request_form_dict = legacy_plug_request.from_dict(legacy_plug_request_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugRequestMetadata.md b/docs/LegacyPlugRequestMetadata.md deleted file mode 100644 index 2faad20c..00000000 --- a/docs/LegacyPlugRequestMetadata.md +++ /dev/null @@ -1,40 +0,0 @@ -# LegacyPlugRequestMetadata - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**required_properties** | [**List[LegacyRequiredPropertiesInner]**](LegacyRequiredPropertiesInner.md) | | [optional] -**supported_states** | **List[str]** | | [optional] -**raw_data** | [**List[LegacyPlugRequestMetadataRawDataInner]**](LegacyPlugRequestMetadataRawDataInner.md) | | [optional] -**configuration** | [**List[LegacyConfigurationObject]**](LegacyConfigurationObject.md) | | [optional] -**author** | **str** | | [optional] -**description** | **str** | | [optional] -**category** | **str** | | [optional] -**tags** | [**List[Tag]**](Tag.md) | | [optional] -**icon_url** | **str** | | [optional] -**friendly_name** | **str** | | [optional] -**documentation** | [**LegacyPlugRequestMetadataDocumentation**](LegacyPlugRequestMetadataDocumentation.md) | | [optional] -**documentation_url** | **str** | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_plug_request_metadata import LegacyPlugRequestMetadata - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugRequestMetadata from a JSON string -legacy_plug_request_metadata_instance = LegacyPlugRequestMetadata.from_json(json) -# print the JSON string representation of the object -print LegacyPlugRequestMetadata.to_json() - -# convert the object into a dict -legacy_plug_request_metadata_dict = legacy_plug_request_metadata_instance.to_dict() -# create an instance of LegacyPlugRequestMetadata from a dict -legacy_plug_request_metadata_form_dict = legacy_plug_request_metadata.from_dict(legacy_plug_request_metadata_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugRequestMetadataDocumentation.md b/docs/LegacyPlugRequestMetadataDocumentation.md deleted file mode 100644 index cd3a0af7..00000000 --- a/docs/LegacyPlugRequestMetadataDocumentation.md +++ /dev/null @@ -1,35 +0,0 @@ -# LegacyPlugRequestMetadataDocumentation - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**supported_states** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | [optional] -**configuration** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | [optional] -**raw_data** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | [optional] -**description** | **str** | | [optional] -**states** | [**List[DocumentationProperty]**](DocumentationProperty.md) | Documentation of the plug states. | [optional] -**input** | [**List[DocumentationProperty]**](DocumentationProperty.md) | Documentation of the plug input parameters. | [optional] -**output** | [**List[DocumentationProperty]**](DocumentationProperty.md) | Documentation of the plug response parameters. | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_plug_request_metadata_documentation import LegacyPlugRequestMetadataDocumentation - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugRequestMetadataDocumentation from a JSON string -legacy_plug_request_metadata_documentation_instance = LegacyPlugRequestMetadataDocumentation.from_json(json) -# print the JSON string representation of the object -print LegacyPlugRequestMetadataDocumentation.to_json() - -# convert the object into a dict -legacy_plug_request_metadata_documentation_dict = legacy_plug_request_metadata_documentation_instance.to_dict() -# create an instance of LegacyPlugRequestMetadataDocumentation from a dict -legacy_plug_request_metadata_documentation_form_dict = legacy_plug_request_metadata_documentation.from_dict(legacy_plug_request_metadata_documentation_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugRequestMetadataDocumentationAnyOf.md b/docs/LegacyPlugRequestMetadataDocumentationAnyOf.md deleted file mode 100644 index 07b106ae..00000000 --- a/docs/LegacyPlugRequestMetadataDocumentationAnyOf.md +++ /dev/null @@ -1,31 +0,0 @@ -# LegacyPlugRequestMetadataDocumentationAnyOf - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**supported_states** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | [optional] -**configuration** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | [optional] -**raw_data** | [**List[DocumentationProperty]**](DocumentationProperty.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_plug_request_metadata_documentation_any_of import LegacyPlugRequestMetadataDocumentationAnyOf - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugRequestMetadataDocumentationAnyOf from a JSON string -legacy_plug_request_metadata_documentation_any_of_instance = LegacyPlugRequestMetadataDocumentationAnyOf.from_json(json) -# print the JSON string representation of the object -print LegacyPlugRequestMetadataDocumentationAnyOf.to_json() - -# convert the object into a dict -legacy_plug_request_metadata_documentation_any_of_dict = legacy_plug_request_metadata_documentation_any_of_instance.to_dict() -# create an instance of LegacyPlugRequestMetadataDocumentationAnyOf from a dict -legacy_plug_request_metadata_documentation_any_of_form_dict = legacy_plug_request_metadata_documentation_any_of.from_dict(legacy_plug_request_metadata_documentation_any_of_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugRequestMetadataRawDataInner.md b/docs/LegacyPlugRequestMetadataRawDataInner.md deleted file mode 100644 index 839add8b..00000000 --- a/docs/LegacyPlugRequestMetadataRawDataInner.md +++ /dev/null @@ -1,30 +0,0 @@ -# LegacyPlugRequestMetadataRawDataInner - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parameter** | **str** | | -**data_type** | [**PlugPropertyDataType**](PlugPropertyDataType.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_plug_request_metadata_raw_data_inner import LegacyPlugRequestMetadataRawDataInner - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugRequestMetadataRawDataInner from a JSON string -legacy_plug_request_metadata_raw_data_inner_instance = LegacyPlugRequestMetadataRawDataInner.from_json(json) -# print the JSON string representation of the object -print LegacyPlugRequestMetadataRawDataInner.to_json() - -# convert the object into a dict -legacy_plug_request_metadata_raw_data_inner_dict = legacy_plug_request_metadata_raw_data_inner_instance.to_dict() -# create an instance of LegacyPlugRequestMetadataRawDataInner from a dict -legacy_plug_request_metadata_raw_data_inner_form_dict = legacy_plug_request_metadata_raw_data_inner.from_dict(legacy_plug_request_metadata_raw_data_inner_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugResponse.md b/docs/LegacyPlugResponse.md deleted file mode 100644 index eee5cda5..00000000 --- a/docs/LegacyPlugResponse.md +++ /dev/null @@ -1,44 +0,0 @@ -# LegacyPlugResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**author** | **str** | | [optional] -**category** | **str** | | [optional] -**icon_url** | **str** | | [optional] -**documentation_url** | **str** | | [optional] -**is_deprecated** | **bool** | | -**description** | **str** | | [optional] -**states** | **List[str]** | | [optional] -**raw_data** | **List[object]** | | [optional] -**media_type** | [**MediaType**](MediaType.md) | | -**configuration** | [**List[LegacyConfigurationResponseObject]**](LegacyConfigurationResponseObject.md) | | [optional] -**commands** | **List[str]** | | -**status** | [**Status**](Status.md) | | -**failure_reason** | [**FailureReason**](FailureReason.md) | | [optional] -**metadata** | [**LegacyPlugResponseMetadata**](LegacyPlugResponseMetadata.md) | | - -## Example - -```python -from waylay.services.registry.models.legacy_plug_response import LegacyPlugResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugResponse from a JSON string -legacy_plug_response_instance = LegacyPlugResponse.from_json(json) -# print the JSON string representation of the object -print LegacyPlugResponse.to_json() - -# convert the object into a dict -legacy_plug_response_dict = legacy_plug_response_instance.to_dict() -# create an instance of LegacyPlugResponse from a dict -legacy_plug_response_form_dict = legacy_plug_response.from_dict(legacy_plug_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugResponseMetadata.md b/docs/LegacyPlugResponseMetadata.md deleted file mode 100644 index f1a92eb2..00000000 --- a/docs/LegacyPlugResponseMetadata.md +++ /dev/null @@ -1,35 +0,0 @@ -# LegacyPlugResponseMetadata - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**documentation** | [**LegacyDocumentation**](LegacyDocumentation.md) | | [optional] -**author** | **str** | | [optional] -**description** | **str** | | [optional] -**category** | **str** | | [optional] -**tags** | [**List[Tag]**](Tag.md) | | [optional] -**icon_url** | **str** | | [optional] -**friendly_name** | **str** | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_plug_response_metadata import LegacyPlugResponseMetadata - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugResponseMetadata from a JSON string -legacy_plug_response_metadata_instance = LegacyPlugResponseMetadata.from_json(json) -# print the JSON string representation of the object -print LegacyPlugResponseMetadata.to_json() - -# convert the object into a dict -legacy_plug_response_metadata_dict = legacy_plug_response_metadata_instance.to_dict() -# create an instance of LegacyPlugResponseMetadata from a dict -legacy_plug_response_metadata_form_dict = legacy_plug_response_metadata.from_dict(legacy_plug_response_metadata_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugScriptMeta.md b/docs/LegacyPlugScriptMeta.md deleted file mode 100644 index 71e93923..00000000 --- a/docs/LegacyPlugScriptMeta.md +++ /dev/null @@ -1,37 +0,0 @@ -# LegacyPlugScriptMeta - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**author** | **str** | | [optional] -**description** | **str** | | [optional] -**category** | **str** | | [optional] -**tags** | [**List[Tag]**](Tag.md) | | [optional] -**icon_url** | **str** | | [optional] -**friendly_name** | **str** | | [optional] -**supported_states** | **List[str]** | | -**raw_data** | [**List[LegacyPlugScriptMetaRawDataInner]**](LegacyPlugScriptMetaRawDataInner.md) | | -**required_properties** | [**List[LegacyRequiredPropertiesInner]**](LegacyRequiredPropertiesInner.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_plug_script_meta import LegacyPlugScriptMeta - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugScriptMeta from a JSON string -legacy_plug_script_meta_instance = LegacyPlugScriptMeta.from_json(json) -# print the JSON string representation of the object -print LegacyPlugScriptMeta.to_json() - -# convert the object into a dict -legacy_plug_script_meta_dict = legacy_plug_script_meta_instance.to_dict() -# create an instance of LegacyPlugScriptMeta from a dict -legacy_plug_script_meta_form_dict = legacy_plug_script_meta.from_dict(legacy_plug_script_meta_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugScriptMetaRawDataInner.md b/docs/LegacyPlugScriptMetaRawDataInner.md deleted file mode 100644 index 10ac219e..00000000 --- a/docs/LegacyPlugScriptMetaRawDataInner.md +++ /dev/null @@ -1,30 +0,0 @@ -# LegacyPlugScriptMetaRawDataInner - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**parameter** | **str** | | -**data_type** | **str** | | [optional] - -## Example - -```python -from waylay.services.registry.models.legacy_plug_script_meta_raw_data_inner import LegacyPlugScriptMetaRawDataInner - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugScriptMetaRawDataInner from a JSON string -legacy_plug_script_meta_raw_data_inner_instance = LegacyPlugScriptMetaRawDataInner.from_json(json) -# print the JSON string representation of the object -print LegacyPlugScriptMetaRawDataInner.to_json() - -# convert the object into a dict -legacy_plug_script_meta_raw_data_inner_dict = legacy_plug_script_meta_raw_data_inner_instance.to_dict() -# create an instance of LegacyPlugScriptMetaRawDataInner from a dict -legacy_plug_script_meta_raw_data_inner_form_dict = legacy_plug_script_meta_raw_data_inner.from_dict(legacy_plug_script_meta_raw_data_inner_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyPlugScriptResponse.md b/docs/LegacyPlugScriptResponse.md deleted file mode 100644 index 5efff572..00000000 --- a/docs/LegacyPlugScriptResponse.md +++ /dev/null @@ -1,34 +0,0 @@ -# LegacyPlugScriptResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**type** | [**PlugType**](PlugType.md) | | -**script** | **str** | | -**metadata** | [**LegacyPlugScriptMeta**](LegacyPlugScriptMeta.md) | | -**dependencies** | **object** | | - -## Example - -```python -from waylay.services.registry.models.legacy_plug_script_response import LegacyPlugScriptResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyPlugScriptResponse from a JSON string -legacy_plug_script_response_instance = LegacyPlugScriptResponse.from_json(json) -# print the JSON string representation of the object -print LegacyPlugScriptResponse.to_json() - -# convert the object into a dict -legacy_plug_script_response_dict = legacy_plug_script_response_instance.to_dict() -# create an instance of LegacyPlugScriptResponse from a dict -legacy_plug_script_response_form_dict = legacy_plug_script_response.from_dict(legacy_plug_script_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyRequiredPropertiesInner.md b/docs/LegacyRequiredPropertiesInner.md deleted file mode 100644 index 69a8ba4a..00000000 --- a/docs/LegacyRequiredPropertiesInner.md +++ /dev/null @@ -1,32 +0,0 @@ -# LegacyRequiredPropertiesInner - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**type** | [**PlugPropertyDataType**](PlugPropertyDataType.md) | | -**mandatory** | **bool** | | -**sensitive** | **bool** | | - -## Example - -```python -from waylay.services.registry.models.legacy_required_properties_inner import LegacyRequiredPropertiesInner - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyRequiredPropertiesInner from a JSON string -legacy_required_properties_inner_instance = LegacyRequiredPropertiesInner.from_json(json) -# print the JSON string representation of the object -print LegacyRequiredPropertiesInner.to_json() - -# convert the object into a dict -legacy_required_properties_inner_dict = legacy_required_properties_inner_instance.to_dict() -# create an instance of LegacyRequiredPropertiesInner from a dict -legacy_required_properties_inner_form_dict = legacy_required_properties_inner.from_dict(legacy_required_properties_inner_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LegacyRequiredPropertyObject.md b/docs/LegacyRequiredPropertyObject.md deleted file mode 100644 index fcc66515..00000000 --- a/docs/LegacyRequiredPropertyObject.md +++ /dev/null @@ -1,32 +0,0 @@ -# LegacyRequiredPropertyObject - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**type** | [**PlugPropertyDataType**](PlugPropertyDataType.md) | | -**mandatory** | **bool** | | -**sensitive** | **bool** | | - -## Example - -```python -from waylay.services.registry.models.legacy_required_property_object import LegacyRequiredPropertyObject - -# TODO update the JSON string below -json = "{}" -# create an instance of LegacyRequiredPropertyObject from a JSON string -legacy_required_property_object_instance = LegacyRequiredPropertyObject.from_json(json) -# print the JSON string representation of the object -print LegacyRequiredPropertyObject.to_json() - -# convert the object into a dict -legacy_required_property_object_dict = legacy_required_property_object_instance.to_dict() -# create an instance of LegacyRequiredPropertyObject from a dict -legacy_required_property_object_form_dict = legacy_required_property_object.from_dict(legacy_required_property_object_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/LimitQuery.md b/docs/LimitQuery.md deleted file mode 100644 index 671d56e4..00000000 --- a/docs/LimitQuery.md +++ /dev/null @@ -1,29 +0,0 @@ -# LimitQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] - -## Example - -```python -from waylay.services.registry.models.limit_query import LimitQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of LimitQuery from a JSON string -limit_query_instance = LimitQuery.from_json(json) -# print the JSON string representation of the object -print LimitQuery.to_json() - -# convert the object into a dict -limit_query_dict = limit_query_instance.to_dict() -# create an instance of LimitQuery from a dict -limit_query_form_dict = limit_query.from_dict(limit_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/MessageAndStatusResponse.md b/docs/MessageAndStatusResponse.md deleted file mode 100644 index 2c3635a4..00000000 --- a/docs/MessageAndStatusResponse.md +++ /dev/null @@ -1,30 +0,0 @@ -# MessageAndStatusResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | -**status_code** | **float** | | - -## Example - -```python -from waylay.services.registry.models.message_and_status_response import MessageAndStatusResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of MessageAndStatusResponse from a JSON string -message_and_status_response_instance = MessageAndStatusResponse.from_json(json) -# print the JSON string representation of the object -print MessageAndStatusResponse.to_json() - -# convert the object into a dict -message_and_status_response_dict = message_and_status_response_instance.to_dict() -# create an instance of MessageAndStatusResponse from a dict -message_and_status_response_form_dict = message_and_status_response.from_dict(message_and_status_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/MessageResponse.md b/docs/MessageResponse.md deleted file mode 100644 index 5090ae32..00000000 --- a/docs/MessageResponse.md +++ /dev/null @@ -1,29 +0,0 @@ -# MessageResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | - -## Example - -```python -from waylay.services.registry.models.message_response import MessageResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of MessageResponse from a JSON string -message_response_instance = MessageResponse.from_json(json) -# print the JSON string representation of the object -print MessageResponse.to_json() - -# convert the object into a dict -message_response_dict = message_response_instance.to_dict() -# create an instance of MessageResponse from a dict -message_response_form_dict = message_response.from_dict(message_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/ModelFunctionsApi.md b/docs/ModelsApi.md similarity index 76% rename from docs/ModelFunctionsApi.md rename to docs/ModelsApi.md index a55a1025..91f1fed6 100644 --- a/docs/ModelFunctionsApi.md +++ b/docs/ModelsApi.md @@ -1,26 +1,26 @@ -# waylay.services.registry.ModelFunctionsApi +# waylay.services.registry.ModelsApi All URIs are relative to *https://api.waylay.io* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**](ModelFunctionsApi.md#create) | **POST** /registry/v2/models/ | Create Model -[**delete_asset**](ModelFunctionsApi.md#delete_asset) | **DELETE** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Delete Model Asset -[**get_archive**](ModelFunctionsApi.md#get_archive) | **GET** /registry/v2/models/{name}/versions/{version}/content | Get Model Archive -[**get_asset**](ModelFunctionsApi.md#get_asset) | **GET** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Get File From Model Archive -[**get_latest**](ModelFunctionsApi.md#get_latest) | **GET** /registry/v2/models/{name} | Get Latest Model Version -[**get**](ModelFunctionsApi.md#get) | **GET** /registry/v2/models/{name}/versions/{version} | Get Model Version -[**jobs**](ModelFunctionsApi.md#jobs) | **GET** /registry/v2/models/{name}/versions/{version}/jobs | List Model Jobs -[**list**](ModelFunctionsApi.md#list) | **GET** /registry/v2/models/ | List Models -[**list_versions**](ModelFunctionsApi.md#list_versions) | **GET** /registry/v2/models/{name}/versions | List Model Versions -[**patch_metadata**](ModelFunctionsApi.md#patch_metadata) | **PATCH** /registry/v2/models/{name}/versions/{version}/metadata | Patch Model Metadata -[**publish**](ModelFunctionsApi.md#publish) | **POST** /registry/v2/models/{name}/versions/{version}/publish | Publish Draft Model -[**rebuild**](ModelFunctionsApi.md#rebuild) | **POST** /registry/v2/models/{name}/versions/{version}/rebuild | Rebuild Model -[**remove_version**](ModelFunctionsApi.md#remove_version) | **DELETE** /registry/v2/models/{name}/versions/{version} | Remove Model Version -[**remove_versions**](ModelFunctionsApi.md#remove_versions) | **DELETE** /registry/v2/models/{name} | Remove Model -[**update_asset**](ModelFunctionsApi.md#update_asset) | **PUT** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Update Model Asset -[**update_assets**](ModelFunctionsApi.md#update_assets) | **PUT** /registry/v2/models/{name}/versions/{version}/content | Update Model Assets -[**verify**](ModelFunctionsApi.md#verify) | **POST** /registry/v2/models/{name}/versions/{version}/verify | Verify Health Of Model +[**create**](ModelsApi.md#create) | **POST** /registry/v2/models/ | Create Model +[**delete_asset**](ModelsApi.md#delete_asset) | **DELETE** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Delete Model Asset +[**get_archive**](ModelsApi.md#get_archive) | **GET** /registry/v2/models/{name}/versions/{version}/content | Get Model Archive +[**get_asset**](ModelsApi.md#get_asset) | **GET** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Get File From Model Archive +[**get_latest**](ModelsApi.md#get_latest) | **GET** /registry/v2/models/{name} | Get Latest Model Version +[**get**](ModelsApi.md#get) | **GET** /registry/v2/models/{name}/versions/{version} | Get Model Version +[**jobs**](ModelsApi.md#jobs) | **GET** /registry/v2/models/{name}/versions/{version}/jobs | List Model Jobs +[**list**](ModelsApi.md#list) | **GET** /registry/v2/models/ | List Models +[**list_versions**](ModelsApi.md#list_versions) | **GET** /registry/v2/models/{name}/versions | List Model Versions +[**patch_metadata**](ModelsApi.md#patch_metadata) | **PATCH** /registry/v2/models/{name}/versions/{version}/metadata | Patch Model Metadata +[**publish**](ModelsApi.md#publish) | **POST** /registry/v2/models/{name}/versions/{version}/publish | Publish Draft Model +[**rebuild**](ModelsApi.md#rebuild) | **POST** /registry/v2/models/{name}/versions/{version}/rebuild | Rebuild Model +[**remove_version**](ModelsApi.md#remove_version) | **DELETE** /registry/v2/models/{name}/versions/{version} | Remove Model Version +[**remove_versions**](ModelsApi.md#remove_versions) | **DELETE** /registry/v2/models/{name} | Remove Model +[**update_asset**](ModelsApi.md#update_asset) | **PUT** /registry/v2/models/{name}/versions/{version}/content/{wildcard} | Update Model Asset +[**update_assets**](ModelsApi.md#update_assets) | **PUT** /registry/v2/models/{name}/versions/{version}/content | Update Model Assets +[**verify**](ModelsApi.md#verify) | **POST** /registry/v2/models/{name}/versions/{version}/verify | Verify Health Of Model # **create** > create( @@ -31,7 +31,7 @@ Method | HTTP request | Description Create Model -Creates a new model function by uploading its assets. The assets for a model function can be provided as either The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. +Creates a new model function by uploading its assets. The assets for a model function can be provided as The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. ### Example @@ -47,32 +47,34 @@ waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed from waylay.services.registry.models.deprecate_previous_policy import DeprecatePreviousPolicy -from waylay.services.registry.models.multipart_file_upload import MultipartFileUpload from waylay.services.registry.models.post_model_job_sync_response_v2 import PostModelJobSyncResponseV2 try: # Create Model # calls `POST /registry/v2/models/` - api_response = await waylay_client.registry.model_functions.create( + api_response = await waylay_client.registry.models.create( # query parameters: query = { + 'deploy': True + 'scaleToZero': False 'deprecatePrevious': 'none' 'dryRun': True 'async': True - 'scaleToZero': False 'draft': False }, + # json data: use a generated model or a json-serializable python data structure (dict, list) + json = None # bytearray | The assets for a model function can be provided as The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. (optional) # non-json binary data: use a byte array or a generator of bytearray chuncks content=b'my-binary-data', # this operation supports multiple request content types: use `headers` to specify the one used - # alternatives: 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', + # alternatives: 'application/tar', 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', 'application/json', '*/*+json', headers = { 'content-type': 'application/octet-stream' }, ) - print("The response of registry.model_functions.create:\n") + print("The response of registry.models.create:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.create: %s\n" % e) + print("Exception when calling registry.models.create: %s\n" % e) ``` ### Endpoint @@ -83,18 +85,24 @@ POST /registry/v2/models/ Name | Type | API binding | Description | Notes -------- | ----- | ------------- | ------------- | ------------- -**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>model</em> function can be provided as either <ul> <li>a single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>separate files in a <code>multipart/form-data</code> request</li> </ul> The required <code>model.json</code> json file contains the function metadata, and must have a <code>runtime</code> attribute that is one of the supported <em>runtime</em>s (see <code>GET /registry/v2/runtimes?functionType=kfserving</code>). For each <em>runtime</em> other files will be required or supported. | [optional] +**json** | **bytearray** | json request body | The assets for a <em>model</em> function can be provided as <ul> <li>A single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>Separate files in a <code>multipart/form-data</code> request</li> <li>A reference to the assets of another <em>model</em> in the <code>copy</code> argument</li> </ul> The required <code>model.json</code> json file contains the function metadata, and must have a <code>runtime</code> attribute that is one of the supported <em>runtime</em>s (see <code>GET /registry/v2/runtimes?functionType=kfserving</code>). For each <em>runtime</em> other files will be required or supported. | [optional] +**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>model</em> function can be provided as <ul> <li>A single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>Separate files in a <code>multipart/form-data</code> request</li> <li>A reference to the assets of another <em>model</em> in the <code>copy</code> argument</li> </ul> The required <code>model.json</code> json file contains the function metadata, and must have a <code>runtime</code> attribute that is one of the supported <em>runtime</em>s (see <code>GET /registry/v2/runtimes?functionType=kfserving</code>). For each <em>runtime</em> other files will be required or supported. | [optional] **files** | **[FileTypes](Operation.md#req_arg_files)** | request body files | | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] +**query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] **query['deprecatePrevious']** (dict)
**query.deprecate_previous** (Query) | [**DeprecatePreviousPolicy**](.md) | query parameter `"deprecatePrevious"` | Set the cleanup policy used to automatically deprecate/delete previous versions. | [optional] **query['dryRun']** (dict)
**query.dry_run** (Query) | **bool** | query parameter `"dryRun"` | If set to <code>true</code>, validates the deployment conditions, but does not change anything. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately. | [optional] [default False] **query['version']** (dict)
**query.version** (Query) | [**SemanticVersionRange**](.md) | query parameter `"version"` | If set, the function version will be an increment of the latest existing version that satisfies the `version` range. Note that this increment always takes precedence over an explicit `version` in the function manifest. | [optional] **query['name']** (dict)
**query.name** (Query) | **str** | query parameter `"name"` | If set, the value will be used as the function name instead of the one specified in the manifest. | [optional] **query['draft']** (dict)
**query.draft** (Query) | **bool** | query parameter `"draft"` | If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. | [optional] [default False] +**query['runtime']** (dict)
**query.runtime** (Query) | **str** | query parameter `"runtime"` | If set, the created function will use the indicated runtime (latest version within specified range). This takes precedence over the runtime specified in a function manifest (copied or from request body). | [optional] +**query['copy']** (dict)
**query.copy_from** (Query) | [**CreateWebscriptsCopyParameter**](.md) | query parameter `"copy"` | Indicates the _source_ of initial assets for a _new function_. When using this query parameter, the request body does not need to contain assets, but any assets in the request body will overwrite the copied assets. #### Selection of _assets_ source * If set as `<sourceName>[@<sourceVersionRange>]`, the _new function_ will be created with copied assets of the selected _source function_. * If set as `!example`, a `runtime` query parameter is required, and the _new function_ will be initialized with assets of the _runtime example_. #### Selection of the _source function_ When `<sourceVersionRange>` is a range (or is not given), the latest _published_ version (in that range) is used. If no _published_ version exists, the latest _draft_ is selected. If no versions in the range exist, a `404` _Not Found_ error is returned. #### The `name` of the _new function_ If a `name` is NOT specified (either as query parameter, or in an optional manifest asset in the request body), the `name` of the _new function_ will be that of the _source function_. #### The `version` of the _new function_ When the _target_ and _source_ name are equal, the `version` query parameters is defaulted to `<sourceVersionRange>` (`~<sourceVersionRange>` when it's an exact version) The version of the _new function_ will be: * If a `version` is NOT specified (either as query parameter, in an optional manifest asset, or as `<sourceVersionRange>` _default_) * a **patch increment** (`<major>.<minor>.<patch>+1`) of the latest **existing version** with the target `name` * **`1.0.0`** otherwise * If a `version` is specified: * the **lowest version** in that range **if no existing version** is in that range. * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. #### Deployment overrides The new function will use the deployment overrides of the copied function, unless a _manifest_ was specified in the request body. | [optional] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | -**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data` +**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data`, `application/json`, `*/*+json` ### Return type @@ -106,7 +114,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - - **Content-Type**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data + - **Content-Type**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data, application/json, */*+json - **Accept**: application/json ### HTTP response details @@ -148,20 +156,22 @@ from waylay.services.registry.models.post_model_job_sync_response_v2 import Post try: # Delete Model Asset # calls `DELETE /registry/v2/models/{name}/versions/{version}/content/{wildcard}` - api_response = await waylay_client.registry.model_functions.delete_asset( + api_response = await waylay_client.registry.models.delete_asset( 'name_example', # name | path param "name" 'version_example', # version | path param "version" 'wildcard_example', # wildcard | path param "wildcard" # query parameters: query = { - 'async': True + 'scaleToZero': False + 'deploy': True 'chown': False + 'async': True }, ) - print("The response of registry.model_functions.delete_asset:\n") + print("The response of registry.models.delete_asset:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.delete_asset: %s\n" % e) + print("Exception when calling registry.models.delete_asset: %s\n" % e) ``` ### Endpoint @@ -176,9 +186,12 @@ Name | Type | API binding | Description | Notes **version** | **str** | path parameter `"version"` | The version of the function. | **wildcard** | **str** | path parameter `"wildcard"` | Full path or path prefix of the asset within the archive | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [default False] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | ### Return type @@ -200,6 +213,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected |-------------|-------------|------------------| **201** | Default Response | - | **202** | Default Response | - | +**403** | Default Response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -231,7 +245,7 @@ waylay_client = WaylayClient.from_profile() try: # Get Model Archive # calls `GET /registry/v2/models/{name}/versions/{version}/content` - api_response = await waylay_client.registry.model_functions.get_archive( + api_response = await waylay_client.registry.models.get_archive( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: @@ -239,10 +253,10 @@ try: 'ls': False }, ) - print("The response of registry.model_functions.get_archive:\n") + print("The response of registry.models.get_archive:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.get_archive: %s\n" % e) + print("Exception when calling registry.models.get_archive: %s\n" % e) ``` ### Endpoint @@ -270,7 +284,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json + - **Accept**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json ### HTTP response details @@ -309,7 +323,7 @@ waylay_client = WaylayClient.from_profile() try: # Get File From Model Archive # calls `GET /registry/v2/models/{name}/versions/{version}/content/{wildcard}` - api_response = await waylay_client.registry.model_functions.get_asset( + api_response = await waylay_client.registry.models.get_asset( 'name_example', # name | path param "name" 'version_example', # version | path param "version" 'wildcard_example', # wildcard | path param "wildcard" @@ -318,10 +332,10 @@ try: 'ls': False }, ) - print("The response of registry.model_functions.get_asset:\n") + print("The response of registry.models.get_asset:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.get_asset: %s\n" % e) + print("Exception when calling registry.models.get_asset: %s\n" % e) ``` ### Endpoint @@ -350,7 +364,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json + - **Accept**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json ### HTTP response details @@ -388,7 +402,7 @@ from waylay.services.registry.models.get_model_response_v2 import GetModelRespon try: # Get Latest Model Version # calls `GET /registry/v2/models/{name}` - api_response = await waylay_client.registry.model_functions.get_latest( + api_response = await waylay_client.registry.models.get_latest( 'name_example', # name | path param "name" # query parameters: query = { @@ -396,10 +410,10 @@ try: 'includeDeprecated': True }, ) - print("The response of registry.model_functions.get_latest:\n") + print("The response of registry.models.get_latest:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.get_latest: %s\n" % e) + print("Exception when calling registry.models.get_latest: %s\n" % e) ``` ### Endpoint @@ -465,14 +479,14 @@ from waylay.services.registry.models.get_model_response_v2 import GetModelRespon try: # Get Model Version # calls `GET /registry/v2/models/{name}/versions/{version}` - api_response = await waylay_client.registry.model_functions.get( + api_response = await waylay_client.registry.models.get( 'name_example', # name | path param "name" 'version_example', # version | path param "version" ) - print("The response of registry.model_functions.get:\n") + print("The response of registry.models.get:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.get: %s\n" % e) + print("Exception when calling registry.models.get: %s\n" % e) ``` ### Endpoint @@ -540,17 +554,17 @@ from waylay.services.registry.models.jobs_for_model_response_v2 import JobsForMo try: # List Model Jobs # calls `GET /registry/v2/models/{name}/versions/{version}/jobs` - api_response = await waylay_client.registry.model_functions.jobs( + api_response = await waylay_client.registry.models.jobs( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { }, ) - print("The response of registry.model_functions.jobs:\n") + print("The response of registry.models.jobs:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.jobs: %s\n" % e) + print("Exception when calling registry.models.jobs: %s\n" % e) ``` ### Endpoint @@ -601,7 +615,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected List Models -List the (latest) versions of available models. ### List Latest Model Versions By default, the result includes the latest non-deprecated, non-draft version for each model name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour: As long as no _version filters_ are used, each listed model version item will contain a HAL **link to the latest** _draft_ (`entities[]._links.draft`) or latest _published_ (`entities[]._links.publisned`) version (if existing and different). ### List Latest Model Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named model that satisfy the filters, but **without links**. ### List All Model Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ models versions that satisfy the query, possibly multiple versions per named models. No HAL links are provided. #### Filter on _status_ By default model versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the model listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft` +List the (latest) versions of available models. ### List Latest Model Versions By default, the result includes the latest non-deprecated, non-draft version for each model name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour: As long as no version filters are used, each listed model version contains representations of the latest draft (`entities[]._links.draft`) or latest published (`entities[]._links.published`) version (if existing and different). Use the query parameter `showRelated` to include only a link (default `showRelated=link`) or a full representation (`showRelated=embed`). ### List Latest Model Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named model that satisfy the filters, but **without links**. ### List All Model Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ models versions that satisfy the query, possibly multiple versions per named models. No HAL links are provided. #### Filter on _status_ By default model versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the model listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft` ### Example @@ -618,11 +632,12 @@ waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed from waylay.services.registry.models.archive_format import ArchiveFormat from waylay.services.registry.models.latest_models_response_v2 import LatestModelsResponseV2 +from waylay.services.registry.models.show_related_type import ShowRelatedType from waylay.services.registry.models.status_filter import StatusFilter try: # List Models # calls `GET /registry/v2/models/` - api_response = await waylay_client.registry.model_functions.list( + api_response = await waylay_client.registry.models.list( # query parameters: query = { 'includeDraft': True @@ -632,12 +647,13 @@ try: 'createdBy': '@me' 'updatedBy': '@me' 'latest': True + 'showRelated': 'embed' }, ) - print("The response of registry.model_functions.list:\n") + print("The response of registry.models.list:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.list: %s\n" % e) + print("Exception when calling registry.models.list: %s\n" % e) ``` ### Endpoint @@ -669,6 +685,7 @@ Name | Type | API binding | Description | Notes **query['archiveFormat']** (dict)
**query.archive_format** (Query) | [**List[ArchiveFormat]**](ArchiveFormat.md) | query parameter `"archiveFormat"` | Filter on the archive format of the function. | [optional] **query['runtime']** (dict)
**query.runtime** (Query) | [**List[str]**](str.md) | query parameter `"runtime"` | Filter on the runtime of the function. | [optional] **query['latest']** (dict)
**query.latest** (Query) | **bool** | query parameter `"latest"` | When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. | [optional] +**query['showRelated']** (dict)
**query.show_related** (Query) | [**ShowRelatedType**](.md) | query parameter `"showRelated"` | Sets the representation of related function versions (like the _latest_ draft and/or published) in the response. - `embed`: as full summary representation (in `_embedded`). - `link`: as HAL link in (in `_links`). - `none`: omitted. | [optional] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | ### Return type @@ -722,7 +739,7 @@ from waylay.services.registry.models.status_filter import StatusFilter try: # List Model Versions # calls `GET /registry/v2/models/{name}/versions` - api_response = await waylay_client.registry.model_functions.list_versions( + api_response = await waylay_client.registry.models.list_versions( 'name_example', # name | path param "name" # query parameters: query = { @@ -732,10 +749,10 @@ try: 'updatedBy': '@me' }, ) - print("The response of registry.model_functions.list_versions:\n") + print("The response of registry.models.list_versions:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.list_versions: %s\n" % e) + print("Exception when calling registry.models.list_versions: %s\n" % e) ``` ### Endpoint @@ -816,7 +833,7 @@ from waylay.services.registry.models.get_model_response_v2 import GetModelRespon try: # Patch Model Metadata # calls `PATCH /registry/v2/models/{name}/versions/{version}/metadata` - api_response = await waylay_client.registry.model_functions.patch_metadata( + api_response = await waylay_client.registry.models.patch_metadata( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: @@ -825,10 +842,10 @@ try: # json data: use a generated model or a json-serializable python data structure (dict, list) json = waylay.services.registry.FunctionMeta() # FunctionMeta | (optional) ) - print("The response of registry.model_functions.patch_metadata:\n") + print("The response of registry.models.patch_metadata:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.patch_metadata: %s\n" % e) + print("Exception when calling registry.models.patch_metadata: %s\n" % e) ``` ### Endpoint @@ -897,19 +914,20 @@ from waylay.services.registry.models.post_model_job_sync_response_v2 import Post try: # Publish Draft Model # calls `POST /registry/v2/models/{name}/versions/{version}/publish` - api_response = await waylay_client.registry.model_functions.publish( + api_response = await waylay_client.registry.models.publish( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { + 'chown': False 'deprecatePrevious': 'none' 'async': True }, ) - print("The response of registry.model_functions.publish:\n") + print("The response of registry.models.publish:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.publish: %s\n" % e) + print("Exception when calling registry.models.publish: %s\n" % e) ``` ### Endpoint @@ -923,7 +941,9 @@ Name | Type | API binding | Description | Notes **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['deprecatePrevious']** (dict)
**query.deprecate_previous** (Query) | [**DeprecatePreviousPolicy**](.md) | query parameter `"deprecatePrevious"` | Set the cleanup policy used to automatically deprecate/delete previous versions. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | @@ -980,23 +1000,23 @@ from waylay.services.registry.models.rebuild_policy import RebuildPolicy try: # Rebuild Model # calls `POST /registry/v2/models/{name}/versions/{version}/rebuild` - api_response = await waylay_client.registry.model_functions.rebuild( + api_response = await waylay_client.registry.models.rebuild( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { + 'scaleToZero': True 'dryRun': True 'async': True 'upgrade': 'patch' 'ignoreChecks': True - 'scaleToZero': True 'skipRebuild': True }, ) - print("The response of registry.model_functions.rebuild:\n") + print("The response of registry.models.rebuild:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.rebuild: %s\n" % e) + print("Exception when calling registry.models.rebuild: %s\n" % e) ``` ### Endpoint @@ -1010,13 +1030,13 @@ Name | Type | API binding | Description | Notes **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. | [optional] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] **query['dryRun']** (dict)
**query.dry_run** (Query) | **bool** | query parameter `"dryRun"` | If set to <code>true</code>, checks whether rebuild jobs are needed, but do not start any jobs. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **query['upgrade']** (dict)
**query.upgrade** (Query) | [**RebuildPolicy**](.md) | query parameter `"upgrade"` | If set, force a rebuild with the given <em>runtime</em> version selection policy. <ul> <li><code>same</code> <b>patch</b> version. This should only include backward compatible upgrades. </li> <li><code>minor</code> <b>major</b> version. This might include an upgrade of e.g. the language runtime and/or provided dependencies that could break compatiblity with the function. .</li> </ul> | [optional] **query['forceVersion']** (dict)
**query.force_version** (Query) | **str** | query parameter `"forceVersion"` | If set, force a rebuild with the given runtime version (including downgrades). This parameter is mutually exclusive to the `upgrade` parameter. | [optional] **query['ignoreChecks']** (dict)
**query.ignore_checks** (Query) | **bool** | query parameter `"ignoreChecks"` | If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option | [optional] -**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command. | [optional] **query['skipRebuild']** (dict)
**query.skip_rebuild** (Query) | **bool** | query parameter `"skipRebuild"` | If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function. | [optional] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | @@ -1071,7 +1091,7 @@ from waylay.services.registry.models.undeployed_response_v2 import UndeployedRes try: # Remove Model Version # calls `DELETE /registry/v2/models/{name}/versions/{version}` - api_response = await waylay_client.registry.model_functions.remove_version( + api_response = await waylay_client.registry.models.remove_version( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: @@ -1081,10 +1101,10 @@ try: 'undeploy': True }, ) - print("The response of registry.model_functions.remove_version:\n") + print("The response of registry.models.remove_version:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.remove_version: %s\n" % e) + print("Exception when calling registry.models.remove_version: %s\n" % e) ``` ### Endpoint @@ -1154,7 +1174,7 @@ from waylay.services.registry.models.undeployed_response_v2 import UndeployedRes try: # Remove Model # calls `DELETE /registry/v2/models/{name}` - api_response = await waylay_client.registry.model_functions.remove_versions( + api_response = await waylay_client.registry.models.remove_versions( 'name_example', # name | path param "name" # query parameters: query = { @@ -1163,10 +1183,10 @@ try: 'async': True }, ) - print("The response of registry.model_functions.remove_versions:\n") + print("The response of registry.models.remove_versions:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.remove_versions: %s\n" % e) + print("Exception when calling registry.models.remove_versions: %s\n" % e) ``` ### Endpoint @@ -1238,14 +1258,16 @@ from waylay.services.registry.models.post_model_job_sync_response_v2 import Post try: # Update Model Asset # calls `PUT /registry/v2/models/{name}/versions/{version}/content/{wildcard}` - api_response = await waylay_client.registry.model_functions.update_asset( + api_response = await waylay_client.registry.models.update_asset( 'name_example', # name | path param "name" 'version_example', # version | path param "version" 'wildcard_example', # wildcard | path param "wildcard" # query parameters: query = { - 'async': True + 'scaleToZero': False + 'deploy': True 'chown': False + 'async': True }, # non-json binary data: use a byte array or a generator of bytearray chuncks content=b'my-binary-data', @@ -1255,10 +1277,10 @@ try: 'content-type': 'application/octet-stream' }, ) - print("The response of registry.model_functions.update_asset:\n") + print("The response of registry.models.update_asset:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.update_asset: %s\n" % e) + print("Exception when calling registry.models.update_asset: %s\n" % e) ``` ### Endpoint @@ -1274,11 +1296,14 @@ Name | Type | API binding | Description | Notes **wildcard** | **str** | path parameter `"wildcard"` | Full path or path prefix of the asset within the archive | **content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | A single asset file. | [optional] **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [default False] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | -**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream` +**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType ### Return type @@ -1290,7 +1315,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - - **Content-Type**: application/octet-stream + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -1299,6 +1324,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected |-------------|-------------|------------------| **201** | Default Response | - | **202** | Default Response | - | +**403** | Default Response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -1313,7 +1339,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected Update Model Assets -Update a draft model function by updating its assets. The assets for a model function can be provided as either The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. +Update a draft model function by updating its assets. The assets for a model function can be provided as either The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. ### Example @@ -1328,31 +1354,32 @@ from waylay.sdk.api.api_exceptions import ApiError waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed -from waylay.services.registry.models.multipart_file_upload import MultipartFileUpload from waylay.services.registry.models.post_model_job_sync_response_v2 import PostModelJobSyncResponseV2 try: # Update Model Assets # calls `PUT /registry/v2/models/{name}/versions/{version}/content` - api_response = await waylay_client.registry.model_functions.update_assets( + api_response = await waylay_client.registry.models.update_assets( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { - 'async': True + 'scaleToZero': False + 'deploy': True 'chown': False + 'async': True }, # non-json binary data: use a byte array or a generator of bytearray chuncks content=b'my-binary-data', # this operation supports multiple request content types: use `headers` to specify the one used - # alternatives: 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', + # alternatives: 'application/tar', 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', headers = { 'content-type': 'application/octet-stream' }, ) - print("The response of registry.model_functions.update_assets:\n") + print("The response of registry.models.update_assets:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.update_assets: %s\n" % e) + print("Exception when calling registry.models.update_assets: %s\n" % e) ``` ### Endpoint @@ -1365,14 +1392,17 @@ Name | Type | API binding | Description | Notes -------- | ----- | ------------- | ------------- | ------------- **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | -**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>model</em> function can be provided as either <ul> <li>a single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>separate files in a <code>multipart/form-data</code> request</li> </ul> The provided assets will be added to the <em>model</em> function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json</code> json file with a changed value for any of the <code>name</code>, <code>version</code> and/or <code>runtime</code> attributes. For each <em>runtime</em> other files are supported. | [optional] +**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>model</em> function can be provided as either <ul> <li>a single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>separate files in a <code>multipart/form-data</code> request</li> </ul> The provided assets will be added to the <em>model</em> function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json</code> json file with a changed value for any of the <code>name</code>, <code>version</code> and/or <code>runtime</code> attributes. For each <em>runtime</em> other files are supported. | [optional] **files** | **[FileTypes](Operation.md#req_arg_files)** | request body files | | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [default False] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | -**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data` +**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data` ### Return type @@ -1384,7 +1414,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - - **Content-Type**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data + - **Content-Type**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data - **Accept**: application/json ### HTTP response details @@ -1393,6 +1423,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected |-------------|-------------|------------------| **201** | Default Response | - | **202** | Default Response | - | +**403** | Default Response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -1425,19 +1456,19 @@ from waylay.services.registry.models.verify_model_sync_response_v2 import Verify try: # Verify Health Of Model # calls `POST /registry/v2/models/{name}/versions/{version}/verify` - api_response = await waylay_client.registry.model_functions.verify( + api_response = await waylay_client.registry.models.verify( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { - 'async': True 'scaleToZero': True + 'async': True }, ) - print("The response of registry.model_functions.verify:\n") + print("The response of registry.models.verify:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.model_functions.verify: %s\n" % e) + print("Exception when calling registry.models.verify: %s\n" % e) ``` ### Endpoint @@ -1451,9 +1482,8 @@ Name | Type | API binding | Description | Notes **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | -**query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] -**query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. | [optional] +**query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | ### Return type diff --git a/docs/MultipartFileUpload.md b/docs/MultipartFileUpload.md deleted file mode 100644 index d111b105..00000000 --- a/docs/MultipartFileUpload.md +++ /dev/null @@ -1,30 +0,0 @@ -# MultipartFileUpload - -A multi-part upload containing one or more file assets. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**filename** | **List[bytearray]** | | [optional] - -## Example - -```python -from waylay.services.registry.models.multipart_file_upload import MultipartFileUpload - -# TODO update the JSON string below -json = "{}" -# create an instance of MultipartFileUpload from a JSON string -multipart_file_upload_instance = MultipartFileUpload.from_json(json) -# print the JSON string representation of the object -print MultipartFileUpload.to_json() - -# convert the object into a dict -multipart_file_upload_dict = multipart_file_upload_instance.to_dict() -# create an instance of MultipartFileUpload from a dict -multipart_file_upload_form_dict = multipart_file_upload.from_dict(multipart_file_upload_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/Name.md b/docs/Name.md deleted file mode 100644 index 5ba4a644..00000000 --- a/docs/Name.md +++ /dev/null @@ -1,29 +0,0 @@ -# Name - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the function. | - -## Example - -```python -from waylay.services.registry.models.name import Name - -# TODO update the JSON string below -json = "{}" -# create an instance of Name from a JSON string -name_instance = Name.from_json(json) -# print the JSON string representation of the object -print Name.to_json() - -# convert the object into a dict -name_dict = name_instance.to_dict() -# create an instance of Name from a dict -name_form_dict = name.from_dict(name_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NameAndVersion.md b/docs/NameAndVersion.md deleted file mode 100644 index a8fae7a1..00000000 --- a/docs/NameAndVersion.md +++ /dev/null @@ -1,30 +0,0 @@ -# NameAndVersion - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | The name of the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | - -## Example - -```python -from waylay.services.registry.models.name_and_version import NameAndVersion - -# TODO update the JSON string below -json = "{}" -# create an instance of NameAndVersion from a JSON string -name_and_version_instance = NameAndVersion.from_json(json) -# print the JSON string representation of the object -print NameAndVersion.to_json() - -# convert the object into a dict -name_and_version_dict = name_and_version_instance.to_dict() -# create an instance of NameAndVersion from a dict -name_and_version_form_dict = name_and_version.from_dict(name_and_version_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NamedFunctionVersionsQuery.md b/docs/NamedFunctionVersionsQuery.md deleted file mode 100644 index 5399147c..00000000 --- a/docs/NamedFunctionVersionsQuery.md +++ /dev/null @@ -1,44 +0,0 @@ -# NamedFunctionVersionsQuery - -Named function versions listing query. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.named_function_versions_query import NamedFunctionVersionsQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of NamedFunctionVersionsQuery from a JSON string -named_function_versions_query_instance = NamedFunctionVersionsQuery.from_json(json) -# print the JSON string representation of the object -print NamedFunctionVersionsQuery.to_json() - -# convert the object into a dict -named_function_versions_query_dict = named_function_versions_query_instance.to_dict() -# create an instance of NamedFunctionVersionsQuery from a dict -named_function_versions_query_form_dict = named_function_versions_query.from_dict(named_function_versions_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NamedKFServingVersionsQueryV2.md b/docs/NamedKFServingVersionsQueryV2.md deleted file mode 100644 index f4b60ea6..00000000 --- a/docs/NamedKFServingVersionsQueryV2.md +++ /dev/null @@ -1,44 +0,0 @@ -# NamedKFServingVersionsQueryV2 - -Named Model versions query. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.named_kf_serving_versions_query_v2 import NamedKFServingVersionsQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of NamedKFServingVersionsQueryV2 from a JSON string -named_kf_serving_versions_query_v2_instance = NamedKFServingVersionsQueryV2.from_json(json) -# print the JSON string representation of the object -print NamedKFServingVersionsQueryV2.to_json() - -# convert the object into a dict -named_kf_serving_versions_query_v2_dict = named_kf_serving_versions_query_v2_instance.to_dict() -# create an instance of NamedKFServingVersionsQueryV2 from a dict -named_kf_serving_versions_query_v2_form_dict = named_kf_serving_versions_query_v2.from_dict(named_kf_serving_versions_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NamedParametersTypeofAsJobReference.md b/docs/NamedParametersTypeofAsJobReference.md deleted file mode 100644 index c025b36e..00000000 --- a/docs/NamedParametersTypeofAsJobReference.md +++ /dev/null @@ -1,29 +0,0 @@ -# NamedParametersTypeofAsJobReference - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**job_status** | [**NamedParametersTypeofAsJobReferenceJobStatus**](NamedParametersTypeofAsJobReferenceJobStatus.md) | | - -## Example - -```python -from waylay.services.registry.models.named_parameters_typeof_as_job_reference import NamedParametersTypeofAsJobReference - -# TODO update the JSON string below -json = "{}" -# create an instance of NamedParametersTypeofAsJobReference from a JSON string -named_parameters_typeof_as_job_reference_instance = NamedParametersTypeofAsJobReference.from_json(json) -# print the JSON string representation of the object -print NamedParametersTypeofAsJobReference.to_json() - -# convert the object into a dict -named_parameters_typeof_as_job_reference_dict = named_parameters_typeof_as_job_reference_instance.to_dict() -# create an instance of NamedParametersTypeofAsJobReference from a dict -named_parameters_typeof_as_job_reference_form_dict = named_parameters_typeof_as_job_reference.from_dict(named_parameters_typeof_as_job_reference_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NamedParametersTypeofAsJobReferenceJobStatus.md b/docs/NamedParametersTypeofAsJobReferenceJobStatus.md deleted file mode 100644 index 191d7120..00000000 --- a/docs/NamedParametersTypeofAsJobReferenceJobStatus.md +++ /dev/null @@ -1,39 +0,0 @@ -# NamedParametersTypeofAsJobReferenceJobStatus - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**JobHALLinks**](JobHALLinks.md) | | [optional] -**type** | **object** | The type of the background task. | -**state** | [**JobStateResult**](JobStateResult.md) | | -**request** | **object** | The request that initiated this job. | [optional] -**result** | **object** | The result of the job if completed. | [optional] -**created_at** | **datetime** | The timestamp of creation of this job | -**created_by** | **str** | The user that created this job | -**operation** | **str** | Request operation | -**function** | [**FunctionRef**](FunctionRef.md) | | [optional] -**job** | [**JobStatus**](JobStatus.md) | | [optional] -**failure_reason** | [**FailureReason**](FailureReason.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.named_parameters_typeof_as_job_reference_job_status import NamedParametersTypeofAsJobReferenceJobStatus - -# TODO update the JSON string below -json = "{}" -# create an instance of NamedParametersTypeofAsJobReferenceJobStatus from a JSON string -named_parameters_typeof_as_job_reference_job_status_instance = NamedParametersTypeofAsJobReferenceJobStatus.from_json(json) -# print the JSON string representation of the object -print NamedParametersTypeofAsJobReferenceJobStatus.to_json() - -# convert the object into a dict -named_parameters_typeof_as_job_reference_job_status_dict = named_parameters_typeof_as_job_reference_job_status_instance.to_dict() -# create an instance of NamedParametersTypeofAsJobReferenceJobStatus from a dict -named_parameters_typeof_as_job_reference_job_status_form_dict = named_parameters_typeof_as_job_reference_job_status.from_dict(named_parameters_typeof_as_job_reference_job_status_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NamedParametersTypeofFromLegacy.md b/docs/NamedParametersTypeofFromLegacy.md deleted file mode 100644 index 93ff4a6e..00000000 --- a/docs/NamedParametersTypeofFromLegacy.md +++ /dev/null @@ -1,30 +0,0 @@ -# NamedParametersTypeofFromLegacy - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**metadata** | [**LegacyPlugMetaRequest**](LegacyPlugMetaRequest.md) | | -**current_interface** | [**PlugInterface**](PlugInterface.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.named_parameters_typeof_from_legacy import NamedParametersTypeofFromLegacy - -# TODO update the JSON string below -json = "{}" -# create an instance of NamedParametersTypeofFromLegacy from a JSON string -named_parameters_typeof_from_legacy_instance = NamedParametersTypeofFromLegacy.from_json(json) -# print the JSON string representation of the object -print NamedParametersTypeofFromLegacy.to_json() - -# convert the object into a dict -named_parameters_typeof_from_legacy_dict = named_parameters_typeof_from_legacy_instance.to_dict() -# create an instance of NamedParametersTypeofFromLegacy from a dict -named_parameters_typeof_from_legacy_form_dict = named_parameters_typeof_from_legacy.from_dict(named_parameters_typeof_from_legacy_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NamedParametersTypeofFromLegacyDocumentation.md b/docs/NamedParametersTypeofFromLegacyDocumentation.md deleted file mode 100644 index 893757c3..00000000 --- a/docs/NamedParametersTypeofFromLegacyDocumentation.md +++ /dev/null @@ -1,30 +0,0 @@ -# NamedParametersTypeofFromLegacyDocumentation - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**legacy_documentation** | [**LegacyPlugRequestMetadataDocumentation**](LegacyPlugRequestMetadataDocumentation.md) | | [optional] -**current_interface** | [**PlugInterface**](PlugInterface.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.named_parameters_typeof_from_legacy_documentation import NamedParametersTypeofFromLegacyDocumentation - -# TODO update the JSON string below -json = "{}" -# create an instance of NamedParametersTypeofFromLegacyDocumentation from a JSON string -named_parameters_typeof_from_legacy_documentation_instance = NamedParametersTypeofFromLegacyDocumentation.from_json(json) -# print the JSON string representation of the object -print NamedParametersTypeofFromLegacyDocumentation.to_json() - -# convert the object into a dict -named_parameters_typeof_from_legacy_documentation_dict = named_parameters_typeof_from_legacy_documentation_instance.to_dict() -# create an instance of NamedParametersTypeofFromLegacyDocumentation from a dict -named_parameters_typeof_from_legacy_documentation_form_dict = named_parameters_typeof_from_legacy_documentation.from_dict(named_parameters_typeof_from_legacy_documentation_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NamedParametersTypeofIsNotLegacy.md b/docs/NamedParametersTypeofIsNotLegacy.md deleted file mode 100644 index e1b30c2d..00000000 --- a/docs/NamedParametersTypeofIsNotLegacy.md +++ /dev/null @@ -1,29 +0,0 @@ -# NamedParametersTypeofIsNotLegacy - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**documentation** | [**LegacyPlugRequestMetadataDocumentation**](LegacyPlugRequestMetadataDocumentation.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.named_parameters_typeof_is_not_legacy import NamedParametersTypeofIsNotLegacy - -# TODO update the JSON string below -json = "{}" -# create an instance of NamedParametersTypeofIsNotLegacy from a JSON string -named_parameters_typeof_is_not_legacy_instance = NamedParametersTypeofIsNotLegacy.from_json(json) -# print the JSON string representation of the object -print NamedParametersTypeofIsNotLegacy.to_json() - -# convert the object into a dict -named_parameters_typeof_is_not_legacy_dict = named_parameters_typeof_is_not_legacy_instance.to_dict() -# create an instance of NamedParametersTypeofIsNotLegacy from a dict -named_parameters_typeof_is_not_legacy_form_dict = named_parameters_typeof_is_not_legacy.from_dict(named_parameters_typeof_is_not_legacy_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NamedPlugVersionsQueryV2.md b/docs/NamedPlugVersionsQueryV2.md deleted file mode 100644 index 02bcedff..00000000 --- a/docs/NamedPlugVersionsQueryV2.md +++ /dev/null @@ -1,45 +0,0 @@ -# NamedPlugVersionsQueryV2 - -Named plug version listing query - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tags** | [**TagsFilter**](TagsFilter.md) | | [optional] -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.named_plug_versions_query_v2 import NamedPlugVersionsQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of NamedPlugVersionsQueryV2 from a JSON string -named_plug_versions_query_v2_instance = NamedPlugVersionsQueryV2.from_json(json) -# print the JSON string representation of the object -print NamedPlugVersionsQueryV2.to_json() - -# convert the object into a dict -named_plug_versions_query_v2_dict = named_plug_versions_query_v2_instance.to_dict() -# create an instance of NamedPlugVersionsQueryV2 from a dict -named_plug_versions_query_v2_form_dict = named_plug_versions_query_v2.from_dict(named_plug_versions_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NamedVersionsFilter.md b/docs/NamedVersionsFilter.md deleted file mode 100644 index 562d0099..00000000 --- a/docs/NamedVersionsFilter.md +++ /dev/null @@ -1,29 +0,0 @@ -# NamedVersionsFilter - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name_version** | **List[str]** | Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered. | [optional] - -## Example - -```python -from waylay.services.registry.models.named_versions_filter import NamedVersionsFilter - -# TODO update the JSON string below -json = "{}" -# create an instance of NamedVersionsFilter from a JSON string -named_versions_filter_instance = NamedVersionsFilter.from_json(json) -# print the JSON string representation of the object -print NamedVersionsFilter.to_json() - -# convert the object into a dict -named_versions_filter_dict = named_versions_filter_instance.to_dict() -# create an instance of NamedVersionsFilter from a dict -named_versions_filter_form_dict = named_versions_filter.from_dict(named_versions_filter_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NamedWebscriptVersionsQueryV2.md b/docs/NamedWebscriptVersionsQueryV2.md deleted file mode 100644 index 85fca343..00000000 --- a/docs/NamedWebscriptVersionsQueryV2.md +++ /dev/null @@ -1,44 +0,0 @@ -# NamedWebscriptVersionsQueryV2 - -Webscript named versions listing query. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.named_webscript_versions_query_v2 import NamedWebscriptVersionsQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of NamedWebscriptVersionsQueryV2 from a JSON string -named_webscript_versions_query_v2_instance = NamedWebscriptVersionsQueryV2.from_json(json) -# print the JSON string representation of the object -print NamedWebscriptVersionsQueryV2.to_json() - -# convert the object into a dict -named_webscript_versions_query_v2_dict = named_webscript_versions_query_v2_instance.to_dict() -# create an instance of NamedWebscriptVersionsQueryV2 from a dict -named_webscript_versions_query_v2_form_dict = named_webscript_versions_query_v2.from_dict(named_webscript_versions_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/NotifyResult.md b/docs/NotifyResult.md new file mode 100644 index 00000000..b1cb2a8b --- /dev/null +++ b/docs/NotifyResult.md @@ -0,0 +1,30 @@ +# NotifyResult + +The result data for a change notification. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**operation** | [**RequestOperation**](RequestOperation.md) | | + +## Example + +```python +from waylay.services.registry.models.notify_result import NotifyResult + +# TODO update the JSON string below +json = "{}" +# create an instance of NotifyResult from a JSON string +notify_result_instance = NotifyResult.from_json(json) +# print the JSON string representation of the object +print NotifyResult.to_json() + +# convert the object into a dict +notify_result_dict = notify_result_instance.to_dict() +# create an instance of NotifyResult from a dict +notify_result_form_dict = notify_result.from_dict(notify_result_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/OpenfaasDeployArgs.md b/docs/OpenfaasDeployArgs.md deleted file mode 100644 index 359ddb5d..00000000 --- a/docs/OpenfaasDeployArgs.md +++ /dev/null @@ -1,31 +0,0 @@ -# OpenfaasDeployArgs - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**namespace** | **str** | The (openfaas) namespace for the target function. | -**endpoint** | **str** | The (openfaas) endpoint service name | -**image_name** | **str** | The image name to use for deploying this function | - -## Example - -```python -from waylay.services.registry.models.openfaas_deploy_args import OpenfaasDeployArgs - -# TODO update the JSON string below -json = "{}" -# create an instance of OpenfaasDeployArgs from a JSON string -openfaas_deploy_args_instance = OpenfaasDeployArgs.from_json(json) -# print the JSON string representation of the object -print OpenfaasDeployArgs.to_json() - -# convert the object into a dict -openfaas_deploy_args_dict = openfaas_deploy_args_instance.to_dict() -# create an instance of OpenfaasDeployArgs from a dict -openfaas_deploy_args_form_dict = openfaas_deploy_args.from_dict(openfaas_deploy_args_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/OpenfaasFunctionRef.md b/docs/OpenfaasFunctionRef.md deleted file mode 100644 index 5be75f8c..00000000 --- a/docs/OpenfaasFunctionRef.md +++ /dev/null @@ -1,30 +0,0 @@ -# OpenfaasFunctionRef - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**namespace** | **str** | The (openfaas) namespace for the target function. | -**endpoint** | **str** | The (openfaas) endpoint service name | - -## Example - -```python -from waylay.services.registry.models.openfaas_function_ref import OpenfaasFunctionRef - -# TODO update the JSON string below -json = "{}" -# create an instance of OpenfaasFunctionRef from a JSON string -openfaas_function_ref_instance = OpenfaasFunctionRef.from_json(json) -# print the JSON string representation of the object -print OpenfaasFunctionRef.to_json() - -# convert the object into a dict -openfaas_function_ref_dict = openfaas_function_ref_instance.to_dict() -# create an instance of OpenfaasFunctionRef from a dict -openfaas_function_ref_form_dict = openfaas_function_ref.from_dict(openfaas_function_ref_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/OperationStatus.md b/docs/OperationStatus.md deleted file mode 100644 index da7f2538..00000000 --- a/docs/OperationStatus.md +++ /dev/null @@ -1,34 +0,0 @@ -# OperationStatus - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**id** | **str** | | -**description** | **str** | | -**name** | **str** | | -**type** | [**JobType**](JobType.md) | | -**done** | **bool** | | -**error** | [**OperationStatusError**](OperationStatusError.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.operation_status import OperationStatus - -# TODO update the JSON string below -json = "{}" -# create an instance of OperationStatus from a JSON string -operation_status_instance = OperationStatus.from_json(json) -# print the JSON string representation of the object -print OperationStatus.to_json() - -# convert the object into a dict -operation_status_dict = operation_status_instance.to_dict() -# create an instance of OperationStatus from a dict -operation_status_form_dict = operation_status.from_dict(operation_status_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/OperationStatusError.md b/docs/OperationStatusError.md deleted file mode 100644 index 38b42f10..00000000 --- a/docs/OperationStatusError.md +++ /dev/null @@ -1,32 +0,0 @@ -# OperationStatusError - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**message** | **str** | | -**stack** | **str** | | [optional] -**code** | **str** | | - -## Example - -```python -from waylay.services.registry.models.operation_status_error import OperationStatusError - -# TODO update the JSON string below -json = "{}" -# create an instance of OperationStatusError from a JSON string -operation_status_error_instance = OperationStatusError.from_json(json) -# print the JSON string representation of the object -print OperationStatusError.to_json() - -# convert the object into a dict -operation_status_error_dict = operation_status_error_instance.to_dict() -# create an instance of OperationStatusError from a dict -operation_status_error_form_dict = operation_status_error.from_dict(operation_status_error_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PagingQuery.md b/docs/PagingQuery.md deleted file mode 100644 index 7b497ff4..00000000 --- a/docs/PagingQuery.md +++ /dev/null @@ -1,30 +0,0 @@ -# PagingQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] - -## Example - -```python -from waylay.services.registry.models.paging_query import PagingQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of PagingQuery from a JSON string -paging_query_instance = PagingQuery.from_json(json) -# print the JSON string representation of the object -print PagingQuery.to_json() - -# convert the object into a dict -paging_query_dict = paging_query_instance.to_dict() -# create an instance of PagingQuery from a dict -paging_query_form_dict = paging_query.from_dict(paging_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PagingResponse.md b/docs/PagingResponse.md deleted file mode 100644 index d49d884c..00000000 --- a/docs/PagingResponse.md +++ /dev/null @@ -1,31 +0,0 @@ -# PagingResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **float** | The total count of matching items, from which this result is one page. | [optional] -**limit** | **float** | The page size used for this query result. | [optional] -**page** | **float** | The page number of a paged query result. | [optional] - -## Example - -```python -from waylay.services.registry.models.paging_response import PagingResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of PagingResponse from a JSON string -paging_response_instance = PagingResponse.from_json(json) -# print the JSON string representation of the object -print PagingResponse.to_json() - -# convert the object into a dict -paging_response_dict = paging_response_instance.to_dict() -# create an instance of PagingResponse from a dict -paging_response_form_dict = paging_response.from_dict(paging_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PatchInterfaceQuery.md b/docs/PatchInterfaceQuery.md deleted file mode 100644 index 3302970f..00000000 --- a/docs/PatchInterfaceQuery.md +++ /dev/null @@ -1,29 +0,0 @@ -# PatchInterfaceQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comment** | **str** | An optional user-specified comment corresponding to the operation. | [optional] - -## Example - -```python -from waylay.services.registry.models.patch_interface_query import PatchInterfaceQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of PatchInterfaceQuery from a JSON string -patch_interface_query_instance = PatchInterfaceQuery.from_json(json) -# print the JSON string representation of the object -print PatchInterfaceQuery.to_json() - -# convert the object into a dict -patch_interface_query_dict = patch_interface_query_instance.to_dict() -# create an instance of PatchInterfaceQuery from a dict -patch_interface_query_form_dict = patch_interface_query.from_dict(patch_interface_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PatchMetadataQuery.md b/docs/PatchMetadataQuery.md deleted file mode 100644 index 9efdb5d3..00000000 --- a/docs/PatchMetadataQuery.md +++ /dev/null @@ -1,29 +0,0 @@ -# PatchMetadataQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comment** | **str** | An optional user-specified comment corresponding to the operation. | [optional] - -## Example - -```python -from waylay.services.registry.models.patch_metadata_query import PatchMetadataQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of PatchMetadataQuery from a JSON string -patch_metadata_query_instance = PatchMetadataQuery.from_json(json) -# print the JSON string representation of the object -print PatchMetadataQuery.to_json() - -# convert the object into a dict -patch_metadata_query_dict = patch_metadata_query_instance.to_dict() -# create an instance of PatchMetadataQuery from a dict -patch_metadata_query_form_dict = patch_metadata_query.from_dict(patch_metadata_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PatchPlugRequestV1.md b/docs/PatchPlugRequestV1.md deleted file mode 100644 index 16f42e99..00000000 --- a/docs/PatchPlugRequestV1.md +++ /dev/null @@ -1,29 +0,0 @@ -# PatchPlugRequestV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**metadata** | [**UserPlugMeta**](UserPlugMeta.md) | | - -## Example - -```python -from waylay.services.registry.models.patch_plug_request_v1 import PatchPlugRequestV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of PatchPlugRequestV1 from a JSON string -patch_plug_request_v1_instance = PatchPlugRequestV1.from_json(json) -# print the JSON string representation of the object -print PatchPlugRequestV1.to_json() - -# convert the object into a dict -patch_plug_request_v1_dict = patch_plug_request_v1_instance.to_dict() -# create an instance of PatchPlugRequestV1 from a dict -patch_plug_request_v1_form_dict = patch_plug_request_v1.from_dict(patch_plug_request_v1_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PlugDeleteForceQuery.md b/docs/PlugDeleteForceQuery.md deleted file mode 100644 index 46b9622d..00000000 --- a/docs/PlugDeleteForceQuery.md +++ /dev/null @@ -1,29 +0,0 @@ -# PlugDeleteForceQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**force** | **bool** | If <code>true</code>, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be <code>deprecated</code>, i.e removed from regular listings. | [optional] - -## Example - -```python -from waylay.services.registry.models.plug_delete_force_query import PlugDeleteForceQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of PlugDeleteForceQuery from a JSON string -plug_delete_force_query_instance = PlugDeleteForceQuery.from_json(json) -# print the JSON string representation of the object -print PlugDeleteForceQuery.to_json() - -# convert the object into a dict -plug_delete_force_query_dict = plug_delete_force_query_instance.to_dict() -# create an instance of PlugDeleteForceQuery from a dict -plug_delete_force_query_form_dict = plug_delete_force_query.from_dict(plug_delete_force_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PlugDeleteQuery.md b/docs/PlugDeleteQuery.md deleted file mode 100644 index d7632aba..00000000 --- a/docs/PlugDeleteQuery.md +++ /dev/null @@ -1,30 +0,0 @@ -# PlugDeleteQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**force** | **bool** | If <code>true</code>, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be <code>deprecated</code>, i.e removed from regular listings. | [optional] -**undeploy** | **bool** | If `true`, the `DELETE` operation * undeploys the (openfaas) function for the plug: it becomes no longer available for invocation. * does NOT remove the plug from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the plug can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug version(s) as _deprecated_: the plug remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only. | [optional] - -## Example - -```python -from waylay.services.registry.models.plug_delete_query import PlugDeleteQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of PlugDeleteQuery from a JSON string -plug_delete_query_instance = PlugDeleteQuery.from_json(json) -# print the JSON string representation of the object -print PlugDeleteQuery.to_json() - -# convert the object into a dict -plug_delete_query_dict = plug_delete_query_instance.to_dict() -# create an instance of PlugDeleteQuery from a dict -plug_delete_query_form_dict = plug_delete_query.from_dict(plug_delete_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PlugListingAndQueryResponse.md b/docs/PlugListingAndQueryResponse.md deleted file mode 100644 index 8df27280..00000000 --- a/docs/PlugListingAndQueryResponse.md +++ /dev/null @@ -1,33 +0,0 @@ -# PlugListingAndQueryResponse - -Successful Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**count** | **float** | The total count of matching items, from which this result is one page. | [optional] -**limit** | **float** | The page size used for this query result. | [optional] -**page** | **float** | The page number of a paged query result. | [optional] -**plugs** | [**List[PlugResponse]**](PlugResponse.md) | | - -## Example - -```python -from waylay.services.registry.models.plug_listing_and_query_response import PlugListingAndQueryResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of PlugListingAndQueryResponse from a JSON string -plug_listing_and_query_response_instance = PlugListingAndQueryResponse.from_json(json) -# print the JSON string representation of the object -print PlugListingAndQueryResponse.to_json() - -# convert the object into a dict -plug_listing_and_query_response_dict = plug_listing_and_query_response_instance.to_dict() -# create an instance of PlugListingAndQueryResponse from a dict -plug_listing_and_query_response_form_dict = plug_listing_and_query_response.from_dict(plug_listing_and_query_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PlugListingResponse.md b/docs/PlugListingResponse.md deleted file mode 100644 index 77babf58..00000000 --- a/docs/PlugListingResponse.md +++ /dev/null @@ -1,30 +0,0 @@ -# PlugListingResponse - -Successful Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**plugs** | [**List[PlugResponse]**](PlugResponse.md) | | - -## Example - -```python -from waylay.services.registry.models.plug_listing_response import PlugListingResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of PlugListingResponse from a JSON string -plug_listing_response_instance = PlugListingResponse.from_json(json) -# print the JSON string representation of the object -print PlugListingResponse.to_json() - -# convert the object into a dict -plug_listing_response_dict = plug_listing_response_instance.to_dict() -# create an instance of PlugListingResponse from a dict -plug_listing_response_form_dict = plug_listing_response.from_dict(plug_listing_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PlugResponse.md b/docs/PlugResponse.md deleted file mode 100644 index 117b5068..00000000 --- a/docs/PlugResponse.md +++ /dev/null @@ -1,42 +0,0 @@ -# PlugResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deploy** | [**FunctionDeployOverridesType**](FunctionDeployOverridesType.md) | | [optional] -**name** | **str** | The logical name for the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**runtime** | **str** | | -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**metadata** | [**FunctionMeta**](FunctionMeta.md) | | -**created_by** | **str** | The user that created this entity. | -**created_at** | **datetime** | The timestamp at which this entity was created. | -**updated_by** | **str** | The user that last updated this entity. | -**updated_at** | **datetime** | The timestamp at which this entity was last updated. | -**status** | [**Status**](Status.md) | | -**failure_reason** | [**FailureReason**](FailureReason.md) | | [optional] -**links** | [**List[JobHALLinks]**](JobHALLinks.md) | Links to related entities. | [optional] -**is_deprecated** | **bool** | | - -## Example - -```python -from waylay.services.registry.models.plug_response import PlugResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of PlugResponse from a JSON string -plug_response_instance = PlugResponse.from_json(json) -# print the JSON string representation of the object -print PlugResponse.to_json() - -# convert the object into a dict -plug_response_dict = plug_response_instance.to_dict() -# create an instance of PlugResponse from a dict -plug_response_form_dict = plug_response.from_dict(plug_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PlugTypeQuery.md b/docs/PlugTypeQuery.md deleted file mode 100644 index f155cc53..00000000 --- a/docs/PlugTypeQuery.md +++ /dev/null @@ -1,29 +0,0 @@ -# PlugTypeQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**type** | [**PlugType**](PlugType.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.plug_type_query import PlugTypeQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of PlugTypeQuery from a JSON string -plug_type_query_instance = PlugTypeQuery.from_json(json) -# print the JSON string representation of the object -print PlugTypeQuery.to_json() - -# convert the object into a dict -plug_type_query_dict = plug_type_query_instance.to_dict() -# create an instance of PlugTypeQuery from a dict -plug_type_query_form_dict = plug_type_query.from_dict(plug_type_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/PlugFunctionsApi.md b/docs/PlugsApi.md similarity index 77% rename from docs/PlugFunctionsApi.md rename to docs/PlugsApi.md index a6d9dc22..e46c2555 100644 --- a/docs/PlugFunctionsApi.md +++ b/docs/PlugsApi.md @@ -1,27 +1,27 @@ -# waylay.services.registry.PlugFunctionsApi +# waylay.services.registry.PlugsApi All URIs are relative to *https://api.waylay.io* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**](PlugFunctionsApi.md#create) | **POST** /registry/v2/plugs/ | Create Plug -[**delete_asset**](PlugFunctionsApi.md#delete_asset) | **DELETE** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Delete Plug Asset -[**get_archive**](PlugFunctionsApi.md#get_archive) | **GET** /registry/v2/plugs/{name}/versions/{version}/content | Get Plug Archive -[**get_asset**](PlugFunctionsApi.md#get_asset) | **GET** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Get File From Plug Archive -[**get_latest**](PlugFunctionsApi.md#get_latest) | **GET** /registry/v2/plugs/{name} | Get Latest Plug Version -[**get**](PlugFunctionsApi.md#get) | **GET** /registry/v2/plugs/{name}/versions/{version} | Get Plug Version -[**jobs**](PlugFunctionsApi.md#jobs) | **GET** /registry/v2/plugs/{name}/versions/{version}/jobs | List Plug Jobs -[**list**](PlugFunctionsApi.md#list) | **GET** /registry/v2/plugs/ | List Plugs -[**list_versions**](PlugFunctionsApi.md#list_versions) | **GET** /registry/v2/plugs/{name}/versions | List Plug Versions -[**patch_interface**](PlugFunctionsApi.md#patch_interface) | **PATCH** /registry/v2/plugs/{name}/versions/{version}/interface | Patch Plug Interface -[**patch_metadata**](PlugFunctionsApi.md#patch_metadata) | **PATCH** /registry/v2/plugs/{name}/versions/{version}/metadata | Patch Plug Metadata -[**publish**](PlugFunctionsApi.md#publish) | **POST** /registry/v2/plugs/{name}/versions/{version}/publish | Publish Draft Plug -[**rebuild**](PlugFunctionsApi.md#rebuild) | **POST** /registry/v2/plugs/{name}/versions/{version}/rebuild | Rebuild Plug -[**remove_version**](PlugFunctionsApi.md#remove_version) | **DELETE** /registry/v2/plugs/{name}/versions/{version} | Remove Plug Version -[**remove_versions**](PlugFunctionsApi.md#remove_versions) | **DELETE** /registry/v2/plugs/{name} | Remove Plug -[**update_asset**](PlugFunctionsApi.md#update_asset) | **PUT** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Update Plug Asset -[**update_assets**](PlugFunctionsApi.md#update_assets) | **PUT** /registry/v2/plugs/{name}/versions/{version}/content | Update Plug Assets -[**verify**](PlugFunctionsApi.md#verify) | **POST** /registry/v2/plugs/{name}/versions/{version}/verify | Verify Health Of Plug +[**create**](PlugsApi.md#create) | **POST** /registry/v2/plugs/ | Create Plug +[**delete_asset**](PlugsApi.md#delete_asset) | **DELETE** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Delete Plug Asset +[**get_archive**](PlugsApi.md#get_archive) | **GET** /registry/v2/plugs/{name}/versions/{version}/content | Get Plug Archive +[**get_asset**](PlugsApi.md#get_asset) | **GET** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Get File From Plug Archive +[**get_latest**](PlugsApi.md#get_latest) | **GET** /registry/v2/plugs/{name} | Get Latest Plug Version +[**get**](PlugsApi.md#get) | **GET** /registry/v2/plugs/{name}/versions/{version} | Get Plug Version +[**jobs**](PlugsApi.md#jobs) | **GET** /registry/v2/plugs/{name}/versions/{version}/jobs | List Plug Jobs +[**list**](PlugsApi.md#list) | **GET** /registry/v2/plugs/ | List Plugs +[**list_versions**](PlugsApi.md#list_versions) | **GET** /registry/v2/plugs/{name}/versions | List Plug Versions +[**patch_interface**](PlugsApi.md#patch_interface) | **PATCH** /registry/v2/plugs/{name}/versions/{version}/interface | Patch Plug Interface +[**patch_metadata**](PlugsApi.md#patch_metadata) | **PATCH** /registry/v2/plugs/{name}/versions/{version}/metadata | Patch Plug Metadata +[**publish**](PlugsApi.md#publish) | **POST** /registry/v2/plugs/{name}/versions/{version}/publish | Publish Draft Plug +[**rebuild**](PlugsApi.md#rebuild) | **POST** /registry/v2/plugs/{name}/versions/{version}/rebuild | Rebuild Plug +[**remove_version**](PlugsApi.md#remove_version) | **DELETE** /registry/v2/plugs/{name}/versions/{version} | Remove Plug Version +[**remove_versions**](PlugsApi.md#remove_versions) | **DELETE** /registry/v2/plugs/{name} | Remove Plug +[**update_asset**](PlugsApi.md#update_asset) | **PUT** /registry/v2/plugs/{name}/versions/{version}/content/{wildcard} | Update Plug Asset +[**update_assets**](PlugsApi.md#update_assets) | **PUT** /registry/v2/plugs/{name}/versions/{version}/content | Update Plug Assets +[**verify**](PlugsApi.md#verify) | **POST** /registry/v2/plugs/{name}/versions/{version}/verify | Verify Health Of Plug # **create** > create( @@ -32,7 +32,7 @@ Method | HTTP request | Description Create Plug -Creates a new plug function by uploading its assets. The assets for a plug function can be provided as either The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. +Creates a new plug function by uploading its assets. The assets for a plug function can be provided as The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. ### Example @@ -48,32 +48,34 @@ waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed from waylay.services.registry.models.deprecate_previous_policy import DeprecatePreviousPolicy -from waylay.services.registry.models.multipart_file_upload import MultipartFileUpload from waylay.services.registry.models.post_plug_job_sync_response_v2 import PostPlugJobSyncResponseV2 try: # Create Plug # calls `POST /registry/v2/plugs/` - api_response = await waylay_client.registry.plug_functions.create( + api_response = await waylay_client.registry.plugs.create( # query parameters: query = { + 'deploy': True + 'scaleToZero': False 'deprecatePrevious': 'none' 'dryRun': True 'async': True - 'scaleToZero': False 'draft': False }, + # json data: use a generated model or a json-serializable python data structure (dict, list) + json = None # bytearray | The assets for a plug function can be provided as The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. (optional) # non-json binary data: use a byte array or a generator of bytearray chuncks content=b'my-binary-data', # this operation supports multiple request content types: use `headers` to specify the one used - # alternatives: 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', + # alternatives: 'application/tar', 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', 'application/json', '*/*+json', headers = { 'content-type': 'application/octet-stream' }, ) - print("The response of registry.plug_functions.create:\n") + print("The response of registry.plugs.create:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.create: %s\n" % e) + print("Exception when calling registry.plugs.create: %s\n" % e) ``` ### Endpoint @@ -84,18 +86,24 @@ POST /registry/v2/plugs/ Name | Type | API binding | Description | Notes -------- | ----- | ------------- | ------------- | ------------- -**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>plug</em> function can be provided as either <ul> <li>a single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>separate files in a <code>multipart/form-data</code> request</li> </ul> The required <code>plug.json</code> json file contains the function metadata, and must have a <code>runtime</code> attribute that is one of the supported <em>runtime</em>s (see <code>GET /registry/v2/runtimes?functionType=plugs</code>). For each <em>runtime</em> other files will be required or supported. | [optional] +**json** | **bytearray** | json request body | The assets for a <em>plug</em> function can be provided as <ul> <li>A single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>Separate files in a <code>multipart/form-data</code> request</li> <li>A reference to the assets of another <em>plug</em> in the <code>copy</code> argument</li> </ul> The required <code>plug.json</code> json file contains the function metadata, and must have a <code>runtime</code> attribute that is one of the supported <em>runtime</em>s (see <code>GET /registry/v2/runtimes?functionType=plugs</code>). For each <em>runtime</em> other files will be required or supported. | [optional] +**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>plug</em> function can be provided as <ul> <li>A single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>Separate files in a <code>multipart/form-data</code> request</li> <li>A reference to the assets of another <em>plug</em> in the <code>copy</code> argument</li> </ul> The required <code>plug.json</code> json file contains the function metadata, and must have a <code>runtime</code> attribute that is one of the supported <em>runtime</em>s (see <code>GET /registry/v2/runtimes?functionType=plugs</code>). For each <em>runtime</em> other files will be required or supported. | [optional] **files** | **[FileTypes](Operation.md#req_arg_files)** | request body files | | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] +**query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] **query['deprecatePrevious']** (dict)
**query.deprecate_previous** (Query) | [**DeprecatePreviousPolicy**](.md) | query parameter `"deprecatePrevious"` | Set the cleanup policy used to automatically deprecate/delete previous versions. | [optional] **query['dryRun']** (dict)
**query.dry_run** (Query) | **bool** | query parameter `"dryRun"` | If set to <code>true</code>, validates the deployment conditions, but does not change anything. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately. | [optional] [default False] **query['version']** (dict)
**query.version** (Query) | [**SemanticVersionRange**](.md) | query parameter `"version"` | If set, the function version will be an increment of the latest existing version that satisfies the `version` range. Note that this increment always takes precedence over an explicit `version` in the function manifest. | [optional] **query['name']** (dict)
**query.name** (Query) | **str** | query parameter `"name"` | If set, the value will be used as the function name instead of the one specified in the manifest. | [optional] **query['draft']** (dict)
**query.draft** (Query) | **bool** | query parameter `"draft"` | If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. | [optional] [default False] +**query['runtime']** (dict)
**query.runtime** (Query) | **str** | query parameter `"runtime"` | If set, the created function will use the indicated runtime (latest version within specified range). This takes precedence over the runtime specified in a function manifest (copied or from request body). | [optional] +**query['copy']** (dict)
**query.copy_from** (Query) | [**CreateWebscriptsCopyParameter**](.md) | query parameter `"copy"` | Indicates the _source_ of initial assets for a _new function_. When using this query parameter, the request body does not need to contain assets, but any assets in the request body will overwrite the copied assets. #### Selection of _assets_ source * If set as `<sourceName>[@<sourceVersionRange>]`, the _new function_ will be created with copied assets of the selected _source function_. * If set as `!example`, a `runtime` query parameter is required, and the _new function_ will be initialized with assets of the _runtime example_. #### Selection of the _source function_ When `<sourceVersionRange>` is a range (or is not given), the latest _published_ version (in that range) is used. If no _published_ version exists, the latest _draft_ is selected. If no versions in the range exist, a `404` _Not Found_ error is returned. #### The `name` of the _new function_ If a `name` is NOT specified (either as query parameter, or in an optional manifest asset in the request body), the `name` of the _new function_ will be that of the _source function_. #### The `version` of the _new function_ When the _target_ and _source_ name are equal, the `version` query parameters is defaulted to `<sourceVersionRange>` (`~<sourceVersionRange>` when it's an exact version) The version of the _new function_ will be: * If a `version` is NOT specified (either as query parameter, in an optional manifest asset, or as `<sourceVersionRange>` _default_) * a **patch increment** (`<major>.<minor>.<patch>+1`) of the latest **existing version** with the target `name` * **`1.0.0`** otherwise * If a `version` is specified: * the **lowest version** in that range **if no existing version** is in that range. * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. #### Deployment overrides The new function will use the deployment overrides of the copied function, unless a _manifest_ was specified in the request body. | [optional] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | -**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data` +**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data`, `application/json`, `*/*+json` ### Return type @@ -107,7 +115,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - - **Content-Type**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data + - **Content-Type**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data, application/json, */*+json - **Accept**: application/json ### HTTP response details @@ -149,20 +157,22 @@ from waylay.services.registry.models.post_plug_job_sync_response_v2 import PostP try: # Delete Plug Asset # calls `DELETE /registry/v2/plugs/{name}/versions/{version}/content/{wildcard}` - api_response = await waylay_client.registry.plug_functions.delete_asset( + api_response = await waylay_client.registry.plugs.delete_asset( 'name_example', # name | path param "name" 'version_example', # version | path param "version" 'wildcard_example', # wildcard | path param "wildcard" # query parameters: query = { - 'async': True + 'scaleToZero': False + 'deploy': True 'chown': False + 'async': True }, ) - print("The response of registry.plug_functions.delete_asset:\n") + print("The response of registry.plugs.delete_asset:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.delete_asset: %s\n" % e) + print("Exception when calling registry.plugs.delete_asset: %s\n" % e) ``` ### Endpoint @@ -177,9 +187,12 @@ Name | Type | API binding | Description | Notes **version** | **str** | path parameter `"version"` | The version of the function. | **wildcard** | **str** | path parameter `"wildcard"` | Full path or path prefix of the asset within the archive | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [default False] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | ### Return type @@ -201,6 +214,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected |-------------|-------------|------------------| **201** | Default Response | - | **202** | Default Response | - | +**403** | Default Response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -232,7 +246,7 @@ waylay_client = WaylayClient.from_profile() try: # Get Plug Archive # calls `GET /registry/v2/plugs/{name}/versions/{version}/content` - api_response = await waylay_client.registry.plug_functions.get_archive( + api_response = await waylay_client.registry.plugs.get_archive( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: @@ -240,10 +254,10 @@ try: 'ls': False }, ) - print("The response of registry.plug_functions.get_archive:\n") + print("The response of registry.plugs.get_archive:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.get_archive: %s\n" % e) + print("Exception when calling registry.plugs.get_archive: %s\n" % e) ``` ### Endpoint @@ -271,7 +285,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json + - **Accept**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json ### HTTP response details @@ -310,7 +324,7 @@ waylay_client = WaylayClient.from_profile() try: # Get File From Plug Archive # calls `GET /registry/v2/plugs/{name}/versions/{version}/content/{wildcard}` - api_response = await waylay_client.registry.plug_functions.get_asset( + api_response = await waylay_client.registry.plugs.get_asset( 'name_example', # name | path param "name" 'version_example', # version | path param "version" 'wildcard_example', # wildcard | path param "wildcard" @@ -319,10 +333,10 @@ try: 'ls': False }, ) - print("The response of registry.plug_functions.get_asset:\n") + print("The response of registry.plugs.get_asset:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.get_asset: %s\n" % e) + print("Exception when calling registry.plugs.get_asset: %s\n" % e) ``` ### Endpoint @@ -351,7 +365,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json + - **Accept**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json ### HTTP response details @@ -390,7 +404,7 @@ from waylay.services.registry.models.plug_type import PlugType try: # Get Latest Plug Version # calls `GET /registry/v2/plugs/{name}` - api_response = await waylay_client.registry.plug_functions.get_latest( + api_response = await waylay_client.registry.plugs.get_latest( 'name_example', # name | path param "name" # query parameters: query = { @@ -399,10 +413,10 @@ try: 'includeDeprecated': True }, ) - print("The response of registry.plug_functions.get_latest:\n") + print("The response of registry.plugs.get_latest:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.get_latest: %s\n" % e) + print("Exception when calling registry.plugs.get_latest: %s\n" % e) ``` ### Endpoint @@ -469,14 +483,14 @@ from waylay.services.registry.models.get_plug_response_v2 import GetPlugResponse try: # Get Plug Version # calls `GET /registry/v2/plugs/{name}/versions/{version}` - api_response = await waylay_client.registry.plug_functions.get( + api_response = await waylay_client.registry.plugs.get( 'name_example', # name | path param "name" 'version_example', # version | path param "version" ) - print("The response of registry.plug_functions.get:\n") + print("The response of registry.plugs.get:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.get: %s\n" % e) + print("Exception when calling registry.plugs.get: %s\n" % e) ``` ### Endpoint @@ -544,17 +558,17 @@ from waylay.services.registry.models.jobs_for_plug_response_v2 import JobsForPlu try: # List Plug Jobs # calls `GET /registry/v2/plugs/{name}/versions/{version}/jobs` - api_response = await waylay_client.registry.plug_functions.jobs( + api_response = await waylay_client.registry.plugs.jobs( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { }, ) - print("The response of registry.plug_functions.jobs:\n") + print("The response of registry.plugs.jobs:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.jobs: %s\n" % e) + print("Exception when calling registry.plugs.jobs: %s\n" % e) ``` ### Endpoint @@ -605,7 +619,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected List Plugs -List the (latest) versions of available plugs. ### List Latest Plug Versions By default, the result includes the latest non-deprecated, non-draft version for each plug name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour: As long as no _version filters_ are used, each listed plug version item will contain a HAL **link to the latest** _draft_ (`entities[]._links.draft`) or latest _published_ (`entities[]._links.publisned`) version (if existing and different). ### List Latest Plug Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named plug that satisfy the filters, but **without links**. ### List All Plug Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ plugs versions that satisfy the query, possibly multiple versions per named plugs. No HAL links are provided. #### Filter on _status_ By default plug versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the plug listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft`, `tags` +List the (latest) versions of available plugs. ### List Latest Plug Versions By default, the result includes the latest non-deprecated, non-draft version for each plug name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour: As long as no version filters are used, each listed plug version contains representations of the latest draft (`entities[]._links.draft`) or latest published (`entities[]._links.published`) version (if existing and different). Use the query parameter `showRelated` to include only a link (default `showRelated=link`) or a full representation (`showRelated=embed`). ### List Latest Plug Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named plug that satisfy the filters, but **without links**. ### List All Plug Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ plugs versions that satisfy the query, possibly multiple versions per named plugs. No HAL links are provided. #### Filter on _status_ By default plug versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the plug listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft`, `tags` ### Example @@ -623,11 +637,12 @@ waylay_client = WaylayClient.from_profile() from waylay.services.registry.models.archive_format import ArchiveFormat from waylay.services.registry.models.latest_plugs_response_v2 import LatestPlugsResponseV2 from waylay.services.registry.models.plug_type import PlugType +from waylay.services.registry.models.show_related_type import ShowRelatedType from waylay.services.registry.models.status_filter import StatusFilter try: # List Plugs # calls `GET /registry/v2/plugs/` - api_response = await waylay_client.registry.plug_functions.list( + api_response = await waylay_client.registry.plugs.list( # query parameters: query = { 'type': 'sensor' @@ -638,12 +653,13 @@ try: 'createdBy': '@me' 'updatedBy': '@me' 'latest': True + 'showRelated': 'embed' }, ) - print("The response of registry.plug_functions.list:\n") + print("The response of registry.plugs.list:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.list: %s\n" % e) + print("Exception when calling registry.plugs.list: %s\n" % e) ``` ### Endpoint @@ -677,6 +693,7 @@ Name | Type | API binding | Description | Notes **query['archiveFormat']** (dict)
**query.archive_format** (Query) | [**List[ArchiveFormat]**](ArchiveFormat.md) | query parameter `"archiveFormat"` | Filter on the archive format of the function. | [optional] **query['runtime']** (dict)
**query.runtime** (Query) | [**List[str]**](str.md) | query parameter `"runtime"` | Filter on the runtime of the function. | [optional] **query['latest']** (dict)
**query.latest** (Query) | **bool** | query parameter `"latest"` | When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. | [optional] +**query['showRelated']** (dict)
**query.show_related** (Query) | [**ShowRelatedType**](.md) | query parameter `"showRelated"` | Sets the representation of related function versions (like the _latest_ draft and/or published) in the response. - `embed`: as full summary representation (in `_embedded`). - `link`: as HAL link in (in `_links`). - `none`: omitted. | [optional] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | ### Return type @@ -730,7 +747,7 @@ from waylay.services.registry.models.status_filter import StatusFilter try: # List Plug Versions # calls `GET /registry/v2/plugs/{name}/versions` - api_response = await waylay_client.registry.plug_functions.list_versions( + api_response = await waylay_client.registry.plugs.list_versions( 'name_example', # name | path param "name" # query parameters: query = { @@ -740,10 +757,10 @@ try: 'updatedBy': '@me' }, ) - print("The response of registry.plug_functions.list_versions:\n") + print("The response of registry.plugs.list_versions:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.list_versions: %s\n" % e) + print("Exception when calling registry.plugs.list_versions: %s\n" % e) ``` ### Endpoint @@ -825,7 +842,7 @@ from waylay.services.registry.models.get_plug_response_v2 import GetPlugResponse try: # Patch Plug Interface # calls `PATCH /registry/v2/plugs/{name}/versions/{version}/interface` - api_response = await waylay_client.registry.plug_functions.patch_interface( + api_response = await waylay_client.registry.plugs.patch_interface( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: @@ -834,10 +851,10 @@ try: # json data: use a generated model or a json-serializable python data structure (dict, list) json = waylay.services.registry.Documentation() # Documentation | (optional) ) - print("The response of registry.plug_functions.patch_interface:\n") + print("The response of registry.plugs.patch_interface:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.patch_interface: %s\n" % e) + print("Exception when calling registry.plugs.patch_interface: %s\n" % e) ``` ### Endpoint @@ -906,7 +923,7 @@ from waylay.services.registry.models.update_metadata_request_v2 import UpdateMet try: # Patch Plug Metadata # calls `PATCH /registry/v2/plugs/{name}/versions/{version}/metadata` - api_response = await waylay_client.registry.plug_functions.patch_metadata( + api_response = await waylay_client.registry.plugs.patch_metadata( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: @@ -915,10 +932,10 @@ try: # json data: use a generated model or a json-serializable python data structure (dict, list) json = waylay.services.registry.UpdateMetadataRequestV2() # UpdateMetadataRequestV2 | (optional) ) - print("The response of registry.plug_functions.patch_metadata:\n") + print("The response of registry.plugs.patch_metadata:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.patch_metadata: %s\n" % e) + print("Exception when calling registry.plugs.patch_metadata: %s\n" % e) ``` ### Endpoint @@ -987,19 +1004,20 @@ from waylay.services.registry.models.post_plug_job_sync_response_v2 import PostP try: # Publish Draft Plug # calls `POST /registry/v2/plugs/{name}/versions/{version}/publish` - api_response = await waylay_client.registry.plug_functions.publish( + api_response = await waylay_client.registry.plugs.publish( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { + 'chown': False 'deprecatePrevious': 'none' 'async': True }, ) - print("The response of registry.plug_functions.publish:\n") + print("The response of registry.plugs.publish:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.publish: %s\n" % e) + print("Exception when calling registry.plugs.publish: %s\n" % e) ``` ### Endpoint @@ -1013,7 +1031,9 @@ Name | Type | API binding | Description | Notes **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['deprecatePrevious']** (dict)
**query.deprecate_previous** (Query) | [**DeprecatePreviousPolicy**](.md) | query parameter `"deprecatePrevious"` | Set the cleanup policy used to automatically deprecate/delete previous versions. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | @@ -1070,23 +1090,23 @@ from waylay.services.registry.models.rebuild_policy import RebuildPolicy try: # Rebuild Plug # calls `POST /registry/v2/plugs/{name}/versions/{version}/rebuild` - api_response = await waylay_client.registry.plug_functions.rebuild( + api_response = await waylay_client.registry.plugs.rebuild( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { + 'scaleToZero': True 'dryRun': True 'async': True 'upgrade': 'patch' 'ignoreChecks': True - 'scaleToZero': True 'skipRebuild': True }, ) - print("The response of registry.plug_functions.rebuild:\n") + print("The response of registry.plugs.rebuild:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.rebuild: %s\n" % e) + print("Exception when calling registry.plugs.rebuild: %s\n" % e) ``` ### Endpoint @@ -1100,13 +1120,13 @@ Name | Type | API binding | Description | Notes **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. | [optional] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] **query['dryRun']** (dict)
**query.dry_run** (Query) | **bool** | query parameter `"dryRun"` | If set to <code>true</code>, checks whether rebuild jobs are needed, but do not start any jobs. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **query['upgrade']** (dict)
**query.upgrade** (Query) | [**RebuildPolicy**](.md) | query parameter `"upgrade"` | If set, force a rebuild with the given <em>runtime</em> version selection policy. <ul> <li><code>same</code> <b>patch</b> version. This should only include backward compatible upgrades. </li> <li><code>minor</code> <b>major</b> version. This might include an upgrade of e.g. the language runtime and/or provided dependencies that could break compatiblity with the function. .</li> </ul> | [optional] **query['forceVersion']** (dict)
**query.force_version** (Query) | **str** | query parameter `"forceVersion"` | If set, force a rebuild with the given runtime version (including downgrades). This parameter is mutually exclusive to the `upgrade` parameter. | [optional] **query['ignoreChecks']** (dict)
**query.ignore_checks** (Query) | **bool** | query parameter `"ignoreChecks"` | If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option | [optional] -**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command. | [optional] **query['skipRebuild']** (dict)
**query.skip_rebuild** (Query) | **bool** | query parameter `"skipRebuild"` | If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function. | [optional] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | @@ -1161,7 +1181,7 @@ from waylay.services.registry.models.undeployed_response_v2 import UndeployedRes try: # Remove Plug Version # calls `DELETE /registry/v2/plugs/{name}/versions/{version}` - api_response = await waylay_client.registry.plug_functions.remove_version( + api_response = await waylay_client.registry.plugs.remove_version( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: @@ -1171,10 +1191,10 @@ try: 'undeploy': True }, ) - print("The response of registry.plug_functions.remove_version:\n") + print("The response of registry.plugs.remove_version:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.remove_version: %s\n" % e) + print("Exception when calling registry.plugs.remove_version: %s\n" % e) ``` ### Endpoint @@ -1244,7 +1264,7 @@ from waylay.services.registry.models.undeployed_response_v2 import UndeployedRes try: # Remove Plug # calls `DELETE /registry/v2/plugs/{name}` - api_response = await waylay_client.registry.plug_functions.remove_versions( + api_response = await waylay_client.registry.plugs.remove_versions( 'name_example', # name | path param "name" # query parameters: query = { @@ -1253,10 +1273,10 @@ try: 'undeploy': True }, ) - print("The response of registry.plug_functions.remove_versions:\n") + print("The response of registry.plugs.remove_versions:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.remove_versions: %s\n" % e) + print("Exception when calling registry.plugs.remove_versions: %s\n" % e) ``` ### Endpoint @@ -1328,14 +1348,16 @@ from waylay.services.registry.models.post_plug_job_sync_response_v2 import PostP try: # Update Plug Asset # calls `PUT /registry/v2/plugs/{name}/versions/{version}/content/{wildcard}` - api_response = await waylay_client.registry.plug_functions.update_asset( + api_response = await waylay_client.registry.plugs.update_asset( 'name_example', # name | path param "name" 'version_example', # version | path param "version" 'wildcard_example', # wildcard | path param "wildcard" # query parameters: query = { - 'async': True + 'scaleToZero': False + 'deploy': True 'chown': False + 'async': True }, # non-json binary data: use a byte array or a generator of bytearray chuncks content=b'my-binary-data', @@ -1345,10 +1367,10 @@ try: 'content-type': 'application/octet-stream' }, ) - print("The response of registry.plug_functions.update_asset:\n") + print("The response of registry.plugs.update_asset:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.update_asset: %s\n" % e) + print("Exception when calling registry.plugs.update_asset: %s\n" % e) ``` ### Endpoint @@ -1364,11 +1386,14 @@ Name | Type | API binding | Description | Notes **wildcard** | **str** | path parameter `"wildcard"` | Full path or path prefix of the asset within the archive | **content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | A single asset file. | [optional] **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [default False] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | -**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream` +**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType ### Return type @@ -1380,7 +1405,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - - **Content-Type**: application/octet-stream + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -1389,6 +1414,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected |-------------|-------------|------------------| **201** | Default Response | - | **202** | Default Response | - | +**403** | Default Response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -1403,7 +1429,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected Update Plug Assets -Update a draft plug function by updating its assets. The assets for a plug function can be provided as either The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. +Update a draft plug function by updating its assets. The assets for a plug function can be provided as either The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. ### Example @@ -1418,31 +1444,32 @@ from waylay.sdk.api.api_exceptions import ApiError waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed -from waylay.services.registry.models.multipart_file_upload import MultipartFileUpload from waylay.services.registry.models.post_plug_job_sync_response_v2 import PostPlugJobSyncResponseV2 try: # Update Plug Assets # calls `PUT /registry/v2/plugs/{name}/versions/{version}/content` - api_response = await waylay_client.registry.plug_functions.update_assets( + api_response = await waylay_client.registry.plugs.update_assets( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { - 'async': True + 'scaleToZero': False + 'deploy': True 'chown': False + 'async': True }, # non-json binary data: use a byte array or a generator of bytearray chuncks content=b'my-binary-data', # this operation supports multiple request content types: use `headers` to specify the one used - # alternatives: 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', + # alternatives: 'application/tar', 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', headers = { 'content-type': 'application/octet-stream' }, ) - print("The response of registry.plug_functions.update_assets:\n") + print("The response of registry.plugs.update_assets:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.update_assets: %s\n" % e) + print("Exception when calling registry.plugs.update_assets: %s\n" % e) ``` ### Endpoint @@ -1455,14 +1482,17 @@ Name | Type | API binding | Description | Notes -------- | ----- | ------------- | ------------- | ------------- **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | -**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>plug</em> function can be provided as either <ul> <li>a single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>separate files in a <code>multipart/form-data</code> request</li> </ul> The provided assets will be added to the <em>plug</em> function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json</code> json file with a changed value for any of the <code>name</code>, <code>version</code> and/or <code>runtime</code> attributes. For each <em>runtime</em> other files are supported. | [optional] +**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>plug</em> function can be provided as either <ul> <li>a single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>separate files in a <code>multipart/form-data</code> request</li> </ul> The provided assets will be added to the <em>plug</em> function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json</code> json file with a changed value for any of the <code>name</code>, <code>version</code> and/or <code>runtime</code> attributes. For each <em>runtime</em> other files are supported. | [optional] **files** | **[FileTypes](Operation.md#req_arg_files)** | request body files | | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [default False] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | -**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data` +**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data` ### Return type @@ -1474,7 +1504,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - - **Content-Type**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data + - **Content-Type**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data - **Accept**: application/json ### HTTP response details @@ -1483,6 +1513,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected |-------------|-------------|------------------| **201** | Default Response | - | **202** | Default Response | - | +**403** | Default Response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -1515,19 +1546,19 @@ from waylay.services.registry.models.verify_plug_sync_response_v2 import VerifyP try: # Verify Health Of Plug # calls `POST /registry/v2/plugs/{name}/versions/{version}/verify` - api_response = await waylay_client.registry.plug_functions.verify( + api_response = await waylay_client.registry.plugs.verify( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { - 'async': True 'scaleToZero': True + 'async': True }, ) - print("The response of registry.plug_functions.verify:\n") + print("The response of registry.plugs.verify:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.plug_functions.verify: %s\n" % e) + print("Exception when calling registry.plugs.verify: %s\n" % e) ``` ### Endpoint @@ -1541,9 +1572,8 @@ Name | Type | API binding | Description | Notes **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | -**query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] -**query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. | [optional] +**query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | ### Return type diff --git a/docs/PublishFunctionQuery.md b/docs/PublishFunctionQuery.md deleted file mode 100644 index ee061366..00000000 --- a/docs/PublishFunctionQuery.md +++ /dev/null @@ -1,31 +0,0 @@ -# PublishFunctionQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comment** | **str** | An optional user-specified comment corresponding to the operation. | [optional] -**deprecate_previous** | [**DeprecatePreviousPolicy**](DeprecatePreviousPolicy.md) | | [optional] -**var_async** | **bool** | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to True] - -## Example - -```python -from waylay.services.registry.models.publish_function_query import PublishFunctionQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of PublishFunctionQuery from a JSON string -publish_function_query_instance = PublishFunctionQuery.from_json(json) -# print the JSON string representation of the object -print PublishFunctionQuery.to_json() - -# convert the object into a dict -publish_function_query_dict = publish_function_query_instance.to_dict() -# create an instance of PublishFunctionQuery from a dict -publish_function_query_form_dict = publish_function_query.from_dict(publish_function_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RebuildComputedResponse.md b/docs/RebuildComputedResponse.md deleted file mode 100644 index 576f7af0..00000000 --- a/docs/RebuildComputedResponse.md +++ /dev/null @@ -1,31 +0,0 @@ -# RebuildComputedResponse - -Rebuild Ignored - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | -**causes** | [**JobCauses**](JobCauses.md) | | - -## Example - -```python -from waylay.services.registry.models.rebuild_computed_response import RebuildComputedResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of RebuildComputedResponse from a JSON string -rebuild_computed_response_instance = RebuildComputedResponse.from_json(json) -# print the JSON string representation of the object -print RebuildComputedResponse.to_json() - -# convert the object into a dict -rebuild_computed_response_dict = rebuild_computed_response_instance.to_dict() -# create an instance of RebuildComputedResponse from a dict -rebuild_computed_response_form_dict = rebuild_computed_response.from_dict(rebuild_computed_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RebuildQueryParams.md b/docs/RebuildQueryParams.md deleted file mode 100644 index aec2fd1e..00000000 --- a/docs/RebuildQueryParams.md +++ /dev/null @@ -1,34 +0,0 @@ -# RebuildQueryParams - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**upgrade** | [**RebuildPolicy**](RebuildPolicy.md) | | [optional] -**dry_run** | **bool** | If set to <code>true</code>, checks whether rebuild jobs are needed, but do not start any jobs. | [optional] -**force_version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | [optional] -**ignore_checks** | **bool** | If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option | [optional] -**scale_to_zero** | **bool** | Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command. | [optional] -**skip_rebuild** | **bool** | If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.rebuild_query_params import RebuildQueryParams - -# TODO update the JSON string below -json = "{}" -# create an instance of RebuildQueryParams from a JSON string -rebuild_query_params_instance = RebuildQueryParams.from_json(json) -# print the JSON string representation of the object -print RebuildQueryParams.to_json() - -# convert the object into a dict -rebuild_query_params_dict = rebuild_query_params_instance.to_dict() -# create an instance of RebuildQueryParams from a dict -rebuild_query_params_form_dict = rebuild_query_params.from_dict(rebuild_query_params_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RebuildQueryV2.md b/docs/RebuildQueryV2.md deleted file mode 100644 index aca9b403..00000000 --- a/docs/RebuildQueryV2.md +++ /dev/null @@ -1,36 +0,0 @@ -# RebuildQueryV2 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comment** | **str** | An optional user-specified comment corresponding to the operation. | [optional] -**dry_run** | **bool** | If set to <code>true</code>, checks whether rebuild jobs are needed, but do not start any jobs. | [optional] -**var_async** | **bool** | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to True] -**upgrade** | [**RebuildPolicy**](RebuildPolicy.md) | | [optional] -**force_version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | [optional] -**ignore_checks** | **bool** | If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option | [optional] -**scale_to_zero** | **bool** | Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command. | [optional] -**skip_rebuild** | **bool** | If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.rebuild_query_v2 import RebuildQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of RebuildQueryV2 from a JSON string -rebuild_query_v2_instance = RebuildQueryV2.from_json(json) -# print the JSON string representation of the object -print RebuildQueryV2.to_json() - -# convert the object into a dict -rebuild_query_v2_dict = rebuild_query_v2_instance.to_dict() -# create an instance of RebuildQueryV2 from a dict -rebuild_query_v2_form_dict = rebuild_query_v2.from_dict(rebuild_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RebuildSubmittedResponse.md b/docs/RebuildSubmittedResponse.md deleted file mode 100644 index 971a54fc..00000000 --- a/docs/RebuildSubmittedResponse.md +++ /dev/null @@ -1,32 +0,0 @@ -# RebuildSubmittedResponse - -Rebuild Initiated - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**message** | **str** | | -**links** | [**JobHALLinks**](JobHALLinks.md) | | -**causes** | [**JobCauses**](JobCauses.md) | | - -## Example - -```python -from waylay.services.registry.models.rebuild_submitted_response import RebuildSubmittedResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of RebuildSubmittedResponse from a JSON string -rebuild_submitted_response_instance = RebuildSubmittedResponse.from_json(json) -# print the JSON string representation of the object -print RebuildSubmittedResponse.to_json() - -# convert the object into a dict -rebuild_submitted_response_dict = rebuild_submitted_response_instance.to_dict() -# create an instance of RebuildSubmittedResponse from a dict -rebuild_submitted_response_form_dict = rebuild_submitted_response.from_dict(rebuild_submitted_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RegistryErrorResponse.md b/docs/RegistryErrorResponse.md new file mode 100644 index 00000000..d397fb23 --- /dev/null +++ b/docs/RegistryErrorResponse.md @@ -0,0 +1,32 @@ +# RegistryErrorResponse + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**error** | **str** | | +**code** | **str** | | +**status_code** | **float** | | +**data** | **Dict[str, str]** | | [optional] + +## Example + +```python +from waylay.services.registry.models.registry_error_response import RegistryErrorResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of RegistryErrorResponse from a JSON string +registry_error_response_instance = RegistryErrorResponse.from_json(json) +# print the JSON string representation of the object +print RegistryErrorResponse.to_json() + +# convert the object into a dict +registry_error_response_dict = registry_error_response_instance.to_dict() +# create an instance of RegistryErrorResponse from a dict +registry_error_response_form_dict = registry_error_response.from_dict(registry_error_response_dict) +``` +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/RemoveFunctionQueryV2.md b/docs/RemoveFunctionQueryV2.md deleted file mode 100644 index bfb33c3c..00000000 --- a/docs/RemoveFunctionQueryV2.md +++ /dev/null @@ -1,32 +0,0 @@ -# RemoveFunctionQueryV2 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comment** | **str** | An optional user-specified comment corresponding to the operation. | [optional] -**var_async** | **bool** | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to True] -**force** | **bool** | If <code>true</code>, the function version will be immediately undeployed and removed. Otherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_. | [optional] -**undeploy** | **bool** | If `true`, the `DELETE` operation * undeploys the (openfaas) function: it becomes no longer available for invocation. * does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only. | [optional] - -## Example - -```python -from waylay.services.registry.models.remove_function_query_v2 import RemoveFunctionQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of RemoveFunctionQueryV2 from a JSON string -remove_function_query_v2_instance = RemoveFunctionQueryV2.from_json(json) -# print the JSON string representation of the object -print RemoveFunctionQueryV2.to_json() - -# convert the object into a dict -remove_function_query_v2_dict = remove_function_query_v2_instance.to_dict() -# create an instance of RemoveFunctionQueryV2 from a dict -remove_function_query_v2_form_dict = remove_function_query_v2.from_dict(remove_function_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RemovePlugQueryV2.md b/docs/RemovePlugQueryV2.md deleted file mode 100644 index c2cf685d..00000000 --- a/docs/RemovePlugQueryV2.md +++ /dev/null @@ -1,32 +0,0 @@ -# RemovePlugQueryV2 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comment** | **str** | An optional user-specified comment corresponding to the operation. | [optional] -**var_async** | **bool** | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to True] -**force** | **bool** | If <code>true</code>, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be <code>deprecated</code>, i.e removed from regular listings. | [optional] -**undeploy** | **bool** | If `true`, the `DELETE` operation * undeploys the (openfaas) function for the plug: it becomes no longer available for invocation. * does NOT remove the plug from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the plug can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug version(s) as _deprecated_: the plug remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only. | [optional] - -## Example - -```python -from waylay.services.registry.models.remove_plug_query_v2 import RemovePlugQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of RemovePlugQueryV2 from a JSON string -remove_plug_query_v2_instance = RemovePlugQueryV2.from_json(json) -# print the JSON string representation of the object -print RemovePlugQueryV2.to_json() - -# convert the object into a dict -remove_plug_query_v2_dict = remove_plug_query_v2_instance.to_dict() -# create an instance of RemovePlugQueryV2 from a dict -remove_plug_query_v2_form_dict = remove_plug_query_v2.from_dict(remove_plug_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeInfo.md b/docs/RuntimeInfo.md deleted file mode 100644 index 20ca29bc..00000000 --- a/docs/RuntimeInfo.md +++ /dev/null @@ -1,32 +0,0 @@ -# RuntimeInfo - -Runtime attributes that are the same for all versions of a runtime. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**function_type** | [**FunctionType**](FunctionType.md) | | -**archive_format** | [**ArchiveFormat**](ArchiveFormat.md) | | - -## Example - -```python -from waylay.services.registry.models.runtime_info import RuntimeInfo - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeInfo from a JSON string -runtime_info_instance = RuntimeInfo.from_json(json) -# print the JSON string representation of the object -print RuntimeInfo.to_json() - -# convert the object into a dict -runtime_info_dict = runtime_info_instance.to_dict() -# create an instance of RuntimeInfo from a dict -runtime_info_form_dict = runtime_info.from_dict(runtime_info_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeNameQuery.md b/docs/RuntimeNameQuery.md deleted file mode 100644 index 020557ce..00000000 --- a/docs/RuntimeNameQuery.md +++ /dev/null @@ -1,31 +0,0 @@ -# RuntimeNameQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | If set, filters on the <code>name</code> of a runtime. Supports <code>*</code> and <code>?</code> wildcards and is case-insensitive. | [optional] -**function_type** | [**List[FunctionType]**](FunctionType.md) | If set, filters on the <code>functionType</code> of a runtime. Uses an exact match. | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | If set, filters on the <code>archiveFormat</code> of a runtime. Uses an exact match. | [optional] - -## Example - -```python -from waylay.services.registry.models.runtime_name_query import RuntimeNameQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeNameQuery from a JSON string -runtime_name_query_instance = RuntimeNameQuery.from_json(json) -# print the JSON string representation of the object -print RuntimeNameQuery.to_json() - -# convert the object into a dict -runtime_name_query_dict = runtime_name_query_instance.to_dict() -# create an instance of RuntimeNameQuery from a dict -runtime_name_query_form_dict = runtime_name_query.from_dict(runtime_name_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeParams.md b/docs/RuntimeParams.md deleted file mode 100644 index 8977e9f2..00000000 --- a/docs/RuntimeParams.md +++ /dev/null @@ -1,29 +0,0 @@ -# RuntimeParams - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | - -## Example - -```python -from waylay.services.registry.models.runtime_params import RuntimeParams - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeParams from a JSON string -runtime_params_instance = RuntimeParams.from_json(json) -# print the JSON string representation of the object -print RuntimeParams.to_json() - -# convert the object into a dict -runtime_params_dict = runtime_params_instance.to_dict() -# create an instance of RuntimeParams from a dict -runtime_params_form_dict = runtime_params.from_dict(runtime_params_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeQuery.md b/docs/RuntimeQuery.md deleted file mode 100644 index 3178b1d5..00000000 --- a/docs/RuntimeQuery.md +++ /dev/null @@ -1,34 +0,0 @@ -# RuntimeQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**latest** | [**LatestVersionLevel**](LatestVersionLevel.md) | | [optional] -**include_deprecated** | **bool** | If set to `true`, deprecated runtimes will be included in the query. | [optional] [default to False] -**name** | **str** | If set, filters on the <code>name</code> of a runtime. Supports <code>*</code> and <code>?</code> wildcards and is case-insensitive. | [optional] -**function_type** | [**List[FunctionType]**](FunctionType.md) | If set, filters on the <code>functionType</code> of a runtime. Uses an exact match. | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | If set, filters on the <code>archiveFormat</code> of a runtime. Uses an exact match. | [optional] - -## Example - -```python -from waylay.services.registry.models.runtime_query import RuntimeQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeQuery from a JSON string -runtime_query_instance = RuntimeQuery.from_json(json) -# print the JSON string representation of the object -print RuntimeQuery.to_json() - -# convert the object into a dict -runtime_query_dict = runtime_query_instance.to_dict() -# create an instance of RuntimeQuery from a dict -runtime_query_form_dict = runtime_query.from_dict(runtime_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeReference.md b/docs/RuntimeReference.md deleted file mode 100644 index ee0a045b..00000000 --- a/docs/RuntimeReference.md +++ /dev/null @@ -1,31 +0,0 @@ -# RuntimeReference - -Reference to a runtime version. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | - -## Example - -```python -from waylay.services.registry.models.runtime_reference import RuntimeReference - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeReference from a JSON string -runtime_reference_instance = RuntimeReference.from_json(json) -# print the JSON string representation of the object -print RuntimeReference.to_json() - -# convert the object into a dict -runtime_reference_dict = runtime_reference_instance.to_dict() -# create an instance of RuntimeReference from a dict -runtime_reference_form_dict = runtime_reference.from_dict(runtime_reference_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeSpecification.md b/docs/RuntimeSpecification.md deleted file mode 100644 index a16dbd4a..00000000 --- a/docs/RuntimeSpecification.md +++ /dev/null @@ -1,35 +0,0 @@ -# RuntimeSpecification - -Runtime (version) specification that says * what assets are required/allowed to build the function * what build parameters are used * what deployment parameters are used * which dependencies are provided by the runtime - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**build** | [**BuildSpec**](BuildSpec.md) | | [optional] -**deploy** | [**DeploySpec**](DeploySpec.md) | | [optional] -**language** | [**LanguageRelease**](LanguageRelease.md) | | [optional] -**provided_dependencies** | [**List[ProvidedDependency]**](ProvidedDependency.md) | Description of dependencies provided by this runtime version. | [optional] -**assets** | [**AssetsConditions**](AssetsConditions.md) | | [optional] -**deprecated** | **bool** | If true, this runtime should no longer be used for new functions. | [optional] - -## Example - -```python -from waylay.services.registry.models.runtime_specification import RuntimeSpecification - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeSpecification from a JSON string -runtime_specification_instance = RuntimeSpecification.from_json(json) -# print the JSON string representation of the object -print RuntimeSpecification.to_json() - -# convert the object into a dict -runtime_specification_dict = runtime_specification_instance.to_dict() -# create an instance of RuntimeSpecification from a dict -runtime_specification_form_dict = runtime_specification.from_dict(runtime_specification_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeSummaryAttrs.md b/docs/RuntimeSummaryAttrs.md deleted file mode 100644 index 4985d1d7..00000000 --- a/docs/RuntimeSummaryAttrs.md +++ /dev/null @@ -1,33 +0,0 @@ -# RuntimeSummaryAttrs - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**title** | **str** | | -**description** | **str** | | [optional] -**function_type** | [**FunctionType**](FunctionType.md) | | -**archive_format** | [**ArchiveFormat**](ArchiveFormat.md) | | - -## Example - -```python -from waylay.services.registry.models.runtime_summary_attrs import RuntimeSummaryAttrs - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeSummaryAttrs from a JSON string -runtime_summary_attrs_instance = RuntimeSummaryAttrs.from_json(json) -# print the JSON string representation of the object -print RuntimeSummaryAttrs.to_json() - -# convert the object into a dict -runtime_summary_attrs_dict = runtime_summary_attrs_instance.to_dict() -# create an instance of RuntimeSummaryAttrs from a dict -runtime_summary_attrs_form_dict = runtime_summary_attrs.from_dict(runtime_summary_attrs_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeVersionAndPathParams.md b/docs/RuntimeVersionAndPathParams.md deleted file mode 100644 index 991fd67a..00000000 --- a/docs/RuntimeVersionAndPathParams.md +++ /dev/null @@ -1,31 +0,0 @@ -# RuntimeVersionAndPathParams - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**wildcard** | **str** | Full path or path prefix of the asset within the archive | -**name** | **str** | | -**version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | - -## Example - -```python -from waylay.services.registry.models.runtime_version_and_path_params import RuntimeVersionAndPathParams - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeVersionAndPathParams from a JSON string -runtime_version_and_path_params_instance = RuntimeVersionAndPathParams.from_json(json) -# print the JSON string representation of the object -print RuntimeVersionAndPathParams.to_json() - -# convert the object into a dict -runtime_version_and_path_params_dict = runtime_version_and_path_params_instance.to_dict() -# create an instance of RuntimeVersionAndPathParams from a dict -runtime_version_and_path_params_form_dict = runtime_version_and_path_params.from_dict(runtime_version_and_path_params_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeVersionParams.md b/docs/RuntimeVersionParams.md deleted file mode 100644 index 2feb3f02..00000000 --- a/docs/RuntimeVersionParams.md +++ /dev/null @@ -1,30 +0,0 @@ -# RuntimeVersionParams - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | | -**version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | - -## Example - -```python -from waylay.services.registry.models.runtime_version_params import RuntimeVersionParams - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeVersionParams from a JSON string -runtime_version_params_instance = RuntimeVersionParams.from_json(json) -# print the JSON string representation of the object -print RuntimeVersionParams.to_json() - -# convert the object into a dict -runtime_version_params_dict = runtime_version_params_instance.to_dict() -# create an instance of RuntimeVersionParams from a dict -runtime_version_params_form_dict = runtime_version_params.from_dict(runtime_version_params_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeVersionQuery.md b/docs/RuntimeVersionQuery.md deleted file mode 100644 index c9d3cabc..00000000 --- a/docs/RuntimeVersionQuery.md +++ /dev/null @@ -1,31 +0,0 @@ -# RuntimeVersionQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**latest** | [**LatestVersionLevel**](LatestVersionLevel.md) | | [optional] -**include_deprecated** | **bool** | If set to `true`, deprecated runtimes will be included in the query. | [optional] [default to False] - -## Example - -```python -from waylay.services.registry.models.runtime_version_query import RuntimeVersionQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeVersionQuery from a JSON string -runtime_version_query_instance = RuntimeVersionQuery.from_json(json) -# print the JSON string representation of the object -print RuntimeVersionQuery.to_json() - -# convert the object into a dict -runtime_version_query_dict = runtime_version_query_instance.to_dict() -# create an instance of RuntimeVersionQuery from a dict -runtime_version_query_form_dict = runtime_version_query.from_dict(runtime_version_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeVersionSpecification.md b/docs/RuntimeVersionSpecification.md deleted file mode 100644 index 5cea0643..00000000 --- a/docs/RuntimeVersionSpecification.md +++ /dev/null @@ -1,37 +0,0 @@ -# RuntimeVersionSpecification - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**build** | [**BuildSpec**](BuildSpec.md) | | [optional] -**deploy** | [**DeploySpec**](DeploySpec.md) | | [optional] -**language** | [**LanguageRelease**](LanguageRelease.md) | | [optional] -**provided_dependencies** | [**List[ProvidedDependency]**](ProvidedDependency.md) | Description of dependencies provided by this runtime version. | [optional] -**assets** | [**AssetsConditions**](AssetsConditions.md) | | [optional] -**deprecated** | **bool** | If true, this runtime should no longer be used for new functions. | [optional] -**title** | **str** | | -**description** | **str** | | [optional] -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | - -## Example - -```python -from waylay.services.registry.models.runtime_version_specification import RuntimeVersionSpecification - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeVersionSpecification from a JSON string -runtime_version_specification_instance = RuntimeVersionSpecification.from_json(json) -# print the JSON string representation of the object -print RuntimeVersionSpecification.to_json() - -# convert the object into a dict -runtime_version_specification_dict = runtime_version_specification_instance.to_dict() -# create an instance of RuntimeVersionSpecification from a dict -runtime_version_specification_form_dict = runtime_version_specification.from_dict(runtime_version_specification_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeVersionStatus.md b/docs/RuntimeVersionStatus.md deleted file mode 100644 index 81db72ce..00000000 --- a/docs/RuntimeVersionStatus.md +++ /dev/null @@ -1,30 +0,0 @@ -# RuntimeVersionStatus - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deprecated** | **bool** | If true, the function uses a deprecated runtime. | -**upgradable** | **bool** | If true, a newer runtime for this function is available using the `rebuild` API. | - -## Example - -```python -from waylay.services.registry.models.runtime_version_status import RuntimeVersionStatus - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeVersionStatus from a JSON string -runtime_version_status_instance = RuntimeVersionStatus.from_json(json) -# print the JSON string representation of the object -print RuntimeVersionStatus.to_json() - -# convert the object into a dict -runtime_version_status_dict = runtime_version_status_instance.to_dict() -# create an instance of RuntimeVersionStatus from a dict -runtime_version_status_form_dict = runtime_version_status.from_dict(runtime_version_status_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimeVersionSummary.md b/docs/RuntimeVersionSummary.md deleted file mode 100644 index 28dcc0b7..00000000 --- a/docs/RuntimeVersionSummary.md +++ /dev/null @@ -1,36 +0,0 @@ -# RuntimeVersionSummary - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deprecated** | **bool** | If true, the function uses a deprecated runtime. | -**upgradable** | **bool** | If true, a newer runtime for this function is available using the `rebuild` API. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**title** | **str** | | -**description** | **str** | | [optional] -**name** | **str** | | -**function_type** | [**FunctionType**](FunctionType.md) | | -**archive_format** | [**ArchiveFormat**](ArchiveFormat.md) | | - -## Example - -```python -from waylay.services.registry.models.runtime_version_summary import RuntimeVersionSummary - -# TODO update the JSON string below -json = "{}" -# create an instance of RuntimeVersionSummary from a JSON string -runtime_version_summary_instance = RuntimeVersionSummary.from_json(json) -# print the JSON string representation of the object -print RuntimeVersionSummary.to_json() - -# convert the object into a dict -runtime_version_summary_dict = runtime_version_summary_instance.to_dict() -# create an instance of RuntimeVersionSummary from a dict -runtime_version_summary_form_dict = runtime_version_summary.from_dict(runtime_version_summary_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/RuntimesApi.md b/docs/RuntimesApi.md index b77e10e9..9c4dbb2f 100644 --- a/docs/RuntimesApi.md +++ b/docs/RuntimesApi.md @@ -80,7 +80,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json + - **Accept**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json ### HTTP response details @@ -162,7 +162,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json + - **Accept**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json ### HTTP response details diff --git a/docs/ScaleArgs.md b/docs/ScaleArgs.md index 81e6634f..70fab2e9 100644 --- a/docs/ScaleArgs.md +++ b/docs/ScaleArgs.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **endpoint** | **str** | The (openfaas) endpoint service name | **runtime_name** | **str** | | **runtime_version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**revision** | **str** | The revision hash of the current (draft) function revision | [optional] +**revision** | **str** | The revision hash of the current (draft) function revision | **replicas** | **float** | Number of target replicas | ## Example diff --git a/docs/SchemaByIdParams.md b/docs/SchemaByIdParams.md deleted file mode 100644 index 9d572326..00000000 --- a/docs/SchemaByIdParams.md +++ /dev/null @@ -1,29 +0,0 @@ -# SchemaByIdParams - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**schema_id** | **str** | Schema id | - -## Example - -```python -from waylay.services.registry.models.schema_by_id_params import SchemaByIdParams - -# TODO update the JSON string below -json = "{}" -# create an instance of SchemaByIdParams from a JSON string -schema_by_id_params_instance = SchemaByIdParams.from_json(json) -# print the JSON string representation of the object -print SchemaByIdParams.to_json() - -# convert the object into a dict -schema_by_id_params_dict = schema_by_id_params_instance.to_dict() -# create an instance of SchemaByIdParams from a dict -schema_by_id_params_form_dict = schema_by_id_params.from_dict(schema_by_id_params_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/SchemaParams.md b/docs/SchemaParams.md deleted file mode 100644 index 89dac21a..00000000 --- a/docs/SchemaParams.md +++ /dev/null @@ -1,30 +0,0 @@ -# SchemaParams - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**function_type** | [**FunctionType**](FunctionType.md) | | -**role** | [**AssetRole**](AssetRole.md) | | - -## Example - -```python -from waylay.services.registry.models.schema_params import SchemaParams - -# TODO update the JSON string below -json = "{}" -# create an instance of SchemaParams from a JSON string -schema_params_instance = SchemaParams.from_json(json) -# print the JSON string representation of the object -print SchemaParams.to_json() - -# convert the object into a dict -schema_params_dict = schema_params_instance.to_dict() -# create an instance of SchemaParams from a dict -schema_params_form_dict = schema_params.from_dict(schema_params_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/MediaType.md b/docs/ShowRelatedType.md similarity index 93% rename from docs/MediaType.md rename to docs/ShowRelatedType.md index 718af037..f59107e5 100644 --- a/docs/MediaType.md +++ b/docs/ShowRelatedType.md @@ -1,4 +1,4 @@ -# MediaType +# ShowRelatedType ## Properties diff --git a/docs/StatusExclude.md b/docs/StatusExclude.md new file mode 100644 index 00000000..12e52914 --- /dev/null +++ b/docs/StatusExclude.md @@ -0,0 +1,12 @@ +# StatusExclude + +Any status value with a `-` postfix appended, excludes that status as a filter. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/docs/StatusResponse.md b/docs/StatusResponse.md deleted file mode 100644 index 656f8ecf..00000000 --- a/docs/StatusResponse.md +++ /dev/null @@ -1,29 +0,0 @@ -# StatusResponse - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**status_code** | **float** | | - -## Example - -```python -from waylay.services.registry.models.status_response import StatusResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of StatusResponse from a JSON string -status_response_instance = StatusResponse.from_json(json) -# print the JSON string representation of the object -print StatusResponse.to_json() - -# convert the object into a dict -status_response_dict = status_response_instance.to_dict() -# create an instance of StatusResponse from a dict -status_response_form_dict = status_response.from_dict(status_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TagQuery.md b/docs/TagQuery.md deleted file mode 100644 index 1a2c7930..00000000 --- a/docs/TagQuery.md +++ /dev/null @@ -1,30 +0,0 @@ -# TagQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**name** | **str** | If set, filters on the <code>name</code> of a tag. Supports <code>*</code> and <code>?</code> wildcards and is case-insensitive. | [optional] -**color** | **str** | If set, filters on the <code>color</code> of a tag. Uses an exact match. | [optional] - -## Example - -```python -from waylay.services.registry.models.tag_query import TagQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of TagQuery from a JSON string -tag_query_instance = TagQuery.from_json(json) -# print the JSON string representation of the object -print TagQuery.to_json() - -# convert the object into a dict -tag_query_dict = tag_query_instance.to_dict() -# create an instance of TagQuery from a dict -tag_query_form_dict = tag_query.from_dict(tag_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/TagsQuery.md b/docs/TagsQuery.md deleted file mode 100644 index cae3d324..00000000 --- a/docs/TagsQuery.md +++ /dev/null @@ -1,29 +0,0 @@ -# TagsQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**tags** | [**TagsFilter**](TagsFilter.md) | | [optional] - -## Example - -```python -from waylay.services.registry.models.tags_query import TagsQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of TagsQuery from a JSON string -tags_query_instance = TagsQuery.from_json(json) -# print the JSON string representation of the object -print TagsQuery.to_json() - -# convert the object into a dict -tags_query_dict = tags_query_instance.to_dict() -# create an instance of TagsQuery from a dict -tags_query_form_dict = tags_query.from_dict(tags_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UndeployArgs.md b/docs/UndeployArgs.md index 103f8062..6f9d05a7 100644 --- a/docs/UndeployArgs.md +++ b/docs/UndeployArgs.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **endpoint** | **str** | The (openfaas) endpoint service name | **runtime_name** | **str** | | **runtime_version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**revision** | **str** | The revision hash of the current (draft) function revision | [optional] +**revision** | **str** | The revision hash of the current (draft) function revision | **is_native_plug** | **bool** | If true, the function is not expected to be deployed on openfaas. | **delete_entity** | **bool** | | diff --git a/docs/UnhealthyInvokableWebscriptError.md b/docs/UnhealthyInvokableWebscriptError.md deleted file mode 100644 index 8e1c6aff..00000000 --- a/docs/UnhealthyInvokableWebscriptError.md +++ /dev/null @@ -1,33 +0,0 @@ -# UnhealthyInvokableWebscriptError - -Webscript Not Healthy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**entity** | [**InvokableWebscriptResponseEntity**](InvokableWebscriptResponseEntity.md) | | -**links** | [**InvokeInternalHALLink**](InvokeInternalHALLink.md) | | -**error** | **str** | | -**code** | **str** | | - -## Example - -```python -from waylay.services.registry.models.unhealthy_invokable_webscript_error import UnhealthyInvokableWebscriptError - -# TODO update the JSON string below -json = "{}" -# create an instance of UnhealthyInvokableWebscriptError from a JSON string -unhealthy_invokable_webscript_error_instance = UnhealthyInvokableWebscriptError.from_json(json) -# print the JSON string representation of the object -print UnhealthyInvokableWebscriptError.to_json() - -# convert the object into a dict -unhealthy_invokable_webscript_error_dict = unhealthy_invokable_webscript_error_instance.to_dict() -# create an instance of UnhealthyInvokableWebscriptError from a dict -unhealthy_invokable_webscript_error_form_dict = unhealthy_invokable_webscript_error.from_dict(unhealthy_invokable_webscript_error_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UpdateComment.md b/docs/UpdateComment.md deleted file mode 100644 index 2b128c1a..00000000 --- a/docs/UpdateComment.md +++ /dev/null @@ -1,29 +0,0 @@ -# UpdateComment - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comment** | **str** | An optional user-specified comment corresponding to the operation. | [optional] - -## Example - -```python -from waylay.services.registry.models.update_comment import UpdateComment - -# TODO update the JSON string below -json = "{}" -# create an instance of UpdateComment from a JSON string -update_comment_instance = UpdateComment.from_json(json) -# print the JSON string representation of the object -print UpdateComment.to_json() - -# convert the object into a dict -update_comment_dict = update_comment_instance.to_dict() -# create an instance of UpdateComment from a dict -update_comment_form_dict = update_comment.from_dict(update_comment_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UpdateDraftQuery.md b/docs/UpdateDraftQuery.md deleted file mode 100644 index 3ddbd56c..00000000 --- a/docs/UpdateDraftQuery.md +++ /dev/null @@ -1,31 +0,0 @@ -# UpdateDraftQuery - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**comment** | **str** | An optional user-specified comment corresponding to the operation. | [optional] -**var_async** | **bool** | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default to True] -**chown** | **bool** | If set, ownership of the draft function is transferred to the current user. | [default to False] - -## Example - -```python -from waylay.services.registry.models.update_draft_query import UpdateDraftQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of UpdateDraftQuery from a JSON string -update_draft_query_instance = UpdateDraftQuery.from_json(json) -# print the JSON string representation of the object -print UpdateDraftQuery.to_json() - -# convert the object into a dict -update_draft_query_dict = update_draft_query_instance.to_dict() -# create an instance of UpdateDraftQuery from a dict -update_draft_query_form_dict = update_draft_query.from_dict(update_draft_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UpdateMetadataRequestV1.md b/docs/UpdateMetadataRequestV1.md deleted file mode 100644 index 8e01d5ac..00000000 --- a/docs/UpdateMetadataRequestV1.md +++ /dev/null @@ -1,35 +0,0 @@ -# UpdateMetadataRequestV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**author** | **str** | The author of the function. | [optional] -**description** | **str** | A description of the function | [optional] -**icon_url** | **str** | An url to an icon that represents this function. | [optional] -**category** | **str** | A category for this function (Deprecated: use tags to categorise your functions) | [optional] -**documentation_url** | **str** | External url that document this function. | [optional] -**tags** | [**List[Tag]**](Tag.md) | Tags associated with this function. | [optional] -**friendly_name** | **str** | Display title for this function. | [optional] - -## Example - -```python -from waylay.services.registry.models.update_metadata_request_v1 import UpdateMetadataRequestV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of UpdateMetadataRequestV1 from a JSON string -update_metadata_request_v1_instance = UpdateMetadataRequestV1.from_json(json) -# print the JSON string representation of the object -print UpdateMetadataRequestV1.to_json() - -# convert the object into a dict -update_metadata_request_v1_dict = update_metadata_request_v1_instance.to_dict() -# create an instance of UpdateMetadataRequestV1 from a dict -update_metadata_request_v1_form_dict = update_metadata_request_v1.from_dict(update_metadata_request_v1_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/UserPlugMeta.md b/docs/UserPlugMeta.md deleted file mode 100644 index c784e631..00000000 --- a/docs/UserPlugMeta.md +++ /dev/null @@ -1,36 +0,0 @@ -# UserPlugMeta - -Plug metadata that the user can update as `metadata` - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**author** | **str** | The author of the function. | [optional] -**description** | **str** | A description of the function | [optional] -**icon_url** | **str** | An url to an icon that represents this function. | [optional] -**category** | **str** | A category for this function (Deprecated: use tags to categorise your functions) | [optional] -**documentation_url** | **str** | External url that document this function. | [optional] -**tags** | [**List[Tag]**](Tag.md) | Tags associated with this function. | [optional] -**friendly_name** | **str** | Display title for this function. | [optional] - -## Example - -```python -from waylay.services.registry.models.user_plug_meta import UserPlugMeta - -# TODO update the JSON string below -json = "{}" -# create an instance of UserPlugMeta from a JSON string -user_plug_meta_instance = UserPlugMeta.from_json(json) -# print the JSON string representation of the object -print UserPlugMeta.to_json() - -# convert the object into a dict -user_plug_meta_dict = user_plug_meta_instance.to_dict() -# create an instance of UserPlugMeta from a dict -user_plug_meta_form_dict = user_plug_meta.from_dict(user_plug_meta_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VerifyArgs.md b/docs/VerifyArgs.md index b145e3a6..b28c1966 100644 --- a/docs/VerifyArgs.md +++ b/docs/VerifyArgs.md @@ -10,7 +10,7 @@ Name | Type | Description | Notes **endpoint** | **str** | The (openfaas) endpoint service name | **runtime_name** | **str** | | **runtime_version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**revision** | **str** | The revision hash of the current (draft) function revision | [optional] +**revision** | **str** | The revision hash of the current (draft) function revision | ## Example diff --git a/docs/VerifyQueryV1.md b/docs/VerifyQueryV1.md deleted file mode 100644 index 7cad5fbd..00000000 --- a/docs/VerifyQueryV1.md +++ /dev/null @@ -1,29 +0,0 @@ -# VerifyQueryV1 - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**scale_to_zero** | **bool** | Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. | [optional] - -## Example - -```python -from waylay.services.registry.models.verify_query_v1 import VerifyQueryV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of VerifyQueryV1 from a JSON string -verify_query_v1_instance = VerifyQueryV1.from_json(json) -# print the JSON string representation of the object -print VerifyQueryV1.to_json() - -# convert the object into a dict -verify_query_v1_dict = verify_query_v1_instance.to_dict() -# create an instance of VerifyQueryV1 from a dict -verify_query_v1_form_dict = verify_query_v1.from_dict(verify_query_v1_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VersionIncludes.md b/docs/VersionIncludes.md deleted file mode 100644 index 6bdb0f41..00000000 --- a/docs/VersionIncludes.md +++ /dev/null @@ -1,30 +0,0 @@ -# VersionIncludes - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] - -## Example - -```python -from waylay.services.registry.models.version_includes import VersionIncludes - -# TODO update the JSON string below -json = "{}" -# create an instance of VersionIncludes from a JSON string -version_includes_instance = VersionIncludes.from_json(json) -# print the JSON string representation of the object -print VersionIncludes.to_json() - -# convert the object into a dict -version_includes_dict = version_includes_instance.to_dict() -# create an instance of VersionIncludes from a dict -version_includes_form_dict = version_includes.from_dict(version_includes_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VersionsQuery.md b/docs/VersionsQuery.md deleted file mode 100644 index 1f24101a..00000000 --- a/docs/VersionsQuery.md +++ /dev/null @@ -1,49 +0,0 @@ -# VersionsQuery - -Function versions paged query - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**endpoint** | **str** | Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**image_name** | **str** | Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**storage_location** | **str** | Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] -**name_version** | **List[str]** | Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.versions_query import VersionsQuery - -# TODO update the JSON string below -json = "{}" -# create an instance of VersionsQuery from a JSON string -versions_query_instance = VersionsQuery.from_json(json) -# print the JSON string representation of the object -print VersionsQuery.to_json() - -# convert the object into a dict -versions_query_dict = versions_query_instance.to_dict() -# create an instance of VersionsQuery from a dict -versions_query_form_dict = versions_query.from_dict(versions_query_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VersionsQueryV2.md b/docs/VersionsQueryV2.md deleted file mode 100644 index 5fe0b71b..00000000 --- a/docs/VersionsQueryV2.md +++ /dev/null @@ -1,49 +0,0 @@ -# VersionsQueryV2 - -Function versions paged query - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**endpoint** | **str** | Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**image_name** | **str** | Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**storage_location** | **str** | Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] -**name_version** | **List[str]** | Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.versions_query_v2 import VersionsQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of VersionsQueryV2 from a JSON string -versions_query_v2_instance = VersionsQueryV2.from_json(json) -# print the JSON string representation of the object -print VersionsQueryV2.to_json() - -# convert the object into a dict -versions_query_v2_dict = versions_query_v2_instance.to_dict() -# create an instance of VersionsQueryV2 from a dict -versions_query_v2_form_dict = versions_query_v2.from_dict(versions_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/VersionsResponseV2.md b/docs/VersionsResponseV2.md deleted file mode 100644 index 54d027fa..00000000 --- a/docs/VersionsResponseV2.md +++ /dev/null @@ -1,33 +0,0 @@ -# VersionsResponseV2 - -Version Listing Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The page size used for this query result. | [optional] -**count** | **float** | The total count of matching items, from which this result is one page. | -**page** | **float** | The page number of a paged query result. | [optional] -**entities** | [**List[AnyFunctionResponse]**](AnyFunctionResponse.md) | The specification and deployment status of the queried functions | - -## Example - -```python -from waylay.services.registry.models.versions_response_v2 import VersionsResponseV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of VersionsResponseV2 from a JSON string -versions_response_v2_instance = VersionsResponseV2.from_json(json) -# print the JSON string representation of the object -print VersionsResponseV2.to_json() - -# convert the object into a dict -versions_response_v2_dict = versions_response_v2_instance.to_dict() -# create an instance of VersionsResponseV2 from a dict -versions_response_v2_form_dict = versions_response_v2.from_dict(versions_response_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/WebscriptLatestVersionQueryV2.md b/docs/WebscriptLatestVersionQueryV2.md deleted file mode 100644 index c684e995..00000000 --- a/docs/WebscriptLatestVersionQueryV2.md +++ /dev/null @@ -1,31 +0,0 @@ -# WebscriptLatestVersionQueryV2 - -Webscript latest named version query. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] - -## Example - -```python -from waylay.services.registry.models.webscript_latest_version_query_v2 import WebscriptLatestVersionQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of WebscriptLatestVersionQueryV2 from a JSON string -webscript_latest_version_query_v2_instance = WebscriptLatestVersionQueryV2.from_json(json) -# print the JSON string representation of the object -print WebscriptLatestVersionQueryV2.to_json() - -# convert the object into a dict -webscript_latest_version_query_v2_dict = webscript_latest_version_query_v2_instance.to_dict() -# create an instance of WebscriptLatestVersionQueryV2 from a dict -webscript_latest_version_query_v2_form_dict = webscript_latest_version_query_v2.from_dict(webscript_latest_version_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/WebscriptLatestVersionsQueryV1.md b/docs/WebscriptLatestVersionsQueryV1.md deleted file mode 100644 index 303aee0e..00000000 --- a/docs/WebscriptLatestVersionsQueryV1.md +++ /dev/null @@ -1,45 +0,0 @@ -# WebscriptLatestVersionsQueryV1 - -Webscript lastest versions listing query - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] - -## Example - -```python -from waylay.services.registry.models.webscript_latest_versions_query_v1 import WebscriptLatestVersionsQueryV1 - -# TODO update the JSON string below -json = "{}" -# create an instance of WebscriptLatestVersionsQueryV1 from a JSON string -webscript_latest_versions_query_v1_instance = WebscriptLatestVersionsQueryV1.from_json(json) -# print the JSON string representation of the object -print WebscriptLatestVersionsQueryV1.to_json() - -# convert the object into a dict -webscript_latest_versions_query_v1_dict = webscript_latest_versions_query_v1_instance.to_dict() -# create an instance of WebscriptLatestVersionsQueryV1 from a dict -webscript_latest_versions_query_v1_form_dict = webscript_latest_versions_query_v1.from_dict(webscript_latest_versions_query_v1_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/WebscriptLatestVersionsQueryV2.md b/docs/WebscriptLatestVersionsQueryV2.md deleted file mode 100644 index e2ec0638..00000000 --- a/docs/WebscriptLatestVersionsQueryV2.md +++ /dev/null @@ -1,49 +0,0 @@ -# WebscriptLatestVersionsQueryV2 - -Webscript lastest versions listing query. - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. | [optional] -**page** | **float** | The number of pages to skip when returning result to this query. | [optional] -**include_draft** | **bool** | Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**. | [optional] -**include_deprecated** | **bool** | Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**. | [optional] -**deprecated** | **bool** | Filter on the deprecation status of the function. | [optional] -**draft** | **bool** | Filter on the draft status of the function. | [optional] -**name_version** | **List[str]** | Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered. | [optional] -**version** | **str** | Filter on the version of the function (case-sensitive, supports wildcards). | [optional] -**status** | [**List[StatusFilter]**](StatusFilter.md) | Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions. | [optional] -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**created_by** | **str** | Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**updated_by** | **str** | Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs. | [optional] -**created_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**created_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_before** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**updated_after** | [**TimestampSpec**](TimestampSpec.md) | | [optional] -**name** | **str** | Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters). | [optional] -**archive_format** | [**List[ArchiveFormat]**](ArchiveFormat.md) | Filter on the archive format of the function. | [optional] -**runtime** | **List[str]** | Filter on the runtime of the function. | [optional] -**latest** | **bool** | When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. | [optional] - -## Example - -```python -from waylay.services.registry.models.webscript_latest_versions_query_v2 import WebscriptLatestVersionsQueryV2 - -# TODO update the JSON string below -json = "{}" -# create an instance of WebscriptLatestVersionsQueryV2 from a JSON string -webscript_latest_versions_query_v2_instance = WebscriptLatestVersionsQueryV2.from_json(json) -# print the JSON string representation of the object -print WebscriptLatestVersionsQueryV2.to_json() - -# convert the object into a dict -webscript_latest_versions_query_v2_dict = webscript_latest_versions_query_v2_instance.to_dict() -# create an instance of WebscriptLatestVersionsQueryV2 from a dict -webscript_latest_versions_query_v2_form_dict = webscript_latest_versions_query_v2.from_dict(webscript_latest_versions_query_v2_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/WebscriptResponse.md b/docs/WebscriptResponse.md deleted file mode 100644 index 2e16f225..00000000 --- a/docs/WebscriptResponse.md +++ /dev/null @@ -1,43 +0,0 @@ -# WebscriptResponse - -Successful Response - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**deploy** | [**FunctionDeployOverridesType**](FunctionDeployOverridesType.md) | | [optional] -**name** | **str** | The logical name for the function. | -**version** | **str** | A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org | -**runtime** | **str** | | -**runtime_version** | [**SemanticVersionRange**](SemanticVersionRange.md) | | [optional] -**metadata** | [**FunctionMeta**](FunctionMeta.md) | | -**created_by** | **str** | The user that created this entity. | -**created_at** | **datetime** | The timestamp at which this entity was created. | -**updated_by** | **str** | The user that last updated this entity. | -**updated_at** | **datetime** | The timestamp at which this entity was last updated. | -**status** | [**Status**](Status.md) | | -**failure_reason** | [**FailureReason**](FailureReason.md) | | [optional] -**links** | [**List[JobHALLinks]**](JobHALLinks.md) | Links to related entities. | [optional] -**secret** | **str** | | - -## Example - -```python -from waylay.services.registry.models.webscript_response import WebscriptResponse - -# TODO update the JSON string below -json = "{}" -# create an instance of WebscriptResponse from a JSON string -webscript_response_instance = WebscriptResponse.from_json(json) -# print the JSON string representation of the object -print WebscriptResponse.to_json() - -# convert the object into a dict -webscript_response_dict = webscript_response_instance.to_dict() -# create an instance of WebscriptResponse from a dict -webscript_response_form_dict = webscript_response.from_dict(webscript_response_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/WebscriptFunctionsApi.md b/docs/WebscriptsApi.md similarity index 76% rename from docs/WebscriptFunctionsApi.md rename to docs/WebscriptsApi.md index 4d2ff2c5..5809ade5 100644 --- a/docs/WebscriptFunctionsApi.md +++ b/docs/WebscriptsApi.md @@ -1,26 +1,26 @@ -# waylay.services.registry.WebscriptFunctionsApi +# waylay.services.registry.WebscriptsApi All URIs are relative to *https://api.waylay.io* Method | HTTP request | Description ------------- | ------------- | ------------- -[**create**](WebscriptFunctionsApi.md#create) | **POST** /registry/v2/webscripts/ | Create Webscript Version -[**delete_asset**](WebscriptFunctionsApi.md#delete_asset) | **DELETE** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Delete Webscript Asset -[**get_archive**](WebscriptFunctionsApi.md#get_archive) | **GET** /registry/v2/webscripts/{name}/versions/{version}/content | Get Webscript Archive -[**get_asset**](WebscriptFunctionsApi.md#get_asset) | **GET** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Get File From Webscript Archive -[**get_latest**](WebscriptFunctionsApi.md#get_latest) | **GET** /registry/v2/webscripts/{name} | Get Latest Webscript Version -[**get**](WebscriptFunctionsApi.md#get) | **GET** /registry/v2/webscripts/{name}/versions/{version} | Get Webscript Version -[**jobs**](WebscriptFunctionsApi.md#jobs) | **GET** /registry/v2/webscripts/{name}/versions/{version}/jobs | List Webscript Jobs -[**list_versions**](WebscriptFunctionsApi.md#list_versions) | **GET** /registry/v2/webscripts/{name}/versions | List Webscript Versions -[**list**](WebscriptFunctionsApi.md#list) | **GET** /registry/v2/webscripts/ | List Webscripts -[**patch_metadata**](WebscriptFunctionsApi.md#patch_metadata) | **PATCH** /registry/v2/webscripts/{name}/versions/{version}/metadata | Patch Webscript Metadata -[**publish**](WebscriptFunctionsApi.md#publish) | **POST** /registry/v2/webscripts/{name}/versions/{version}/publish | Publish Draft Webscript -[**rebuild**](WebscriptFunctionsApi.md#rebuild) | **POST** /registry/v2/webscripts/{name}/versions/{version}/rebuild | Rebuild Webscript -[**remove_version**](WebscriptFunctionsApi.md#remove_version) | **DELETE** /registry/v2/webscripts/{name}/versions/{version} | Remove Webscript Version -[**remove_versions**](WebscriptFunctionsApi.md#remove_versions) | **DELETE** /registry/v2/webscripts/{name} | Remove Webscript -[**update_asset**](WebscriptFunctionsApi.md#update_asset) | **PUT** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Update Webscript Asset -[**update_assets**](WebscriptFunctionsApi.md#update_assets) | **PUT** /registry/v2/webscripts/{name}/versions/{version}/content | Update Webscript Assets -[**verify**](WebscriptFunctionsApi.md#verify) | **POST** /registry/v2/webscripts/{name}/versions/{version}/verify | Verify Health Of Webscript +[**create**](WebscriptsApi.md#create) | **POST** /registry/v2/webscripts/ | Create Webscript Version +[**delete_asset**](WebscriptsApi.md#delete_asset) | **DELETE** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Delete Webscript Asset +[**get_archive**](WebscriptsApi.md#get_archive) | **GET** /registry/v2/webscripts/{name}/versions/{version}/content | Get Webscript Archive +[**get_asset**](WebscriptsApi.md#get_asset) | **GET** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Get File From Webscript Archive +[**get_latest**](WebscriptsApi.md#get_latest) | **GET** /registry/v2/webscripts/{name} | Get Latest Webscript Version +[**get**](WebscriptsApi.md#get) | **GET** /registry/v2/webscripts/{name}/versions/{version} | Get Webscript Version +[**jobs**](WebscriptsApi.md#jobs) | **GET** /registry/v2/webscripts/{name}/versions/{version}/jobs | List Webscript Jobs +[**list_versions**](WebscriptsApi.md#list_versions) | **GET** /registry/v2/webscripts/{name}/versions | List Webscript Versions +[**list**](WebscriptsApi.md#list) | **GET** /registry/v2/webscripts/ | List Webscripts +[**patch_metadata**](WebscriptsApi.md#patch_metadata) | **PATCH** /registry/v2/webscripts/{name}/versions/{version}/metadata | Patch Webscript Metadata +[**publish**](WebscriptsApi.md#publish) | **POST** /registry/v2/webscripts/{name}/versions/{version}/publish | Publish Draft Webscript +[**rebuild**](WebscriptsApi.md#rebuild) | **POST** /registry/v2/webscripts/{name}/versions/{version}/rebuild | Rebuild Webscript +[**remove_version**](WebscriptsApi.md#remove_version) | **DELETE** /registry/v2/webscripts/{name}/versions/{version} | Remove Webscript Version +[**remove_versions**](WebscriptsApi.md#remove_versions) | **DELETE** /registry/v2/webscripts/{name} | Remove Webscript +[**update_asset**](WebscriptsApi.md#update_asset) | **PUT** /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard} | Update Webscript Asset +[**update_assets**](WebscriptsApi.md#update_assets) | **PUT** /registry/v2/webscripts/{name}/versions/{version}/content | Update Webscript Assets +[**verify**](WebscriptsApi.md#verify) | **POST** /registry/v2/webscripts/{name}/versions/{version}/verify | Verify Health Of Webscript # **create** > create( @@ -31,7 +31,7 @@ Method | HTTP request | Description Create Webscript Version -Creates a new webscript function by uploading its assets. The assets for a webscript function can be provided as either The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. +Creates a new webscript function by uploading its assets. The assets for a webscript function can be provided as The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. ### Example @@ -47,32 +47,34 @@ waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed from waylay.services.registry.models.deprecate_previous_policy import DeprecatePreviousPolicy -from waylay.services.registry.models.multipart_file_upload import MultipartFileUpload from waylay.services.registry.models.post_webscript_job_sync_response_v2 import PostWebscriptJobSyncResponseV2 try: # Create Webscript Version # calls `POST /registry/v2/webscripts/` - api_response = await waylay_client.registry.webscript_functions.create( + api_response = await waylay_client.registry.webscripts.create( # query parameters: query = { + 'deploy': True + 'scaleToZero': False 'deprecatePrevious': 'none' 'dryRun': True 'async': True - 'scaleToZero': False 'draft': False }, + # json data: use a generated model or a json-serializable python data structure (dict, list) + json = None # bytearray | The assets for a webscript function can be provided as The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. (optional) # non-json binary data: use a byte array or a generator of bytearray chuncks content=b'my-binary-data', # this operation supports multiple request content types: use `headers` to specify the one used - # alternatives: 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', + # alternatives: 'application/tar', 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', 'application/json', '*/*+json', headers = { 'content-type': 'application/octet-stream' }, ) - print("The response of registry.webscript_functions.create:\n") + print("The response of registry.webscripts.create:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.create: %s\n" % e) + print("Exception when calling registry.webscripts.create: %s\n" % e) ``` ### Endpoint @@ -83,18 +85,24 @@ POST /registry/v2/webscripts/ Name | Type | API binding | Description | Notes -------- | ----- | ------------- | ------------- | ------------- -**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>webscript</em> function can be provided as either <ul> <li>a single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>separate files in a <code>multipart/form-data</code> request</li> </ul> The required <code>webscript.json</code> json file contains the function metadata, and must have a <code>runtime</code> attribute that is one of the supported <em>runtime</em>s (see <code>GET /registry/v2/runtimes?functionType=webscripts</code>). For each <em>runtime</em> other files will be required or supported. | [optional] +**json** | **bytearray** | json request body | The assets for a <em>webscript</em> function can be provided as <ul> <li>A single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>Separate files in a <code>multipart/form-data</code> request</li> <li>A reference to the assets of another <em>webscript</em> in the <code>copy</code> argument</li> </ul> The required <code>webscript.json</code> json file contains the function metadata, and must have a <code>runtime</code> attribute that is one of the supported <em>runtime</em>s (see <code>GET /registry/v2/runtimes?functionType=webscripts</code>). For each <em>runtime</em> other files will be required or supported. | [optional] +**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>webscript</em> function can be provided as <ul> <li>A single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>Separate files in a <code>multipart/form-data</code> request</li> <li>A reference to the assets of another <em>webscript</em> in the <code>copy</code> argument</li> </ul> The required <code>webscript.json</code> json file contains the function metadata, and must have a <code>runtime</code> attribute that is one of the supported <em>runtime</em>s (see <code>GET /registry/v2/runtimes?functionType=webscripts</code>). For each <em>runtime</em> other files will be required or supported. | [optional] **files** | **[FileTypes](Operation.md#req_arg_files)** | request body files | | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] +**query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] **query['deprecatePrevious']** (dict)
**query.deprecate_previous** (Query) | [**DeprecatePreviousPolicy**](.md) | query parameter `"deprecatePrevious"` | Set the cleanup policy used to automatically deprecate/delete previous versions. | [optional] **query['dryRun']** (dict)
**query.dry_run** (Query) | **bool** | query parameter `"dryRun"` | If set to <code>true</code>, validates the deployment conditions, but does not change anything. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately. | [optional] [default False] **query['version']** (dict)
**query.version** (Query) | [**SemanticVersionRange**](.md) | query parameter `"version"` | If set, the function version will be an increment of the latest existing version that satisfies the `version` range. Note that this increment always takes precedence over an explicit `version` in the function manifest. | [optional] **query['name']** (dict)
**query.name** (Query) | **str** | query parameter `"name"` | If set, the value will be used as the function name instead of the one specified in the manifest. | [optional] **query['draft']** (dict)
**query.draft** (Query) | **bool** | query parameter `"draft"` | If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. | [optional] [default False] +**query['runtime']** (dict)
**query.runtime** (Query) | **str** | query parameter `"runtime"` | If set, the created function will use the indicated runtime (latest version within specified range). This takes precedence over the runtime specified in a function manifest (copied or from request body). | [optional] +**query['copy']** (dict)
**query.copy_from** (Query) | [**CreateWebscriptsCopyParameter**](.md) | query parameter `"copy"` | Indicates the _source_ of initial assets for a _new function_. When using this query parameter, the request body does not need to contain assets, but any assets in the request body will overwrite the copied assets. #### Selection of _assets_ source * If set as `<sourceName>[@<sourceVersionRange>]`, the _new function_ will be created with copied assets of the selected _source function_. * If set as `!example`, a `runtime` query parameter is required, and the _new function_ will be initialized with assets of the _runtime example_. #### Selection of the _source function_ When `<sourceVersionRange>` is a range (or is not given), the latest _published_ version (in that range) is used. If no _published_ version exists, the latest _draft_ is selected. If no versions in the range exist, a `404` _Not Found_ error is returned. #### The `name` of the _new function_ If a `name` is NOT specified (either as query parameter, or in an optional manifest asset in the request body), the `name` of the _new function_ will be that of the _source function_. #### The `version` of the _new function_ When the _target_ and _source_ name are equal, the `version` query parameters is defaulted to `<sourceVersionRange>` (`~<sourceVersionRange>` when it's an exact version) The version of the _new function_ will be: * If a `version` is NOT specified (either as query parameter, in an optional manifest asset, or as `<sourceVersionRange>` _default_) * a **patch increment** (`<major>.<minor>.<patch>+1`) of the latest **existing version** with the target `name` * **`1.0.0`** otherwise * If a `version` is specified: * the **lowest version** in that range **if no existing version** is in that range. * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. #### Deployment overrides The new function will use the deployment overrides of the copied function, unless a _manifest_ was specified in the request body. | [optional] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | -**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data` +**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data`, `application/json`, `*/*+json` ### Return type @@ -106,7 +114,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - - **Content-Type**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data + - **Content-Type**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data, application/json, */*+json - **Accept**: application/json ### HTTP response details @@ -148,20 +156,22 @@ from waylay.services.registry.models.post_webscript_job_sync_response_v2 import try: # Delete Webscript Asset # calls `DELETE /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard}` - api_response = await waylay_client.registry.webscript_functions.delete_asset( + api_response = await waylay_client.registry.webscripts.delete_asset( 'name_example', # name | path param "name" 'version_example', # version | path param "version" 'wildcard_example', # wildcard | path param "wildcard" # query parameters: query = { - 'async': True + 'scaleToZero': False + 'deploy': True 'chown': False + 'async': True }, ) - print("The response of registry.webscript_functions.delete_asset:\n") + print("The response of registry.webscripts.delete_asset:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.delete_asset: %s\n" % e) + print("Exception when calling registry.webscripts.delete_asset: %s\n" % e) ``` ### Endpoint @@ -176,9 +186,12 @@ Name | Type | API binding | Description | Notes **version** | **str** | path parameter `"version"` | The version of the function. | **wildcard** | **str** | path parameter `"wildcard"` | Full path or path prefix of the asset within the archive | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [default False] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | ### Return type @@ -200,6 +213,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected |-------------|-------------|------------------| **201** | Default Response | - | **202** | Default Response | - | +**403** | Default Response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -231,7 +245,7 @@ waylay_client = WaylayClient.from_profile() try: # Get Webscript Archive # calls `GET /registry/v2/webscripts/{name}/versions/{version}/content` - api_response = await waylay_client.registry.webscript_functions.get_archive( + api_response = await waylay_client.registry.webscripts.get_archive( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: @@ -239,10 +253,10 @@ try: 'ls': False }, ) - print("The response of registry.webscript_functions.get_archive:\n") + print("The response of registry.webscripts.get_archive:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.get_archive: %s\n" % e) + print("Exception when calling registry.webscripts.get_archive: %s\n" % e) ``` ### Endpoint @@ -270,7 +284,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json + - **Accept**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json ### HTTP response details @@ -309,7 +323,7 @@ waylay_client = WaylayClient.from_profile() try: # Get File From Webscript Archive # calls `GET /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard}` - api_response = await waylay_client.registry.webscript_functions.get_asset( + api_response = await waylay_client.registry.webscripts.get_asset( 'name_example', # name | path param "name" 'version_example', # version | path param "version" 'wildcard_example', # wildcard | path param "wildcard" @@ -318,10 +332,10 @@ try: 'ls': False }, ) - print("The response of registry.webscript_functions.get_asset:\n") + print("The response of registry.webscripts.get_asset:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.get_asset: %s\n" % e) + print("Exception when calling registry.webscripts.get_asset: %s\n" % e) ``` ### Endpoint @@ -350,7 +364,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - **Content-Type**: Not defined - - **Accept**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json + - **Accept**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, application/json ### HTTP response details @@ -388,7 +402,7 @@ from waylay.services.registry.models.get_webscript_response_v2 import GetWebscri try: # Get Latest Webscript Version # calls `GET /registry/v2/webscripts/{name}` - api_response = await waylay_client.registry.webscript_functions.get_latest( + api_response = await waylay_client.registry.webscripts.get_latest( 'name_example', # name | path param "name" # query parameters: query = { @@ -396,10 +410,10 @@ try: 'includeDeprecated': True }, ) - print("The response of registry.webscript_functions.get_latest:\n") + print("The response of registry.webscripts.get_latest:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.get_latest: %s\n" % e) + print("Exception when calling registry.webscripts.get_latest: %s\n" % e) ``` ### Endpoint @@ -465,14 +479,14 @@ from waylay.services.registry.models.get_webscript_response_v2 import GetWebscri try: # Get Webscript Version # calls `GET /registry/v2/webscripts/{name}/versions/{version}` - api_response = await waylay_client.registry.webscript_functions.get( + api_response = await waylay_client.registry.webscripts.get( 'name_example', # name | path param "name" 'version_example', # version | path param "version" ) - print("The response of registry.webscript_functions.get:\n") + print("The response of registry.webscripts.get:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.get: %s\n" % e) + print("Exception when calling registry.webscripts.get: %s\n" % e) ``` ### Endpoint @@ -540,17 +554,17 @@ from waylay.services.registry.models.jobs_for_webscript_response_v2 import JobsF try: # List Webscript Jobs # calls `GET /registry/v2/webscripts/{name}/versions/{version}/jobs` - api_response = await waylay_client.registry.webscript_functions.jobs( + api_response = await waylay_client.registry.webscripts.jobs( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { }, ) - print("The response of registry.webscript_functions.jobs:\n") + print("The response of registry.webscripts.jobs:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.jobs: %s\n" % e) + print("Exception when calling registry.webscripts.jobs: %s\n" % e) ``` ### Endpoint @@ -623,7 +637,7 @@ from waylay.services.registry.models.webscript_versions_response_v2 import Websc try: # List Webscript Versions # calls `GET /registry/v2/webscripts/{name}/versions` - api_response = await waylay_client.registry.webscript_functions.list_versions( + api_response = await waylay_client.registry.webscripts.list_versions( 'name_example', # name | path param "name" # query parameters: query = { @@ -633,10 +647,10 @@ try: 'updatedBy': '@me' }, ) - print("The response of registry.webscript_functions.list_versions:\n") + print("The response of registry.webscripts.list_versions:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.list_versions: %s\n" % e) + print("Exception when calling registry.webscripts.list_versions: %s\n" % e) ``` ### Endpoint @@ -695,7 +709,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected List Webscripts -List the (latest) versions of available webscripts. ### List Latest Webscript Versions By default, the result includes the latest non-deprecated, non-draft version for each webscript name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour: As long as no _version filters_ are used, each listed webscript version item will contain a HAL **link to the latest** _draft_ (`entities[]._links.draft`) or latest _published_ (`entities[]._links.publisned`) version (if existing and different). ### List Latest Webscript Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named webscript that satisfy the filters, but **without links**. ### List All Webscript Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ webscripts versions that satisfy the query, possibly multiple versions per named webscripts. No HAL links are provided. #### Filter on _status_ By default webscript versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the webscript listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft` +List the (latest) versions of available webscripts. ### List Latest Webscript Versions By default, the result includes the latest non-deprecated, non-draft version for each webscript name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour: As long as no version filters are used, each listed webscript version contains representations of the latest draft (`entities[]._links.draft`) or latest published (`entities[]._links.published`) version (if existing and different). Use the query parameter `showRelated` to include only a link (default `showRelated=link`) or a full representation (`showRelated=embed`). ### List Latest Webscript Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named webscript that satisfy the filters, but **without links**. ### List All Webscript Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ webscripts versions that satisfy the query, possibly multiple versions per named webscripts. No HAL links are provided. #### Filter on _status_ By default webscript versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the webscript listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft` ### Example @@ -712,11 +726,12 @@ waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed from waylay.services.registry.models.archive_format import ArchiveFormat from waylay.services.registry.models.latest_webscripts_response_v2 import LatestWebscriptsResponseV2 +from waylay.services.registry.models.show_related_type import ShowRelatedType from waylay.services.registry.models.status_filter import StatusFilter try: # List Webscripts # calls `GET /registry/v2/webscripts/` - api_response = await waylay_client.registry.webscript_functions.list( + api_response = await waylay_client.registry.webscripts.list( # query parameters: query = { 'includeDraft': True @@ -726,12 +741,13 @@ try: 'createdBy': '@me' 'updatedBy': '@me' 'latest': True + 'showRelated': 'embed' }, ) - print("The response of registry.webscript_functions.list:\n") + print("The response of registry.webscripts.list:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.list: %s\n" % e) + print("Exception when calling registry.webscripts.list: %s\n" % e) ``` ### Endpoint @@ -763,6 +779,7 @@ Name | Type | API binding | Description | Notes **query['archiveFormat']** (dict)
**query.archive_format** (Query) | [**List[ArchiveFormat]**](ArchiveFormat.md) | query parameter `"archiveFormat"` | Filter on the archive format of the function. | [optional] **query['runtime']** (dict)
**query.runtime** (Query) | [**List[str]**](str.md) | query parameter `"runtime"` | Filter on the runtime of the function. | [optional] **query['latest']** (dict)
**query.latest** (Query) | **bool** | query parameter `"latest"` | When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. | [optional] +**query['showRelated']** (dict)
**query.show_related** (Query) | [**ShowRelatedType**](.md) | query parameter `"showRelated"` | Sets the representation of related function versions (like the _latest_ draft and/or published) in the response. - `embed`: as full summary representation (in `_embedded`). - `link`: as HAL link in (in `_links`). - `none`: omitted. | [optional] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | ### Return type @@ -816,7 +833,7 @@ from waylay.services.registry.models.get_webscript_response_v2 import GetWebscri try: # Patch Webscript Metadata # calls `PATCH /registry/v2/webscripts/{name}/versions/{version}/metadata` - api_response = await waylay_client.registry.webscript_functions.patch_metadata( + api_response = await waylay_client.registry.webscripts.patch_metadata( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: @@ -825,10 +842,10 @@ try: # json data: use a generated model or a json-serializable python data structure (dict, list) json = waylay.services.registry.FunctionMeta() # FunctionMeta | (optional) ) - print("The response of registry.webscript_functions.patch_metadata:\n") + print("The response of registry.webscripts.patch_metadata:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.patch_metadata: %s\n" % e) + print("Exception when calling registry.webscripts.patch_metadata: %s\n" % e) ``` ### Endpoint @@ -897,19 +914,20 @@ from waylay.services.registry.models.post_webscript_job_sync_response_v2 import try: # Publish Draft Webscript # calls `POST /registry/v2/webscripts/{name}/versions/{version}/publish` - api_response = await waylay_client.registry.webscript_functions.publish( + api_response = await waylay_client.registry.webscripts.publish( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { + 'chown': False 'deprecatePrevious': 'none' 'async': True }, ) - print("The response of registry.webscript_functions.publish:\n") + print("The response of registry.webscripts.publish:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.publish: %s\n" % e) + print("Exception when calling registry.webscripts.publish: %s\n" % e) ``` ### Endpoint @@ -923,7 +941,9 @@ Name | Type | API binding | Description | Notes **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['deprecatePrevious']** (dict)
**query.deprecate_previous** (Query) | [**DeprecatePreviousPolicy**](.md) | query parameter `"deprecatePrevious"` | Set the cleanup policy used to automatically deprecate/delete previous versions. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | @@ -980,23 +1000,23 @@ from waylay.services.registry.models.rebuild_webscript_sync_response_v2 import R try: # Rebuild Webscript # calls `POST /registry/v2/webscripts/{name}/versions/{version}/rebuild` - api_response = await waylay_client.registry.webscript_functions.rebuild( + api_response = await waylay_client.registry.webscripts.rebuild( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { + 'scaleToZero': True 'dryRun': True 'async': True 'upgrade': 'patch' 'ignoreChecks': True - 'scaleToZero': True 'skipRebuild': True }, ) - print("The response of registry.webscript_functions.rebuild:\n") + print("The response of registry.webscripts.rebuild:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.rebuild: %s\n" % e) + print("Exception when calling registry.webscripts.rebuild: %s\n" % e) ``` ### Endpoint @@ -1010,13 +1030,13 @@ Name | Type | API binding | Description | Notes **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. | [optional] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] **query['dryRun']** (dict)
**query.dry_run** (Query) | **bool** | query parameter `"dryRun"` | If set to <code>true</code>, checks whether rebuild jobs are needed, but do not start any jobs. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **query['upgrade']** (dict)
**query.upgrade** (Query) | [**RebuildPolicy**](.md) | query parameter `"upgrade"` | If set, force a rebuild with the given <em>runtime</em> version selection policy. <ul> <li><code>same</code> <b>patch</b> version. This should only include backward compatible upgrades. </li> <li><code>minor</code> <b>major</b> version. This might include an upgrade of e.g. the language runtime and/or provided dependencies that could break compatiblity with the function. .</li> </ul> | [optional] **query['forceVersion']** (dict)
**query.force_version** (Query) | **str** | query parameter `"forceVersion"` | If set, force a rebuild with the given runtime version (including downgrades). This parameter is mutually exclusive to the `upgrade` parameter. | [optional] **query['ignoreChecks']** (dict)
**query.ignore_checks** (Query) | **bool** | query parameter `"ignoreChecks"` | If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option | [optional] -**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command. | [optional] **query['skipRebuild']** (dict)
**query.skip_rebuild** (Query) | **bool** | query parameter `"skipRebuild"` | If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function. | [optional] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | @@ -1071,7 +1091,7 @@ from waylay.services.registry.models.undeployed_response_v2 import UndeployedRes try: # Remove Webscript Version # calls `DELETE /registry/v2/webscripts/{name}/versions/{version}` - api_response = await waylay_client.registry.webscript_functions.remove_version( + api_response = await waylay_client.registry.webscripts.remove_version( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: @@ -1081,10 +1101,10 @@ try: 'undeploy': True }, ) - print("The response of registry.webscript_functions.remove_version:\n") + print("The response of registry.webscripts.remove_version:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.remove_version: %s\n" % e) + print("Exception when calling registry.webscripts.remove_version: %s\n" % e) ``` ### Endpoint @@ -1154,7 +1174,7 @@ from waylay.services.registry.models.undeployed_response_v2 import UndeployedRes try: # Remove Webscript # calls `DELETE /registry/v2/webscripts/{name}` - api_response = await waylay_client.registry.webscript_functions.remove_versions( + api_response = await waylay_client.registry.webscripts.remove_versions( 'name_example', # name | path param "name" # query parameters: query = { @@ -1163,10 +1183,10 @@ try: 'undeploy': True }, ) - print("The response of registry.webscript_functions.remove_versions:\n") + print("The response of registry.webscripts.remove_versions:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.remove_versions: %s\n" % e) + print("Exception when calling registry.webscripts.remove_versions: %s\n" % e) ``` ### Endpoint @@ -1238,14 +1258,16 @@ from waylay.services.registry.models.post_webscript_job_sync_response_v2 import try: # Update Webscript Asset # calls `PUT /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard}` - api_response = await waylay_client.registry.webscript_functions.update_asset( + api_response = await waylay_client.registry.webscripts.update_asset( 'name_example', # name | path param "name" 'version_example', # version | path param "version" 'wildcard_example', # wildcard | path param "wildcard" # query parameters: query = { - 'async': True + 'scaleToZero': False + 'deploy': True 'chown': False + 'async': True }, # non-json binary data: use a byte array or a generator of bytearray chuncks content=b'my-binary-data', @@ -1255,10 +1277,10 @@ try: 'content-type': 'application/octet-stream' }, ) - print("The response of registry.webscript_functions.update_asset:\n") + print("The response of registry.webscripts.update_asset:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.update_asset: %s\n" % e) + print("Exception when calling registry.webscripts.update_asset: %s\n" % e) ``` ### Endpoint @@ -1274,11 +1296,14 @@ Name | Type | API binding | Description | Notes **wildcard** | **str** | path parameter `"wildcard"` | Full path or path prefix of the asset within the archive | **content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | A single asset file. | [optional] **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [default False] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | -**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream` +**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType ### Return type @@ -1290,7 +1315,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - - **Content-Type**: application/octet-stream + - **Content-Type**: Not defined - **Accept**: application/json ### HTTP response details @@ -1299,6 +1324,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected |-------------|-------------|------------------| **201** | Default Response | - | **202** | Default Response | - | +**403** | Default Response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -1313,7 +1339,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected Update Webscript Assets -Update a draft webscript function by updating its assets. The assets for a webscript function can be provided as either The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. +Update a draft webscript function by updating its assets. The assets for a webscript function can be provided as either The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. ### Example @@ -1328,31 +1354,32 @@ from waylay.sdk.api.api_exceptions import ApiError waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed -from waylay.services.registry.models.multipart_file_upload import MultipartFileUpload from waylay.services.registry.models.post_webscript_job_sync_response_v2 import PostWebscriptJobSyncResponseV2 try: # Update Webscript Assets # calls `PUT /registry/v2/webscripts/{name}/versions/{version}/content` - api_response = await waylay_client.registry.webscript_functions.update_assets( + api_response = await waylay_client.registry.webscripts.update_assets( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { - 'async': True + 'scaleToZero': False + 'deploy': True 'chown': False + 'async': True }, # non-json binary data: use a byte array or a generator of bytearray chuncks content=b'my-binary-data', # this operation supports multiple request content types: use `headers` to specify the one used - # alternatives: 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', + # alternatives: 'application/tar', 'application/tar+gzip', 'application/x-gzip', 'application/x-tar', 'application/gzip', 'multipart/form-data', headers = { 'content-type': 'application/octet-stream' }, ) - print("The response of registry.webscript_functions.update_assets:\n") + print("The response of registry.webscripts.update_assets:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.update_assets: %s\n" % e) + print("Exception when calling registry.webscripts.update_assets: %s\n" % e) ``` ### Endpoint @@ -1365,14 +1392,17 @@ Name | Type | API binding | Description | Notes -------- | ----- | ------------- | ------------- | ------------- **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | -**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>webscript</em> function can be provided as either <ul> <li>a single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>separate files in a <code>multipart/form-data</code> request</li> </ul> The provided assets will be added to the <em>webscript</em> function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json</code> json file with a changed value for any of the <code>name</code>, <code>version</code> and/or <code>runtime</code> attributes. For each <em>runtime</em> other files are supported. | [optional] +**content** | **[ContentRequest](Operation.md#req_arg_content)** | binary request body | The assets for a <em>webscript</em> function can be provided as either <ul> <li>a single <em>tar</em> archive (optionally compressed), with one of the content types <code>application/octet-stream</code>, <code>application/tar</code>, <code>application/tar+gzip</code>, <code>application/x-gzip</code>, <code>application/x-tar</code>, <code>application/gzip</code></li> <li>separate files in a <code>multipart/form-data</code> request</li> </ul> The provided assets will be added to the <em>webscript</em> function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json</code> json file with a changed value for any of the <code>name</code>, <code>version</code> and/or <code>runtime</code> attributes. For each <em>runtime</em> other files are supported. | [optional] **files** | **[FileTypes](Operation.md#req_arg_files)** | request body files | | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | +**query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | If set to <code>true</code>, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. | [optional] [default False] +**query['deploy']** (dict)
**query.deploy** (Query) | **bool** | query parameter `"deploy"` | Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. | [optional] [default True] +**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [optional] [default False] **query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] +**query['author']** (dict)
**query.author** (Query) | **str** | query parameter `"author"` | Optionally changes the author metadata when updating a function. | [optional] **query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] -**query['chown']** (dict)
**query.chown** (Query) | **bool** | query parameter `"chown"` | If set, ownership of the draft function is transferred to the current user. | [default False] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | -**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data` +**headers['content-type']** | **str** | content type | request header `"content-type"` | should match mediaType `application/octet-stream`, `application/tar`, `application/tar+gzip`, `application/x-gzip`, `application/x-tar`, `application/gzip`, `multipart/form-data` ### Return type @@ -1384,7 +1414,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected ### HTTP request headers - - **Content-Type**: application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data + - **Content-Type**: application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip, multipart/form-data - **Accept**: application/json ### HTTP response details @@ -1393,6 +1423,7 @@ str | False _(default)_ | **`Any`** | If any other string value for the selected |-------------|-------------|------------------| **201** | Default Response | - | **202** | Default Response | - | +**403** | Default Response | - | [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) @@ -1425,19 +1456,19 @@ from waylay.services.registry.models.verify_webscript_sync_response_v2 import Ve try: # Verify Health Of Webscript # calls `POST /registry/v2/webscripts/{name}/versions/{version}/verify` - api_response = await waylay_client.registry.webscript_functions.verify( + api_response = await waylay_client.registry.webscripts.verify( 'name_example', # name | path param "name" 'version_example', # version | path param "version" # query parameters: query = { - 'async': True 'scaleToZero': True + 'async': True }, ) - print("The response of registry.webscript_functions.verify:\n") + print("The response of registry.webscripts.verify:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.webscript_functions.verify: %s\n" % e) + print("Exception when calling registry.webscripts.verify: %s\n" % e) ``` ### Endpoint @@ -1451,9 +1482,8 @@ Name | Type | API binding | Description | Notes **name** | **str** | path parameter `"name"` | The name of the function. | **version** | **str** | path parameter `"version"` | The version of the function. | **query** | [QueryParamTypes](Operation.md#req_arg_query) \| **None** | URL query parameter | | -**query['comment']** (dict)
**query.comment** (Query) | **str** | query parameter `"comment"` | An optional user-specified comment corresponding to the operation. | [optional] -**query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **query['scaleToZero']** (dict)
**query.scale_to_zero** (Query) | **bool** | query parameter `"scaleToZero"` | Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. | [optional] +**query['async']** (dict)
**query.var_async** (Query) | **bool** | query parameter `"async"` | Unless this is set to <code>false</code>, the server will start the required job actions asynchronously and return a <code>202</code> <em>Accepted</em> response. If <code>false</code> the request will block until the job actions are completed, or a timeout occurs. | [optional] [default True] **headers** | [HeaderTypes](Operation.md#req_headers) | request headers | | ### Return type diff --git a/docs/WithAssetHALLink.md b/docs/WithAssetHALLink.md deleted file mode 100644 index ecf8dc02..00000000 --- a/docs/WithAssetHALLink.md +++ /dev/null @@ -1,29 +0,0 @@ -# WithAssetHALLink - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**links** | [**AssetSummaryWithHALLinkLinks**](AssetSummaryWithHALLinkLinks.md) | | - -## Example - -```python -from waylay.services.registry.models.with_asset_hal_link import WithAssetHALLink - -# TODO update the JSON string below -json = "{}" -# create an instance of WithAssetHALLink from a JSON string -with_asset_hal_link_instance = WithAssetHALLink.from_json(json) -# print the JSON string representation of the object -print WithAssetHALLink.to_json() - -# convert the object into a dict -with_asset_hal_link_dict = with_asset_hal_link_instance.to_dict() -# create an instance of WithAssetHALLink from a dict -with_asset_hal_link_form_dict = with_asset_hal_link.from_dict(with_asset_hal_link_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/WithEntityAttributes.md b/docs/WithEntityAttributes.md deleted file mode 100644 index 929ad635..00000000 --- a/docs/WithEntityAttributes.md +++ /dev/null @@ -1,38 +0,0 @@ -# WithEntityAttributes - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**created_by** | **str** | The user that created this entity. | -**created_at** | **datetime** | The timestamp at which this entity was created. | -**updated_by** | **str** | The user that last updated this entity. | -**updated_at** | **datetime** | The timestamp at which this entity was last updated. | -**updates** | [**List[UpdateRecord]**](UpdateRecord.md) | The audit logs corresponding to the latest modifying operations on this entity. | -**status** | [**Status**](Status.md) | | -**failure_reason** | [**FailureReason**](FailureReason.md) | | [optional] -**runtime** | [**RuntimeAttributes**](RuntimeAttributes.md) | | -**deprecated** | **bool** | If <code>true</code> this function is deprecated and removed from regular listings. | -**draft** | **bool** | If <code>true</code> this function is a draft function and it's assets are still mutable. | - -## Example - -```python -from waylay.services.registry.models.with_entity_attributes import WithEntityAttributes - -# TODO update the JSON string below -json = "{}" -# create an instance of WithEntityAttributes from a JSON string -with_entity_attributes_instance = WithEntityAttributes.from_json(json) -# print the JSON string representation of the object -print WithEntityAttributes.to_json() - -# convert the object into a dict -with_entity_attributes_dict = with_entity_attributes_instance.to_dict() -# create an instance of WithEntityAttributes from a dict -with_entity_attributes_form_dict = with_entity_attributes.from_dict(with_entity_attributes_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/WithLimit.md b/docs/WithLimit.md deleted file mode 100644 index 457421d5..00000000 --- a/docs/WithLimit.md +++ /dev/null @@ -1,29 +0,0 @@ -# WithLimit - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The page size used for this query result. | [optional] - -## Example - -```python -from waylay.services.registry.models.with_limit import WithLimit - -# TODO update the JSON string below -json = "{}" -# create an instance of WithLimit from a JSON string -with_limit_instance = WithLimit.from_json(json) -# print the JSON string representation of the object -print WithLimit.to_json() - -# convert the object into a dict -with_limit_dict = with_limit_instance.to_dict() -# create an instance of WithLimit from a dict -with_limit_form_dict = with_limit.from_dict(with_limit_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/docs/WithPaging.md b/docs/WithPaging.md deleted file mode 100644 index 52268c75..00000000 --- a/docs/WithPaging.md +++ /dev/null @@ -1,31 +0,0 @@ -# WithPaging - - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**limit** | **float** | The page size used for this query result. | [optional] -**count** | **float** | The total count of matching items, from which this result is one page. | -**page** | **float** | The page number of a paged query result. | [optional] - -## Example - -```python -from waylay.services.registry.models.with_paging import WithPaging - -# TODO update the JSON string below -json = "{}" -# create an instance of WithPaging from a JSON string -with_paging_instance = WithPaging.from_json(json) -# print the JSON string representation of the object -print WithPaging.to_json() - -# convert the object into a dict -with_paging_dict = with_paging_instance.to_dict() -# create an instance of WithPaging from a dict -with_paging_form_dict = with_paging.from_dict(with_paging_dict) -``` -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/openapi/registry.openapi.yaml b/openapi/registry.openapi.yaml index 41e4693d..6e7d0021 100644 --- a/openapi/registry.openapi.yaml +++ b/openapi/registry.openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.1.0 info: title: Waylay Function Registry - version: 2.12.4 + version: 2.13.0 x-visibility: stable description: V2 API to build and deploy Waylay functions (plugs, webscripts, BYOML models). @@ -25,17 +25,6 @@ components: '415': description: Unsupported Media Type schemas: - JobReferenceParams: - type: object - properties: - type: - $ref: '#/components/schemas/EJobType' - id: - type: string - required: - - type - - id - additionalProperties: false EJobType: type: string enum: @@ -46,40 +35,7 @@ components: - batch - scale - cleanup - - other - IJobEventsFilterQuery: - type: object - properties: - type: - $ref: '#/components/schemas/EJobType' - description: The type of the job. - id: - type: string - description: The id of the job. - children: - type: boolean - description: If set to true, the event stream will include - events of the job's dependants. E.g., when subscribing to a verify job - with `children=true`, you will also receive the events of the underlying - build and deploy jobs. Defaults to false. - additionalProperties: false - IName: - type: object - properties: - name: - type: string - description: The name of the function. - required: - - name - IFunctionType: - type: object - properties: - functionType: - $ref: '#/components/schemas/EFunctionType' - description: The general type of the function. - required: - - functionType - additionalProperties: false + - notify EFunctionType: type: string enum: @@ -87,18 +43,6 @@ components: - webscripts - kfserving description: Type of functions supported by the registry service. - INameAndVersion: - type: object - properties: - name: - type: string - description: The name of the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The version of the function. - required: - - name - - version SemanticVersion: type: string description: A semantic version with _exactly_ a `major`, `minor` and `patch` @@ -113,71 +57,6 @@ components: - same description: The policy to select a new runtime version when a rebuild is issued. - IRebuildQueryParams: - type: object - properties: - upgrade: - $ref: '#/components/schemas/ERebuildPolicy' - description: If set, force a rebuild with the given runtime version - selection policy. - dryRun: - type: boolean - description: If set to true, checks whether rebuild jobs are - needed, but do not start any jobs. - forceVersion: - $ref: '#/components/schemas/SemanticVersion' - description: If set, force a rebuild with the given runtime version (including - downgrades). This parameter is mutually exclusive to the `upgrade` parameter. - ignoreChecks: - type: boolean - description: 'If set to true, checks that normally prevent a rebuild are - overriden. These checks include: - - * function state in `pending`, `running`, `failed` or `undeployed` - - * backoff period due to recent failures - - * usage of deprecated dependencies - - * running jobs on entity - - * the `dryRun` option' - scaleToZero: - type: boolean - description: Indicates whether the function needs to be scaled down after - successful (re-)deployment. If not set, the function is scaled to zero - only if it was not active before this command. - skipRebuild: - type: boolean - description: If set, the function will not be rebuild. Always uses the current - runtime version when re-deploying/re-verifying the function. - additionalProperties: false - ILimitQuery: - type: object - properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - additionalProperties: false - IPagingQuery: - type: object - properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - additionalProperties: false EStatusInclude: type: string enum: @@ -195,6 +74,15 @@ components: title: Status Inclusion Filter EStatusExclude: type: string + enum: + - registered- + - running- + - pending- + - deployed- + - unhealthy- + - failed- + - undeploying- + - undeployed- description: Any status value with a `-` postfix appended, excludes that status as a filter. examples: @@ -214,27 +102,12 @@ components: - $ref: '#/components/schemas/EStatusAny' description: Inclusion or exclusion filter on the `status` property. title: Status Filter - IFunctionEntityQuery: - type: object - properties: - name: - type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - additionalProperties: false - description: Filter on function attributes that do not change across function - versions. + ShowRelatedType: + type: string + enum: + - embed + - link + - none EArchiveFormat: type: string enum: @@ -245,57 +118,6 @@ components: - native ERuntime: type: string - IFunctionVersionQuery: - type: object - properties: - version: - type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: - type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - additionalProperties: false - description: Filter on function attributes that can change across function versions. - When these query parameters are used, the query is considered a _function - version_ listing and no HAL links to latest (_draft_, _published_) versions - are included. SemanticVersionRange: anyOf: - type: string @@ -342,1811 +164,1009 @@ components: pattern: \d{4}-\d{2}-\d{2}(Z|([+-]\d\d:\d\d))? format: date title: ISO8601 Date - IDeprecatedDraftFilter: + NamedVersion: + type: string + description: A function version reference represented as `@`. + pattern: ^[^@]*@(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$ + EPlugType: + type: string + enum: + - sensor + - actuator + - transformer + TagsFilter: + anyOf: + - type: array + items: + type: string + - type: string + JobTypeSchema: + anyOf: + - $ref: '#/components/schemas/JobTypeBuild' + - $ref: '#/components/schemas/JobTypeDeploy' + - $ref: '#/components/schemas/JobTypeVerify' + - $ref: '#/components/schemas/JobTypeUndeploy' + - $ref: '#/components/schemas/JobTypeScale' + - $ref: '#/components/schemas/JobTypeBatch' + - $ref: '#/components/schemas/JobTypeNotify' + title: Job Type + JobTypeBuild: + type: string + description: Build + title: Build + enum: + - build + JobTypeDeploy: + type: string + description: A job that deploys a function image to the openfaas runtime. + title: Deploy + enum: + - deploy + JobTypeVerify: + type: string + description: A job that checks the health of a deployed function. + title: Verify + enum: + - verify + JobTypeUndeploy: + type: string + description: A job that undeploys a deployed function and removes it from the + registry. + title: Undeploy + enum: + - undeploy + JobTypeScale: + type: string + description: A job that scales a function to a target. + title: Scale + enum: + - scale + JobTypeBatch: + type: string + description: A job that groups other jobs as a parent. + title: Batch + enum: + - batch + JobTypeNotify: + type: string + description: A job to notify that an function version has changed. + title: Notify + enum: + - notify + JobStateResult: + anyOf: + - $ref: '#/components/schemas/JobState' + - $ref: '#/components/schemas/JobStateUnknown' + description: All reported job states + title: Job States + JobState: + anyOf: + - $ref: '#/components/schemas/JobStateFinished' + - $ref: '#/components/schemas/JobStateActive' + - $ref: '#/components/schemas/JobStateDelayed' + - $ref: '#/components/schemas/JobStateWaiting' + - $ref: '#/components/schemas/JobStateWaitingChildren' + description: Allowed job states + title: Job States + JobStateFinished: + anyOf: + - $ref: '#/components/schemas/JobStateCompleted' + - $ref: '#/components/schemas/JobStateFailed' + description: The job completed successfully or with failure. + title: Finished + JobStateCompleted: + type: string + description: The job has completed successfully. + title: Completed + enum: + - completed + JobStateFailed: + type: string + description: The job failed in execution. + title: Failed + enum: + - failed + JobStateActive: + type: string + description: The job is running. + title: Active + enum: + - active + JobStateDelayed: + type: string + description: The job has been delayed for retry after a failure. + title: Delayed + enum: + - delayed + JobStateWaiting: + type: string + description: The job has been queued for execution, but might be waiting because + of rate limiting. + title: Waiting + enum: + - waiting + JobStateWaitingChildren: + type: string + description: The job is waiting for child jobs to be completed. + title: Waiting Children + enum: + - waiting-children + JobStateUnknown: + type: string + description: The job state is unknown (undocument or inconsistent). + title: Unknown + enum: + - unknown + LatestVersionLevel: + type: string + enum: + - major + - minor + - patch + - 'true' + - 'false' + description: Level of latest versions that should be included. + IUpdateMetadataRequestV2: type: object - properties: - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. additionalProperties: false - IDeployAttributesFilter: - type: object properties: - endpoint: + author: type: string - description: Filter on the openfaas endpoint. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of characters). - imageName: + description: The author of the function. + description: type: string - description: Filter on the container image name. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - storageLocation: + description: A description of the function + iconURL: type: string - description: Filter on the storageLocation. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of characters). - additionalProperties: false - IVersionIncludes: - type: object - properties: - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - additionalProperties: false - INamedVersionsFilter: - type: object - properties: - nameVersion: - type: array - items: - $ref: '#/components/schemas/NamedVersion' - description: Filter on exact `{name}@{version}` functions. Using this filter - implies a `latest=false` default, returning multiple versions of the same - named versions if they are filtered. - additionalProperties: false - NamedVersion: - type: string - description: A function reference represented by `name@version`. - pattern: ^.*@(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$ - ILatestFunctionsQuery: - type: object - additionalProperties: false - properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - name: + description: An url to an icon that represents this function. + category: type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: + description: 'A category for this function (Deprecated: use tags to categorise + your functions)' + deprecated: true + documentationURL: + type: string + description: External url that document this function. + tags: type: array items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - description: Request to list latest function versions per named function. A - request that only uses these query parameters will include links to the _latest_ - draft/published versions. - ILatestFunctionVersionsQuery: + $ref: '#/components/schemas/ITag' + description: Tags associated with this function. + examples: + - - name: awaiting-review + color: '#4153ea' + - name: demo + color: '#e639a4' + friendlyName: + type: string + description: Display title for this function. + IFunctionMeta: type: object properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - nameVersion: - type: array - items: - $ref: '#/components/schemas/NamedVersion' - description: Filter on exact `{name}@{version}` functions. Using this filter - implies a `latest=false` default, returning multiple versions of the same - named versions if they are filtered. - version: + author: type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: + description: The author of the function. + description: type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: + description: A description of the function + iconURL: type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - name: + description: An url to an icon that represents this function. + category: type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - latest: - type: boolean - description: When `true`, only the latest version per function name is returned. - If set to `false`, multiple versions per named function can be returned. - Defaults to `true`, except when specific versions are selected with the - `nameVersion` filter. - additionalProperties: false - description: Latest function versions listing query. - INamedFunctionVersionsQuery: + description: 'A category for this function (Deprecated: use tags to categorise + your functions)' + deprecated: true + ITag: type: object - additionalProperties: false properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - version: - type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: + name: type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: + description: Name of the tag + color: type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - description: Named function versions listing query. - IVersionsQuery: + description: Color associated with the tag in an UI. + required: + - name + - color + description: One or more tags can be assigned to a function entity to facilitate + grouping and searching. + DeprecatePreviousPolicy: + type: string + enum: + - none + - all + - patch + - minor + NamedVersionRange: + type: string + description: 'A name reference with optional version range: `[@]`. + + + References (a version range of) a named and versioned entity like _function_ + or _runtime_.' + pattern: ^[^@]*(@.*)?$ + ExampleReference: + type: string + description: 'Example reference. + + + References the example assets from the selected runtime.' + enum: + - '!example' + EAssetRole: + type: string + enum: + - manifest + - project + - main + - lib + - script + - other + description: Classification of assets with regard to their role. + IDocumentationProperty: type: object - additionalProperties: false properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - endpoint: - type: string - description: Filter on the openfaas endpoint. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of characters). - imageName: + name: type: string - description: Filter on the container image name. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - storageLocation: + description: Name of the documented property. + description: type: string - description: Filter on the storageLocation. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of characters). - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - nameVersion: - type: array - items: - $ref: '#/components/schemas/NamedVersion' - description: Filter on exact `{name}@{version}` functions. Using this filter - implies a `latest=false` default, returning multiple versions of the same - named versions if they are filtered. - version: + description: Documentation of the property. + required: + - name + - description + IDocumentation: + type: object + properties: + description: type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: + states: type: array items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: - type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - name: - type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: + $ref: '#/components/schemas/IDocumentationProperty' + description: Documentation of the plug states. + input: type: array items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: + $ref: '#/components/schemas/IDocumentationProperty' + description: Documentation of the plug input parameters. + output: type: array items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - description: Function versions paged query - IPlugTypeQuery: - type: object - properties: - type: - $ref: '#/components/schemas/EPlugType' - description: If set, filters on the type of plug. - additionalProperties: false - EPlugType: + $ref: '#/components/schemas/IDocumentationProperty' + description: Documentation of the plug response parameters. + EPlugPropertyDataType: type: string enum: - - sensor - - actuator - - transformer - ILatestPlugsQuery: - type: object - additionalProperties: false - properties: - type: - $ref: '#/components/schemas/EPlugType' - description: If set, filters on the type of plug. - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - name: - type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - description: Latest plug versions listing query with latest links. A request - that only uses these query parameters will include links to the _latest_ draft/published - versions of the plug. - ILatestPlugVersionsQuery: + - string + - integer + - long + - float + - double + - boolean + - object + description: Datatype supported in plug input or output properties. + EPlugPropertyFormatType: + type: string + enum: + - enum + - resource + - vault + - duration + - code + - url + - date + - template + description: Value domain for a plug input or output property. + EnumValue: + title: An allowed value for the property + DefaultValue: + title: A default value for the property + FunctionDeployOverridesType: type: object - additionalProperties: false properties: - tags: - $ref: '#/components/schemas/TagsFilter' - description: Filter on the tags of the item. Can be a single tag, or a list - of tags. When multiple tags are specified, an item must have all of the - tags to be selected. - type: - $ref: '#/components/schemas/EPlugType' - description: If set, filters on the type of plug. - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - nameVersion: - type: array - items: - $ref: '#/components/schemas/NamedVersion' - description: Filter on exact `{name}@{version}` functions. Using this filter - implies a `latest=false` default, returning multiple versions of the same - named versions if they are filtered. - version: - type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: + envVars: + type: object + additionalProperties: + type: string + labels: + type: object + additionalProperties: + type: string + annotations: + type: object + additionalProperties: + type: string + limits: + $ref: '#/components/schemas/ResourceLimits' + requests: + $ref: '#/components/schemas/ResourceLimits' + ResourceLimits: + type: object + properties: + memory: type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - name: + cpu: type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - latest: - type: boolean - description: When `true`, only the latest version per function name is returned. - If set to `false`, multiple versions per named function can be returned. - Defaults to `true`, except when specific versions are selected with the - `nameVersion` filter. - description: Plug versions listing query. - ITagsQuery: + required: + - memory + - cpu + IRegistryErrorResponse: type: object properties: - tags: - $ref: '#/components/schemas/TagsFilter' - description: Filter on the tags of the item. Can be a single tag, or a list - of tags. When multiple tags are specified, an item must have all of the - tags to be selected. - additionalProperties: false - TagsFilter: - anyOf: - - type: array - items: + error: type: string - - type: string - ITagQuery: + code: + type: string + statusCode: + type: number + data: + type: object + additionalProperties: + type: string + required: + - code + - error + - statusCode + IJobHALLinks: type: object properties: - name: - type: string - description: If set, filters on the name of a tag. Supports - * and ? wildcards and is case-insensitive. + event: + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). examples: - - '*-demo-??' - color: - type: string - description: If set, filters on the color of a tag. Uses an - exact match. + - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. examples: - - '#4153ea' - additionalProperties: false - IFunctionDeleteQuery: + - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + description: HAL links to related actions. + IJobStatusHALLink: type: object properties: - force: - type: boolean - description: 'If true, the function version will be immediately - undeployed and removed. - - - Otherwise, the removal will be delayed to allow current invocations to - end. During that period, the function is marked _deprecated_.' - undeploy: - type: boolean - description: 'If `true`, the `DELETE` operation - - * undeploys the (openfaas) function: it becomes no longer available for - invocation. - - * does NOT remove the function from registry: it stays in an `undeployed` - status. All assets and definitions are retained, so the version can be - restored later with a _rebuild_ action. - - - If `false`, the `DELETE` operation - - * _only_ marks the plug function as _deprecated_, the function remains - active but is removed from the default listings. This also applies to - _draft_ versions. - - - This parameter is incompatible with `force=true`. - - - If not set the default behaviour applies: - - * _draft_ versions are _undeployed_ and _removed_ from registry. - - * non-_draft_ versions are marked _deprecated_ only.' - additionalProperties: false - IPlugDeleteForceQuery: + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + examples: + - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + description: HAL links to related actions. + HALLink: + anyOf: + - $ref: '#/components/schemas/IHALLink' + - type: array + items: + $ref: '#/components/schemas/IHALLink' + description: One or more links of the same HAL collection. + IHALLink: type: object properties: - force: - type: boolean - description: If true, the plug version(s) will be undeployed - and removed. Otherwise, the plug version(s) will only be deprecated, - i.e removed from regular listings. - additionalProperties: false - IPlugDeleteQuery: + href: + type: string + required: + - href + IJobEventsHALLink: type: object properties: - force: - type: boolean - description: If true, the plug version(s) will be undeployed - and removed. Otherwise, the plug version(s) will only be deprecated, - i.e removed from regular listings. - undeploy: - type: boolean - description: 'If `true`, the `DELETE` operation - - * undeploys the (openfaas) function for the plug: it becomes no longer - available for invocation. - - * does NOT remove the plug from registry: it stays in an `undeployed` - status. All assets and definitions are retained, so the plug can be restored - later with a _rebuild_ action. - - - If `false`, the `DELETE` operation - - * _only_ marks the plug version(s) as _deprecated_: the plug remains active - but is removed from the default listings. This also applies to _draft_ - versions. - - - This parameter is incompatible with `force=true`. - - - If not set the default behaviour applies: - - * _draft_ versions are _undeployed_ and _removed_ from registry. - - * non-_draft_ versions are marked _deprecated_ only.' - additionalProperties: false - IAsyncQueryDefaultFalse: + event: + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + examples: + - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + description: HAL links to related actions. + JobCauses: type: object properties: - async: - type: boolean - description: If this is set to true, the server will start - the required job actions asynchronously and return a 202 - Accepted response. Otherwise, the request will block until the - job actions are completed, or a timeout occurs. - default: false - additionalProperties: false - IAsyncQueryDefaultTrue: + build: + $ref: '#/components/schemas/JobCause' + deploy: + $ref: '#/components/schemas/JobCause' + verify: + $ref: '#/components/schemas/JobCause' + undeploy: + $ref: '#/components/schemas/JobCause' + scale: + $ref: '#/components/schemas/JobCause' + description: The motivations for including or excluding a job in response to + a rebuild request. + JobCause: type: object properties: - async: + changed: type: boolean - description: Unless this is set to false, the server will start - the required job actions asynchronously and return a 202 - Accepted response. If false the request will block - until the job actions are completed, or a timeout occurs. - default: true - additionalProperties: false - IAsyncVerifyQuery: - type: object - properties: - comment: + description: If true, the argument configuration for this job + has changed in comparison to the previous job execution. A false + will prevent the job to be run. Use forceVersion or upgrade + parameter to force a rebuild. + reason: type: string - description: An optional user-specified comment corresponding to the operation. - async: - type: boolean - description: Unless this is set to false, the server will start - the required job actions asynchronously and return a 202 - Accepted response. If false the request will block - until the job actions are completed, or a timeout occurs. - default: true - scaleToZero: + description: Human readable message describing the cause. + backoff: type: boolean - description: Indicates whether the function needs to be scaled down after - successful verification. If not set, the function is scaled to zero only - if it was not active before this command. - additionalProperties: false - IUpdateComment: - type: object - properties: - comment: + description: If true, recent failures of the job prevented + the re-execution. Use forceVersion or upgrade + parameter to force a rebuild. + newValue: type: string - description: An optional user-specified comment corresponding to the operation. - IAsyncDeployQuery: - type: object - properties: - deprecatePrevious: - $ref: '#/components/schemas/DeprecatePreviousPolicy' - description: Set the cleanup policy used to automatically deprecate/delete - previous versions. - dryRun: - type: boolean - description: If set to true, validates the deployment conditions, - but does not change anything. - async: - type: boolean - description: Unless this is set to false, the server will start - the required job actions asynchronously and return a 202 - Accepted response. If false the request will block - until the job actions are completed, or a timeout occurs. - default: true - scaleToZero: - type: boolean - description: If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources when - the function is not to be used immediately. - default: false - additionalProperties: false - IDryRunQuery: - type: object - properties: - dryRun: - type: boolean - description: If set to true, validates the deployment conditions, - but does not change anything. - additionalProperties: false - IDeprecatePreviousQuery: + description: The new configuration value that causes the change. + oldValue: + type: string + description: The old configuration value used by the last succeeded job. + required: + - changed + - reason + description: The motivation for including or excluding a job (build, + deploy, verify, ...) in response to a rebuild request. + IRootPageResponse: type: object properties: - deprecatePrevious: - $ref: '#/components/schemas/DeprecatePreviousPolicy' - description: Set the cleanup policy used to automatically deprecate/delete - previous versions. - additionalProperties: false - DeprecatePreviousPolicy: - type: string - enum: - - none - - all - - patch - - minor - IJobQuery: - type: object - properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - type: - type: array - items: - $ref: '#/components/schemas/JobTypeSchema' - description: Filter on job type - state: - type: array - items: - $ref: '#/components/schemas/JobStateResult' - description: Filter on job state - functionType: - type: array - items: - $ref: '#/components/schemas/EFunctionType' - description: Filter on function type - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on jobs that created before the given timestamp or age - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on jobs that created after the given timestamp or age - additionalProperties: false - JobTypeSchema: - anyOf: - - $ref: '#/components/schemas/JobTypeBuild' - - $ref: '#/components/schemas/JobTypeDeploy' - - $ref: '#/components/schemas/JobTypeVerify' - - $ref: '#/components/schemas/JobTypeUndeploy' - - $ref: '#/components/schemas/JobTypeScale' - - $ref: '#/components/schemas/JobTypeBatch' - title: Job Type - JobTypeBuild: - type: string - description: Build - title: Build - enum: - - build - JobTypeDeploy: - type: string - description: A job that deploys a function image to the openfaas runtime. - title: Deploy - enum: - - deploy - JobTypeVerify: - type: string - description: A job that checks the health of a deployed function. - title: Verify - enum: - - verify - JobTypeUndeploy: - type: string - description: A job that undeploys a deployed function and removes it from the - registry. - title: Undeploy - enum: - - undeploy - JobTypeScale: - type: string - description: A job that scales a function to a target. - title: Scale - enum: - - scale - JobTypeBatch: - type: string - description: A job that groups other jobs as a parent. - title: Batch - enum: - - batch - JobStateResult: - anyOf: - - $ref: '#/components/schemas/JobState' - - $ref: '#/components/schemas/JobStateUnknown' - description: All reported job states - title: Job States - JobState: - anyOf: - - $ref: '#/components/schemas/JobStateFinished' - - $ref: '#/components/schemas/JobStateActive' - - $ref: '#/components/schemas/JobStateDelayed' - - $ref: '#/components/schemas/JobStateWaiting' - - $ref: '#/components/schemas/JobStateWaitingChildren' - description: Allowed job states - title: Job States - JobStateFinished: - anyOf: - - $ref: '#/components/schemas/JobStateCompleted' - - $ref: '#/components/schemas/JobStateFailed' - description: The job completed successfully or with failure. - title: Finished - JobStateCompleted: - type: string - description: The job has completed successfully. - title: Completed - enum: - - completed - JobStateFailed: - type: string - description: The job failed in execution. - title: Failed - enum: - - failed - JobStateActive: - type: string - description: The job is running. - title: Active - enum: - - active - JobStateDelayed: - type: string - description: The job has been delayed for retry after a failure. - title: Delayed - enum: - - delayed - JobStateWaiting: - type: string - description: The job has been queued for execution, but might be waiting because - of rate limiting. - title: Waiting - enum: - - waiting - JobStateWaitingChildren: - type: string - description: The job is waiting for child jobs to be completed. - title: Waiting Children - enum: - - waiting-children - JobStateUnknown: + name: + type: string + description: Name of the service. + version: + $ref: '#/components/schemas/SemanticVersion' + description: Semantic version of the service. + enabled: + type: object + description: Description of the features enabled on this service deployment. + revision: + type: string + description: Revision of the service source code. + required: + - name + - version + - enabled + - revision + description: Status Page + PlugHtmlResponse: type: string - description: The job state is unknown (undocument or inconsistent). - title: Unknown - enum: - - unknown - IRuntimeNameQuery: + description: Successful Response + IRuntimeSummary: type: object properties: name: + $ref: '#/components/schemas/ERuntime' + title: + type: string + description: type: string - description: If set, filters on the name of a runtime. Supports - * and ? wildcards and is case-insensitive. - examples: - - node* functionType: - type: array - items: - $ref: '#/components/schemas/EFunctionType' - description: If set, filters on the functionType of a runtime. - Uses an exact match. - examples: - - plugs + $ref: '#/components/schemas/EFunctionType' archiveFormat: + $ref: '#/components/schemas/EArchiveFormat' + versions: type: array items: - $ref: '#/components/schemas/EArchiveFormat' - description: If set, filters on the archiveFormat of a runtime. - Uses an exact match. - examples: - - node - additionalProperties: false - IRuntimeVersionQuery: + $ref: '#/components/schemas/IRuntimeVersionInfo' + required: + - archiveFormat + - functionType + - name + - title + - versions + description: A summary representation of the runtime, and (selected) versions + of it. + IRuntimeVersionInfo: type: object properties: - version: - $ref: '#/components/schemas/SemanticVersionRange' - description: If set, filters on the version of a runtime. Supports - [version ranges](https://devhints.io/semver). - default: '*' - latest: - $ref: '#/components/schemas/LatestVersionLevel' - description: 'If set, filters on the level of latest versions that will - be included in the query. - - * `major`: include at most one latest version per name and major release. - - * `minor`: include at most one latest version per name and minor release. - - * `patch`: include each matching patch version. - - * `true`: include the latest matching version. - - * `false`: include any matching version (same as `patch`). - - - This filter is applied after all other selection criteria.' - examples: - - minor - default: minor - includeDeprecated: + deprecated: type: boolean - description: If set to `true`, deprecated runtimes will be included in the - query. - default: false - additionalProperties: false - LatestVersionLevel: - type: string - enum: - - major - - minor - - patch - - 'true' - - 'false' - description: Level of latest versions that should be included. - IRuntimeQuery: - type: object - additionalProperties: false - properties: - version: - $ref: '#/components/schemas/SemanticVersionRange' - description: If set, filters on the version of a runtime. Supports - [version ranges](https://devhints.io/semver). - default: '*' - latest: - $ref: '#/components/schemas/LatestVersionLevel' - description: 'If set, filters on the level of latest versions that will - be included in the query. - - * `major`: include at most one latest version per name and major release. - - * `minor`: include at most one latest version per name and minor release. - - * `patch`: include each matching patch version. - - * `true`: include the latest matching version. - - * `false`: include any matching version (same as `patch`). - - - This filter is applied after all other selection criteria.' - examples: - - minor - default: minor - includeDeprecated: + description: If true, the function uses a deprecated runtime. + upgradable: type: boolean - description: If set to `true`, deprecated runtimes will be included in the - query. - default: false - name: + description: If true, a newer runtime for this function is available using + the `rebuild` API. + version: + $ref: '#/components/schemas/SemanticVersion' + title: type: string - description: If set, filters on the name of a runtime. Supports - * and ? wildcards and is case-insensitive. - examples: - - node* - functionType: - type: array - items: - $ref: '#/components/schemas/EFunctionType' - description: If set, filters on the functionType of a runtime. - Uses an exact match. - examples: - - plugs - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: If set, filters on the archiveFormat of a runtime. - Uses an exact match. - examples: - - node - IGetRuntimeByNameQuery: + description: + type: string + required: + - deprecated + - title + - upgradable + - version + description: A summary of a selected version for a runtime + IRuntimeSummaryResponse: type: object - additionalProperties: false properties: - version: - $ref: '#/components/schemas/SemanticVersionRange' - description: If set, filters on the version of a runtime. Supports - [version ranges](https://devhints.io/semver). - default: '*' - includeDeprecated: - type: boolean - description: If set to `true`, deprecated runtimes will be included in the - query. - default: false - functionType: - type: array - items: - $ref: '#/components/schemas/EFunctionType' - description: If set, filters on the functionType of a runtime. - Uses an exact match. - examples: - - plugs - archiveFormat: + runtimes: type: array items: - $ref: '#/components/schemas/EArchiveFormat' - description: If set, filters on the archiveFormat of a runtime. - Uses an exact match. - examples: - - node - IGetRuntimeVersionsQuery: + $ref: '#/components/schemas/IRuntimeSummary' + required: + - runtimes + description: Runtimes Found + IRuntimeVersionResponse: type: object - additionalProperties: false properties: - version: - $ref: '#/components/schemas/SemanticVersionRange' - description: If set, filters on the version of a runtime. Supports - [version ranges](https://devhints.io/semver). - default: '*' - latest: - $ref: '#/components/schemas/LatestVersionLevel' - description: 'If set, filters on the level of latest versions that will - be included in the query. - - * `major`: include at most one latest version per name and major release. - - * `minor`: include at most one latest version per name and minor release. - - * `patch`: include each matching patch version. - - * `true`: include the latest matching version. - - * `false`: include any matching version (same as `patch`). - - - This filter is applied after all other selection criteria.' - examples: - - minor - default: minor - includeDeprecated: + runtime: + $ref: '#/components/schemas/CompiledRuntimeVersion' + required: + - runtime + description: ': Runtime Version Found' + CompiledRuntimeVersion: + type: object + properties: + deprecated: type: boolean - description: If set to `true`, deprecated runtimes will be included in the - query. - default: false + description: If true, this runtime should no longer be used for new functions. + upgradable: + type: boolean + description: If true, a newer runtime for this function is available using + the `rebuild` API. + name: + type: string functionType: - type: array - items: - $ref: '#/components/schemas/EFunctionType' - description: If set, filters on the functionType of a runtime. - Uses an exact match. - examples: - - plugs + $ref: '#/components/schemas/EFunctionType' archiveFormat: + $ref: '#/components/schemas/EArchiveFormat' + build: + $ref: '#/components/schemas/BuildSpec' + deploy: + $ref: '#/components/schemas/DeploySpec' + language: + $ref: '#/components/schemas/LanguageRelease' + description: Description of the language release + providedDependencies: type: array items: - $ref: '#/components/schemas/EArchiveFormat' - description: If set, filters on the archiveFormat of a runtime. - Uses an exact match. - examples: - - node - IGetRuntimeByNameAndVersionQuery: - type: object - properties: - includeDeprecated: - type: boolean - description: If set to `true`, deprecated runtimes will be included in the - query. - default: true - additionalProperties: false - IGetRuntimeExampleQuery: - type: object - additionalProperties: false - properties: - ls: - type: boolean - description: If set to `true`, the result will be a listing of the files - in the asset, annotated with metadata and validation report from the asset - conditions of the functions runtime. - default: false - includeDeprecated: - type: boolean - description: If set to `true`, deprecated runtimes will be included in the - query. - default: true - IContentQueryV2: + $ref: '#/components/schemas/ProvidedDependency' + description: Description of dependencies provided by this runtime version. + assets: + $ref: '#/components/schemas/AssetsConditions' + description: Restrictions on the assets in the function archive. + title: + type: string + description: + type: string + version: + $ref: '#/components/schemas/SemanticVersion' + required: + - archiveFormat + - deprecated + - functionType + - name + - title + - upgradable + - version + description: Compiled build and deployment information for a runtime version. + Contains all defaults applied on the _global_, _functionType_, _archiveFormat_, + _runtime_ and _runtime version_ level. + BuildSpec: type: object properties: - ls: - type: boolean - description: If set to `true`, the result will be a listing of the files - in the asset, annotated with metadata and validation report from the asset - conditions of the functions runtime. - default: false - additionalProperties: false - IRuntimeParams: + context: + type: string + args: + type: object + additionalProperties: + type: string + required: + - context + - args + DeploySpec: type: object properties: - name: - $ref: '#/components/schemas/ERuntime' - description: The name of a runtime - required: - - name - additionalProperties: false - IRuntimeVersionParams: + openfaasSpec: + type: object + properties: + service: + type: string + image: + type: string + namespace: + type: string + envProcess: + type: string + network: + type: string + envVars: + type: object + additionalProperties: + type: string + constraints: + type: array + items: + type: string + labels: + type: object + additionalProperties: + type: string + annotations: + type: object + additionalProperties: + type: string + secrets: + type: array + items: + type: string + registryAuth: + type: string + limits: + $ref: '#/components/schemas/ResourceLimits' + requests: + $ref: '#/components/schemas/ResourceLimits' + readOnlyRootFilesystem: + type: boolean + description: If specified, it overrides the properties in `default`. Non-specified + properties are taken from `default` + LanguageRelease: type: object properties: name: - $ref: '#/components/schemas/ERuntime' - description: The name of a runtime + type: string + description: Short technical name of the language or framework used. version: - $ref: '#/components/schemas/SemanticVersionRange' - description: A version range for a runtime + type: string + description: Release version of the language or framework. + title: + type: string + description: Display title. + description: + type: string required: - name - version - additionalProperties: false - IRuntimeVersionAndPathParams: + - title + description: Description of the language or framework release used by a runtime + (version). + ProvidedDependency: type: object - additionalProperties: false properties: - '*': - type: string - description: Full path or path prefix of the asset within the archive name: - $ref: '#/components/schemas/ERuntime' - description: The name of a runtime + type: string + description: Name of a provided dependency. + title: + type: string + description: Optional display title. + description: + type: string + description: Optional description. version: - $ref: '#/components/schemas/SemanticVersionRange' - description: A version range for a runtime - required: - - '*' - - name - - version - IAssetPathParamsV2: - type: object - properties: - '*': type: string - description: Full path or path prefix of the asset within the archive - required: - - '*' - additionalProperties: false - ILatestPlugVersionsQueryV2: - anyOf: - - $ref: '#/components/schemas/ILatestPlugVersionsQuery' - - $ref: '#/components/schemas/ILatestPlugsQuery' - description: Latest plug versions listing query. - ILatestPlugVersionQueryV2: - type: object - additionalProperties: false - properties: - type: - $ref: '#/components/schemas/EPlugType' - description: If set, filters on the type of plug. - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - description: Latest named plug version listing query - INamedPlugVersionsQueryV2: - type: object - additionalProperties: false - properties: - tags: - $ref: '#/components/schemas/TagsFilter' - description: Filter on the tags of the item. Can be a single tag, or a list - of tags. When multiple tags are specified, an item must have all of the - tags to be selected. - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 + description: Versions specification of a provided dependency deprecated: type: boolean - description: Filter on the deprecation status of the function. - draft: + description: If true, this provided dependency is scheduled for removal + (or incompatible upgrade) in a next runtime version. + default: false + removed: type: boolean - description: Filter on the draft status of the function. - version: - type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: + description: If true, this dependency has been removed from the runtime + (version) + default: false + globals: type: array items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: - type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - archiveFormat: + type: string + description: Global variables that expose this library to the user code. + As the usage of these globals is deprecated, any usage of such global + will pose issues in an next runtime version. + native: + type: boolean + description: 'If true, the library is provided natively by the runtime: + e.g. node for javascript.' + required: + - name + description: Library dependency that is provided by this runtime. + AssetsConditions: + type: object + properties: + conditions: type: array items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - description: Named plug version listing query - IKFServingLatestVersionsQueryV2: - anyOf: - - $ref: '#/components/schemas/ILatestFunctionVersionsQuery' - - $ref: '#/components/schemas/ILatestFunctionsQuery' - description: Latest model versions listing query. - IKFServingLatestVersionQueryV2: - type: object - additionalProperties: false - properties: - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - description: Named Model latest version query. - INamedKFServingVersionsQueryV2: + $ref: '#/components/schemas/AssetCondition' + description: All files in a function archive are checked against these conditions. + A file that is not matched is ignored. + maxSize: + type: string + description: The maximum size of the archive (in bytes, unless unit is provided) + description: Describes the assets that are required/allowed/supported for a + function. + AssetCondition: type: object - additionalProperties: false properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - version: + title: type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: + description: type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. + role: + $ref: '#/components/schemas/EAssetRole' + description: Role in the function deployment + pattern: + anyOf: + - type: string + - type: array + items: + type: string + description: Pattern that selects a file in a function archive + contentType: + anyOf: + - type: string + - type: array + items: + type: string + description: Allowed content type(s) of matching files. + min: + type: number + description: The minimal number of files that must match this pattern. Use + `0` for an optional file. examples: - - '@me' - updatedBy: - type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. + - 0 + max: + type: number + description: The maximal number of files that can match this pattern. Use + `0` for a disallowed file. This condition only raises an error if there + are no other conditions that examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - description: Named Model versions query. - IKFServingDeleteQueryV2: - type: object - additionalProperties: false - properties: - comment: + - 1 + maxSize: type: string - description: An optional user-specified comment corresponding to the operation. - force: - type: boolean - description: 'If true, the function version will be immediately - undeployed and removed. - - - Otherwise, the removal will be delayed to allow current invocations to - end. During that period, the function is marked _deprecated_.' - undeploy: - type: boolean - description: 'If `true`, the `DELETE` operation - - * undeploys the (openfaas) function: it becomes no longer available for - invocation. - - * does NOT remove the function from registry: it stays in an `undeployed` - status. All assets and definitions are retained, so the version can be - restored later with a _rebuild_ action. - - - If `false`, the `DELETE` operation - - * _only_ marks the plug function as _deprecated_, the function remains - active but is removed from the default listings. This also applies to - _draft_ versions. - - - This parameter is incompatible with `force=true`. - - - If not set the default behaviour applies: - - * _draft_ versions are _undeployed_ and _removed_ from registry. - - * non-_draft_ versions are marked _deprecated_ only.' - async: - type: boolean - description: Unless this is set to false, the server will start - the required job actions asynchronously and return a 202 - Accepted response. If false the request will block - until the job actions are completed, or a timeout occurs. - default: true - IVersionsQueryV2: + description: The maximum size for each file matching this pattern (in bytes, + unless unit is provided) + schema: + description: The json schema validator that applies (in case of `application/json` + entries). + required: + - role + - pattern + description: Describes conditions on the set of files that match a file pattern. + IPlugResponseV2: type: object - additionalProperties: false properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - endpoint: - type: string - description: Filter on the openfaas endpoint. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of characters). - imageName: - type: string - description: Filter on the container image name. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - storageLocation: - type: string - description: Filter on the storageLocation. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of characters). - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - nameVersion: - type: array - items: - $ref: '#/components/schemas/NamedVersion' - description: Filter on exact `{name}@{version}` functions. Using this filter - implies a `latest=false` default, returning multiple versions of the same - named versions if they are filtered. - version: - type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. createdBy: type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' + description: The user that created this entity. + createdAt: + type: string + format: date-time + description: The timestamp at which this entity was created. updatedBy: type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - name: + description: The user that last updated this entity. + updatedAt: type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: + format: date-time + description: The timestamp at which this entity was last updated. + updates: type: array items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. + $ref: '#/components/schemas/IUpdateRecord' + description: The audit logs corresponding to the latest modifying operations + on this entity. + status: + $ref: '#/components/schemas/EStatus' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function + entity. runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - description: Function versions paged query - IWebscriptLatestVersionsQueryV2: - anyOf: - - $ref: '#/components/schemas/ILatestFunctionVersionsQuery' - - $ref: '#/components/schemas/ILatestFunctionsQuery' - description: Webscript lastest versions listing query. - IWebscriptLatestVersionQueryV2: - type: object - additionalProperties: false - properties: - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - description: Webscript latest named version query. - INamedWebscriptVersionsQueryV2: - type: object - additionalProperties: false - properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 + $ref: '#/components/schemas/IRuntimeAttributes' + description: Information about the current runtime used by this function + deployment. deprecated: type: boolean - description: Filter on the deprecation status of the function. + description: If true this plug is removed from regular listings, + as a result of a DELETE with force=false. draft: type: boolean - description: Filter on the draft status of the function. - version: - type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: - type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - description: Webscript named versions listing query. - IRebuildQueryV2: - type: object - properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - dryRun: - type: boolean - description: If set to true, checks whether rebuild jobs are - needed, but do not start any jobs. - async: - type: boolean - description: Unless this is set to false, the server will start - the required job actions asynchronously and return a 202 - Accepted response. If false the request will block - until the job actions are completed, or a timeout occurs. - default: true - upgrade: - $ref: '#/components/schemas/ERebuildPolicy' - description: If set, force a rebuild with the given runtime version - selection policy.
  • same patch version. This - should only include backward compatible upgrades.
  • minor - major version. This might include an upgrade of e.g. the language - runtime and/or provided dependencies that could break compatiblity with - the function. .
- forceVersion: - $ref: '#/components/schemas/SemanticVersion' - description: If set, force a rebuild with the given runtime version (including - downgrades). This parameter is mutually exclusive to the `upgrade` parameter. - ignoreChecks: - type: boolean - description: 'If set to true, checks that normally prevent a rebuild are - overriden. These checks include: - - * function state in `pending`, `running`, `failed` or `undeployed` - - * backoff period due to recent failures - - * usage of deprecated dependencies - - * running jobs on entity - - * the `dryRun` option' - scaleToZero: - type: boolean - description: Indicates whether the function needs to be scaled down after - successful (re-)deployment. If not set, the function is scaled to zero - only if it was not active before this command. - skipRebuild: - type: boolean - description: If set, the function will not be rebuild. Always uses the current - runtime version when re-deploying/re-verifying the function. - additionalProperties: false - IRemovePlugQueryV2: + description: If true this function is a draft function and + it's assets are still mutable. + plug: + $ref: '#/components/schemas/IPlugManifest' + description: The plug specification as provided by the plug.json + asset. + required: + - createdAt + - createdBy + - deprecated + - draft + - plug + - runtime + - status + - updatedAt + - updatedBy + - updates + IUpdateRecord: type: object - additionalProperties: false properties: comment: type: string description: An optional user-specified comment corresponding to the operation. - async: - type: boolean - description: Unless this is set to false, the server will start - the required job actions asynchronously and return a 202 - Accepted response. If false the request will block - until the job actions are completed, or a timeout occurs. - default: true - force: - type: boolean - description: If true, the plug version(s) will be undeployed - and removed. Otherwise, the plug version(s) will only be deprecated, - i.e removed from regular listings. - undeploy: - type: boolean - description: 'If `true`, the `DELETE` operation - - * undeploys the (openfaas) function for the plug: it becomes no longer - available for invocation. - - * does NOT remove the plug from registry: it stays in an `undeployed` - status. All assets and definitions are retained, so the plug can be restored - later with a _rebuild_ action. - - - If `false`, the `DELETE` operation - - * _only_ marks the plug version(s) as _deprecated_: the plug remains active - but is removed from the default listings. This also applies to _draft_ - versions. - - - This parameter is incompatible with `force=true`. - - - If not set the default behaviour applies: - - * _draft_ versions are _undeployed_ and _removed_ from registry. - - * non-_draft_ versions are marked _deprecated_ only.' - IRemoveFunctionQueryV2: + operation: + $ref: '#/components/schemas/ERequestOperation' + description: The type of modifying operation. + jobs: + type: array + items: + type: string + description: The job id's of the corresponding jobs, if applicable. + at: + type: string + format: date-time + by: + type: string + description: The user that initiated this operation. + required: + - at + - by + - operation + description: An update report corresponding to a modifying operation initiated + by a user/administrator on the entity. + ERequestOperation: + type: string + enum: + - create + - metadata-update + - assets-update + - rebuild + - verify + - publish + - deprecate + - undeploy + description: A modifying operation on the function. + EStatus: + type: string + enum: + - registered + - running + - pending + - deployed + - unhealthy + - killed + - failed + - undeploying + - undeployed + description: Status for a deployed function. + FailureReason: + anyOf: + - $ref: '#/components/schemas/IFailureReason' + - type: string + IFailureReason: type: object - additionalProperties: false properties: - comment: + log: + type: array + items: + type: string + description: Log lines associated with this failure. + events: + type: array + items: + type: string + description: Events associated with this failure. + cause: type: string - description: An optional user-specified comment corresponding to the operation. - async: - type: boolean - description: Unless this is set to false, the server will start - the required job actions asynchronously and return a 202 - Accepted response. If false the request will block - until the job actions are completed, or a timeout occurs. - default: true - force: + description: Main cause for the failure. + required: + - log + - events + IRuntimeAttributes: + type: object + properties: + deprecated: type: boolean - description: 'If true, the function version will be immediately - undeployed and removed. - - - Otherwise, the removal will be delayed to allow current invocations to - end. During that period, the function is marked _deprecated_.' - undeploy: + description: If true, the function uses a deprecated runtime. + upgradable: type: boolean - description: 'If `true`, the `DELETE` operation - - * undeploys the (openfaas) function: it becomes no longer available for - invocation. - - * does NOT remove the function from registry: it stays in an `undeployed` - status. All assets and definitions are retained, so the version can be - restored later with a _rebuild_ action. - - - If `false`, the `DELETE` operation - - * _only_ marks the plug function as _deprecated_, the function remains - active but is removed from the default listings. This also applies to - _draft_ versions. - - - This parameter is incompatible with `force=true`. - - - If not set the default behaviour applies: - - * _draft_ versions are _undeployed_ and _removed_ from registry. - - * non-_draft_ versions are marked _deprecated_ only.' - IUpdateMetadataRequestV2: + description: If true, a newer runtime for this function is available using + the `rebuild` API. + name: + $ref: '#/components/schemas/ERuntime' + description: The name of a runtime + version: + $ref: '#/components/schemas/SemanticVersion' + description: The version of a runtime + required: + - deprecated + - name + - upgradable + - version + IPlugManifest: type: object - additionalProperties: false properties: - author: - type: string - description: The author of the function. - description: - type: string - description: A description of the function - iconURL: - type: string - description: An url to an icon that represents this function. - category: + deploy: + $ref: '#/components/schemas/FunctionDeployOverridesType' + description: Deployment overrides of the function. + name: type: string - description: 'A category for this function (Deprecated: use tags to categorise - your functions)' - deprecated: true - documentationURL: + description: The logical name for the function. + version: + $ref: '#/components/schemas/SemanticVersion' + description: The semantic version of the function. + runtime: + $ref: '#/components/schemas/ERuntime' + description: The runtime that specifies how this function should be built + and deployed. This could be overridden or modified on initial deployment + or later rebuild. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersionRange' + description: An optional runtime version constraint for deployment of the + function. When not set, the latest runtime version is used for build and + deployment. When set, the latest available patch version with + the same minor version is used. Note that, after deployment, + this runtime version can become obsolete with a rebuild action. + metadata: + $ref: '#/components/schemas/IPlugMeta' + description: Metadata describing the function. Note that, after deployment, + this metadata can be patched for the deployed plug, as long it does not + affect the runtime behaviour. + type: + $ref: '#/components/schemas/EPlugType' + description: Type of the plug. + interface: + $ref: '#/components/schemas/IPlugInterface' + description: Description of the user interface of the plug, as visible to + end-users when configuring plug nodes in the rule engine. + required: + - interface + - metadata + - name + - runtime + - type + - version + IPlugInterface: + type: object + properties: + states: + type: array + items: + type: string + description: The states of a plug as implemented in the plug code. + input: + type: array + items: + $ref: '#/components/schemas/IPlugProperty' + description: The named input parameters of a plug + output: + type: array + items: + $ref: '#/components/schemas/IPlugProperty' + description: The named output parameters of a plug + IPlugProperty: + type: object + properties: + name: type: string - description: External url that document this function. - tags: + description: The name of a plug input or output property. + dataType: + $ref: '#/components/schemas/EPlugPropertyDataType' + description: The datatype of the property + mandatory: + type: boolean + description: If true this property is required. + examples: + - true + format: + $ref: '#/components/schemas/IPlugPropertyFormat' + description: If present, refines the value domain of the property. + defaultValue: + $ref: '#/components/schemas/DefaultValue' + description: Default value assumed to be used when no value is given. + required: + - name + description: Interface specification of a plug property. + IPlugPropertyFormat: + type: object + properties: + type: + $ref: '#/components/schemas/EPlugPropertyFormatType' + description: The value domain type for a plug property. + examples: + - enum + values: type: array items: - $ref: '#/components/schemas/ITag' - description: Tags associated with this function. + $ref: '#/components/schemas/EnumValue' + description: The enumerated value domain when type="enum" examples: - - - name: awaiting-review - color: '#4153ea' - - name: demo - color: '#e639a4' - friendlyName: - type: string - description: Display title for this function. - IUserPlugMeta: + - - low + - high + IPlugMeta: type: object properties: author: @@ -2179,2107 +1199,1597 @@ components: friendlyName: type: string description: Display title for this function. - description: Plug metadata that the user can update as `metadata` - IFunctionMeta: + documentation: + $ref: '#/components/schemas/IDocumentation' + description: Documentation of the plug interface. + IKfservingResponseV2: type: object properties: - author: + createdBy: type: string - description: The author of the function. - description: + description: The user that created this entity. + createdAt: type: string - description: A description of the function - iconURL: + format: date-time + description: The timestamp at which this entity was created. + updatedBy: type: string - description: An url to an icon that represents this function. - category: - type: string - description: 'A category for this function (Deprecated: use tags to categorise - your functions)' - deprecated: true - ITag: - type: object - properties: - name: - type: string - description: Name of the tag - color: + description: The user that last updated this entity. + updatedAt: type: string - description: Color associated with the tag in an UI. + format: date-time + description: The timestamp at which this entity was last updated. + updates: + type: array + items: + $ref: '#/components/schemas/IUpdateRecord' + description: The audit logs corresponding to the latest modifying operations + on this entity. + status: + $ref: '#/components/schemas/EStatus' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function + entity. + runtime: + $ref: '#/components/schemas/IRuntimeAttributes' + description: Information about the current runtime used by this function + deployment. + deprecated: + type: boolean + description: If true this function is deprecated and removed + from regular listings. + draft: + type: boolean + description: If true this function is a draft function and + it's assets are still mutable. + model: + $ref: '#/components/schemas/IKFServingManifest' + description: The model specification as provided by the model.json + asset. required: - - name - - color - description: One or more tags can be assigned to a function entity to facilitate - grouping and searching. - IGetContentParamsV2: + - createdAt + - createdBy + - deprecated + - draft + - model + - runtime + - status + - updatedAt + - updatedBy + - updates + IKFServingManifest: type: object - additionalProperties: false properties: - '*': - type: string - description: Full path or path prefix of the asset within the archive + deploy: + $ref: '#/components/schemas/FunctionDeployOverridesType' + description: Deployment overrides of the function. name: type: string - description: The name of the function. + description: The logical name for the function. version: $ref: '#/components/schemas/SemanticVersion' - description: The version of the function. + description: The semantic version of the function. + runtime: + $ref: '#/components/schemas/ERuntime' + description: The runtime that specifies how this function should be built + and deployed. This could be overridden or modified on initial deployment + or later rebuild. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersionRange' + description: An optional runtime version constraint for deployment of the + function. When not set, the latest runtime version is used for build and + deployment. When set, the latest available patch version with + the same minor version is used. Note that, after deployment, + this runtime version can become obsolete with a rebuild action. + metadata: + $ref: '#/components/schemas/IFunctionMeta' + description: Metadata describing the function. Note that, after deployment, + this metadata can be updated for the deployed function, without affecting + the runtime behaviour of the function itself. required: - - '*' + - metadata - name + - runtime - version - IGetInvokableWebscriptQuery: + IWebscriptResponseV2: type: object properties: - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - version: - $ref: '#/components/schemas/SemanticVersionRange' - description: If set, filters on the `version` of the webscript. Supports - [version ranges](https://devhints.io/semver) - status: + createdBy: + type: string + description: The user that created this entity. + createdAt: + type: string + format: date-time + description: The timestamp at which this entity was created. + updatedBy: + type: string + description: The user that last updated this entity. + updatedAt: + type: string + format: date-time + description: The timestamp at which this entity was last updated. + updates: type: array items: - $ref: '#/components/schemas/EStatusFilter' - description: If set, filters on the `status` of the webscript. - default: - - running - - deployed - - unhealthy - additionalProperties: false - ICreateFunctionQueryV2: - type: object - properties: - deprecatePrevious: - $ref: '#/components/schemas/DeprecatePreviousPolicy' - description: Set the cleanup policy used to automatically deprecate/delete - previous versions. - dryRun: - type: boolean - description: If set to true, validates the deployment conditions, - but does not change anything. - async: - type: boolean - description: Unless this is set to false, the server will start - the required job actions asynchronously and return a 202 - Accepted response. If false the request will block - until the job actions are completed, or a timeout occurs. - default: true - scaleToZero: + $ref: '#/components/schemas/IUpdateRecord' + description: The audit logs corresponding to the latest modifying operations + on this entity. + status: + $ref: '#/components/schemas/EStatus' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function + entity. + runtime: + $ref: '#/components/schemas/IRuntimeAttributes' + description: Information about the current runtime used by this function + deployment. + deprecated: type: boolean - description: If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources when - the function is not to be used immediately. - default: false - version: - $ref: '#/components/schemas/SemanticVersionRange' - description: If set, the function version will be an increment of the latest - existing version that satisfies the `version` range. Note that this increment - always takes precedence over an explicit `version` in the function manifest. - name: - type: string - description: If set, the value will be used as the function name instead - of the one specified in the manifest. + description: If true this function is deprecated and removed + from regular listings. draft: type: boolean - description: If set, the created function will be a draft function and its - assets are still mutable. A build and deploy is initiated only in the - case when all necessary assets are present and valid. - default: false - additionalProperties: false - IPublishFunctionQuery: - type: object - additionalProperties: false - properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - deprecatePrevious: - $ref: '#/components/schemas/DeprecatePreviousPolicy' - description: Set the cleanup policy used to automatically deprecate/delete - previous versions. - async: - type: boolean - description: Unless this is set to false, the server will start - the required job actions asynchronously and return a 202 - Accepted response. If false the request will block - until the job actions are completed, or a timeout occurs. - default: true - IPatchMetadataQuery: - type: object - additionalProperties: false - properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - IPatchInterfaceQuery: - type: object - additionalProperties: false - properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - ISchemaParams: - type: object - properties: - functionType: - $ref: '#/components/schemas/EFunctionType' - description: Function type - role: - $ref: '#/components/schemas/EAssetRole' - description: Asset role - required: - - functionType - - role - additionalProperties: false - EAssetRole: - type: string - enum: - - manifest - - project - - main - - lib - - script - - other - description: Classification of assets with regard to their role. - ISchemaByIdParams: - type: object - properties: - schemaId: + description: If true this function is a draft function and + it's assets are still mutable. + webscript: + $ref: '#/components/schemas/IWebscriptManifest' + description: The webscript specification as provided by the webscript.json + asset. + secret: type: string - description: Schema id + description: The secret for this webscript deployment. This is null + when allowHmac=false in the webscript specificaton. required: - - schemaId - additionalProperties: false - IUpdateDraftQuery: + - createdAt + - createdBy + - deprecated + - draft + - runtime + - status + - updatedAt + - updatedBy + - updates + - webscript + IWebscriptManifest: type: object properties: - comment: + deploy: + $ref: '#/components/schemas/FunctionDeployOverridesType' + description: Deployment overrides of the function. + name: type: string - description: An optional user-specified comment corresponding to the operation. - async: + description: The logical name for the function. + version: + $ref: '#/components/schemas/SemanticVersion' + description: The semantic version of the function. + runtime: + $ref: '#/components/schemas/ERuntime' + description: The runtime that specifies how this function should be built + and deployed. This could be overridden or modified on initial deployment + or later rebuild. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersionRange' + description: An optional runtime version constraint for deployment of the + function. When not set, the latest runtime version is used for build and + deployment. When set, the latest available patch version with + the same minor version is used. Note that, after deployment, + this runtime version can become obsolete with a rebuild action. + metadata: + $ref: '#/components/schemas/IFunctionMeta' + description: Metadata describing the function. Note that, after deployment, + this metadata can be updated for the deployed function, without affecting + the runtime behaviour of the function itself. + private: type: boolean - description: Unless this is set to false, the server will start - the required job actions asynchronously and return a 202 - Accepted response. If false the request will block - until the job actions are completed, or a timeout occurs. - default: true - chown: + description: If true this webscript will require authentication. + allowHmac: type: boolean - description: If set, ownership of the draft function is transferred to the - current user. - default: false + description: If true this webscript will support authentication + with a HMAC key, available as the secret attribute + of the deployed webscript entity. required: - - chown - additionalProperties: false - ILatestPlugQuery: + - allowHmac + - metadata + - name + - private + - runtime + - version + IWebscriptResponseWithInvokeLinkV2: type: object properties: - tags: - $ref: '#/components/schemas/TagsFilter' - description: Filter on the tags of the item. Can be a single tag, or a list - of tags. When multiple tags are specified, an item must have all of the - tags to be selected. - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - version: + createdBy: type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: + description: The user that created this entity. + createdAt: type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' + format: date-time + description: The timestamp at which this entity was created. updatedBy: type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - name: + description: The user that last updated this entity. + updatedAt: type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: + format: date-time + description: The timestamp at which this entity was last updated. + updates: type: array items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. + $ref: '#/components/schemas/IUpdateRecord' + description: The audit logs corresponding to the latest modifying operations + on this entity. + status: + $ref: '#/components/schemas/EStatus' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function + entity. runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - type: - $ref: '#/components/schemas/EPlugType' - description: Filter on the type of the plug. + $ref: '#/components/schemas/IRuntimeAttributes' + description: Information about the current runtime used by this function + deployment. + deprecated: + type: boolean + description: If true this function is deprecated and removed + from regular listings. + draft: + type: boolean + description: If true this function is a draft function and + it's assets are still mutable. + webscript: + $ref: '#/components/schemas/IWebscriptManifest' + description: The webscript specification as provided by the webscript.json + asset. + secret: + type: string + description: The secret for this webscript deployment. This is null + when allowHmac=false in the webscript specificaton. + _links: + $ref: '#/components/schemas/IInvokeHALLink' + description: HAL links to related actions. required: - - type - additionalProperties: false - LegacyPlugQuery: + - createdAt + - createdBy + - deprecated + - draft + - runtime + - status + - updatedAt + - updatedBy + - updates + - webscript + IInvokeHALLink: type: object properties: - name: - type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - version: - type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: - type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. + invoke: + $ref: '#/components/schemas/IHALLink' + description: HAL link to the endpoint where the webscript is exposed. examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - tags: - $ref: '#/components/schemas/TagsFilter' - description: Filter on the tags of the item. Can be a single tag, or a list - of tags. When multiple tags are specified, an item must have all of the - tags to be selected. - additionalProperties: false - ILegacyPlugRequest: + - href: https://api-aws-dev.waylay.io/functions/v1//myWebscript + IUndeploySubmittedResponseV2: type: object properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - script: + message: type: string - dependencies: - $ref: '#/components/schemas/LegacyPlugDependencies' - metadata: - type: object - additionalProperties: false - properties: - requiredProperties: - $ref: '#/components/schemas/LegacyRequiredProperties' - supportedStates: - type: array - items: - type: string - rawData: - type: array - items: - type: object - properties: - parameter: - type: string - dataType: - $ref: '#/components/schemas/EPlugPropertyDataType' - required: - - parameter - additionalProperties: false - configuration: - $ref: '#/components/schemas/LegacyConfiguration' - author: - type: string - description: - type: string - category: - type: string - tags: - type: array - items: - $ref: '#/components/schemas/ITag' - iconURL: - type: string - friendlyName: - type: string - documentation: - anyOf: - - type: object - properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - additionalProperties: false - - $ref: '#/components/schemas/IDocumentation' - documentationURL: - type: string - type: - $ref: '#/components/schemas/EPlugType' + _links: + $ref: '#/components/schemas/IJobHALLinks' + versions: + type: array + items: + $ref: '#/components/schemas/SemanticVersion' + description: The versions for which undeployment and/or removal is initiated. required: - - metadata - - name - - script - - type - - version - additionalProperties: false - LegacyPlugDependencies: - type: object - additionalProperties: - type: string - ILegacyPlugMetaRequest: + - _links + - message + - versions + description: Undeployment Initiated + IUndeployedResponseV2: type: object properties: - author: - type: string - description: - type: string - category: + message: type: string - tags: + versions: type: array items: - $ref: '#/components/schemas/ITag' - iconURL: - type: string - friendlyName: - type: string - documentation: - anyOf: - - type: object - properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - additionalProperties: false - - $ref: '#/components/schemas/IDocumentation' - documentationURL: - type: string - additionalProperties: false - ILegacyFunctionMeta: + $ref: '#/components/schemas/SemanticVersion' + description: The versions that where deprecated, undeployed and/or removed. + required: + - message + - versions + description: Undeployed + IContentValidationListing: type: object properties: - author: - type: string - description: - type: string - category: - type: string - tags: + assets: type: array items: - $ref: '#/components/schemas/ITag' - iconURL: - type: string - friendlyName: - type: string - IDocumentationProperty: + $ref: '#/components/schemas/IAssetSummaryWithHALLink' + required: + - assets + description: Content listing + IAssetSummaryWithHALLink: type: object properties: + _links: + type: object + properties: + asset: + $ref: '#/components/schemas/HALLink' + description: Link to the asset content page for the related entity. + examples: + - href: https://api.waylay.io/registry/v2/plugs/myPlug/versions/1.0.0/content/index.js + required: + - asset + description: HAL links to the asset name: type: string - description: Name of the documented property. + description: File name + title: + type: string description: type: string - description: Documentation of the property. + role: + $ref: '#/components/schemas/EAssetRole' required: + - _links - name - - description - IDocumentation: - type: object - properties: - description: - type: string - states: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - description: Documentation of the plug states. - input: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - description: Documentation of the plug input parameters. - output: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - description: Documentation of the plug response parameters. - EPlugPropertyDataType: - type: string - enum: - - string - - integer - - long - - float - - double - - boolean - - object - description: Datatype supported in plug input or output properties. - LegacyConfiguration: - type: array - items: - $ref: '#/components/schemas/ILegacyConfigurationObject' - ILegacyConfigurationObject: + IGetPlugResponseV2: type: object properties: - name: - type: string - type: - $ref: '#/components/schemas/EPlugPropertyDataType' - mandatory: - type: boolean - format: + entity: + $ref: '#/components/schemas/IPlugResponseV2' + description: The specification and deployment status of the function + _links: type: object properties: - type: - $ref: '#/components/schemas/EPlugPropertyFormatType' - values: - type: array - items: - $ref: '#/components/schemas/EnumValue' - defaultValue: - $ref: '#/components/schemas/DefaultValue' - required: - - name - - type - EPlugPropertyFormatType: - type: string - enum: - - enum - - resource - - vault - - duration - - code - - url - - date - - template - description: Value domain for a plug input or output property. - EnumValue: - title: An allowed value for the property - DefaultValue: - title: A default value for the property - LegacyRequiredProperties: - type: array - items: - anyOf: - - type: string - - $ref: '#/components/schemas/ILegacyRequiredPropertyObject' - ILegacyRequiredPropertyObject: - type: object - properties: - name: - type: string - type: - $ref: '#/components/schemas/EPlugPropertyDataType' - mandatory: - type: boolean - sensitive: - type: boolean + draft: + type: object + properties: + draft: + type: boolean + enum: + - true + href: + type: string + version: + type: string + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest draft version. + examples: + - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.0.1 + draft: true + deprecated: false + published: + type: object + properties: + draft: + type: boolean + enum: + - false + href: + type: string + version: + type: string + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest published version. + examples: + - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.2.0 + draft: false + deprecated: false + jobs: + $ref: '#/components/schemas/IHALLink' + description: HAL link to all active jobs for this function (if any) + description: HAL links to related jobs and plugs required: - - name - - type - - mandatory - - sensitive - ILegacyPlugCreateRequest: + - _links + - entity + description: Plug Found + IAltVersionHALLink: type: object properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - script: - type: string - dependencies: - $ref: '#/components/schemas/LegacyPlugDependencies' - metadata: + draft: type: object - additionalProperties: false properties: - requiredProperties: - $ref: '#/components/schemas/LegacyRequiredProperties' - supportedStates: - type: array - items: - type: string - rawData: - type: array - items: - type: object - properties: - parameter: - type: string - dataType: - $ref: '#/components/schemas/EPlugPropertyDataType' - required: - - parameter - additionalProperties: false - configuration: - $ref: '#/components/schemas/LegacyConfiguration' - author: - type: string - description: - type: string - category: + draft: + type: boolean + enum: + - true + href: type: string - tags: - type: array - items: - $ref: '#/components/schemas/ITag' - iconURL: + version: type: string - friendlyName: + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest draft version. + examples: + - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.0.1 + draft: true + deprecated: false + published: + type: object + properties: + draft: + type: boolean + enum: + - false + href: type: string - documentation: - anyOf: - - type: object - properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - additionalProperties: false - - $ref: '#/components/schemas/IDocumentation' - documentationURL: + version: type: string - type: - $ref: '#/components/schemas/EPlugType' - additionalProperties: false - required: - - metadata - - name - - script - - version - NamedParameters_typeof_isNotLegacy_: - type: object - properties: - documentation: - anyOf: - - type: object - properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - additionalProperties: false - - $ref: '#/components/schemas/IDocumentation' - additionalProperties: false - NamedParameters_typeof_fromLegacyDocumentation_: - type: object - properties: - legacyDocumentation: - anyOf: - - type: object - properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - additionalProperties: false - - $ref: '#/components/schemas/IDocumentation' - currentInterface: - $ref: '#/components/schemas/IPlugInterface' - additionalProperties: false - IPlugInterface: + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest published version. + examples: + - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.2.0 + draft: false + deprecated: false + ILatestPlugsResponseV2: type: object properties: - states: - type: array - items: - type: string - description: The states of a plug as implemented in the plug code. - input: - type: array - items: - $ref: '#/components/schemas/IPlugProperty' - description: The named input parameters of a plug - output: + limit: + type: number + description: The page size used for this query result. + count: + type: number + description: The total count of matching items, from which this result is + one page. + page: + type: number + description: The page number of a paged query result. + entities: type: array items: - $ref: '#/components/schemas/IPlugProperty' - description: The named output parameters of a plug - IPlugProperty: - type: object - properties: - name: - type: string - description: The name of a plug input or output property. - dataType: - $ref: '#/components/schemas/EPlugPropertyDataType' - description: The datatype of the property - mandatory: - type: boolean - description: If true this property is required. - examples: - - true - format: - $ref: '#/components/schemas/IPlugPropertyFormat' - description: If present, refines the value domain of the property. - defaultValue: - $ref: '#/components/schemas/DefaultValue' - description: Default value assumed to be used when no value is given. + $ref: '#/components/schemas/EntityWithLinks_IPlugResponseV2_' + description: The specification and deployment status of the queried functions required: - - name - description: Interface specification of a plug property. - IPlugPropertyFormat: + - count + - entities + description: Plugs Found + EntityWithLinks_IPlugResponseV2_: type: object properties: - type: - $ref: '#/components/schemas/EPlugPropertyFormatType' - description: The value domain type for a plug property. - examples: - - enum - values: + _embedded: + $ref: '#/components/schemas/IAltEmbeddedVersion_IPlugResponseV2_' + description: Embedded representations of the _latest_ draft/published versions. + _links: + $ref: '#/components/schemas/IAltVersionHALLink' + createdBy: + type: string + description: The user that created this entity. + createdAt: + type: string + format: date-time + description: The timestamp at which this entity was created. + updatedBy: + type: string + description: The user that last updated this entity. + updatedAt: + type: string + format: date-time + description: The timestamp at which this entity was last updated. + updates: type: array items: - $ref: '#/components/schemas/EnumValue' - description: The enumerated value domain when type="enum" - examples: - - - low - - high - NamedParameters_typeof_fromLegacy_: - type: object - properties: - metadata: - $ref: '#/components/schemas/ILegacyPlugMetaRequest' - currentInterface: - $ref: '#/components/schemas/IPlugInterface' + $ref: '#/components/schemas/IUpdateRecord' + description: The audit logs corresponding to the latest modifying operations + on this entity. + status: + $ref: '#/components/schemas/EStatus' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function + entity. + runtime: + $ref: '#/components/schemas/IRuntimeAttributes' + description: Information about the current runtime used by this function + deployment. + deprecated: + type: boolean + description: If true this plug is removed from regular listings, + as a result of a DELETE with force=false. + draft: + type: boolean + description: If true this function is a draft function and + it's assets are still mutable. + plug: + $ref: '#/components/schemas/IPlugManifest' + description: The plug specification as provided by the plug.json + asset. required: - - metadata - additionalProperties: false - ILegacyDocumentationRequest: + - createdAt + - createdBy + - deprecated + - draft + - plug + - runtime + - status + - updatedAt + - updatedBy + - updates + IAltEmbeddedVersion_IPlugResponseV2_: type: object - additionalProperties: false properties: - description: - type: string - supportedStates: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - required: - - configuration - - rawData - - supportedStates - ILegacyDocumentation: + draft: + $ref: '#/components/schemas/IPlugResponseV2' + description: Embedded representation of the lastest draft version. + published: + $ref: '#/components/schemas/IPlugResponseV2' + description: Embedded representation of the lastest published version. + description: Embedded representations of the _latest_ draft/published versions. + IPlugVersionsResponseV2: type: object properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/IDocumentationProperty' - rawData: + limit: + type: number + description: The page size used for this query result. + count: + type: number + description: The total count of matching items, from which this result is + one page. + page: + type: number + description: The page number of a paged query result. + entities: type: array items: - $ref: '#/components/schemas/IDocumentationProperty' + $ref: '#/components/schemas/IPlugResponseV2' + description: The specification and deployment status of the queried functions required: - - supportedStates - - configuration - - rawData - ILegacyDebugPlugRequest: + - count + - entities + description: Plugs Versions Found + IPostPlugJobAsyncResponseV2: type: object properties: - type: - $ref: '#/components/schemas/EPlugType' - script: + message: type: string - dependencies: - $ref: '#/components/schemas/LegacyPlugDependencies' - metadata: - $ref: '#/components/schemas/IFunctionMeta' + _links: + $ref: '#/components/schemas/IJobHALLinks' + entity: + $ref: '#/components/schemas/IPlugResponseV2' + description: The specification and deployment status of the function for + which a task was initiated. required: - - script - additionalProperties: false - ILegacyDebugPlugManifest: + - _links + - entity + - message + description: Plug Deployment Initiated + IPostPlugJobSyncResponseV2: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/ERuntime' - description: The runtime that specifies how this function should be built - and deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build and - deployment. When set, the latest available patch version with - the same minor version is used. Note that, after deployment, - this runtime version can become obsolete with a rebuild action. - metadata: - $ref: '#/components/schemas/IFunctionMeta' - description: Metadata describing the function. Note that, after deployment, - this metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - tenant: - $ref: '#/components/schemas/TenantId' - dependencies: - $ref: '#/components/schemas/LegacyPlugDependencies' - script: + message: type: string + entity: + $ref: '#/components/schemas/IPlugResponseV2' + description: The specification and deployment status of the function for + which a task was completed. required: - - metadata - - name - - runtime - - script - - tenant - - version - additionalProperties: false - IFunctionManifest: + - entity + - message + description: Plug Deployed + IRebuildPlugAsyncResponseV2: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: + message: type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/ERuntime' - description: The runtime that specifies how this function should be built - and deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build and - deployment. When set, the latest available patch version with - the same minor version is used. Note that, after deployment, - this runtime version can become obsolete with a rebuild action. - metadata: - $ref: '#/components/schemas/IFunctionMeta' - description: Metadata describing the function. Note that, after deployment, - this metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. + _links: + $ref: '#/components/schemas/IJobHALLinks' + causes: + $ref: '#/components/schemas/JobCauses' + description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/IPlugResponseV2' + description: The specification and deployment status of the function for + which rebuild jobs were initiated. required: - - metadata - - name - - runtime - - version - IFunctionSpec: + - _links + - causes + - entity + - message + description: Plug Rebuild Initiated + IRebuildPlugSyncResponseV2: type: object properties: - name: + message: type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/ERuntime' - description: The runtime that specifies how this function should be built - and deployed. This could be overridden or modified on initial deployment - or later rebuild. + causes: + $ref: '#/components/schemas/JobCauses' + description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/IPlugResponseV2' + description: The specification and deployment status of the function for + which rebuild status is computed. required: - - name - - runtime - - version - IFunctionNameVersion: + - causes + - entity + - message + description: Plug Rebuild Ignored + IVerifyPlugSyncResponseV2: type: object properties: - name: + message: type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. + entity: + $ref: '#/components/schemas/IPlugResponseV2' + description: The specification and deployment status of the function for + which a task was completed. + result: + $ref: '#/components/schemas/IVerifyResult' required: - - name - - version - IFunctionDeployOverrides: + - entity + - message + - result + description: Plug Health Verified + IVerifyResult: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - FunctionDeployOverridesType: + healthy: + type: boolean + description: If true, the deployment check succeeded. + replicas: + type: number + description: The number of replicas this function was running at the time + of the check. + required: + - healthy + description: The result data for a completed verification job. + title: Verify + IJobsForPlugResponseV2: type: object properties: - envVars: - type: object - additionalProperties: - type: string - labels: - type: object - additionalProperties: - type: string - annotations: - type: object - additionalProperties: - type: string - limits: - $ref: '#/components/schemas/ResourceLimits' - requests: - $ref: '#/components/schemas/ResourceLimits' - ResourceLimits: - type: object - properties: - memory: - type: string - cpu: - type: string - required: - - memory - - cpu - TenantId: - type: string - ILegacyPlugCreateQuery: - type: object - properties: - async: - type: boolean - description: If this is set to true, the server will start - the required job actions asynchronously and return a 202 - Accepted response. Otherwise, the request will block until the - job actions are completed, or a timeout occurs. - default: false - dryRun: - type: boolean - description: If set to true, only validates the incoming request. - scaleToZero: - type: boolean - description: If set to true, scales the function to zero after - successful deployment. - additionalProperties: false - IKFServingLatestVersionsQueryV1: - type: object - additionalProperties: false - properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - version: - type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: - type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - name: - type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - description: Model listing query - IKFServingVersionsQueryV1: - type: object - additionalProperties: false - properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - version: - type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: - type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - name: - type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - description: Named model versions query - IKFServingDeleteQueryV1: - type: object - additionalProperties: false - properties: - async: - type: boolean - description: If this is set to true, the server will start - the required job actions asynchronously and return a 202 - Accepted response. Otherwise, the request will block until the - job actions are completed, or a timeout occurs. - default: false - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - version: - type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: - type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - name: - type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - IWebscriptLatestVersionsQueryV1: - type: object - additionalProperties: false - properties: - limit: - type: number - description: The maximum number of items to be return from this query. Has - a deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: Configures the inclusion of _draft_ versions when selecting - latest versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft versions - are **included**. If set to `false`, draft versions are **excluded**. - includeDeprecated: - type: boolean - description: Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only considered - when no other versions are available. If set to `true`, deprecated versions - are **included**. If set to `false`, deprecated versions are **excluded**. - version: - type: string - description: Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/EStatusFilter' - description: Filter on the status of the plug. Filter values with a `-` - postfix exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes _undeployed_ - functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: Filter on the user that create the plug. You can use the `@me` - token to indicate your own plugs. - examples: - - '@me' - updatedBy: - type: string - description: Filter on the user that last updated the plug. You can use - the `@me` token to indicate your own plugs. - examples: - - '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created before the given timestamp - or age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were created after the given timestamp - or age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated before the given timestamp - or age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on funtions that were updated after the given timestamp - or age. - name: - type: string - description: Filter on the name of the function. This is case-insensitive - and supports wild-cards `?` (any one character) and `*` (any sequence - of characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/EArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/ERuntime' - description: Filter on the runtime of the function. - description: Webscript lastest versions listing query - IForceDeleteQueryV1: - type: object - additionalProperties: false - properties: - async: - type: boolean - description: If this is set to true, the server will start - the required job actions asynchronously and return a 202 - Accepted response. Otherwise, the request will block until the - job actions are completed, or a timeout occurs. - default: false - force: - type: boolean - description: If true, the plug version(s) will be undeployed - and removed. Otherwise, the plug version(s) will only be deprecated, - i.e removed from regular listings. - IUpdateMetadataRequestV1: - type: object - additionalProperties: false - properties: - author: - type: string - description: The author of the function. - description: - type: string - description: A description of the function - iconURL: - type: string - description: An url to an icon that represents this function. - category: - type: string - description: 'A category for this function (Deprecated: use tags to categorise - your functions)' - deprecated: true - documentationURL: - type: string - description: External url that document this function. - tags: + jobs: type: array items: - $ref: '#/components/schemas/ITag' - description: Tags associated with this function. - examples: - - - name: awaiting-review - color: '#4153ea' - - name: demo - color: '#e639a4' - friendlyName: - type: string - description: Display title for this function. - IPatchPlugRequestV1: - type: object - properties: - metadata: - $ref: '#/components/schemas/IUserPlugMeta' - required: - - metadata - additionalProperties: false - IVerifyQueryV1: - type: object - properties: - scaleToZero: - type: boolean - description: Indicates whether the function needs to be scaled down after - successful verification. If not set, the function is scaled to zero only - if it was not active before this command. - additionalProperties: false - IAsyncDeployQueryV1: - type: object - additionalProperties: false - properties: - scaleToZero: - type: boolean - description: If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources when - the function is not to be used immediately. - default: false - async: - type: boolean - description: Unless this is set to false, the server will start - the required job actions asynchronously and return a 202 - Accepted response. If false the request will block - until the job actions are completed, or a timeout occurs. - default: true - dryRun: - type: boolean - description: If set to true, validates the deployment conditions, - but does not change anything. - IMessageResponse: - type: object - properties: - message: - type: string + $ref: '#/components/schemas/AnyJobForFunction' + description: Listing of jobs related to the function deployment. This includes + active jobs, and the most recently failed job (per type) that was archived + on the entity. + function: + $ref: '#/components/schemas/IFunctionRef' + description: Function reference. + _links: + type: object + properties: + plug: + $ref: '#/components/schemas/HALLink' + additionalProperties: false + description: Link to the function entity. required: - - message - IErrorResponse: + - function + - jobs + description: Plug Jobs Found + AnyJobForFunction: + anyOf: + - type: object + properties: + _links: + $ref: '#/components/schemas/IJobHALLinks' + description: Links to events if the job is still active. + type: + type: string + description: The type of the background task. + title: Build + enum: + - build + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/IBuildArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/IBuildResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be missing + for batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job, if available. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: Failure reason if available + required: + - createdAt + - createdBy + - operation + - state + - type + title: Build + - type: object + properties: + _links: + $ref: '#/components/schemas/IJobHALLinks' + description: Links to events if the job is still active. + type: + type: string + description: The type of the background task. + title: Deploy + enum: + - deploy + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/IDeployArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/IDeployResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be missing + for batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job, if available. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: Failure reason if available + required: + - createdAt + - createdBy + - operation + - state + - type + title: Deploy + - type: object + properties: + _links: + $ref: '#/components/schemas/IJobHALLinks' + description: Links to events if the job is still active. + type: + type: string + description: The type of the background task. + title: Verify + enum: + - verify + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/IVerifyArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/IVerifyResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be missing + for batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job, if available. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: Failure reason if available + required: + - createdAt + - createdBy + - operation + - state + - type + title: Verify + - type: object + properties: + _links: + $ref: '#/components/schemas/IJobHALLinks' + description: Links to events if the job is still active. + type: + type: string + description: The type of the background task. + title: Undeploy + enum: + - undeploy + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/IUndeployArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/IUndeployResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be missing + for batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job, if available. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: Failure reason if available + required: + - createdAt + - createdBy + - operation + - state + - type + title: Undeploy + - type: object + properties: + _links: + $ref: '#/components/schemas/IJobHALLinks' + description: Links to events if the job is still active. + type: + type: string + description: The type of the background task. + enum: + - scale + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/IScaleArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/IScaleResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be missing + for batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job, if available. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: Failure reason if available + required: + - createdAt + - createdBy + - operation + - state + - type + title: Scale + IBuildArgs: type: object properties: - error: + runtimeName: + $ref: '#/components/schemas/ERuntime' + description: Provided (or defaulted) name of the runtime configuration. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersion' + description: Provided (or defaulted) version of the runtime configuration. + revision: type: string - required: - - error - IOperation: - type: object - properties: - id: + description: The revision hash of the current (draft) function revision + storageLocation: type: string - description: + description: Location of the function assets. + imageName: + type: string + description: Provided (or defaulted) image name to publish the function + image. + args: + type: object + additionalProperties: + type: string + description: Parameters to the runtime configuration. + required: + - args + - imageName + - revision + - runtimeName + - runtimeVersion + - storageLocation + description: Input arguments to a job that builds a function. + title: Build + IBuildResult: + type: object + properties: + digest: + type: string + description: SHA digest of the built image. + log: + type: array + items: + type: string + description: Detailed logs of the build steps. + status: type: string + description: Outcome of the build. + required: + - digest + title: Build + IFunctionRef: + type: object + properties: + functionType: + $ref: '#/components/schemas/EFunctionType' + description: Function type name: type: string - deprecated: true - type: - $ref: '#/components/schemas/EJobType' + description: The logical name for the function. + version: + type: string + description: The semantic version of the function (all versions if undefined) + runtime: + $ref: '#/components/schemas/ERuntime' + description: Runtime id + runtimeVersion: + $ref: '#/components/schemas/SemanticVersion' + description: Runtime version required: - - id - - description + - functionType - name - - type - IOperationStatus: + JobStatus: type: object properties: id: type: string - description: - type: string name: type: string - deprecated: true - type: - $ref: '#/components/schemas/EJobType' - done: - type: boolean - error: - type: object - properties: - name: - type: string - message: - type: string - stack: - type: string - code: - type: string - required: - - code - - message - - name + progress: + anyOf: + - type: number + - type: object + attemptsMade: + type: number + finishedOn: + type: string + format: date-time + processedOn: + type: string + format: date-time + failedReason: + type: string + parent: + $ref: '#/components/schemas/ParentKeys' + delay: + type: number required: - - description - - done - id - name - - type - IJobSubmittedResponse: + - progress + - attemptsMade + ParentKeys: type: object properties: - message: + id: type: string - _links: - $ref: '#/components/schemas/IJobHALLinks' required: - - _links - - message - IJobHALLinks: - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - examples: - - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - examples: - - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - description: HAL links to related actions. - IJobStatusHALLink: - type: object - properties: - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - examples: - - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - description: HAL links to related actions. - HALLink: - anyOf: - - $ref: '#/components/schemas/IHALLink' - - type: array - items: - $ref: '#/components/schemas/IHALLink' - description: One or more links of the same HAL collection. - IHALLink: + - id + IDeployArgs: type: object properties: - href: + namespace: + type: string + description: The (openfaas) namespace for the target function. + endpoint: + type: string + description: The (openfaas) endpoint service name + imageName: type: string + description: The image name to use for deploying this function + runtimeName: + $ref: '#/components/schemas/ERuntime' + description: Provided (or defaulted) name of the runtime configuration. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersion' + description: Provided (or defaulted) version of the runtime configuration. + revision: + type: string + description: The revision hash of the current (draft) function revision + deploySpecOverrides: + type: object + properties: + service: + type: string + image: + type: string + namespace: + type: string + envProcess: + type: string + network: + type: string + envVars: + type: object + additionalProperties: + type: string + constraints: + type: array + items: + type: string + labels: + type: object + additionalProperties: + type: string + annotations: + type: object + additionalProperties: + type: string + secrets: + type: array + items: + type: string + registryAuth: + type: string + limits: + $ref: '#/components/schemas/ResourceLimits' + requests: + $ref: '#/components/schemas/ResourceLimits' + readOnlyRootFilesystem: + type: boolean + description: Overrides on the deployment specification. required: - - href - IJobEventsHALLink: + - deploySpecOverrides + - endpoint + - imageName + - namespace + - revision + - runtimeName + - runtimeVersion + description: Input argument to an (openfaas) deployment job for a function. + title: Deploy + IDeployResult: type: object properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - examples: - - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - description: HAL links to related actions. - IRebuildSubmittedResponse: + deploySpec: + $ref: '#/components/schemas/IExposedOpenfaasDeploySpec' + description: The deployment parameters used for this function deployment. + required: + - deploySpec + description: The result data for a completed deployment job. + title: Deploy + IExposedOpenfaasDeploySpec: type: object properties: - message: + service: type: string - _links: - $ref: '#/components/schemas/IJobHALLinks' - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions + image: + type: string + namespace: + type: string + labels: + type: object + additionalProperties: + type: string + annotations: + type: object + additionalProperties: + type: string + limits: + $ref: '#/components/schemas/ResourceLimits' + requests: + $ref: '#/components/schemas/ResourceLimits' required: - - _links - - causes - - message - description: Rebuild Initiated - JobCauses: + - image + - namespace + - service + IVerifyArgs: type: object properties: - build: - $ref: '#/components/schemas/JobCause' - deploy: - $ref: '#/components/schemas/JobCause' - verify: - $ref: '#/components/schemas/JobCause' - undeploy: - $ref: '#/components/schemas/JobCause' - scale: - $ref: '#/components/schemas/JobCause' - description: The motivations for including or excluding a job in response to - a rebuild request. - JobCause: - type: object - properties: - changed: - type: boolean - description: If true, the argument configuration for this job - has changed in comparison to the previous job execution. A false - will prevent the job to be run. Use forceVersion or upgrade - parameter to force a rebuild. - reason: - type: string - description: Human readable message describing the cause. - backoff: - type: boolean - description: If true, recent failures of the job prevented - the re-execution. Use forceVersion or upgrade - parameter to force a rebuild. - newValue: - type: string - description: The new configuration value that causes the change. - oldValue: - type: string - description: The old configuration value used by the last succeeded job. - required: - - changed - - reason - description: The motivation for including or excluding a job (build, - deploy, verify, ...) in response to a rebuild request. - IRebuildComputedResponse: - type: object - properties: - message: + namespace: type: string - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - required: - - causes - - message - description: Rebuild Ignored - IRootPageResponse: - type: object - properties: - name: + description: The (openfaas) namespace for the target function. + endpoint: type: string - description: Name of the service. - version: + description: The (openfaas) endpoint service name + runtimeName: + $ref: '#/components/schemas/ERuntime' + description: Provided (or defaulted) name of the runtime configuration. + runtimeVersion: $ref: '#/components/schemas/SemanticVersion' - description: Semantic version of the service. - enabled: - type: object - description: Description of the features enabled on this service deployment. + description: Provided (or defaulted) version of the runtime configuration. revision: type: string - description: Revision of the service source code. + description: The revision hash of the current (draft) function revision required: - - name - - version - - enabled + - endpoint + - namespace - revision - description: Status Page - PlugHtmlResponse: - type: string - description: Successful Response - IRuntimeSummaryAttrs: + - runtimeName + - runtimeVersion + description: Input arguments for an (openfaas) deployment verification job. + title: Verify + IUndeployArgs: type: object properties: - name: - $ref: '#/components/schemas/ERuntime' - title: + namespace: type: string - description: + description: The (openfaas) namespace for the target function. + endpoint: type: string - functionType: - $ref: '#/components/schemas/EFunctionType' - archiveFormat: - $ref: '#/components/schemas/EArchiveFormat' - required: - - name - - title - - functionType - - archiveFormat - IRuntimeSummary: - type: object - properties: - name: + description: The (openfaas) endpoint service name + runtimeName: $ref: '#/components/schemas/ERuntime' - title: - type: string - description: + description: Provided (or defaulted) name of the runtime configuration. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersion' + description: Provided (or defaulted) version of the runtime configuration. + revision: type: string - functionType: - $ref: '#/components/schemas/EFunctionType' - archiveFormat: - $ref: '#/components/schemas/EArchiveFormat' - versions: - type: array - items: - $ref: '#/components/schemas/IRuntimeVersionInfo' - required: - - archiveFormat - - functionType - - name - - title - - versions - description: A summary representation of the runtime, and (selected) versions - of it. - IRuntimeVersionInfo: - type: object - properties: - deprecated: + description: The revision hash of the current (draft) function revision + isNativePlug: type: boolean - description: If true, the function uses a deprecated runtime. - upgradable: + description: If true, the function is not expected to be deployed on openfaas. + deleteEntity: type: boolean - description: If true, a newer runtime for this function is available using - the `rebuild` API. - version: - $ref: '#/components/schemas/SemanticVersion' - title: - type: string - description: - type: string required: - - deprecated - - title - - upgradable - - version - description: A summary of a selected version for a runtime - IRuntimeVersionStatus: + - deleteEntity + - endpoint + - isNativePlug + - namespace + - revision + - runtimeName + - runtimeVersion + description: Input argument to an (openfaas) undeployment job for a function. + title: Undeploy + IUndeployResult: type: object properties: - deprecated: + deployment: type: boolean - description: If true, the function uses a deprecated runtime. - upgradable: + assets: + type: boolean + registration: type: boolean - description: If true, a newer runtime for this function is available using - the `rebuild` API. required: - - deprecated - - upgradable - IRuntimeVersionSummary: + - deployment + - assets + - registration + description: The result data for a completed undeployment job. + title: Undeploy + IScaleArgs: type: object properties: - deprecated: - type: boolean - description: If true, the function uses a deprecated runtime. - upgradable: - type: boolean - description: If true, a newer runtime for this function is available using - the `rebuild` API. - version: - $ref: '#/components/schemas/SemanticVersion' - title: + namespace: type: string - description: + description: The (openfaas) namespace for the target function. + endpoint: type: string - name: + description: The (openfaas) endpoint service name + runtimeName: $ref: '#/components/schemas/ERuntime' - functionType: - $ref: '#/components/schemas/EFunctionType' - archiveFormat: - $ref: '#/components/schemas/EArchiveFormat' - required: - - archiveFormat - - deprecated - - functionType - - name - - title - - upgradable - - version - IRuntimeSummaryResponse: - type: object - properties: - runtimes: - type: array - items: - $ref: '#/components/schemas/IRuntimeSummary' + description: Provided (or defaulted) name of the runtime configuration. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersion' + description: Provided (or defaulted) version of the runtime configuration. + revision: + type: string + description: The revision hash of the current (draft) function revision + replicas: + type: number + description: Number of target replicas required: - - runtimes - description: Runtimes Found - IRuntimeVersionResponse: + - endpoint + - namespace + - replicas + - revision + - runtimeName + - runtimeVersion + description: Input argument to an (openfaas) scale job for a function. + title: Scale + IScaleResult: type: object - properties: - runtime: - $ref: '#/components/schemas/CompiledRuntimeVersion' - required: - - runtime - description: ': Runtime Version Found' - CompiledRuntimeVersion: + description: The result data for a completed scale job. + title: Scale + IGetModelResponseV2: type: object properties: - deprecated: - type: boolean - description: If true, this runtime should no longer be used for new functions. - upgradable: - type: boolean - description: If true, a newer runtime for this function is available using - the `rebuild` API. - name: - type: string - functionType: - $ref: '#/components/schemas/EFunctionType' - archiveFormat: - $ref: '#/components/schemas/EArchiveFormat' - build: - $ref: '#/components/schemas/BuildSpec' - deploy: - $ref: '#/components/schemas/DeploySpec' - language: - $ref: '#/components/schemas/LanguageRelease' - description: Description of the language release - providedDependencies: + entity: + $ref: '#/components/schemas/IKfservingResponseV2' + description: The specification and deployment status of the function + _links: + type: object + properties: + draft: + type: object + properties: + draft: + type: boolean + enum: + - true + href: + type: string + version: + type: string + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest draft version. + examples: + - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.0.1 + draft: true + deprecated: false + published: + type: object + properties: + draft: + type: boolean + enum: + - false + href: + type: string + version: + type: string + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest published version. + examples: + - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.2.0 + draft: false + deprecated: false + jobs: + $ref: '#/components/schemas/IHALLink' + description: HAL link to all active jobs for this function (if any) + description: HAL links to related jobs and plugs + required: + - _links + - entity + description: Model Found + ILatestModelsResponseV2: + type: object + properties: + limit: + type: number + description: The page size used for this query result. + count: + type: number + description: The total count of matching items, from which this result is + one page. + page: + type: number + description: The page number of a paged query result. + entities: type: array items: - $ref: '#/components/schemas/ProvidedDependency' - description: Description of dependencies provided by this runtime version. - assets: - $ref: '#/components/schemas/AssetsConditions' - description: Restrictions on the assets in the function archive. - title: - type: string - description: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' + $ref: '#/components/schemas/EntityWithLinks_IKfservingResponseV2_' + description: The specification and deployment status of the queried functions required: - - archiveFormat - - deprecated - - functionType - - name - - title - - upgradable - - version - description: Compiled build and deployment information for a runtime version. - Contains all defaults applied on the _global_, _functionType_, _archiveFormat_, - _runtime_ and _runtime version_ level. - RuntimeVersionSpecification: + - count + - entities + description: Models Found + EntityWithLinks_IKfservingResponseV2_: type: object properties: - build: - $ref: '#/components/schemas/BuildSpec' - deploy: - $ref: '#/components/schemas/DeploySpec' - language: - $ref: '#/components/schemas/LanguageRelease' - description: Description of the language release - providedDependencies: + _embedded: + $ref: '#/components/schemas/IAltEmbeddedVersion_IKfservingResponseV2_' + description: Embedded representations of the _latest_ draft/published versions. + _links: + $ref: '#/components/schemas/IAltVersionHALLink' + createdBy: + type: string + description: The user that created this entity. + createdAt: + type: string + format: date-time + description: The timestamp at which this entity was created. + updatedBy: + type: string + description: The user that last updated this entity. + updatedAt: + type: string + format: date-time + description: The timestamp at which this entity was last updated. + updates: type: array items: - $ref: '#/components/schemas/ProvidedDependency' - description: Description of dependencies provided by this runtime version. - assets: - $ref: '#/components/schemas/AssetsConditions' - description: Restrictions on the assets in the function archive. + $ref: '#/components/schemas/IUpdateRecord' + description: The audit logs corresponding to the latest modifying operations + on this entity. + status: + $ref: '#/components/schemas/EStatus' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function + entity. + runtime: + $ref: '#/components/schemas/IRuntimeAttributes' + description: Information about the current runtime used by this function + deployment. deprecated: type: boolean - description: If true, this runtime should no longer be used for new functions. - title: - type: string - description: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' + description: If true this function is deprecated and removed + from regular listings. + draft: + type: boolean + description: If true this function is a draft function and + it's assets are still mutable. + model: + $ref: '#/components/schemas/IKFServingManifest' + description: The model specification as provided by the model.json + asset. required: - - title - - version - RuntimeSpecification: + - createdAt + - createdBy + - deprecated + - draft + - model + - runtime + - status + - updatedAt + - updatedBy + - updates + IAltEmbeddedVersion_IKfservingResponseV2_: type: object properties: - build: - $ref: '#/components/schemas/BuildSpec' - deploy: - $ref: '#/components/schemas/DeploySpec' - language: - $ref: '#/components/schemas/LanguageRelease' - description: Description of the language release - providedDependencies: + draft: + $ref: '#/components/schemas/IKfservingResponseV2' + description: Embedded representation of the lastest draft version. + published: + $ref: '#/components/schemas/IKfservingResponseV2' + description: Embedded representation of the lastest published version. + description: Embedded representations of the _latest_ draft/published versions. + IModelVersionsResponseV2: + type: object + properties: + limit: + type: number + description: The page size used for this query result. + count: + type: number + description: The total count of matching items, from which this result is + one page. + page: + type: number + description: The page number of a paged query result. + entities: type: array items: - $ref: '#/components/schemas/ProvidedDependency' - description: Description of dependencies provided by this runtime version. - assets: - $ref: '#/components/schemas/AssetsConditions' - description: Restrictions on the assets in the function archive. - deprecated: - type: boolean - description: If true, this runtime should no longer be used for new functions. - description: 'Runtime (version) specification that says - - * what assets are required/allowed to build the function - - * what build parameters are used - - * what deployment parameters are used - - * which dependencies are provided by the runtime' - BuildSpec: + $ref: '#/components/schemas/IKfservingResponseV2' + description: The specification and deployment status of the queried functions + required: + - count + - entities + description: Model Versions Found + IPostModelJobAsyncResponseV2: type: object properties: - context: + message: type: string - args: - type: object - additionalProperties: - type: string + _links: + $ref: '#/components/schemas/IJobHALLinks' + entity: + $ref: '#/components/schemas/IKfservingResponseV2' + description: The specification and deployment status of the function for + which a task was initiated. required: - - context - - args - DeploySpec: + - _links + - entity + - message + description: Model Deployment Initiated + IPostModelJobSyncResponseV2: type: object properties: - openfaasSpec: - type: object - properties: - service: - type: string - image: - type: string - namespace: - type: string - envProcess: - type: string - network: - type: string - envVars: - type: object - additionalProperties: - type: string - constraints: - type: array - items: - type: string - labels: - type: object - additionalProperties: - type: string - annotations: - type: object - additionalProperties: - type: string - secrets: - type: array - items: - type: string - registryAuth: - type: string - limits: - $ref: '#/components/schemas/ResourceLimits' - requests: - $ref: '#/components/schemas/ResourceLimits' - readOnlyRootFilesystem: - type: boolean - description: If specified, it overrides the properties in `default`. Non-specified - properties are taken from `default` - LanguageRelease: + message: + type: string + entity: + $ref: '#/components/schemas/IKfservingResponseV2' + description: The specification and deployment status of the function for + which a task was completed. + required: + - entity + - message + description: Model Deployed + IRebuildModelAsyncResponseV2: type: object properties: - name: - type: string - description: Short technical name of the language or framework used. - version: - type: string - description: Release version of the language or framework. - title: - type: string - description: Display title. - description: + message: type: string + _links: + $ref: '#/components/schemas/IJobHALLinks' + causes: + $ref: '#/components/schemas/JobCauses' + description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/IKfservingResponseV2' + description: The specification and deployment status of the function for + which rebuild jobs were initiated. required: - - name - - version - - title - description: Description of the language or framework release used by a runtime - (version). - ProvidedDependency: + - _links + - causes + - entity + - message + description: Model Rebuild Initiated + IRebuildModelSyncResponseV2: type: object properties: - name: - type: string - description: Name of a provided dependency. - title: - type: string - description: Optional display title. - description: + message: type: string - description: Optional description. - version: + causes: + $ref: '#/components/schemas/JobCauses' + description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/IKfservingResponseV2' + description: The specification and deployment status of the function for + which rebuild status is computed. + required: + - causes + - entity + - message + description: Model Rebuild Ignored + IVerifyModelSyncResponseV2: + type: object + properties: + message: type: string - description: Versions specification of a provided dependency - deprecated: - type: boolean - description: If true, this provided dependency is scheduled for removal - (or incompatible upgrade) in a next runtime version. - default: false - removed: - type: boolean - description: If true, this dependency has been removed from the runtime - (version) - default: false - globals: - type: array - items: - type: string - description: Global variables that expose this library to the user code. - As the usage of these globals is deprecated, any usage of such global - will pose issues in an next runtime version. - native: - type: boolean - description: 'If true, the library is provided natively by the runtime: - e.g. node for javascript.' + entity: + $ref: '#/components/schemas/IKfservingResponseV2' + description: The specification and deployment status of the function for + which a task was completed. + result: + $ref: '#/components/schemas/IVerifyResult' required: - - name - description: Library dependency that is provided by this runtime. - AssetsConditions: + - entity + - message + - result + description: Model Health Verified + IJobsForModelResponseV2: type: object properties: - conditions: + jobs: type: array items: - $ref: '#/components/schemas/AssetCondition' - description: All files in a function archive are checked against these conditions. - A file that is not matched is ignored. - maxSize: - type: string - description: The maximum size of the archive (in bytes, unless unit is provided) - description: Describes the assets that are required/allowed/supported for a - function. - AssetCondition: + $ref: '#/components/schemas/AnyJobForFunction' + description: Listing of jobs related to the function deployment. This includes + active jobs, and the most recently failed job (per type) that was archived + on the entity. + function: + $ref: '#/components/schemas/IFunctionRef' + description: Function reference. + _links: + type: object + properties: + model: + $ref: '#/components/schemas/HALLink' + additionalProperties: false + description: Link to the function entity. + required: + - function + - jobs + description: Model Jobs Found + IGetWebscriptResponseV2: type: object properties: - title: - type: string - description: - type: string - role: - $ref: '#/components/schemas/EAssetRole' - description: Role in the function deployment - pattern: - anyOf: - - type: string - - type: array - items: - type: string - description: Pattern that selects a file in a function archive - contentType: - anyOf: - - type: string - - type: array - items: - type: string - description: Allowed content type(s) of matching files. - min: + entity: + $ref: '#/components/schemas/IWebscriptResponseV2' + description: The specification and deployment status of the function + _links: + type: object + properties: + invoke: + $ref: '#/components/schemas/IHALLink' + description: HAL link to the endpoint where the webscript is exposed. + examples: + - href: https://api-aws-dev.waylay.io/functions/v1//myWebscript + jobs: + $ref: '#/components/schemas/IHALLink' + description: HAL link to all active jobs for this function (if any) + description: HAL links to related actions. + required: + - _links + - entity + description: Webscript Found + ILatestWebscriptsResponseV2: + type: object + properties: + limit: type: number - description: The minimal number of files that must match this pattern. Use - `0` for an optional file. - examples: - - 0 - max: + description: The page size used for this query result. + count: type: number - description: The maximal number of files that can match this pattern. Use - `0` for a disallowed file. This condition only raises an error if there - are no other conditions that - examples: - - 1 - maxSize: - type: string - description: The maximum size for each file matching this pattern (in bytes, - unless unit is provided) - schema: - description: The json schema validator that applies (in case of `application/json` - entries). + description: The total count of matching items, from which this result is + one page. + page: + type: number + description: The page number of a paged query result. + entities: + type: array + items: + $ref: '#/components/schemas/EntityWithLinks_IWebscriptResponseWithInvokeLinkV2_' + description: The specification and deployment status of the queried functions required: - - role - - pattern - description: Describes conditions on the set of files that match a file pattern. - RuntimeInfo: + - count + - entities + description: Webscripts Found + EntityWithLinks_IWebscriptResponseWithInvokeLinkV2_: type: object properties: - name: - type: string - functionType: - $ref: '#/components/schemas/EFunctionType' - archiveFormat: - $ref: '#/components/schemas/EArchiveFormat' - required: - - name - - functionType - - archiveFormat - description: Runtime attributes that are the same for all versions of a runtime. - IPlugResponseV2: - type: object - properties: - createdBy: + _embedded: + $ref: '#/components/schemas/IAltEmbeddedVersion_IWebscriptResponseWithInvokeLinkV2_' + description: Embedded representations of the _latest_ draft/published versions. + _links: + $ref: '#/components/schemas/IInvokeHALLink' + description: HAL links to related actions. + createdBy: type: string description: The user that created this entity. createdAt: @@ -4312,4172 +2822,1312 @@ components: deployment. deprecated: type: boolean - description: If true this plug is removed from regular listings, - as a result of a DELETE with force=false. + description: If true this function is deprecated and removed + from regular listings. draft: type: boolean description: If true this function is a draft function and it's assets are still mutable. - plug: - $ref: '#/components/schemas/IPlugManifest' - description: The plug specification as provided by the plug.json + webscript: + $ref: '#/components/schemas/IWebscriptManifest' + description: The webscript specification as provided by the webscript.json asset. + secret: + type: string + description: The secret for this webscript deployment. This is null + when allowHmac=false in the webscript specificaton. required: - createdAt - createdBy - deprecated - draft - - plug - runtime - status - updatedAt - updatedBy - updates - IWithEntityAttributes: + - webscript + IAltEmbeddedVersion_IWebscriptResponseWithInvokeLinkV2_: type: object properties: - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/IUpdateRecord' - description: The audit logs corresponding to the latest modifying operations - on this entity. - status: - $ref: '#/components/schemas/EStatus' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function - entity. - runtime: - $ref: '#/components/schemas/IRuntimeAttributes' - description: Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: If true this function is deprecated and removed - from regular listings. draft: - type: boolean - description: If true this function is a draft function and - it's assets are still mutable. - required: - - createdBy - - createdAt - - updatedBy - - updatedAt - - updates - - status - - runtime - - deprecated - - draft - IUpdateRecord: + $ref: '#/components/schemas/IWebscriptResponseWithInvokeLinkV2' + description: Embedded representation of the lastest draft version. + published: + $ref: '#/components/schemas/IWebscriptResponseWithInvokeLinkV2' + description: Embedded representation of the lastest published version. + description: Embedded representations of the _latest_ draft/published versions. + IWebscriptVersionsResponseV2: type: object properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - operation: - $ref: '#/components/schemas/ERequestOperation' - description: The type of modifying operation. - jobs: + limit: + type: number + description: The page size used for this query result. + count: + type: number + description: The total count of matching items, from which this result is + one page. + page: + type: number + description: The page number of a paged query result. + entities: type: array items: - type: string - description: The job id's of the corresponding jobs, if applicable. - at: - type: string - format: date-time - by: + $ref: '#/components/schemas/IWebscriptResponseWithInvokeLinkV2' + description: The specification and deployment status of the queried functions + required: + - count + - entities + description: Webscript Versions Found + IPostWebscriptJobAsyncResponseV2: + type: object + properties: + message: type: string - description: The user that initiated this operation. + _links: + $ref: '#/components/schemas/IJobHALLinks' + entity: + $ref: '#/components/schemas/IWebscriptResponseV2' + description: The specification and deployment status of the function for + which a task was initiated. required: - - at - - by - - operation - description: An update report corresponding to a modifying operation initiated - by a user/administrator on the entity. - ERequestOperation: - type: string - enum: - - create - - metadata-update - - assets-update - - rebuild - - verify - - publish - - deprecate - - undeploy - description: A modifying operation on the function. - EStatus: - type: string - enum: - - registered - - running - - pending - - deployed - - unhealthy - - killed - - failed - - undeploying - - undeployed - description: Status for a deployed function. - FailureReason: - anyOf: - - $ref: '#/components/schemas/IFailureReason' - - type: string - IFailureReason: + - _links + - entity + - message + description: Webscript Deployment Initiated + IPostWebscriptJobSyncResponseV2: type: object properties: - log: - type: array - items: - type: string - description: Log lines associated with this failure. - events: - type: array - items: - type: string - description: Events associated with this failure. - cause: + message: type: string - description: Main cause for the failure. + entity: + $ref: '#/components/schemas/IWebscriptResponseV2' + description: The specification and deployment status of the function for + which a task was completed. required: - - log - - events - IRuntimeAttributes: + - entity + - message + description: Webscript Deployed + IRebuildWebscriptAsyncResponseV2: type: object properties: - deprecated: - type: boolean - description: If true, the function uses a deprecated runtime. - upgradable: - type: boolean - description: If true, a newer runtime for this function is available using - the `rebuild` API. - name: - $ref: '#/components/schemas/ERuntime' - description: The name of a runtime - version: - $ref: '#/components/schemas/SemanticVersion' - description: The version of a runtime + message: + type: string + _links: + $ref: '#/components/schemas/IJobHALLinks' + causes: + $ref: '#/components/schemas/JobCauses' + description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/IWebscriptResponseV2' + description: The specification and deployment status of the function for + which rebuild jobs were initiated. required: - - deprecated - - name - - upgradable - - version - RuntimeReference: + - _links + - causes + - entity + - message + description: Webscript Rebuild Initiated + IRebuildWebscriptSyncResponseV2: type: object properties: - name: - $ref: '#/components/schemas/ERuntime' - description: The name of a runtime - version: - $ref: '#/components/schemas/SemanticVersion' - description: The version of a runtime + message: + type: string + causes: + $ref: '#/components/schemas/JobCauses' + description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/IWebscriptResponseV2' + description: The specification and deployment status of the function for + which rebuild status is computed. required: - - name - - version - description: Reference to a runtime version. - IPlugManifest: + - causes + - entity + - message + description: Webscript Rebuild Ignored + IVerifyWebscriptSyncResponseV2: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: + message: type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/ERuntime' - description: The runtime that specifies how this function should be built - and deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build and - deployment. When set, the latest available patch version with - the same minor version is used. Note that, after deployment, - this runtime version can become obsolete with a rebuild action. - metadata: - $ref: '#/components/schemas/IPlugMeta' - description: Metadata describing the function. Note that, after deployment, - this metadata can be patched for the deployed plug, as long it does not - affect the runtime behaviour. - type: - $ref: '#/components/schemas/EPlugType' - description: Type of the plug. - interface: - $ref: '#/components/schemas/IPlugInterface' - description: Description of the user interface of the plug, as visible to - end-users when configuring plug nodes in the rule engine. + entity: + $ref: '#/components/schemas/IWebscriptResponseV2' + description: The specification and deployment status of the function for + which a task was completed. + result: + $ref: '#/components/schemas/IVerifyResult' required: - - interface - - metadata - - name - - runtime - - type - - version - IPlugMeta: + - entity + - message + - result + description: Webscript Health Verified + IJobsForWebscriptResponseV2: type: object properties: - author: - type: string - description: The author of the function. - description: - type: string - description: A description of the function - iconURL: - type: string - description: An url to an icon that represents this function. - category: - type: string - description: 'A category for this function (Deprecated: use tags to categorise - your functions)' - deprecated: true - documentationURL: - type: string - description: External url that document this function. - tags: + jobs: type: array items: - $ref: '#/components/schemas/ITag' - description: Tags associated with this function. - examples: - - - name: awaiting-review - color: '#4153ea' - - name: demo - color: '#e639a4' - friendlyName: - type: string - description: Display title for this function. - documentation: - $ref: '#/components/schemas/IDocumentation' - description: Documentation of the plug interface. - IKfservingResponseV2: + $ref: '#/components/schemas/AnyJobForFunction' + description: Listing of jobs related to the function deployment. This includes + active jobs, and the most recently failed job (per type) that was archived + on the entity. + function: + $ref: '#/components/schemas/IFunctionRef' + description: Function reference. + _links: + type: object + properties: + webscript: + $ref: '#/components/schemas/HALLink' + additionalProperties: false + description: Link to the function entity. + required: + - function + - jobs + description: Webscript Jobs Found + BuildJobStatus: type: object properties: - createdBy: + type: type: string - description: The user that created this entity. + description: The type of the background task. + title: Build + enum: + - build + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/IBuildArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/IBuildResult' + description: The result of the job if completed. createdAt: type: string format: date-time - description: The timestamp at which this entity was created. - updatedBy: + description: The timestamp of creation of this job + createdBy: type: string - description: The user that last updated this entity. - updatedAt: + description: The user that created this job + operation: type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/IUpdateRecord' - description: The audit logs corresponding to the latest modifying operations - on this entity. - status: - $ref: '#/components/schemas/EStatus' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function - entity. - runtime: - $ref: '#/components/schemas/IRuntimeAttributes' - description: Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: If true this function is deprecated and removed - from regular listings. - draft: - type: boolean - description: If true this function is a draft function and - it's assets are still mutable. - model: - $ref: '#/components/schemas/IKFServingManifest' - description: The model specification as provided by the model.json - asset. + description: Request operation + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be missing + for batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. required: - createdAt - createdBy - - deprecated - - draft - - model - - runtime - - status - - updatedAt - - updatedBy - - updates - IKFServingManifest: + - job + - operation + - request + - state + - type + title: Build + DeployJobStatus: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: + type: type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/ERuntime' - description: The runtime that specifies how this function should be built - and deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build and - deployment. When set, the latest available patch version with - the same minor version is used. Note that, after deployment, - this runtime version can become obsolete with a rebuild action. - metadata: - $ref: '#/components/schemas/IFunctionMeta' - description: Metadata describing the function. Note that, after deployment, - this metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. + description: The type of the background task. + title: Deploy + enum: + - deploy + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/IDeployArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/IDeployResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be missing + for batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. required: - - metadata - - name - - runtime - - version - IWebscriptResponseV2: + - createdAt + - createdBy + - job + - operation + - request + - state + - type + title: Deploy + VerifyJobStatus: type: object properties: - createdBy: + type: type: string - description: The user that created this entity. + description: The type of the background task. + title: Verify + enum: + - verify + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/IVerifyArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/IVerifyResult' + description: The result of the job if completed. createdAt: type: string format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: + description: The timestamp of creation of this job + createdBy: type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/IUpdateRecord' - description: The audit logs corresponding to the latest modifying operations - on this entity. - status: - $ref: '#/components/schemas/EStatus' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function - entity. - runtime: - $ref: '#/components/schemas/IRuntimeAttributes' - description: Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: If true this function is deprecated and removed - from regular listings. - draft: - type: boolean - description: If true this function is a draft function and - it's assets are still mutable. - webscript: - $ref: '#/components/schemas/IWebscriptManifest' - description: The webscript specification as provided by the webscript.json - asset. - secret: + description: The user that created this job + operation: type: string - description: The secret for this webscript deployment. This is null - when allowHmac=false in the webscript specificaton. + description: Request operation + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be missing + for batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. required: - createdAt - createdBy - - deprecated - - draft - - runtime - - status - - updatedAt - - updatedBy - - updates - - webscript - IWebscriptManifest: + - job + - operation + - request + - state + - type + title: Verify + UndeployJobStatus: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: + type: type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/ERuntime' - description: The runtime that specifies how this function should be built - and deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build and - deployment. When set, the latest available patch version with - the same minor version is used. Note that, after deployment, - this runtime version can become obsolete with a rebuild action. - metadata: - $ref: '#/components/schemas/IFunctionMeta' - description: Metadata describing the function. Note that, after deployment, - this metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - private: - type: boolean - description: If true this webscript will require authentication. - allowHmac: - type: boolean - description: If true this webscript will support authentication - with a HMAC key, available as the secret attribute - of the deployed webscript entity. + description: The type of the background task. + title: Undeploy + enum: + - undeploy + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/IUndeployArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/IUndeployResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be missing + for batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. required: - - allowHmac - - metadata - - name - - private - - runtime - - version - IWebscriptResponseWithInvokeLinkV2: + - createdAt + - createdBy + - job + - operation + - request + - state + - type + title: Undeploy + ScaleJobStatus: type: object properties: - createdBy: + type: type: string - description: The user that created this entity. + description: The type of the background task. + enum: + - scale + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/IScaleArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/IScaleResult' + description: The result of the job if completed. createdAt: type: string format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: + description: The timestamp of creation of this job + createdBy: type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/IUpdateRecord' - description: The audit logs corresponding to the latest modifying operations - on this entity. - status: - $ref: '#/components/schemas/EStatus' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function - entity. - runtime: - $ref: '#/components/schemas/IRuntimeAttributes' - description: Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: If true this function is deprecated and removed - from regular listings. - draft: - type: boolean - description: If true this function is a draft function and - it's assets are still mutable. - webscript: - $ref: '#/components/schemas/IWebscriptManifest' - description: The webscript specification as provided by the webscript.json - asset. - secret: + description: The user that created this job + operation: type: string - description: The secret for this webscript deployment. This is null - when allowHmac=false in the webscript specificaton. - _links: - $ref: '#/components/schemas/IInvokeHALLink' - description: HAL links to related actions. + description: Request operation + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be missing + for batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. required: - createdAt - createdBy - - deprecated - - draft - - runtime - - status - - updatedAt - - updatedBy - - updates - - webscript - IInvokeHALLink: - type: object - properties: - invoke: - $ref: '#/components/schemas/IHALLink' - description: HAL link to the endpoint where the webscript is exposed. - examples: - - href: https://api-aws-dev.waylay.io/functions/v1//myWebscript - IUndeploySubmittedResponseV2: + - job + - operation + - request + - state + - type + title: Scale + BatchJobStatus: type: object properties: - message: + type: type: string - _links: - $ref: '#/components/schemas/IJobHALLinks' - versions: - type: array - items: - $ref: '#/components/schemas/SemanticVersion' - description: The versions for which undeployment and/or removal is initiated. - required: - - _links - - message - - versions - description: Undeployment Initiated - IUndeployedResponseV2: - type: object - properties: - message: - type: string - versions: - type: array - items: - $ref: '#/components/schemas/SemanticVersion' - description: The versions that where deprecated, undeployed and/or removed. - required: - - message - - versions - description: Undeployed - IContentValidationListing: - type: object - properties: - assets: - type: array - items: - $ref: '#/components/schemas/IAssetSummaryWithHALLink' - required: - - assets - description: Content listing - IAssetSummaryWithHALLink: - type: object - properties: - _links: - type: object - properties: - asset: - $ref: '#/components/schemas/HALLink' - description: Link to the asset content page for the related entity. - examples: - - href: https://api.waylay.io/registry/v2/plugs/myPlug/versions/1.0.0/content/index.js - required: - - asset - description: HAL links to the asset - name: + description: The type of the background task. + title: Batch + enum: + - batch + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/IBatchArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/IBatchResult' + description: The result of the job if completed. + createdAt: type: string - description: File name - title: + format: date-time + description: The timestamp of creation of this job + createdBy: type: string - description: + description: The user that created this job + operation: type: string - role: - $ref: '#/components/schemas/EAssetRole' + description: Request operation + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be missing + for batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. required: - - _links - - name - IAssetSummary: + - createdAt + - createdBy + - job + - operation + - request + - state + - type + title: Batch + IBatchArgs: type: object properties: - name: - type: string - description: File name - title: + plugName: type: string - description: + functionType: + $ref: '#/components/schemas/EFunctionType' + childType: type: string - role: - $ref: '#/components/schemas/EAssetRole' required: - - name - IWithAssetHALLink: + - plugName + - functionType + title: Batch + IBatchResult: type: object properties: - _links: - type: object - properties: - asset: - $ref: '#/components/schemas/HALLink' - description: Link to the asset content page for the related entity. - examples: - - href: https://api.waylay.io/registry/v2/plugs/myPlug/versions/1.0.0/content/index.js - required: - - asset - description: HAL links to the asset - required: - - _links - IGetPlugResponseV2: + jobCount: + type: number + title: Batch + AnyJobStatus: + anyOf: + - $ref: '#/components/schemas/BuildJobStatus' + - $ref: '#/components/schemas/DeployJobStatus' + - $ref: '#/components/schemas/VerifyJobStatus' + - $ref: '#/components/schemas/UndeployJobStatus' + - $ref: '#/components/schemas/ScaleJobStatus' + - $ref: '#/components/schemas/BatchJobStatus' + IJobResponse: type: object properties: - entity: - $ref: '#/components/schemas/IPlugResponseV2' - description: The specification and deployment status of the function + job: + $ref: '#/components/schemas/AnyJobStatus' + description: Information about the job. _links: - type: object - properties: - draft: - type: object - properties: - draft: - type: boolean - enum: - - true - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest draft version. - examples: - - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.0.1 - draft: true - deprecated: false - published: - type: object - properties: - draft: - type: boolean - enum: - - false - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest published version. - examples: - - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.2.0 - draft: false - deprecated: false - jobs: - $ref: '#/components/schemas/IHALLink' - description: HAL link to all active jobs for this function (if any) - description: HAL links to related jobs and plugs + $ref: '#/components/schemas/IJobEventsAndFunctionHALLink' required: + - job - _links - - entity - description: Plug Found - IJobsHALLink: - type: object - properties: - jobs: - $ref: '#/components/schemas/IHALLink' - description: HAL link to all active jobs for this function (if any) - IAltVersionHALLink: - type: object - properties: - draft: - type: object - properties: - draft: - type: boolean - enum: - - true - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest draft version. - examples: - - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.0.1 - draft: true - deprecated: false - published: - type: object - properties: - draft: - type: boolean - enum: - - false - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest published version. - examples: - - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.2.0 - draft: false - deprecated: false - ILatestPlugsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: The total count of matching items, from which this result is - one page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - type: object - properties: - _links: - $ref: '#/components/schemas/IAltVersionHALLink' - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/IUpdateRecord' - description: The audit logs corresponding to the latest modifying - operations on this entity. - status: - $ref: '#/components/schemas/EStatus' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function - entity. - runtime: - $ref: '#/components/schemas/IRuntimeAttributes' - description: Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: If true this plug is removed from regular - listings, as a result of a DELETE with force=false. - draft: - type: boolean - description: If true this function is a draft function - and it's assets are still mutable. - plug: - $ref: '#/components/schemas/IPlugManifest' - description: The plug specification as provided by the plug.json - asset. - required: - - _links - - createdAt - - createdBy - - deprecated - - draft - - plug - - runtime - - status - - updatedAt - - updatedBy - - updates - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Plugs Found - IWithPaging: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: The total count of matching items, from which this result is - one page. - page: - type: number - description: The page number of a paged query result. - required: - - count - IWithLimit: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - IPlugVersionsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: The total count of matching items, from which this result is - one page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - $ref: '#/components/schemas/IPlugResponseV2' - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Plugs Versions Found - IPostPlugJobAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/IJobHALLinks' - entity: - $ref: '#/components/schemas/IPlugResponseV2' - description: The specification and deployment status of the function for - which a task was initiated. - required: - - _links - - entity - - message - description: Plug Deployment Initiated - IPostPlugJobSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/IPlugResponseV2' - description: The specification and deployment status of the function for - which a task was completed. - required: - - entity - - message - description: Plug Deployed - IRebuildPlugAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/IJobHALLinks' - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/IPlugResponseV2' - description: The specification and deployment status of the function for - which rebuild jobs were initiated. - required: - - _links - - causes - - entity - - message - description: Plug Rebuild Initiated - IRebuildPlugSyncResponseV2: - type: object - properties: - message: - type: string - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/IPlugResponseV2' - description: The specification and deployment status of the function for - which rebuild status is computed. - required: - - causes - - entity - - message - description: Plug Rebuild Ignored - IVerifyPlugSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/IPlugResponseV2' - description: The specification and deployment status of the function for - which a task was completed. - result: - $ref: '#/components/schemas/IVerifyResult' - required: - - entity - - message - - result - description: Plug Health Verified - IVerifyResult: - type: object - properties: - healthy: - type: boolean - description: If true, the deployment check succeeded. - replicas: - type: number - description: The number of replicas this function was running at the time - of the check. - required: - - healthy - description: The result data for a completed verification job. - title: Verify - IJobsForPlugResponseV2: - type: object - properties: - jobs: - type: array - items: - $ref: '#/components/schemas/AnyJobForFunction' - description: Listing of jobs related to the function deployment. This includes - active jobs, and the most recently failed job (per type) that was archived - on the entity. - function: - $ref: '#/components/schemas/IFunctionRef' - description: Function reference. - _links: - type: object - properties: - plug: - $ref: '#/components/schemas/HALLink' - additionalProperties: false - description: Link to the function entity. - required: - - function - - jobs - description: Plug Jobs Found - AnyJobForFunction: + description: Job Found + IJobEventsAndFunctionHALLink: + anyOf: + - type: object + properties: + event: + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + examples: + - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + plug: + $ref: '#/components/schemas/HALLink' + description: Link to the plug. + examples: + - href: https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 + required: + - plug + title: Plug + - type: object + properties: + event: + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + examples: + - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + webscript: + $ref: '#/components/schemas/HALLink' + description: Link to the webscript. + examples: + - href: https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 + required: + - webscript + title: Webscript + - type: object + properties: + event: + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + examples: + - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + model: + $ref: '#/components/schemas/HALLink' + description: Link to the model. + examples: + - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + required: + - model + title: Model + - $ref: '#/components/schemas/IJobEventsHALLink' + title: No Function + description: HAL links to related actions. + AnyJobStatusSummary: anyOf: - type: object properties: - _links: - $ref: '#/components/schemas/IJobHALLinks' - description: Links to events if the job is still active. type: type: string description: The type of the background task. title: Build enum: - build + operation: + type: string + description: The operation name for the background task. + id: + type: string + description: The id of the background job, or the constant `_unknown_` state: $ref: '#/components/schemas/JobStateResult' description: The current processing state of the job - request: - $ref: '#/components/schemas/IBuildArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/IBuildResult' - description: The result of the job if completed. createdAt: type: string format: date-time - description: The timestamp of creation of this job + description: The creation time of this job createdBy: type: string - description: The user that created this job - operation: - type: string - description: Request operation + description: The user that initiated this job function: $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing + description: The function entity that this job acts on, will be `undefined` for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available + _links: + $ref: '#/components/schemas/IJobAndFunctionHALLink' + description: HAL links to related the job status, SSE stream, and function + entity if relevant. required: + - _links - createdAt - createdBy + - id - operation - state - type title: Build - type: object properties: - _links: - $ref: '#/components/schemas/IJobHALLinks' - description: Links to events if the job is still active. type: type: string description: The type of the background task. title: Deploy enum: - deploy + operation: + type: string + description: The operation name for the background task. + id: + type: string + description: The id of the background job, or the constant `_unknown_` state: $ref: '#/components/schemas/JobStateResult' description: The current processing state of the job - request: - $ref: '#/components/schemas/IDeployArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/IDeployResult' - description: The result of the job if completed. createdAt: type: string format: date-time - description: The timestamp of creation of this job + description: The creation time of this job createdBy: type: string - description: The user that created this job - operation: - type: string - description: Request operation + description: The user that initiated this job function: $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing + description: The function entity that this job acts on, will be `undefined` for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available + _links: + $ref: '#/components/schemas/IJobAndFunctionHALLink' + description: HAL links to related the job status, SSE stream, and function + entity if relevant. required: + - _links - createdAt - createdBy + - id - operation - state - type title: Deploy - type: object properties: - _links: - $ref: '#/components/schemas/IJobHALLinks' - description: Links to events if the job is still active. type: type: string description: The type of the background task. title: Verify enum: - verify + operation: + type: string + description: The operation name for the background task. + id: + type: string + description: The id of the background job, or the constant `_unknown_` state: $ref: '#/components/schemas/JobStateResult' description: The current processing state of the job - request: - $ref: '#/components/schemas/IVerifyArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/IVerifyResult' - description: The result of the job if completed. createdAt: type: string format: date-time - description: The timestamp of creation of this job + description: The creation time of this job createdBy: type: string - description: The user that created this job - operation: - type: string - description: Request operation + description: The user that initiated this job function: $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing + description: The function entity that this job acts on, will be `undefined` for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available + _links: + $ref: '#/components/schemas/IJobAndFunctionHALLink' + description: HAL links to related the job status, SSE stream, and function + entity if relevant. required: + - _links - createdAt - createdBy + - id - operation - state - type title: Verify - type: object properties: - _links: - $ref: '#/components/schemas/IJobHALLinks' - description: Links to events if the job is still active. type: type: string description: The type of the background task. title: Undeploy enum: - undeploy + operation: + type: string + description: The operation name for the background task. + id: + type: string + description: The id of the background job, or the constant `_unknown_` state: $ref: '#/components/schemas/JobStateResult' description: The current processing state of the job - request: - $ref: '#/components/schemas/IUndeployArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/IUndeployResult' - description: The result of the job if completed. createdAt: type: string format: date-time - description: The timestamp of creation of this job + description: The creation time of this job createdBy: type: string - description: The user that created this job - operation: - type: string - description: Request operation + description: The user that initiated this job function: $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing + description: The function entity that this job acts on, will be `undefined` for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available + _links: + $ref: '#/components/schemas/IJobAndFunctionHALLink' + description: HAL links to related the job status, SSE stream, and function + entity if relevant. required: + - _links - createdAt - createdBy + - id - operation - state - type title: Undeploy - type: object properties: - _links: - $ref: '#/components/schemas/IJobHALLinks' - description: Links to events if the job is still active. type: type: string description: The type of the background task. enum: - scale + operation: + type: string + description: The operation name for the background task. + id: + type: string + description: The id of the background job, or the constant `_unknown_` state: $ref: '#/components/schemas/JobStateResult' description: The current processing state of the job - request: - $ref: '#/components/schemas/IScaleArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/IScaleResult' - description: The result of the job if completed. createdAt: type: string format: date-time - description: The timestamp of creation of this job + description: The creation time of this job createdBy: type: string - description: The user that created this job - operation: - type: string - description: Request operation + description: The user that initiated this job function: $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing + description: The function entity that this job acts on, will be `undefined` for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available + _links: + $ref: '#/components/schemas/IJobAndFunctionHALLink' + description: HAL links to related the job status, SSE stream, and function + entity if relevant. required: + - _links - createdAt - createdBy + - id - operation - state - type title: Scale - IBuildArgs: - type: object - properties: - runtimeName: - $ref: '#/components/schemas/ERuntime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - storageLocation: - type: string - description: Location of the function assets. - imageName: - type: string - description: Provided (or defaulted) image name to publish the function - image. - args: - type: object - additionalProperties: - type: string - description: Parameters to the runtime configuration. - required: - - args - - imageName - - runtimeName - - runtimeVersion - - storageLocation - description: Input arguments to a job that builds a function. - title: Build - IFunctionJobArgs: - type: object - properties: - runtimeName: - $ref: '#/components/schemas/ERuntime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - required: - - runtimeName - - runtimeVersion - description: Job arguments shared by all function jobs - IBuildResult: - type: object - properties: - digest: - type: string - description: SHA digest of the built image. - log: - type: array - items: + - type: object + properties: + type: type: string - description: Detailed logs of the build steps. - status: - type: string - description: Outcome of the build. - required: - - digest - title: Build - IFunctionRef: - type: object - properties: - functionType: - $ref: '#/components/schemas/EFunctionType' - description: Function type - name: - type: string - description: The logical name for the function. - version: - type: string - description: The semantic version of the function (all versions if undefined) - runtime: - $ref: '#/components/schemas/ERuntime' - description: Runtime id - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Runtime version - required: - - functionType - - name - JobStatus: - type: object - properties: - id: - type: string - name: - type: string - progress: - anyOf: - - type: number - - type: object - attemptsMade: - type: number - finishedOn: - type: string - format: date-time - processedOn: - type: string - format: date-time - failedReason: - type: string - parent: - $ref: '#/components/schemas/ParentKeys' - delay: - type: number - required: - - id - - name - - progress - - attemptsMade - ParentKeys: - type: object - properties: - id: - type: string - required: - - id - IDeployArgs: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - imageName: - type: string - description: The image name to use for deploying this function - runtimeName: - $ref: '#/components/schemas/ERuntime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - deploySpecOverrides: - type: object - properties: - service: - type: string - image: - type: string - namespace: - type: string - envProcess: - type: string - network: - type: string - envVars: - type: object - additionalProperties: - type: string - constraints: - type: array - items: - type: string - labels: - type: object - additionalProperties: - type: string - annotations: - type: object - additionalProperties: - type: string - secrets: - type: array - items: - type: string - registryAuth: - type: string - limits: - $ref: '#/components/schemas/ResourceLimits' - requests: - $ref: '#/components/schemas/ResourceLimits' - readOnlyRootFilesystem: - type: boolean - description: Overrides on the deployment specification. - required: - - deploySpecOverrides - - endpoint - - imageName - - namespace - - runtimeName - - runtimeVersion - description: Input argument to an (openfaas) deployment job for a function. - title: Deploy - IOpenfaasDeployArgs: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - imageName: - type: string - description: The image name to use for deploying this function - required: - - endpoint - - imageName - - namespace - IOpenfaasFunctionRef: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - required: - - namespace - - endpoint - IDeployResult: - type: object - properties: - deploySpec: - $ref: '#/components/schemas/IExposedOpenfaasDeploySpec' - description: The deployment parameters used for this function deployment. - required: - - deploySpec - description: The result data for a completed deployment job. - title: Deploy - IExposedOpenfaasDeploySpec: - type: object - properties: - service: - type: string - image: - type: string - namespace: - type: string - labels: - type: object - additionalProperties: - type: string - annotations: - type: object - additionalProperties: - type: string - limits: - $ref: '#/components/schemas/ResourceLimits' - requests: - $ref: '#/components/schemas/ResourceLimits' - required: - - image - - namespace - - service - IVerifyArgs: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - runtimeName: - $ref: '#/components/schemas/ERuntime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - required: - - endpoint - - namespace - - runtimeName - - runtimeVersion - description: Input arguments for an (openfaas) deployment verification job. - title: Verify - IUndeployArgs: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - runtimeName: - $ref: '#/components/schemas/ERuntime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - isNativePlug: - type: boolean - description: If true, the function is not expected to be deployed on openfaas. - deleteEntity: - type: boolean - required: - - deleteEntity - - endpoint - - isNativePlug - - namespace - - runtimeName - - runtimeVersion - description: Input argument to an (openfaas) undeployment job for a function. - title: Undeploy - IUndeployResult: - type: object - properties: - deployment: - type: boolean - assets: - type: boolean - registration: - type: boolean - required: - - deployment - - assets - - registration - description: The result data for a completed undeployment job. - title: Undeploy - IScaleArgs: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - runtimeName: - $ref: '#/components/schemas/ERuntime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - replicas: - type: number - description: Number of target replicas - required: - - endpoint - - namespace - - replicas - - runtimeName - - runtimeVersion - description: Input argument to an (openfaas) scale job for a function. - title: Scale - IScaleResult: - type: object - description: The result data for a completed scale job. - title: Scale - IGetModelResponseV2: - type: object - properties: - entity: - $ref: '#/components/schemas/IKfservingResponseV2' - description: The specification and deployment status of the function - _links: - type: object - properties: - draft: - type: object - properties: - draft: - type: boolean - enum: - - true - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest draft version. - examples: - - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.0.1 - draft: true - deprecated: false - published: - type: object - properties: - draft: - type: boolean - enum: - - false - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest published version. - examples: - - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.2.0 - draft: false - deprecated: false - jobs: - $ref: '#/components/schemas/IHALLink' - description: HAL link to all active jobs for this function (if any) - description: HAL links to related jobs and plugs - required: - - _links - - entity - description: Model Found - ILatestModelsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: The total count of matching items, from which this result is - one page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - type: object - properties: - _links: - $ref: '#/components/schemas/IAltVersionHALLink' - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/IUpdateRecord' - description: The audit logs corresponding to the latest modifying - operations on this entity. - status: - $ref: '#/components/schemas/EStatus' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function - entity. - runtime: - $ref: '#/components/schemas/IRuntimeAttributes' - description: Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: If true this function is deprecated and - removed from regular listings. - draft: - type: boolean - description: If true this function is a draft function - and it's assets are still mutable. - model: - $ref: '#/components/schemas/IKFServingManifest' - description: The model specification as provided by the model.json - asset. - required: - - _links - - createdAt - - createdBy - - deprecated - - draft - - model - - runtime - - status - - updatedAt - - updatedBy - - updates - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Models Found - IModelVersionsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: The total count of matching items, from which this result is - one page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - $ref: '#/components/schemas/IKfservingResponseV2' - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Model Versions Found - IPostModelJobAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/IJobHALLinks' - entity: - $ref: '#/components/schemas/IKfservingResponseV2' - description: The specification and deployment status of the function for - which a task was initiated. - required: - - _links - - entity - - message - description: Model Deployment Initiated - IPostModelJobSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/IKfservingResponseV2' - description: The specification and deployment status of the function for - which a task was completed. - required: - - entity - - message - description: Model Deployed - IRebuildModelAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/IJobHALLinks' - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/IKfservingResponseV2' - description: The specification and deployment status of the function for - which rebuild jobs were initiated. - required: - - _links - - causes - - entity - - message - description: Model Rebuild Initiated - IRebuildModelSyncResponseV2: - type: object - properties: - message: - type: string - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/IKfservingResponseV2' - description: The specification and deployment status of the function for - which rebuild status is computed. - required: - - causes - - entity - - message - description: Model Rebuild Ignored - IVerifyModelSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/IKfservingResponseV2' - description: The specification and deployment status of the function for - which a task was completed. - result: - $ref: '#/components/schemas/IVerifyResult' - required: - - entity - - message - - result - description: Model Health Verified - IJobsForModelResponseV2: - type: object - properties: - jobs: - type: array - items: - $ref: '#/components/schemas/AnyJobForFunction' - description: Listing of jobs related to the function deployment. This includes - active jobs, and the most recently failed job (per type) that was archived - on the entity. - function: - $ref: '#/components/schemas/IFunctionRef' - description: Function reference. - _links: - type: object - properties: - model: - $ref: '#/components/schemas/HALLink' - additionalProperties: false - description: Link to the function entity. - required: - - function - - jobs - description: Model Jobs Found - IGetWebscriptResponseV2: - type: object - properties: - entity: - $ref: '#/components/schemas/IWebscriptResponseV2' - description: The specification and deployment status of the function - _links: - type: object - properties: - invoke: - $ref: '#/components/schemas/IHALLink' - description: HAL link to the endpoint where the webscript is exposed. - examples: - - href: https://api-aws-dev.waylay.io/functions/v1//myWebscript - jobs: - $ref: '#/components/schemas/IHALLink' - description: HAL link to all active jobs for this function (if any) - description: HAL links to related actions. - required: - - _links - - entity - description: Webscript Found - ILatestWebscriptsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: The total count of matching items, from which this result is - one page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - type: object - properties: - _links: - $ref: '#/components/schemas/IInvokeHALLink' - description: HAL links to related actions. - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/IUpdateRecord' - description: The audit logs corresponding to the latest modifying - operations on this entity. - status: - $ref: '#/components/schemas/EStatus' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function - entity. - runtime: - $ref: '#/components/schemas/IRuntimeAttributes' - description: Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: If true this function is deprecated and - removed from regular listings. - draft: - type: boolean - description: If true this function is a draft function - and it's assets are still mutable. - webscript: - $ref: '#/components/schemas/IWebscriptManifest' - description: The webscript specification as provided by the webscript.json - asset. - secret: - type: string - description: The secret for this webscript deployment. This is null - when allowHmac=false in the webscript specificaton. - required: - - _links - - createdAt - - createdBy - - deprecated - - draft - - runtime - - status - - updatedAt - - updatedBy - - updates - - webscript - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Webscripts Found - IWebscriptVersionsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: The total count of matching items, from which this result is - one page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - $ref: '#/components/schemas/IWebscriptResponseWithInvokeLinkV2' - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Webscript Versions Found - IPostWebscriptJobAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/IJobHALLinks' - entity: - $ref: '#/components/schemas/IWebscriptResponseV2' - description: The specification and deployment status of the function for - which a task was initiated. - required: - - _links - - entity - - message - description: Webscript Deployment Initiated - IPostWebscriptJobSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/IWebscriptResponseV2' - description: The specification and deployment status of the function for - which a task was completed. - required: - - entity - - message - description: Webscript Deployed - IRebuildWebscriptAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/IJobHALLinks' - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/IWebscriptResponseV2' - description: The specification and deployment status of the function for - which rebuild jobs were initiated. - required: - - _links - - causes - - entity - - message - description: Webscript Rebuild Initiated - IRebuildWebscriptSyncResponseV2: - type: object - properties: - message: - type: string - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/IWebscriptResponseV2' - description: The specification and deployment status of the function for - which rebuild status is computed. - required: - - causes - - entity - - message - description: Webscript Rebuild Ignored - IVerifyWebscriptSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/IWebscriptResponseV2' - description: The specification and deployment status of the function for - which a task was completed. - result: - $ref: '#/components/schemas/IVerifyResult' - required: - - entity - - message - - result - description: Webscript Health Verified - IJobsForWebscriptResponseV2: - type: object - properties: - jobs: - type: array - items: - $ref: '#/components/schemas/AnyJobForFunction' - description: Listing of jobs related to the function deployment. This includes - active jobs, and the most recently failed job (per type) that was archived - on the entity. - function: - $ref: '#/components/schemas/IFunctionRef' - description: Function reference. - _links: - type: object - properties: - webscript: - $ref: '#/components/schemas/HALLink' - additionalProperties: false - description: Link to the function entity. - required: - - function - - jobs - description: Webscript Jobs Found - IInvokableWebscriptResponse: - type: object - properties: - entity: - type: object - properties: - status: - $ref: '#/components/schemas/EStatus' - draft: - type: boolean - webscript: - type: object - properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - private: - type: boolean - allowHmac: - type: boolean - required: - - name - - version - - private - - allowHmac - secret: - type: string - required: - - status - - draft - - webscript - _links: - $ref: '#/components/schemas/IInvokeInternalHALLink' - required: - - entity - - _links - description: Webscript Found - IInvokeInternalHALLink: - type: object - properties: - invoke-internal: - $ref: '#/components/schemas/IHALLink' - description: HAL link to the Openfaas endpoint. - examples: - - href: openfaas:/functions/web-a7420ffdf5ffe5b573a57f766aed38552a4e1421.openfaas-fn-740799ef-d515-4704-8718-903851c9899e - IUnhealthyInvokableWebscriptError: - type: object - properties: - entity: - type: object - properties: - status: - $ref: '#/components/schemas/EStatus' - draft: - type: boolean - webscript: - type: object - properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - private: - type: boolean - allowHmac: - type: boolean - required: - - name - - version - - private - - allowHmac - secret: - type: string - required: - - status - - draft - - webscript - _links: - $ref: '#/components/schemas/IInvokeInternalHALLink' - error: - type: string - code: - type: string - required: - - _links - - code - - entity - - error - description: Webscript Not Healthy - AnyFunctionResponse: - anyOf: - - $ref: '#/components/schemas/IPlugResponseV2' - - $ref: '#/components/schemas/IKfservingResponseV2' - - $ref: '#/components/schemas/IWebscriptResponseV2' - IVersionsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: The total count of matching items, from which this result is - one page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - $ref: '#/components/schemas/AnyFunctionResponse' - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Version Listing Response - NamedParameters_typeof_asJobReference_: - type: object - properties: - jobStatus: - type: object - properties: - _links: - $ref: '#/components/schemas/IJobHALLinks' - description: Links to events if the job is still active. - type: - description: The type of the background task. - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - description: The request that initiated this job. - result: - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing - for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available - required: - - createdAt - - createdBy - - operation - - state - - type - required: - - jobStatus - additionalProperties: false - BuildJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - title: Build - enum: - - build - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/IBuildArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/IBuildResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing - for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - title: Build - DeployJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - title: Deploy - enum: - - deploy - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/IDeployArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/IDeployResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing - for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - title: Deploy - VerifyJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - title: Verify - enum: - - verify - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/IVerifyArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/IVerifyResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing - for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - title: Verify - UndeployJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - title: Undeploy - enum: - - undeploy - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/IUndeployArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/IUndeployResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing - for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - title: Undeploy - ScaleJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - scale - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/IScaleArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/IScaleResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing - for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - title: Scale - BatchJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - title: Batch - enum: - - batch - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/IBatchArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/IBatchResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be missing - for batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - title: Batch - IBatchArgs: - type: object - properties: - plugName: - type: string - functionType: - $ref: '#/components/schemas/EFunctionType' - childType: - type: string - required: - - plugName - - functionType - title: Batch - IBatchResult: - type: object - properties: - jobCount: - type: number - title: Batch - AnyJobStatus: - anyOf: - - $ref: '#/components/schemas/BuildJobStatus' - - $ref: '#/components/schemas/DeployJobStatus' - - $ref: '#/components/schemas/VerifyJobStatus' - - $ref: '#/components/schemas/UndeployJobStatus' - - $ref: '#/components/schemas/ScaleJobStatus' - - $ref: '#/components/schemas/BatchJobStatus' - IJobResponse: - type: object - properties: - job: - $ref: '#/components/schemas/AnyJobStatus' - description: Information about the job. - _links: - $ref: '#/components/schemas/IJobEventsAndFunctionHALLink' - required: - - job - - _links - description: Job Found - IJobEventsAndFunctionHALLink: - anyOf: - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - examples: - - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - plug: - $ref: '#/components/schemas/HALLink' - description: Link to the plug. - examples: - - href: https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 - required: - - plug - title: Plug - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - examples: - - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - webscript: - $ref: '#/components/schemas/HALLink' - description: Link to the webscript. - examples: - - href: https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 - required: - - webscript - title: Webscript - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - examples: - - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - model: - $ref: '#/components/schemas/HALLink' - description: Link to the model. - examples: - - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - required: - - model - title: Model - - $ref: '#/components/schemas/IJobEventsHALLink' - title: No Function - description: HAL links to related actions. - AnyJobStatusSummary: - anyOf: - - type: object - properties: - type: - type: string - description: The type of the background task. - title: Build - enum: - - build - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/IJobAndFunctionHALLink' - description: HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Build - - type: object - properties: - type: - type: string - description: The type of the background task. - title: Deploy - enum: - - deploy - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/IJobAndFunctionHALLink' - description: HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Deploy - - type: object - properties: - type: - type: string - description: The type of the background task. - title: Verify - enum: - - verify - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/IJobAndFunctionHALLink' - description: HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Verify - - type: object - properties: - type: - type: string - description: The type of the background task. - title: Undeploy - enum: - - undeploy - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/IJobAndFunctionHALLink' - description: HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Undeploy - - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - scale - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/IJobAndFunctionHALLink' - description: HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Scale - - type: object - properties: - type: - type: string - description: The type of the background task. - title: Batch - enum: - - batch - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/IFunctionRef' - description: The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/IJobHALLinks' - description: HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Batch - IJobAndFunctionHALLink: - anyOf: - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - examples: - - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - examples: - - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - plug: - $ref: '#/components/schemas/HALLink' - description: Link to the plug. - examples: - - href: https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 - required: - - plug - title: Plug - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - examples: - - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - examples: - - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - webscript: - $ref: '#/components/schemas/HALLink' - description: Link to the webscript. - examples: - - href: https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 - required: - - webscript - title: Webscript - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - examples: - - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - examples: - - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - model: - $ref: '#/components/schemas/HALLink' - description: Link to the model. - examples: - - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - required: - - model - title: Model - - $ref: '#/components/schemas/IJobHALLinks' - title: No Function - description: HAL links to related actions. - IJobsResponse: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - jobs: - type: array - items: - $ref: '#/components/schemas/AnyJobStatusSummary' - description: Listing of jobs that satisfy the query. - required: - - jobs - description: Jobs Found - EventAck: - type: string - enum: - - ack - EventClose: - type: string - enum: - - close - EventKeepAlive: - type: string - enum: - - keep-alive - EventTypeSSE: - anyOf: - - $ref: '#/components/schemas/ESupportedEvents' - - $ref: '#/components/schemas/EventAck' - - $ref: '#/components/schemas/EventClose' - - $ref: '#/components/schemas/EventKeepAlive' - ESupportedEvents: - type: string - enum: - - completed - - failed - - active - - delayed - - waiting - - waiting-children - ActiveEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - active - data: - $ref: '#/components/schemas/IJobEventResponse_ActiveEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - title: Active - IJobEventResponse_ActiveEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/ActiveEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/IFunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - IJobEventPayload_ActiveEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/ActiveEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - JobReference: - type: object - properties: - type: - $ref: '#/components/schemas/EJobType' - id: - type: string - required: - - type - ActiveEventData: - type: object - properties: - prev: - $ref: '#/components/schemas/EQueueEvents' - description: The previous state of the job - EQueueEvents: - type: string - enum: - - completed - - failed - - active - - delayed - - waiting - - waiting-children - - added - - cleaned - - drained - - error - - paused - - progress - - removed - - resumed - - retries-exhausted - - stalled - IJobStatusAndEntityHALLinks: - anyOf: - - type: object - properties: - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - examples: - - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - plug: - $ref: '#/components/schemas/HALLink' - description: Link to the plug. - examples: - - href: https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 - required: - - plug - title: Plug - - type: object - properties: - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - examples: - - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - webscript: - $ref: '#/components/schemas/HALLink' - description: Link to the webscript. - examples: - - href: https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 - required: - - webscript - title: Webscript - - type: object - properties: - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - examples: - - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - model: - $ref: '#/components/schemas/HALLink' - description: Link to the model. - examples: - - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - required: - - model - title: Model - - $ref: '#/components/schemas/IJobStatusHALLink' - title: No Function - description: HAL links to related actions. - CompletedEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - completed - data: - $ref: '#/components/schemas/IJobEventResponse_CompletedEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - title: Completed - IJobEventResponse_CompletedEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/CompletedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/IFunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - IJobEventPayload_CompletedEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/CompletedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - CompletedEventData: - type: object - properties: - prev: - $ref: '#/components/schemas/EQueueEvents' - description: The previous state of the job - returnValue: - $ref: '#/components/schemas/AnyJobResult' - description: The return value of the job - required: - - returnValue - AnyJobResult: - anyOf: - - $ref: '#/components/schemas/IBuildResult' - - $ref: '#/components/schemas/IDeployResult' - - $ref: '#/components/schemas/IVerifyResult' - - $ref: '#/components/schemas/IUndeployResult' - - $ref: '#/components/schemas/IScaleResult' - - $ref: '#/components/schemas/IBatchResult' - - $ref: '#/components/schemas/ICleanupResult' - ICleanupResult: - type: object - properties: - scheduledJob: - $ref: '#/components/schemas/JobReference' - description: The result data for a completed cleanup job. - title: Cleanup - FailedEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - failed - data: - $ref: '#/components/schemas/IJobEventResponse_FailedEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - title: Failed - IJobEventResponse_FailedEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/FailedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/IFunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - IJobEventPayload_FailedEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/FailedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - FailedEventData: - type: object - properties: - prev: - $ref: '#/components/schemas/EQueueEvents' - description: The previous state of the job - failedReason: - type: string - description: The failure reason of the job - required: - - failedReason - DelayedEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - delayed - data: - $ref: '#/components/schemas/IJobEventResponse_DelayedEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - title: Delayed - IJobEventResponse_DelayedEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/DelayedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/IFunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - IJobEventPayload_DelayedEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/DelayedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - DelayedEventData: - type: object - properties: - delay: - type: number - required: - - delay - WaitingEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - waiting - data: - $ref: '#/components/schemas/IJobEventResponse_WaitingEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - title: Waiting - IJobEventResponse_WaitingEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/WaitingEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/IFunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - IJobEventPayload_WaitingEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/WaitingEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - WaitingEventData: - type: object - properties: - prev: - $ref: '#/components/schemas/EQueueEvents' - description: The previous state of the job - WaitingChildrenEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - waiting-children - data: - $ref: '#/components/schemas/IJobEventResponse_WaitingChildrenEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - title: Waiting Children - IJobEventResponse_WaitingChildrenEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/WaitingChildrenEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/IFunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - IJobEventPayload_WaitingChildrenEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/WaitingChildrenEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - WaitingChildrenEventData: - type: object - JobEventSSE: - anyOf: - - $ref: '#/components/schemas/ActiveEventSSE' - - $ref: '#/components/schemas/CompletedEventSSE' - - $ref: '#/components/schemas/FailedEventSSE' - - $ref: '#/components/schemas/DelayedEventSSE' - - $ref: '#/components/schemas/WaitingEventSSE' - - $ref: '#/components/schemas/WaitingChildrenEventSSE' - title: Job Event - KeepAliveEventSSE: - type: object - properties: - event: - $ref: '#/components/schemas/EventKeepAlive' - data: - type: string - description: A text message acknowledging that events will be forwarded. - required: - - event - description: A message that acknowledges that the stream is still alive. - title: Keep Alive - EventSSE: + description: The type of the background task. + title: Batch + enum: + - batch + operation: + type: string + description: The operation name for the background task. + id: + type: string + description: The id of the background job, or the constant `_unknown_` + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + createdAt: + type: string + format: date-time + description: The creation time of this job + createdBy: + type: string + description: The user that initiated this job + function: + $ref: '#/components/schemas/IFunctionRef' + description: The function entity that this job acts on, will be `undefined` + for batch jobs. + _links: + $ref: '#/components/schemas/IJobHALLinks' + description: HAL links to related the job status, SSE stream, and function + entity if relevant. + required: + - _links + - createdAt + - createdBy + - id + - operation + - state + - type + title: Batch + IJobAndFunctionHALLink: anyOf: - type: object properties: event: - $ref: '#/components/schemas/EventAck' - data: - type: string - description: A text message acknowledging what events will be forwarded. + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + examples: + - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + examples: + - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + plug: + $ref: '#/components/schemas/HALLink' + description: Link to the plug. + examples: + - href: https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 required: - - event - - data - description: A message that acknowledges that the server will sent job state - changes. - title: Stream Ready - - $ref: '#/components/schemas/JobEventSSE' - - $ref: '#/components/schemas/KeepAliveEventSSE' - description: SSE stream events without closing protocol - EventWithCloseSSE: - anyOf: + - plug + title: Plug - type: object properties: event: - $ref: '#/components/schemas/EventAck' - data: - type: string - description: A text message acknowledging what events will be forwarded. + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + examples: + - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + examples: + - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + webscript: + $ref: '#/components/schemas/HALLink' + description: Link to the webscript. + examples: + - href: https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 required: - - event - - data - description: A message that acknowledges that the server will sent job state - changes. - title: Stream Ready - - $ref: '#/components/schemas/JobEventSSE' - - $ref: '#/components/schemas/KeepAliveEventSSE' + - webscript + title: Webscript - type: object properties: event: - $ref: '#/components/schemas/EventClose' - data: - type: string - description: A text message describing the cause for closing the stream. + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + examples: + - href: https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + examples: + - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + model: + $ref: '#/components/schemas/HALLink' + description: Link to the model. + examples: + - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 required: - - event - - data - description: A message that notifies that the server will not send more events, - and that the client should close. - title: Stream Closing - description: SSE stream events with closing protocol - ILegacyPlugCreateResponse: - type: object - properties: - statusCode: - type: number - uri: - type: string - entity: - $ref: '#/components/schemas/ILegacyPlugScriptResponse' - required: - - entity - - statusCode - - uri - IStatusResponse: - type: object - properties: - statusCode: - type: number - required: - - statusCode - ILegacyPlugScriptResponse: - type: object - properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - type: - $ref: '#/components/schemas/EPlugType' - script: - type: string - metadata: - $ref: '#/components/schemas/ILegacyPlugScriptMeta' - dependencies: - type: object - required: - - name - - version - - type - - script - - metadata - - dependencies - ILegacyPlugScriptMeta: - type: object - properties: - author: - type: string - description: - type: string - category: - type: string - tags: - type: array - items: - $ref: '#/components/schemas/ITag' - iconURL: - type: string - friendlyName: - type: string - supportedStates: - type: array - items: - type: string - rawData: - type: array - items: - type: object - properties: - parameter: - type: string - dataType: - type: string - required: - - parameter - requiredProperties: - $ref: '#/components/schemas/LegacyRequiredProperties' - required: - - supportedStates - - rawData - ILegacyPlugResponse: - type: object - properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - author: - type: string - category: - type: string - iconURL: - type: string - documentationURL: - type: string - isDeprecated: - type: boolean - description: - type: string - states: - type: array - items: - type: string - rawData: - type: array - items: - type: object - mediaType: - $ref: '#/components/schemas/EMediaType' - configuration: - type: array - items: - $ref: '#/components/schemas/ILegacyConfigurationResponseObject' - commands: - type: array - items: - type: string - status: - $ref: '#/components/schemas/EStatus' - failureReason: - $ref: '#/components/schemas/FailureReason' - metadata: - type: object - properties: - documentation: - $ref: '#/components/schemas/ILegacyDocumentation' - author: - type: string - description: - type: string - category: - type: string - tags: - type: array - items: - $ref: '#/components/schemas/ITag' - iconURL: - type: string - friendlyName: - type: string - required: - - name - - version - - isDeprecated - - mediaType - - commands - - status - - metadata - EMediaType: - type: string - enum: - - application/javascript - - application/java-vm - - text/x-python - - text/x-golang - ILegacyConfigurationResponseObject: - type: object - properties: - name: - type: string - type: - $ref: '#/components/schemas/EPlugPropertyDataType' - mandatory: - type: boolean - format: - type: object - properties: - type: - $ref: '#/components/schemas/EPlugPropertyFormatType' - values: - type: array - items: - $ref: '#/components/schemas/EnumValue' - defaultValue: - $ref: '#/components/schemas/DefaultValue' - sensitive: - type: boolean - required: - - name - - type - LegacyPlugHtmlResponse: - type: string - description: The documentation html of a plug. - ILegacyCreateDebugResponse: - type: object - properties: - functionName: - type: string - required: - - functionName - IMessageAndStatusResponse: - type: object - properties: - message: - type: string - statusCode: + - model + title: Model + - $ref: '#/components/schemas/IJobHALLinks' + title: No Function + description: HAL links to related actions. + IJobsResponse: + type: object + properties: + limit: type: number + description: The page size used for this query result. + jobs: + type: array + items: + $ref: '#/components/schemas/AnyJobStatusSummary' + description: Listing of jobs that satisfy the query. required: - - message - - statusCode - IErrorAndStatusResponse: + - jobs + description: Jobs Found + EventAck: + type: string + enum: + - ack + EventClose: + type: string + enum: + - close + EventKeepAlive: + type: string + enum: + - keep-alive + ActiveEventSSE: type: object properties: - error: + event: type: string - statusCode: - type: number + description: The job queue event that trigged this message + enum: + - active + data: + $ref: '#/components/schemas/IJobEventResponse_ActiveEventData_' + description: The payload message (json-encoded in the `text/event-stream`). required: - - error - - statusCode - IEntityResponse: + - event + - data + description: A message that notifies a state change in a background job. + title: Active + IJobEventResponse_ActiveEventData_: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/ERuntime' - description: The runtime that specifies how this function should be built - and deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build and - deployment. When set, the latest available patch version with - the same minor version is used. Note that, after deployment, - this runtime version can become obsolete with a rebuild action. - metadata: - $ref: '#/components/schemas/IFunctionMeta' - description: Metadata describing the function. Note that, after deployment, - this metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: + _links: + $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/ActiveEventData' + description: Additional data for the event + timestamp: type: string format: date-time - description: The timestamp at which this entity was last updated. - status: - $ref: '#/components/schemas/EStatus' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function - entity. - _links: - type: array - items: - $ref: '#/components/schemas/IJobHALLinks' - description: Links to related entities. + description: Timestamp of the event + function: + $ref: '#/components/schemas/IFunctionRef' + description: Information of entity for which this job is executing . required: - - createdAt - - createdBy - - metadata - - name - - runtime - - status - - updatedAt - - updatedBy - - version - IPlugResponse: + - _links + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + JobReference: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/ERuntime' - description: The runtime that specifies how this function should be built - and deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build and - deployment. When set, the latest available patch version with - the same minor version is used. Note that, after deployment, - this runtime version can become obsolete with a rebuild action. - metadata: - $ref: '#/components/schemas/IFunctionMeta' - description: Metadata describing the function. Note that, after deployment, - this metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: + type: + $ref: '#/components/schemas/EJobType' + id: type: string - format: date-time - description: The timestamp at which this entity was last updated. - status: - $ref: '#/components/schemas/EStatus' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function - entity. - _links: - type: array - items: - $ref: '#/components/schemas/IJobHALLinks' - description: Links to related entities. - isDeprecated: - type: boolean required: - - createdAt - - createdBy - - isDeprecated - - metadata - - name - - runtime - - status - - updatedAt - - updatedBy - - version - IPlugListingResponse: + - type + ActiveEventData: + type: object + properties: + prev: + $ref: '#/components/schemas/EQueueEvents' + description: The previous state of the job + EQueueEvents: + type: string + enum: + - completed + - failed + - active + - delayed + - waiting + - waiting-children + - added + - cleaned + - drained + - error + - paused + - progress + - removed + - resumed + - retries-exhausted + - stalled + IJobStatusAndEntityHALLinks: + anyOf: + - type: object + properties: + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + examples: + - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + plug: + $ref: '#/components/schemas/HALLink' + description: Link to the plug. + examples: + - href: https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 + required: + - plug + title: Plug + - type: object + properties: + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + examples: + - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + webscript: + $ref: '#/components/schemas/HALLink' + description: Link to the webscript. + examples: + - href: https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 + required: + - webscript + title: Webscript + - type: object + properties: + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + examples: + - href: https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + model: + $ref: '#/components/schemas/HALLink' + description: Link to the model. + examples: + - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + required: + - model + title: Model + - $ref: '#/components/schemas/IJobStatusHALLink' + title: No Function + description: HAL links to related actions. + CompletedEventSSE: type: object properties: - plugs: - type: array - items: - $ref: '#/components/schemas/IPlugResponse' + event: + type: string + description: The job queue event that trigged this message + enum: + - completed + data: + $ref: '#/components/schemas/IJobEventResponse_CompletedEventData_' + description: The payload message (json-encoded in the `text/event-stream`). required: - - plugs - description: Successful Response - IPagingResponse: + - event + - data + description: A message that notifies a state change in a background job. + title: Completed + IJobEventResponse_CompletedEventData_: type: object properties: - count: - type: number - description: The total count of matching items, from which this result is - one page. - limit: - type: number - description: The page size used for this query result. - page: - type: number - description: The page number of a paged query result. - IPlugListingAndQueryResponse: + _links: + $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/CompletedEventData' + description: Additional data for the event + timestamp: + type: string + format: date-time + description: Timestamp of the event + function: + $ref: '#/components/schemas/IFunctionRef' + description: Information of entity for which this job is executing . + required: + - _links + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + CompletedEventData: type: object properties: - count: - type: number - description: The total count of matching items, from which this result is - one page. - limit: - type: number - description: The page size used for this query result. - page: - type: number - description: The page number of a paged query result. - plugs: - type: array - items: - $ref: '#/components/schemas/IPlugResponse' + prev: + $ref: '#/components/schemas/EQueueEvents' + description: The previous state of the job + returnvalue: + $ref: '#/components/schemas/AnyJobResult' + description: The return value of the job required: - - plugs - description: Successful Response - ICreatePlugAsyncResponse: + - returnvalue + AnyJobResult: + anyOf: + - $ref: '#/components/schemas/IBuildResult' + - $ref: '#/components/schemas/IDeployResult' + - $ref: '#/components/schemas/IVerifyResult' + - $ref: '#/components/schemas/IUndeployResult' + - $ref: '#/components/schemas/IScaleResult' + - $ref: '#/components/schemas/IBatchResult' + - $ref: '#/components/schemas/ICleanupResult' + - $ref: '#/components/schemas/INotifyResult' + ICleanupResult: type: object properties: - message: - type: string - _links: - $ref: '#/components/schemas/IJobHALLinks' - entity: - $ref: '#/components/schemas/IPlugManifest' - required: - - _links - - entity - - message - description: Successful Response - IWebscriptResponse: + scheduledJob: + $ref: '#/components/schemas/JobReference' + description: The result data for a completed cleanup job. + title: Cleanup + INotifyResult: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/ERuntime' - description: The runtime that specifies how this function should be built - and deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build and - deployment. When set, the latest available patch version with - the same minor version is used. Note that, after deployment, - this runtime version can become obsolete with a rebuild action. - metadata: - $ref: '#/components/schemas/IFunctionMeta' - description: Metadata describing the function. Note that, after deployment, - this metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - status: - $ref: '#/components/schemas/EStatus' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function - entity. - _links: - type: array - items: - $ref: '#/components/schemas/IJobHALLinks' - description: Links to related entities. - secret: - type: - - string - - 'null' + operation: + $ref: '#/components/schemas/ERequestOperation' required: - - createdAt - - createdBy - - metadata - - name - - runtime - - secret - - status - - updatedAt - - updatedBy - - version - description: Successful Response - ICreateWebscriptAsyncResponse: + - operation + description: The result data for a change notification. + title: Notify + FailedEventSSE: type: object properties: - message: + event: type: string - _links: - $ref: '#/components/schemas/IJobHALLinks' - entity: - $ref: '#/components/schemas/IWebscriptManifest' + description: The job queue event that trigged this message + enum: + - failed + data: + $ref: '#/components/schemas/IJobEventResponse_FailedEventData_' + description: The payload message (json-encoded in the `text/event-stream`). required: - - _links - - entity - - message - description: Successful Response - IKFServingResponse: + - event + - data + description: A message that notifies a state change in a background job. + title: Failed + IJobEventResponse_FailedEventData_: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/ERuntime' - description: The runtime that specifies how this function should be built - and deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build and - deployment. When set, the latest available patch version with - the same minor version is used. Note that, after deployment, - this runtime version can become obsolete with a rebuild action. - metadata: - $ref: '#/components/schemas/IFunctionMeta' - description: Metadata describing the function. Note that, after deployment, - this metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: + _links: + $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/FailedEventData' + description: Additional data for the event + timestamp: type: string format: date-time - description: The timestamp at which this entity was last updated. - status: - $ref: '#/components/schemas/EStatus' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function - entity. - _links: - type: array - items: - $ref: '#/components/schemas/IJobHALLinks' - description: Links to related entities. - required: - - createdAt - - createdBy - - metadata - - name - - runtime - - status - - updatedAt - - updatedBy - - version - description: Successful Response - IKFServingModelsResponse: + description: Timestamp of the event + function: + $ref: '#/components/schemas/IFunctionRef' + description: Information of entity for which this job is executing . + required: + - _links + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + FailedEventData: type: object properties: - models: - type: array - items: - $ref: '#/components/schemas/IKFServingResponse' - paging: - $ref: '#/components/schemas/IPagingResponse' + prev: + $ref: '#/components/schemas/EQueueEvents' + description: The previous state of the job + failedReason: + type: string + description: The failure reason of the job required: - - models - description: Successful Response - ICreateKFServingAsyncResponse: + - failedReason + DelayedEventSSE: type: object properties: - message: + event: type: string + description: The job queue event that trigged this message + enum: + - delayed + data: + $ref: '#/components/schemas/IJobEventResponse_DelayedEventData_' + description: The payload message (json-encoded in the `text/event-stream`). + required: + - event + - data + description: A message that notifies a state change in a background job. + title: Delayed + IJobEventResponse_DelayedEventData_: + type: object + properties: _links: - $ref: '#/components/schemas/IJobHALLinks' - entity: - $ref: '#/components/schemas/IKFServingManifest' + $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/DelayedEventData' + description: Additional data for the event + timestamp: + type: string + format: date-time + description: Timestamp of the event + function: + $ref: '#/components/schemas/IFunctionRef' + description: Information of entity for which this job is executing . required: - _links - - entity - - message - description: Model Deployment Initiated - IKFServingDeleteMultipleResponse: + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + DelayedEventData: type: object properties: - name: - type: string - versions: - type: array - items: - type: string + delay: + type: number required: - - name - - versions - description: Models Deleted - IKFServingDeleteMultipleWithJobResponse: + - delay + WaitingEventSSE: type: object properties: - name: - type: string - versions: - type: array - items: - type: string - message: + event: type: string + description: The job queue event that trigged this message + enum: + - waiting + data: + $ref: '#/components/schemas/IJobEventResponse_WaitingEventData_' + description: The payload message (json-encoded in the `text/event-stream`). + required: + - event + - data + description: A message that notifies a state change in a background job. + title: Waiting + IJobEventResponse_WaitingEventData_: + type: object + properties: _links: - $ref: '#/components/schemas/IJobHALLinks' + $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/WaitingEventData' + description: Additional data for the event + timestamp: + type: string + format: date-time + description: Timestamp of the event + function: + $ref: '#/components/schemas/IFunctionRef' + description: Information of entity for which this job is executing . required: - _links - - message - - name - - versions - description: Model Deletions Initiated - IKFServingDeleteResponse: + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + WaitingEventData: type: object properties: - name: + prev: + $ref: '#/components/schemas/EQueueEvents' + description: The previous state of the job + WaitingChildrenEventSSE: + type: object + properties: + event: type: string - description: The name of the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The version of the function. + description: The job queue event that trigged this message + enum: + - waiting-children + data: + $ref: '#/components/schemas/IJobEventResponse_WaitingChildrenEventData_' + description: The payload message (json-encoded in the `text/event-stream`). required: - - name - - version - description: Model Deleted - IKFServingDeleteWithJobResponse: + - event + - data + description: A message that notifies a state change in a background job. + title: Waiting Children + IJobEventResponse_WaitingChildrenEventData_: type: object properties: - message: - type: string _links: - $ref: '#/components/schemas/IJobHALLinks' - name: + $ref: '#/components/schemas/IJobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/WaitingChildrenEventData' + description: Additional data for the event + timestamp: type: string - description: The name of the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The version of the function. + format: date-time + description: Timestamp of the event + function: + $ref: '#/components/schemas/IFunctionRef' + description: Information of entity for which this job is executing . required: - _links - - message - - name - - version - description: Model Delete Initiated + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + WaitingChildrenEventData: + type: object + JobEventSSE: + anyOf: + - $ref: '#/components/schemas/ActiveEventSSE' + - $ref: '#/components/schemas/CompletedEventSSE' + - $ref: '#/components/schemas/FailedEventSSE' + - $ref: '#/components/schemas/DelayedEventSSE' + - $ref: '#/components/schemas/WaitingEventSSE' + - $ref: '#/components/schemas/WaitingChildrenEventSSE' + title: Job Event + KeepAliveEventSSE: + type: object + properties: + event: + $ref: '#/components/schemas/EventKeepAlive' + data: + type: string + description: A text message acknowledging that events will be forwarded. + required: + - event + description: A message that acknowledges that the stream is still alive. + title: Keep Alive + EventWithCloseSSE: + anyOf: + - type: object + properties: + event: + $ref: '#/components/schemas/EventAck' + data: + type: string + description: A text message acknowledging what events will be forwarded. + required: + - event + - data + description: A message that acknowledges that the server will sent job state + changes. + title: Stream Ready + - $ref: '#/components/schemas/JobEventSSE' + - $ref: '#/components/schemas/KeepAliveEventSSE' + - type: object + properties: + event: + $ref: '#/components/schemas/EventClose' + data: + type: string + description: A text message describing the cause for closing the stream. + required: + - event + - data + description: A message that notifies that the server will not send more events, + and that the client should close. + title: Stream Closing + description: SSE stream events with closing protocol paths: /registry/v2/: get: - summary: Version - description: Get the version of this function registry deployment. + operationId: get_about + summary: Get Service Status + tags: + - About + description: Get the status and version of the function registry service. x-version: v2 responses: default: @@ -8486,7 +4136,6 @@ paths: application/json: schema: $ref: '#/components/schemas/IRootPageResponse' - operationId: get_registry_v2 security: &id001 - waylayApiKeySecret: [] /registry/v2/jobs/: @@ -8615,7 +4264,7 @@ paths: '200': description: Events Streaming content: - text/eventstream: + text/event-stream: schema: $ref: '#/components/schemas/EventWithCloseSSE' security: *id001 @@ -8927,6 +4576,12 @@ paths: description: Runtime example archive type: string format: binary + application/tar: + schema: + title: Archive + description: Runtime example archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -9009,6 +4664,12 @@ paths: description: Runtime example archive type: string format: binary + application/tar: + schema: + title: Archive + description: Runtime example archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -9039,190 +4700,139 @@ paths: security: *id001 /registry/v2/webscripts/: post: - operationId: create_webscript_functions + operationId: create_webscripts summary: Create Webscript Version tags: - - Webscript Functions + - Webscripts description: "Creates a new webscript function by uploading its assets.\n\ - \ \n The assets for a webscript function can be provided as either\n\ - \
    \n
  • a single tar archive (optionally compressed), with\ - \ one of the content types \n application/octet-stream, application/tar+gzip,\ - \ application/x-gzip, application/x-tar, application/gzip
    • \n\ - \
  • separate files in a multipart/form-data request
    • \n\ - \
\n \n The required webscript.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET /registry/v2/runtimes?functionType=webscripts).\n\ - \n For each runtime other files will be required or supported.\n\ - \n " + \ \n The assets for a webscript function can be provided as\n \ + \
    \n
  • A single tar archive (optionally compressed), with\ + \ one of the content types \n application/octet-stream, application/tar,\ + \ application/tar+gzip, application/x-gzip, application/x-tar,\ + \ application/gzip
    • \n
  • Separate files in a multipart/form-data\ + \ request
    • \n
  • A reference to the assets of another webscript\ + \ in the copy argument
    • \n
\n\n The required webscript.json\ + \ json file contains the function metadata,\n and must have a runtime\ + \ attribute that is one of the supported runtimes \n (see GET\ + \ /registry/v2/runtimes?functionType=webscripts).\n\n For each runtime\ + \ other files will be required or supported.\n\n " requestBody: content: application/octet-stream: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
    \n
  • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
    • \n\ - \
  • separate files in a multipart/form-data request
    • \n\ - \
\n \n The required webscript.json json file\ - \ contains the function metadata,\n and must have a runtime\ - \ attribute that is one of the supported runtimes \n (see\ - \ GET /registry/v2/runtimes?functionType=webscripts).\n\ - \n For each runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
    \n
  • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
    • \n\ - \
  • separate files in a multipart/form-data request
    • \n\ - \
\n \n The required webscript.json json file\ - \ contains the function metadata,\n and must have a runtime\ - \ attribute that is one of the supported runtimes \n (see\ - \ GET /registry/v2/runtimes?functionType=webscripts).\n\ - \n For each runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
    \n
  • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
    • \n\ - \
  • separate files in a multipart/form-data request
    • \n\ - \
\n \n The required webscript.json json file\ - \ contains the function metadata,\n and must have a runtime\ - \ attribute that is one of the supported runtimes \n (see\ - \ GET /registry/v2/runtimes?functionType=webscripts).\n\ - \n For each runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
    \n
  • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
    • \n\ - \
  • separate files in a multipart/form-data request
    • \n\ - \
\n \n The required webscript.json json file\ - \ contains the function metadata,\n and must have a runtime\ - \ attribute that is one of the supported runtimes \n (see\ - \ GET /registry/v2/runtimes?functionType=webscripts).\n\ - \n For each runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
    \n
  • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
    • \n\ - \
  • separate files in a multipart/form-data request
    • \n\ - \
\n \n The required webscript.json json file\ - \ contains the function metadata,\n and must have a runtime\ - \ attribute that is one of the supported runtimes \n (see\ - \ GET /registry/v2/runtimes?functionType=webscripts).\n\ - \n For each runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
    \n
  • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
    • \n\ - \
  • separate files in a multipart/form-data request
    • \n\ - \
\n \n The required webscript.json json file\ - \ contains the function metadata,\n and must have a runtime\ - \ attribute that is one of the supported runtimes \n (see\ - \ GET /registry/v2/runtimes?functionType=webscripts).\n\ - \n For each runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: Multipart file upload. + description: 'A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset path.' + type: object + properties: + assets: + type: array + items: + type: string + format: binary + application/json: + schema: + title: Empty Upload + description: Empty object request body, only allowed when using the + `copy` query parameter. + type: object + maxProperties: 0 + '*/*+json': + schema: + title: Empty Upload + description: Empty object request body, only allowed when using the + `copy` query parameter. + type: object + maxProperties: 0 description: "The assets for a webscript function can be provided\ - \ as either\n
    \n
  • a single tar archive (optionally compressed),\ + \ as\n
      \n
    • A single tar archive (optionally compressed),\ \ with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip, application/x-tar,\ - \ application/gzip
      • \n
    • separate files in a multipart/form-data\ - \ request
      • \n
    \n \n The required webscript.json\ + \ application/tar, application/tar+gzip, application/x-gzip,\ + \ application/x-tar, application/gzip
    • \n \ + \
  • Separate files in a multipart/form-data request
    • \n\ + \
  • A reference to the assets of another webscript in the\ + \ copy argument
    • \n
\n\n The required webscript.json\ \ json file contains the function metadata,\n and must have a runtime\ \ attribute that is one of the supported runtimes \n (see GET\ \ /registry/v2/runtimes?functionType=webscripts).\n\n For each runtime\ \ other files will be required or supported.\n" parameters: + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: patch @@ -9248,15 +4858,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: scaleToZero - required: false - description: If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources when - the function is not to be used immediately. - schema: $ref: '#/components/schemas/SemanticVersionRange' in: query @@ -9281,6 +4882,53 @@ paths: description: If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. + - schema: + $ref: '#/components/schemas/NamedVersionRange' + in: query + name: runtime + required: false + description: 'If set, the created function will use the indicated runtime + (latest version within specified range). + + + This takes precedence over the runtime specified in a function manifest + (copied or from request body).' + - schema: + anyOf: + - $ref: '#/components/schemas/NamedVersionRange' + - $ref: '#/components/schemas/ExampleReference' + in: query + name: copy + required: false + description: "Indicates the _source_ of initial assets for a _new function_.\n\ + \nWhen using this query parameter, the request body does not need to contain\ + \ assets, but any assets in the request body will overwrite the copied assets.\n\ + \n#### Selection of _assets_ source\n\n* If set as `[@]`,\ + \ the _new function_ will be created with copied assets of the selected\ + \ _source function_.\n* If set as `!example`, a `runtime` query parameter\ + \ is required, and the _new function_ will be initialized with assets of\ + \ the _runtime example_.\n\n#### Selection of the _source function_\n\n\ + When `` is a range (or is not given), the latest _published_\ + \ version (in that range) is used.\n\nIf no _published_ version exists,\ + \ the latest _draft_ is selected.\n\nIf no versions in the range exist,\ + \ a `404` _Not Found_ error is returned.\n\n#### The `name` of the _new\ + \ function_\n\nIf a `name` is NOT specified (either as query parameter,\ + \ or in an optional manifest asset in the request body), the `name` of the\ + \ _new function_ will be that of the _source function_.\n\n#### The `version`\ + \ of the _new function_\n\nWhen the _target_ and _source_ name are equal,\ + \ the `version` query parameters is defaulted to ``\ + \ (`~` when it's an exact version)\n\nThe version of\ + \ the _new function_ will be:\n* If a `version` is NOT specified (either\ + \ as query parameter, in an optional manifest asset, or as ``\ + \ _default_)\n\n * a **patch increment** (`..+1`)\ + \ of the latest **existing version** with the target `name`\n\n * **`1.0.0`**\ + \ otherwise\n\n* If a `version` is specified:\n\n * the **lowest version**\ + \ in that range **if no existing version** is in that range.\n\n * an **increment**\ + \ of the latest existing version, **at the highest level** (_major_,_minor_,_patch_)\ + \ allowed by that range.\n\n * otherwise, if all allowed versions already\ + \ exist, a **`409` _Duplicate_ error** is raised.\n\n#### Deployment overrides\n\ + \nThe new function will use the deployment overrides of the copied function,\ + \ unless a _manifest_ was specified in the request body." x-version: v2 responses: '201': @@ -9297,10 +4945,10 @@ paths: $ref: '#/components/schemas/IPostWebscriptJobAsyncResponseV2' security: *id001 get: - operationId: list_webscript_functions + operationId: list_webscripts summary: List Webscripts tags: - - Webscript Functions + - Webscripts description: "List the (latest) versions of available webscripts.\n\ \n### List Latest Webscript Versions\nBy default, the result includes the\ \ latest non-deprecated, non-draft version for each webscript name.\n\ @@ -9313,19 +4961,21 @@ paths: \ versions.\n
  • includeDraft=true: do not prefer non-draft\ \ versions as a latest version: if the latest version is a draft, it will\ \ be shown, even if there are older non-draft versions.
    • \n \n\n\n\ - As long as no _version filters_ are used, each listed webscript version\ - \ item will contain a HAL **link to the \nlatest** _draft_ (`entities[]._links.draft`)\ - \ or latest _published_ (`entities[]._links.publisned`) version (if existing\ - \ and different).\n\n### List Latest Webscript Versions (with filter)\nWhen\ - \ any of the _version filter_ query parameters are used, the response contains\n\ - the _latest_ version per named webscript that satisfy the filters,\ - \ but **without links**.\n\n### List All Webscript Versions\nWhen using `latest=false`\ - \ (default when using the `namedVersion` filter), the listing contains _all_\ - \ \nwebscripts versions that satisfy the query, possibly multiple\ - \ versions per named webscripts.\nNo HAL links are provided.\n\n\ - #### Filter on _status_\nBy default webscript versions with status\ - \ `undeployed` are **excluded** in all cases.\nUse the _version filter_ `status`\ - \ to include/exclude a status from the results.\nBy example, \n> `?status=any&includeDeprecated=true&includeDraft=true&latest=false`\n\ + As long as no version filters are used, each listed webscript version\ + \ contains representations of the latest draft (`entities[]._links.draft`)\ + \ \nor latest published (`entities[]._links.published`) version (if existing\ + \ and different). \nUse the query parameter `showRelated` to include only\ + \ a link (default `showRelated=link`) or a full representation (`showRelated=embed`).\n\ + \n### List Latest Webscript Versions (with filter)\nWhen any of the _version\ + \ filter_ query parameters are used, the response contains\nthe _latest_ version\ + \ per named webscript that satisfy the filters, but **without links**.\n\ + \n### List All Webscript Versions\nWhen using `latest=false` (default when\ + \ using the `namedVersion` filter), the listing contains _all_ \nwebscripts\ + \ versions that satisfy the query, possibly multiple versions per named webscripts.\n\ + No HAL links are provided.\n\n#### Filter on _status_\nBy default webscript\ + \ versions with status `undeployed` are **excluded** in all cases.\n\ + Use the _version filter_ `status` to include/exclude a status from the results.\n\ + By example, \n> `?status=any&includeDeprecated=true&includeDraft=true&latest=false`\n\ \nwill list _ALL_ versions known to the function registry.\n\n#### Version\ \ filter parameters\nThe following query parameters are _version filters_\ \ for the webscript listing:\n> `version`, `status`, `runtimeVersion`,\ @@ -9487,6 +5137,19 @@ paths: If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. + - schema: + $ref: '#/components/schemas/ShowRelatedType' + in: query + name: showRelated + required: false + description: 'Sets the representation of related function versions (like the + _latest_ draft and/or published) in the response. + + - `embed`: as full summary representation (in `_embedded`). + + - `link`: as HAL link in (in `_links`). + + - `none`: omitted.' x-version: v2 responses: '200': @@ -9498,10 +5161,10 @@ paths: security: *id001 /registry/v2/webscripts/{name}/versions: get: - operationId: listVersions_webscript_functions + operationId: listVersions_webscripts summary: List Webscript Versions tags: - - Webscript Functions + - Webscripts description: List all deployed versions of a webscript. parameters: - schema: @@ -9631,10 +5294,10 @@ paths: security: *id001 /registry/v2/webscripts/{name}/versions/{version}: get: - operationId: get_webscript_functions + operationId: get_webscripts summary: Get Webscript Version tags: - - Webscript Functions + - Webscripts description: Get the webscript version. parameters: - schema: @@ -9659,10 +5322,10 @@ paths: $ref: '#/components/schemas/IGetWebscriptResponseV2' security: *id001 delete: - operationId: removeVersion_webscript_functions + operationId: removeVersion_webscripts summary: Remove Webscript Version tags: - - Webscript Functions + - Webscripts description: "Deprecate, undeploy and/or remove a webscript version.\n\ \n By default, a `DELETE` \n * _deprecates_ the webscript version(s): they\ \ are no longer included in listings by default.\n * _undeploys_ the webscript\ @@ -9759,13 +5422,21 @@ paths: security: *id001 /registry/v2/webscripts/{name}/versions/{version}/rebuild: post: - operationId: rebuild_webscript_functions + operationId: rebuild_webscripts summary: Rebuild Webscript tags: - - Webscript Functions + - Webscripts description: Rebuild and deploy a webscript with the original or updated base image. parameters: + - schema: + type: boolean + in: query + name: scaleToZero + required: false + description: Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero only + if it was not active before this command. - schema: type: string in: query @@ -9824,14 +5495,6 @@ paths: * running jobs on entity * the `dryRun` option' - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: Indicates whether the function needs to be scaled down after - successful (re-)deployment. If not set, the function is scaled to zero only - if it was not active before this command. - schema: type: boolean in: query @@ -9868,10 +5531,10 @@ paths: security: *id001 /registry/v2/webscripts/{name}: get: - operationId: getLatest_webscript_functions + operationId: getLatest_webscripts summary: Get Latest Webscript Version tags: - - Webscript Functions + - Webscripts description: "Fetch the latest version of a webscript.\n\n By default,\ \ the result shows the latest non-deprecated, non-draft version.\n If there\ \ is no such version, the latest deprecated or the latest draft version is\ @@ -9920,10 +5583,10 @@ paths: $ref: '#/components/schemas/IGetWebscriptResponseV2' security: *id001 delete: - operationId: removeVersions_webscript_functions + operationId: removeVersions_webscripts summary: Remove Webscript tags: - - Webscript Functions + - Webscripts description: "Deprecate, undeploy and/or remove all versions of this named webscript.\n\ \n By default, a `DELETE` \n * _deprecates_ the webscript version(s): they\ \ are no longer included in listings by default.\n * _undeploys_ the webscript\ @@ -10014,10 +5677,10 @@ paths: security: *id001 /registry/v2/webscripts/{name}/versions/{version}/metadata: patch: - operationId: patchMetadata_webscript_functions + operationId: patchMetadata_webscripts summary: Patch Webscript Metadata tags: - - Webscript Functions + - Webscripts description: Patch the metadata of a webscript version. requestBody: content: @@ -10054,10 +5717,10 @@ paths: security: *id001 /registry/v2/webscripts/{name}/versions/{version}/content: get: - operationId: getArchive_webscript_functions + operationId: getArchive_webscripts summary: Get Webscript Archive tags: - - Webscript Functions + - Webscripts description: Get the specification archive of a webscript. parameters: - schema: @@ -10092,6 +5755,12 @@ paths: description: Webscript archive type: string format: binary + application/tar: + schema: + title: Archive + description: Webscript archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -10121,17 +5790,17 @@ paths: $ref: '#/components/schemas/IContentValidationListing' security: *id001 put: - operationId: updateAssets_webscript_functions + operationId: updateAssets_webscripts summary: Update Webscript Assets tags: - - Webscript Functions + - Webscripts description: "Update a draft webscript function by updating its assets.\n\ \ \n The assets for a webscript function can be provided as either\n\ \
      \n
    • a single tar archive (optionally compressed), with\ - \ one of the content types \n application/octet-stream, application/tar+gzip,\ - \ application/x-gzip, application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the webscript\ + \ one of the content types \n application/octet-stream, application/tar,\ + \ application/tar+gzip, application/x-gzip, application/x-tar,\ + \ application/gzip\n
  • separate files in a multipart/form-data\ + \ request
    • \n \n\n The provided assets will be added to the webscript\ \ function's collection of existing assets,\n replacing any existing assets\ \ with the same name.\n\n Please note that it is not allowed to update the\ \ webscript.json     json file with a changed value for any of the\n \ @@ -10141,190 +5810,113 @@ paths: content: application/octet-stream: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the webscript\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the webscript.json     json file with a changed value\ - \ for any of the\n name, version and/or\ - \ runtime attributes.\n\n For each runtime\ - \ other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the webscript\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the webscript.json json file with a changed value\ - \ for any of the\n name, version and/or\ - \ runtime attributes.\n\n For each runtime\ - \ other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the webscript\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the webscript.json json file with a changed value\ - \ for any of the\n name, version and/or\ - \ runtime attributes.\n\n For each runtime\ - \ other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the webscript\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the webscript.json json file with a changed value\ - \ for any of the\n name, version and/or\ - \ runtime attributes.\n\n For each runtime\ - \ other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the webscript\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the webscript.json json file with a changed value\ - \ for any of the\n name, version and/or\ - \ runtime attributes.\n\n For each runtime\ - \ other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Webscript Function Assets - description: "The assets for a webscript function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the webscript\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the webscript.json json file with a changed value\ - \ for any of the\n name, version and/or\ - \ runtime attributes.\n\n For each runtime\ - \ other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: Multipart file upload. + description: 'A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset path.' + type: object + properties: + assets: + type: array + items: + type: string + format: binary description: "The assets for a webscript function can be provided\ \ as either\n
      \n
    • a single tar archive (optionally compressed),\ \ with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip, application/x-tar,\ - \ application/gzip
      • \n
    • separate files in a multipart/form-data\ - \ request
      • \n
    \n\n The provided assets will be added to the webscript\ + \ application/tar, application/tar+gzip, application/x-gzip,\ + \ application/x-tar, application/gzip\n \ + \
  • separate files in a multipart/form-data request
    • \n\ + \ \n\n The provided assets will be added to the webscript\ \ function's collection of existing assets,\n replacing any existing assets\ \ with the same name.\n\n Please note that it is not allowed to update\ \ the webscript.json json file with a changed value for any of the\n\ \ name, version and/or runtime\ \ attributes.\n\n For each runtime other files are supported.\n" parameters: + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: type: boolean default: true @@ -10335,14 +5927,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: chown - required: true - description: If set, ownership of the draft function is transferred to the - current user. - schema: type: string in: path @@ -10369,13 +5953,19 @@ paths: application/json: schema: $ref: '#/components/schemas/IPostWebscriptJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/IRegistryErrorResponse' security: *id001 /registry/v2/webscripts/{name}/versions/{version}/content/{*}: get: - operationId: getAsset_webscript_functions + operationId: getAsset_webscripts summary: Get File From Webscript Archive tags: - - Webscript Functions + - Webscripts description: Get a file from the specification archive of a webscript. parameters: - schema: @@ -10416,6 +6006,12 @@ paths: description: Webscript archive type: string format: binary + application/tar: + schema: + title: Archive + description: Webscript archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -10445,10 +6041,10 @@ paths: $ref: '#/components/schemas/IContentValidationListing' security: *id001 put: - operationId: updateAsset_webscript_functions + operationId: updateAsset_webscripts summary: Update Webscript Asset tags: - - Webscript Functions + - Webscripts description: "The provided asset will be added to the webscript function's\ \ collection of existing assets,\n replacing any existing asset with the\ \ same name.\n\n Please note that it is not allowed to update the webscript.json\ @@ -10457,7 +6053,7 @@ paths: \ files are supported.\n " requestBody: content: - application/octet-stream: + '*/*': schema: title: File Upload description: A single asset file. @@ -10468,12 +6064,53 @@ paths: format: binary description: A single asset file. parameters: + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: type: boolean default: true @@ -10484,14 +6121,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: chown - required: true - description: If set, ownership of the draft function is transferred to the - current user. - schema: type: string in: path @@ -10524,20 +6153,67 @@ paths: application/json: schema: $ref: '#/components/schemas/IPostWebscriptJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/IRegistryErrorResponse' security: *id001 delete: - operationId: deleteAsset_webscript_functions + operationId: deleteAsset_webscripts summary: Delete Webscript Asset tags: - - Webscript Functions + - Webscripts description: Delete an asset from the webscript's collection of existing assets. parameters: + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: type: boolean default: true @@ -10548,14 +6224,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: chown - required: true - description: If set, ownership of the draft function is transferred to the - current user. - schema: type: string in: path @@ -10588,13 +6256,19 @@ paths: application/json: schema: $ref: '#/components/schemas/IPostWebscriptJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/IRegistryErrorResponse' security: *id001 /registry/v2/webscripts/{name}/versions/{version}/publish: post: - operationId: publish_webscript_functions + operationId: publish_webscripts summary: Publish Draft Webscript tags: - - Webscript Functions + - Webscripts description: "Mark the webscript to be ready and stable, taking it\ \ out of draft mode.,\n\n Typically, the webscript should be in\ \ the running status, \n such that publishing becomes a simple\ @@ -10602,12 +6276,26 @@ paths: \ plug-registry may need to initiate a new build and deployment procedure.\n\ \ " parameters: + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: patch @@ -10657,10 +6345,10 @@ paths: security: *id001 /registry/v2/webscripts/{name}/versions/{version}/jobs: get: - operationId: jobs_webscript_functions + operationId: jobs_webscripts summary: List Webscript Jobs tags: - - Webscript Functions + - Webscripts description: List the ongoing and completed operations on a specific webscript. parameters: - schema: @@ -10730,18 +6418,20 @@ paths: security: *id001 /registry/v2/webscripts/{name}/versions/{version}/verify: post: - operationId: verify_webscript_functions + operationId: verify_webscripts summary: Verify Health Of Webscript tags: - - Webscript Functions + - Webscripts description: Verify health of webscript deployed on openfaas. parameters: - schema: - type: string + type: boolean in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. + description: Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero only + if it was not active before this command. - schema: type: boolean default: true @@ -10752,14 +6442,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: Indicates whether the function needs to be scaled down after - successful verification. If not set, the function is scaled to zero only - if it was not active before this command. - schema: type: string in: path @@ -10845,190 +6527,139 @@ paths: security: *id001 /registry/v2/plugs/: post: - operationId: create_plug_functions + operationId: create_plugs summary: Create Plug tags: - - Plug Functions + - Plugs description: "Creates a new plug function by uploading its assets.\n\ - \ \n The assets for a plug function can be provided as either\n\ - \
      \n
    • a single tar archive (optionally compressed), with\ - \ one of the content types \n application/octet-stream, application/tar+gzip,\ - \ application/x-gzip, application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required plug.json json file contains the\ - \ function metadata,\n and must have a runtime attribute that\ - \ is one of the supported runtimes \n (see GET /registry/v2/runtimes?functionType=plugs).\n\ - \n For each runtime other files will be required or supported.\n\ - \n " + \ \n The assets for a plug function can be provided as\n
      \n\ + \
    • A single tar archive (optionally compressed), with one of\ + \ the content types \n application/octet-stream, application/tar,\ + \ application/tar+gzip, application/x-gzip, application/x-tar,\ + \ application/gzip
      • \n
    • Separate files in a multipart/form-data\ + \ request
      • \n
    • A reference to the assets of another plug\ + \ in the copy argument
      • \n
    \n\n The required plug.json\ + \ json file contains the function metadata,\n and must have a runtime\ + \ attribute that is one of the supported runtimes \n (see GET\ + \ /registry/v2/runtimes?functionType=plugs).\n\n For each runtime\ + \ other files will be required or supported.\n\n " requestBody: content: application/octet-stream: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required plug.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=plugs).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required plug.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=plugs).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required plug.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=plugs).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required plug.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=plugs).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required plug.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=plugs).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required plug.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=plugs).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. - description: "The assets for a plug function can be provided as either\n\ - \
      \n
    • a single tar archive (optionally compressed),\ + title: Multipart file upload. + description: 'A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset path.' + type: object + properties: + assets: + type: array + items: + type: string + format: binary + application/json: + schema: + title: Empty Upload + description: Empty object request body, only allowed when using the + `copy` query parameter. + type: object + maxProperties: 0 + '*/*+json': + schema: + title: Empty Upload + description: Empty object request body, only allowed when using the + `copy` query parameter. + type: object + maxProperties: 0 + description: "The assets for a plug function can be provided as\n\ + \
        \n
      • A single tar archive (optionally compressed),\ \ with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip, application/x-tar,\ - \ application/gzip
        • \n
      • separate files in a multipart/form-data\ - \ request
        • \n
      \n \n The required plug.json json\ - \ file contains the function metadata,\n and must have a runtime\ + \ application/tar, application/tar+gzip, application/x-gzip,\ + \ application/x-tar, application/gzip
      • \n \ + \
    • Separate files in a multipart/form-data request
      • \n\ + \
    • A reference to the assets of another plug in the copy\ + \ argument
      • \n
    \n\n The required plug.json json file\ + \ contains the function metadata,\n and must have a runtime\ \ attribute that is one of the supported runtimes \n (see GET\ \ /registry/v2/runtimes?functionType=plugs).\n\n For each runtime\ \ other files will be required or supported.\n" parameters: + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: none @@ -11054,15 +6685,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: scaleToZero - required: false - description: If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources when - the function is not to be used immediately. - schema: $ref: '#/components/schemas/SemanticVersionRange' in: query @@ -11087,6 +6709,53 @@ paths: description: If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. + - schema: + $ref: '#/components/schemas/NamedVersionRange' + in: query + name: runtime + required: false + description: 'If set, the created function will use the indicated runtime + (latest version within specified range). + + + This takes precedence over the runtime specified in a function manifest + (copied or from request body).' + - schema: + anyOf: + - $ref: '#/components/schemas/NamedVersionRange' + - $ref: '#/components/schemas/ExampleReference' + in: query + name: copy + required: false + description: "Indicates the _source_ of initial assets for a _new function_.\n\ + \nWhen using this query parameter, the request body does not need to contain\ + \ assets, but any assets in the request body will overwrite the copied assets.\n\ + \n#### Selection of _assets_ source\n\n* If set as `[@]`,\ + \ the _new function_ will be created with copied assets of the selected\ + \ _source function_.\n* If set as `!example`, a `runtime` query parameter\ + \ is required, and the _new function_ will be initialized with assets of\ + \ the _runtime example_.\n\n#### Selection of the _source function_\n\n\ + When `` is a range (or is not given), the latest _published_\ + \ version (in that range) is used.\n\nIf no _published_ version exists,\ + \ the latest _draft_ is selected.\n\nIf no versions in the range exist,\ + \ a `404` _Not Found_ error is returned.\n\n#### The `name` of the _new\ + \ function_\n\nIf a `name` is NOT specified (either as query parameter,\ + \ or in an optional manifest asset in the request body), the `name` of the\ + \ _new function_ will be that of the _source function_.\n\n#### The `version`\ + \ of the _new function_\n\nWhen the _target_ and _source_ name are equal,\ + \ the `version` query parameters is defaulted to ``\ + \ (`~` when it's an exact version)\n\nThe version of\ + \ the _new function_ will be:\n* If a `version` is NOT specified (either\ + \ as query parameter, in an optional manifest asset, or as ``\ + \ _default_)\n\n * a **patch increment** (`..+1`)\ + \ of the latest **existing version** with the target `name`\n\n * **`1.0.0`**\ + \ otherwise\n\n* If a `version` is specified:\n\n * the **lowest version**\ + \ in that range **if no existing version** is in that range.\n\n * an **increment**\ + \ of the latest existing version, **at the highest level** (_major_,_minor_,_patch_)\ + \ allowed by that range.\n\n * otherwise, if all allowed versions already\ + \ exist, a **`409` _Duplicate_ error** is raised.\n\n#### Deployment overrides\n\ + \nThe new function will use the deployment overrides of the copied function,\ + \ unless a _manifest_ was specified in the request body." x-version: v2 responses: '201': @@ -11103,10 +6772,10 @@ paths: $ref: '#/components/schemas/IPostPlugJobAsyncResponseV2' security: *id001 get: - operationId: list_plug_functions + operationId: list_plugs summary: List Plugs tags: - - Plug Functions + - Plugs description: "List the (latest) versions of available plugs.\n\n###\ \ List Latest Plug Versions\nBy default, the result includes the latest non-deprecated,\ \ non-draft version for each plug name.\nIf there is no such version,\ @@ -11118,19 +6787,21 @@ paths: \ versions.\n
  • includeDraft=true: do not prefer non-draft\ \ versions as a latest version: if the latest version is a draft, it will\ \ be shown, even if there are older non-draft versions.
    • \n \n\n\n\ - As long as no _version filters_ are used, each listed plug version\ - \ item will contain a HAL **link to the \nlatest** _draft_ (`entities[]._links.draft`)\ - \ or latest _published_ (`entities[]._links.publisned`) version (if existing\ - \ and different).\n\n### List Latest Plug Versions (with filter)\nWhen any\ - \ of the _version filter_ query parameters are used, the response contains\n\ - the _latest_ version per named plug that satisfy the filters, but\ - \ **without links**.\n\n### List All Plug Versions\nWhen using `latest=false`\ - \ (default when using the `namedVersion` filter), the listing contains _all_\ - \ \nplugs versions that satisfy the query, possibly multiple versions\ - \ per named plugs.\nNo HAL links are provided.\n\n#### Filter on\ - \ _status_\nBy default plug versions with status `undeployed` are\ - \ **excluded** in all cases.\nUse the _version filter_ `status` to include/exclude\ - \ a status from the results.\nBy example, \n> `?status=any&includeDeprecated=true&includeDraft=true&latest=false`\n\ + As long as no version filters are used, each listed plug version\ + \ contains representations of the latest draft (`entities[]._links.draft`)\ + \ \nor latest published (`entities[]._links.published`) version (if existing\ + \ and different). \nUse the query parameter `showRelated` to include only\ + \ a link (default `showRelated=link`) or a full representation (`showRelated=embed`).\n\ + \n### List Latest Plug Versions (with filter)\nWhen any of the _version filter_\ + \ query parameters are used, the response contains\nthe _latest_ version per\ + \ named plug that satisfy the filters, but **without links**.\n\n\ + ### List All Plug Versions\nWhen using `latest=false` (default when using\ + \ the `namedVersion` filter), the listing contains _all_ \nplugs\ + \ versions that satisfy the query, possibly multiple versions per named plugs.\n\ + No HAL links are provided.\n\n#### Filter on _status_\nBy default plug\ + \ versions with status `undeployed` are **excluded** in all cases.\n\ + Use the _version filter_ `status` to include/exclude a status from the results.\n\ + By example, \n> `?status=any&includeDeprecated=true&includeDraft=true&latest=false`\n\ \nwill list _ALL_ versions known to the function registry.\n\n#### Version\ \ filter parameters\nThe following query parameters are _version filters_\ \ for the plug listing:\n> `version`, `status`, `runtimeVersion`,\ @@ -11306,6 +6977,19 @@ paths: If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. + - schema: + $ref: '#/components/schemas/ShowRelatedType' + in: query + name: showRelated + required: false + description: 'Sets the representation of related function versions (like the + _latest_ draft and/or published) in the response. + + - `embed`: as full summary representation (in `_embedded`). + + - `link`: as HAL link in (in `_links`). + + - `none`: omitted.' x-version: v2 responses: '200': @@ -11317,10 +7001,10 @@ paths: security: *id001 /registry/v2/plugs/{name}: get: - operationId: getLatest_plug_functions + operationId: getLatest_plugs summary: Get Latest Plug Version tags: - - Plug Functions + - Plugs description: "Fetch the latest version of a plug.\n\n By default,\ \ the result shows the latest non-deprecated, non-draft version.\n If there\ \ is no such version, the latest deprecated or the latest draft version is\ @@ -11378,10 +7062,10 @@ paths: $ref: '#/components/schemas/PlugHtmlResponse' security: *id001 delete: - operationId: removeVersions_plug_functions + operationId: removeVersions_plugs summary: Remove Plug tags: - - Plug Functions + - Plugs description: "Deprecate, undeploy and/or remove all versions of this named plug.\n\ \nBy default, a `DELETE` \n* marks _published_ version(s) _deprecated_: they\ \ remain active, but are no longer included in listings by default.\n* completely\ @@ -11470,10 +7154,10 @@ paths: security: *id001 /registry/v2/plugs/{name}/versions: get: - operationId: listVersions_plug_functions + operationId: listVersions_plugs summary: List Plug Versions tags: - - Plug Functions + - Plugs description: List all versions of a plug, including deprecated versions or not. parameters: - schema: @@ -11611,10 +7295,10 @@ paths: security: *id001 /registry/v2/plugs/{name}/versions/{version}: get: - operationId: get_plug_functions + operationId: get_plugs summary: Get Plug Version tags: - - Plug Functions + - Plugs description: Get a specific version of a plug. parameters: - schema: @@ -11642,10 +7326,10 @@ paths: $ref: '#/components/schemas/PlugHtmlResponse' security: *id001 delete: - operationId: removeVersion_plug_functions + operationId: removeVersion_plugs summary: Remove Plug Version tags: - - Plug Functions + - Plugs description: "Deprecate, undeploy and/or remove a plug version.\n\n\ By default, a `DELETE` \n* marks _published_ version(s) _deprecated_: they\ \ remain active, but are no longer included in listings by default.\n* completely\ @@ -11740,12 +7424,20 @@ paths: security: *id001 /registry/v2/plugs/{name}/versions/{version}/rebuild: post: - operationId: rebuild_plug_functions + operationId: rebuild_plugs summary: Rebuild Plug tags: - - Plug Functions + - Plugs description: Rebuild and deploy a plug with the original or updated base image. parameters: + - schema: + type: boolean + in: query + name: scaleToZero + required: false + description: Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero only + if it was not active before this command. - schema: type: string in: query @@ -11804,14 +7496,6 @@ paths: * running jobs on entity * the `dryRun` option' - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: Indicates whether the function needs to be scaled down after - successful (re-)deployment. If not set, the function is scaled to zero only - if it was not active before this command. - schema: type: boolean in: query @@ -11848,10 +7532,10 @@ paths: security: *id001 /registry/v2/plugs/{name}/versions/{version}/content: get: - operationId: getArchive_plug_functions + operationId: getArchive_plugs summary: Get Plug Archive tags: - - Plug Functions + - Plugs description: Get the specification archive of a plug. parameters: - schema: @@ -11886,6 +7570,12 @@ paths: description: Plug archive type: string format: binary + application/tar: + schema: + title: Archive + description: Plug archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -11915,204 +7605,133 @@ paths: $ref: '#/components/schemas/IContentValidationListing' security: *id001 put: - operationId: updateAssets_plug_functions + operationId: updateAssets_plugs summary: Update Plug Assets tags: - - Plug Functions + - Plugs description: "Update a draft plug function by updating its assets.\n\ \ \n The assets for a plug function can be provided as either\n\ \
      \n
    • a single tar archive (optionally compressed), with\ - \ one of the content types \n application/octet-stream, application/tar+gzip,\ - \ application/x-gzip, application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the plug function's\ - \ collection of existing assets,\n replacing any existing assets with the\ - \ same name.\n\n Please note that it is not allowed to update the plug.json\ - \ json file with a changed value for any of the\n name, version\ - \ and/or runtime attributes.\n\n For each runtime other\ - \ files are supported.\n\n " + \ one of the content types \n application/octet-stream, application/tar,\ + \ application/tar+gzip, application/x-gzip, application/x-tar,\ + \ application/gzip\n
  • separate files in a multipart/form-data\ + \ request
    • \n \n\n The provided assets will be added to the plug\ + \ function's collection of existing assets,\n replacing any existing assets\ + \ with the same name.\n\n Please note that it is not allowed to update the\ + \ plug.json json file with a changed value for any of the\n name,\ + \ version and/or runtime attributes.\n\n For each\ + \ runtime other files are supported.\n\n " requestBody: content: application/octet-stream: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the plug\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the plug.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the plug\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the plug.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the plug\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the plug.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the plug\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the plug.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the plug\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the plug.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Plug Function Assets - description: "The assets for a plug function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the plug\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the plug.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: Multipart file upload. + description: 'A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset path.' + type: object + properties: + assets: + type: array + items: + type: string + format: binary description: "The assets for a plug function can be provided as either\n\ \
      \n
    • a single tar archive (optionally compressed),\ \ with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip, application/x-tar,\ - \ application/gzip
      • \n
    • separate files in a multipart/form-data\ - \ request
      • \n
    \n\n The provided assets will be added to the plug\ - \ function's collection of existing assets,\n replacing any existing assets\ - \ with the same name.\n\n Please note that it is not allowed to update\ - \ the plug.json json file with a changed value for any of the\n \ - \ name, version and/or runtime attributes.\n\ - \n For each runtime other files are supported.\n" + \ application/tar, application/tar+gzip, application/x-gzip,\ + \ application/x-tar, application/gzip\n \ + \
  • separate files in a multipart/form-data request
    • \n\ + \ \n\n The provided assets will be added to the plug function's\ + \ collection of existing assets,\n replacing any existing assets with the\ + \ same name.\n\n Please note that it is not allowed to update the plug.json\ + \ json file with a changed value for any of the\n name, version\ + \ and/or runtime attributes.\n\n For each runtime\ + \ other files are supported.\n" parameters: + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: type: boolean default: true @@ -12123,14 +7742,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: chown - required: true - description: If set, ownership of the draft function is transferred to the - current user. - schema: type: string in: path @@ -12157,13 +7768,19 @@ paths: application/json: schema: $ref: '#/components/schemas/IPostPlugJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/IRegistryErrorResponse' security: *id001 /registry/v2/plugs/{name}/versions/{version}/content/{*}: get: - operationId: getAsset_plug_functions + operationId: getAsset_plugs summary: Get File From Plug Archive tags: - - Plug Functions + - Plugs description: Get a file from the specification archive of a plug. parameters: - schema: @@ -12204,6 +7821,12 @@ paths: description: Plug archive type: string format: binary + application/tar: + schema: + title: Archive + description: Plug archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -12233,10 +7856,10 @@ paths: $ref: '#/components/schemas/IContentValidationListing' security: *id001 put: - operationId: updateAsset_plug_functions + operationId: updateAsset_plugs summary: Update Plug Asset tags: - - Plug Functions + - Plugs description: "The provided asset will be added to the plug function's\ \ collection of existing assets,\n replacing any existing asset with the\ \ same name.\n\n Please note that it is not allowed to update the plug.json\ @@ -12245,7 +7868,7 @@ paths: \ files are supported.\n " requestBody: content: - application/octet-stream: + '*/*': schema: title: File Upload description: A single asset file. @@ -12256,12 +7879,53 @@ paths: format: binary description: A single asset file. parameters: + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: type: boolean default: true @@ -12272,14 +7936,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: chown - required: true - description: If set, ownership of the draft function is transferred to the - current user. - schema: type: string in: path @@ -12312,20 +7968,67 @@ paths: application/json: schema: $ref: '#/components/schemas/IPostPlugJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/IRegistryErrorResponse' security: *id001 delete: - operationId: deleteAsset_plug_functions + operationId: deleteAsset_plugs summary: Delete Plug Asset tags: - - Plug Functions + - Plugs description: Delete an asset from the plug's collection of existing assets. parameters: + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: type: boolean default: true @@ -12336,14 +8039,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: chown - required: true - description: If set, ownership of the draft function is transferred to the - current user. - schema: type: string in: path @@ -12376,25 +8071,45 @@ paths: application/json: schema: $ref: '#/components/schemas/IPostPlugJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/IRegistryErrorResponse' security: *id001 /registry/v2/plugs/{name}/versions/{version}/publish: post: - operationId: publish_plug_functions + operationId: publish_plugs summary: Publish Draft Plug tags: - - Plug Functions + - Plugs description: "Mark the plug to be ready and stable, taking it out of\ \ draft mode.,\n\n Typically, the plug should be in the running\ \ status, \n such that publishing becomes a simple operation where the existing\ \ deployment can be re-used.\n In other statuses, plug-registry may need\ \ to initiate a new build and deployment procedure.\n " parameters: + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: none @@ -12444,10 +8159,10 @@ paths: security: *id001 /registry/v2/plugs/{name}/versions/{version}/interface: patch: - operationId: patchInterface_plug_functions + operationId: patchInterface_plugs summary: Patch Plug Interface tags: - - Plug Functions + - Plugs description: Patch the interface documentation of a plug version. requestBody: content: @@ -12484,10 +8199,10 @@ paths: security: *id001 /registry/v2/plugs/{name}/versions/{version}/metadata: patch: - operationId: patchMetadata_plug_functions + operationId: patchMetadata_plugs summary: Patch Plug Metadata tags: - - Plug Functions + - Plugs description: Patch the metadata of a plug version. requestBody: content: @@ -12524,10 +8239,10 @@ paths: security: *id001 /registry/v2/plugs/{name}/versions/{version}/jobs: get: - operationId: jobs_plug_functions + operationId: jobs_plugs summary: List Plug Jobs tags: - - Plug Functions + - Plugs description: List the ongoing and completed operations on a specific plug. parameters: - schema: @@ -12597,18 +8312,20 @@ paths: security: *id001 /registry/v2/plugs/{name}/versions/{version}/verify: post: - operationId: verify_plug_functions + operationId: verify_plugs summary: Verify Health Of Plug tags: - - Plug Functions + - Plugs description: Verify health of plug deployed on openfaas. parameters: - schema: - type: string + type: boolean in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. + description: Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero only + if it was not active before this command. - schema: type: boolean default: true @@ -12619,14 +8336,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: Indicates whether the function needs to be scaled down after - successful verification. If not set, the function is scaled to zero only - if it was not active before this command. - schema: type: string in: path @@ -12657,190 +8366,139 @@ paths: security: *id001 /registry/v2/models/: post: - operationId: create_model_functions + operationId: create_models summary: Create Model tags: - - Model Functions + - Models description: "Creates a new model function by uploading its assets.\n\ - \ \n The assets for a model function can be provided as either\n\ - \
      \n
    • a single tar archive (optionally compressed), with\ - \ one of the content types \n application/octet-stream, application/tar+gzip,\ - \ application/x-gzip, application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required model.json json file contains the\ - \ function metadata,\n and must have a runtime attribute that\ - \ is one of the supported runtimes \n (see GET /registry/v2/runtimes?functionType=kfserving).\n\ - \n For each runtime other files will be required or supported.\n\ - \n " + \ \n The assets for a model function can be provided as\n
      \n\ + \
    • A single tar archive (optionally compressed), with one of\ + \ the content types \n application/octet-stream, application/tar,\ + \ application/tar+gzip, application/x-gzip, application/x-tar,\ + \ application/gzip
      • \n
    • Separate files in a multipart/form-data\ + \ request
      • \n
    • A reference to the assets of another model\ + \ in the copy argument
      • \n
    \n\n The required model.json\ + \ json file contains the function metadata,\n and must have a runtime\ + \ attribute that is one of the supported runtimes \n (see GET\ + \ /registry/v2/runtimes?functionType=kfserving).\n\n For each runtime\ + \ other files will be required or supported.\n\n " requestBody: content: application/octet-stream: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required model.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=kfserving).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required model.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=kfserving).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required model.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=kfserving).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required model.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=kfserving).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required model.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=kfserving).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n \n The required model.json json file contains\ - \ the function metadata,\n and must have a runtime attribute\ - \ that is one of the supported runtimes \n (see GET\ - \ /registry/v2/runtimes?functionType=kfserving).\n\n For each\ - \ runtime other files will be required or supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. - description: "The assets for a model function can be provided as\ - \ either\n
      \n
    • a single tar archive (optionally compressed),\ + title: Multipart file upload. + description: 'A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset path.' + type: object + properties: + assets: + type: array + items: + type: string + format: binary + application/json: + schema: + title: Empty Upload + description: Empty object request body, only allowed when using the + `copy` query parameter. + type: object + maxProperties: 0 + '*/*+json': + schema: + title: Empty Upload + description: Empty object request body, only allowed when using the + `copy` query parameter. + type: object + maxProperties: 0 + description: "The assets for a model function can be provided as\n\ + \
        \n
      • A single tar archive (optionally compressed),\ \ with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip, application/x-tar,\ - \ application/gzip
        • \n
      • separate files in a multipart/form-data\ - \ request
        • \n
      \n \n The required model.json json\ + \ application/tar, application/tar+gzip, application/x-gzip,\ + \ application/x-tar, application/gzip
      • \n \ + \
    • Separate files in a multipart/form-data request
      • \n\ + \
    • A reference to the assets of another model in the copy\ + \ argument
      • \n
    \n\n The required model.json json\ \ file contains the function metadata,\n and must have a runtime\ \ attribute that is one of the supported runtimes \n (see GET\ \ /registry/v2/runtimes?functionType=kfserving).\n\n For each runtime\ \ other files will be required or supported.\n" parameters: + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: patch @@ -12866,15 +8524,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: scaleToZero - required: false - description: If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources when - the function is not to be used immediately. - schema: $ref: '#/components/schemas/SemanticVersionRange' in: query @@ -12899,6 +8548,53 @@ paths: description: If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. + - schema: + $ref: '#/components/schemas/NamedVersionRange' + in: query + name: runtime + required: false + description: 'If set, the created function will use the indicated runtime + (latest version within specified range). + + + This takes precedence over the runtime specified in a function manifest + (copied or from request body).' + - schema: + anyOf: + - $ref: '#/components/schemas/NamedVersionRange' + - $ref: '#/components/schemas/ExampleReference' + in: query + name: copy + required: false + description: "Indicates the _source_ of initial assets for a _new function_.\n\ + \nWhen using this query parameter, the request body does not need to contain\ + \ assets, but any assets in the request body will overwrite the copied assets.\n\ + \n#### Selection of _assets_ source\n\n* If set as `[@]`,\ + \ the _new function_ will be created with copied assets of the selected\ + \ _source function_.\n* If set as `!example`, a `runtime` query parameter\ + \ is required, and the _new function_ will be initialized with assets of\ + \ the _runtime example_.\n\n#### Selection of the _source function_\n\n\ + When `` is a range (or is not given), the latest _published_\ + \ version (in that range) is used.\n\nIf no _published_ version exists,\ + \ the latest _draft_ is selected.\n\nIf no versions in the range exist,\ + \ a `404` _Not Found_ error is returned.\n\n#### The `name` of the _new\ + \ function_\n\nIf a `name` is NOT specified (either as query parameter,\ + \ or in an optional manifest asset in the request body), the `name` of the\ + \ _new function_ will be that of the _source function_.\n\n#### The `version`\ + \ of the _new function_\n\nWhen the _target_ and _source_ name are equal,\ + \ the `version` query parameters is defaulted to ``\ + \ (`~` when it's an exact version)\n\nThe version of\ + \ the _new function_ will be:\n* If a `version` is NOT specified (either\ + \ as query parameter, in an optional manifest asset, or as ``\ + \ _default_)\n\n * a **patch increment** (`..+1`)\ + \ of the latest **existing version** with the target `name`\n\n * **`1.0.0`**\ + \ otherwise\n\n* If a `version` is specified:\n\n * the **lowest version**\ + \ in that range **if no existing version** is in that range.\n\n * an **increment**\ + \ of the latest existing version, **at the highest level** (_major_,_minor_,_patch_)\ + \ allowed by that range.\n\n * otherwise, if all allowed versions already\ + \ exist, a **`409` _Duplicate_ error** is raised.\n\n#### Deployment overrides\n\ + \nThe new function will use the deployment overrides of the copied function,\ + \ unless a _manifest_ was specified in the request body." x-version: v2 responses: '201': @@ -12915,10 +8611,10 @@ paths: $ref: '#/components/schemas/IPostModelJobAsyncResponseV2' security: *id001 get: - operationId: list_model_functions + operationId: list_models summary: List Models tags: - - Model Functions + - Models description: "List the (latest) versions of available models.\n\n###\ \ List Latest Model Versions\nBy default, the result includes the latest non-deprecated,\ \ non-draft version for each model name.\nIf there is no such version,\ @@ -12930,19 +8626,21 @@ paths: \ versions.\n
  • includeDraft=true: do not prefer non-draft\ \ versions as a latest version: if the latest version is a draft, it will\ \ be shown, even if there are older non-draft versions.
    • \n \n\n\n\ - As long as no _version filters_ are used, each listed model version\ - \ item will contain a HAL **link to the \nlatest** _draft_ (`entities[]._links.draft`)\ - \ or latest _published_ (`entities[]._links.publisned`) version (if existing\ - \ and different).\n\n### List Latest Model Versions (with filter)\nWhen any\ - \ of the _version filter_ query parameters are used, the response contains\n\ - the _latest_ version per named model that satisfy the filters, but\ - \ **without links**.\n\n### List All Model Versions\nWhen using `latest=false`\ - \ (default when using the `namedVersion` filter), the listing contains _all_\ - \ \nmodels versions that satisfy the query, possibly multiple versions\ - \ per named models.\nNo HAL links are provided.\n\n#### Filter on\ - \ _status_\nBy default model versions with status `undeployed` are\ - \ **excluded** in all cases.\nUse the _version filter_ `status` to include/exclude\ - \ a status from the results.\nBy example, \n> `?status=any&includeDeprecated=true&includeDraft=true&latest=false`\n\ + As long as no version filters are used, each listed model version\ + \ contains representations of the latest draft (`entities[]._links.draft`)\ + \ \nor latest published (`entities[]._links.published`) version (if existing\ + \ and different). \nUse the query parameter `showRelated` to include only\ + \ a link (default `showRelated=link`) or a full representation (`showRelated=embed`).\n\ + \n### List Latest Model Versions (with filter)\nWhen any of the _version filter_\ + \ query parameters are used, the response contains\nthe _latest_ version per\ + \ named model that satisfy the filters, but **without links**.\n\n\ + ### List All Model Versions\nWhen using `latest=false` (default when using\ + \ the `namedVersion` filter), the listing contains _all_ \nmodels\ + \ versions that satisfy the query, possibly multiple versions per named models.\n\ + No HAL links are provided.\n\n#### Filter on _status_\nBy default model\ + \ versions with status `undeployed` are **excluded** in all cases.\n\ + Use the _version filter_ `status` to include/exclude a status from the results.\n\ + By example, \n> `?status=any&includeDeprecated=true&includeDraft=true&latest=false`\n\ \nwill list _ALL_ versions known to the function registry.\n\n#### Version\ \ filter parameters\nThe following query parameters are _version filters_\ \ for the model listing:\n> `version`, `status`, `runtimeVersion`,\ @@ -13104,6 +8802,19 @@ paths: If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. + - schema: + $ref: '#/components/schemas/ShowRelatedType' + in: query + name: showRelated + required: false + description: 'Sets the representation of related function versions (like the + _latest_ draft and/or published) in the response. + + - `embed`: as full summary representation (in `_embedded`). + + - `link`: as HAL link in (in `_links`). + + - `none`: omitted.' x-version: v2 responses: '200': @@ -13115,10 +8826,10 @@ paths: security: *id001 /registry/v2/models/{name}: get: - operationId: getLatest_model_functions + operationId: getLatest_models summary: Get Latest Model Version tags: - - Model Functions + - Models description: "Fetch the latest version of a model.\n\n By default,\ \ the result shows the latest non-deprecated, non-draft version.\n If there\ \ is no such version, the latest deprecated or the latest draft version is\ @@ -13167,10 +8878,10 @@ paths: $ref: '#/components/schemas/IGetModelResponseV2' security: *id001 delete: - operationId: removeVersions_model_functions + operationId: removeVersions_models summary: Remove Model tags: - - Model Functions + - Models description: "Deprecate, undeploy and/or remove all versions of this named model.\n\ \n By default, a `DELETE` \n * _deprecates_ the model version(s): they are\ \ no longer included in listings by default.\n * _undeploys_ the model version(s)\ @@ -13261,10 +8972,10 @@ paths: security: *id001 /registry/v2/models/{name}/versions: get: - operationId: listVersions_model_functions + operationId: listVersions_models summary: List Model Versions tags: - - Model Functions + - Models description: List all deployed versions of a model. parameters: - schema: @@ -13394,10 +9105,10 @@ paths: security: *id001 /registry/v2/models/{name}/versions/{version}: get: - operationId: get_model_functions + operationId: get_models summary: Get Model Version tags: - - Model Functions + - Models description: Get a model by name and version. parameters: - schema: @@ -13422,10 +9133,10 @@ paths: $ref: '#/components/schemas/IGetModelResponseV2' security: *id001 delete: - operationId: removeVersion_model_functions + operationId: removeVersion_models summary: Remove Model Version tags: - - Model Functions + - Models description: "Deprecate, undeploy and/or remove a model version.\n\n\ \ By default, a `DELETE` \n * _deprecates_ the model version(s): they are\ \ no longer included in listings by default.\n * _undeploys_ the model version(s)\ @@ -13522,10 +9233,10 @@ paths: security: *id001 /registry/v2/models/{name}/versions/{version}/content: get: - operationId: getArchive_model_functions + operationId: getArchive_models summary: Get Model Archive tags: - - Model Functions + - Models description: Get the specification archive of a model. parameters: - schema: @@ -13560,6 +9271,12 @@ paths: description: Model archive type: string format: binary + application/tar: + schema: + title: Archive + description: Model archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -13589,204 +9306,133 @@ paths: $ref: '#/components/schemas/IContentValidationListing' security: *id001 put: - operationId: updateAssets_model_functions + operationId: updateAssets_models summary: Update Model Assets tags: - - Model Functions + - Models description: "Update a draft model function by updating its assets.\n\ \ \n The assets for a model function can be provided as either\n\ \
      \n
    • a single tar archive (optionally compressed), with\ - \ one of the content types \n application/octet-stream, application/tar+gzip,\ - \ application/x-gzip, application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the model function's\ - \ collection of existing assets,\n replacing any existing assets with the\ - \ same name.\n\n Please note that it is not allowed to update the model.json\ - \ json file with a changed value for any of the\n name, version\ - \ and/or runtime attributes.\n\n For each runtime other\ - \ files are supported.\n\n " + \ one of the content types \n application/octet-stream, application/tar,\ + \ application/tar+gzip, application/x-gzip, application/x-tar,\ + \ application/gzip\n
  • separate files in a multipart/form-data\ + \ request
    • \n \n\n The provided assets will be added to the model\ + \ function's collection of existing assets,\n replacing any existing assets\ + \ with the same name.\n\n Please note that it is not allowed to update the\ + \ model.json json file with a changed value for any of the\n name,\ + \ version and/or runtime attributes.\n\n For each\ + \ runtime other files are supported.\n\n " requestBody: content: application/octet-stream: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the model\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the model.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the model\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the model.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the model\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the model.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the model\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the model.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the model\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the model.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Model Function Assets - description: "The assets for a model function can be provided\ - \ as either\n
      \n
    • a single tar archive (optionally\ - \ compressed), with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip,\ - \ application/x-tar, application/gzip
      • \n\ - \
    • separate files in a multipart/form-data request
      • \n\ - \
    \n\n The provided assets will be added to the model\ - \ function's collection of existing assets,\n replacing any existing\ - \ assets with the same name.\n\n Please note that it is not allowed\ - \ to update the model.json json file with a changed value for\ - \ any of the\n name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: Multipart file upload. + description: 'A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset path.' + type: object + properties: + assets: + type: array + items: + type: string + format: binary description: "The assets for a model function can be provided as\ \ either\n
      \n
    • a single tar archive (optionally compressed),\ \ with one of the content types \n application/octet-stream,\ - \ application/tar+gzip, application/x-gzip, application/x-tar,\ - \ application/gzip
      • \n
    • separate files in a multipart/form-data\ - \ request
      • \n
    \n\n The provided assets will be added to the model\ - \ function's collection of existing assets,\n replacing any existing assets\ - \ with the same name.\n\n Please note that it is not allowed to update\ - \ the model.json json file with a changed value for any of the\n\ - \ name, version and/or runtime\ - \ attributes.\n\n For each runtime other files are supported.\n" + \ application/tar, application/tar+gzip, application/x-gzip,\ + \ application/x-tar, application/gzip\n \ + \
  • separate files in a multipart/form-data request
    • \n\ + \ \n\n The provided assets will be added to the model function's\ + \ collection of existing assets,\n replacing any existing assets with the\ + \ same name.\n\n Please note that it is not allowed to update the model.json\ + \ json file with a changed value for any of the\n name, version\ + \ and/or runtime attributes.\n\n For each runtime\ + \ other files are supported.\n" parameters: + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: type: boolean default: true @@ -13797,14 +9443,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: chown - required: true - description: If set, ownership of the draft function is transferred to the - current user. - schema: type: string in: path @@ -13831,13 +9469,19 @@ paths: application/json: schema: $ref: '#/components/schemas/IPostModelJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/IRegistryErrorResponse' security: *id001 /registry/v2/models/{name}/versions/{version}/content/{*}: get: - operationId: getAsset_model_functions + operationId: getAsset_models summary: Get File From Model Archive tags: - - Model Functions + - Models description: Get a file from the specification archive of a model. parameters: - schema: @@ -13878,6 +9522,12 @@ paths: description: Model archive type: string format: binary + application/tar: + schema: + title: Archive + description: Model archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -13907,10 +9557,10 @@ paths: $ref: '#/components/schemas/IContentValidationListing' security: *id001 put: - operationId: updateAsset_model_functions + operationId: updateAsset_models summary: Update Model Asset tags: - - Model Functions + - Models description: "The provided asset will be added to the model function's\ \ collection of existing assets,\n replacing any existing asset with the\ \ same name.\n\n Please note that it is not allowed to update the model.json\ @@ -13919,7 +9569,7 @@ paths: \ files are supported.\n " requestBody: content: - application/octet-stream: + '*/*': schema: title: File Upload description: A single asset file. @@ -13930,12 +9580,53 @@ paths: format: binary description: A single asset file. parameters: + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: type: boolean default: true @@ -13946,14 +9637,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: chown - required: true - description: If set, ownership of the draft function is transferred to the - current user. - schema: type: string in: path @@ -13986,20 +9669,67 @@ paths: application/json: schema: $ref: '#/components/schemas/IPostModelJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/IRegistryErrorResponse' security: *id001 delete: - operationId: deleteAsset_model_functions + operationId: deleteAsset_models summary: Delete Model Asset tags: - - Model Functions + - Models description: Delete an asset from the model's collection of existing assets. parameters: + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing resources + when the function is not to be used immediately. + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: 'Indicates that a function should be _deployed_ when its assets + are valid. + + + * If `true` (default), jobs to build and deploy the function will be initiated + after it is checked that the assets are valid. Invalid assets lead to a + validation error, and the function and its assets are not created or updated. + + * If `false`, the uploaded assets are stored and the function is created/updated + in `registered` state. Asset validation errors are only returned as warning, + and stored as `failureReason` on the function entity. Use an _asset update_ + or _rebuild_ to initiate a build and deploy at a later stage.' + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: type: boolean default: true @@ -14010,14 +9740,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - default: false - in: query - name: chown - required: true - description: If set, ownership of the draft function is transferred to the - current user. - schema: type: string in: path @@ -14050,25 +9772,45 @@ paths: application/json: schema: $ref: '#/components/schemas/IPostModelJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/IRegistryErrorResponse' security: *id001 /registry/v2/models/{name}/versions/{version}/publish: post: - operationId: publish_model_functions + operationId: publish_models summary: Publish Draft Model tags: - - Model Functions + - Models description: "Mark the model to be ready and stable, taking it out\ \ of draft mode.,\n\n Typically, the model should be in the running\ \ status, \n such that publishing becomes a simple operation where the existing\ \ deployment can be re-used.\n In other statuses, plug-registry may need\ \ to initiate a new build and deployment procedure.\n " parameters: + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: If set, ownership of the draft function is transferred to the + current user. - schema: type: string in: query name: comment required: false description: An optional user-specified comment corresponding to the operation. + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: patch @@ -14118,10 +9860,10 @@ paths: security: *id001 /registry/v2/models/{name}/versions/{version}/metadata: patch: - operationId: patchMetadata_model_functions + operationId: patchMetadata_models summary: Patch Model Metadata tags: - - Model Functions + - Models description: Patch the metadata of a model version. requestBody: content: @@ -14158,10 +9900,10 @@ paths: security: *id001 /registry/v2/models/{name}/versions/{version}/jobs: get: - operationId: jobs_model_functions + operationId: jobs_models summary: List Model Jobs tags: - - Model Functions + - Models description: List the ongoing and completed operations on a model. parameters: - schema: @@ -14231,12 +9973,20 @@ paths: security: *id001 /registry/v2/models/{name}/versions/{version}/rebuild: post: - operationId: rebuild_model_functions + operationId: rebuild_models summary: Rebuild Model tags: - - Model Functions + - Models description: Rebuild and deploy a model with the original or updated base image. parameters: + - schema: + type: boolean + in: query + name: scaleToZero + required: false + description: Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero only + if it was not active before this command. - schema: type: string in: query @@ -14295,14 +10045,6 @@ paths: * running jobs on entity * the `dryRun` option' - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: Indicates whether the function needs to be scaled down after - successful (re-)deployment. If not set, the function is scaled to zero only - if it was not active before this command. - schema: type: boolean in: query @@ -14339,18 +10081,20 @@ paths: security: *id001 /registry/v2/models/{name}/versions/{version}/verify: post: - operationId: verify_model_functions + operationId: verify_models summary: Verify Health Of Model tags: - - Model Functions + - Models description: Verify health of model deployed on openfaas. parameters: - schema: - type: string + type: boolean in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. + description: Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero only + if it was not active before this command. - schema: type: boolean default: true @@ -14361,14 +10105,6 @@ paths: the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: Indicates whether the function needs to be scaled down after - successful verification. If not set, the function is scaled to zero only - if it was not active before this command. - schema: type: string in: path @@ -14398,12 +10134,25 @@ paths: description: Model Verification Initiated security: *id001 tags: +- name: Models + description: BYOML Models are functions that wrap a machine learning model. + externalDocs: + url: https://docs.waylay.io/#/features/byoml/ + description: Waylay Documentation +- name: Plugs + description: Plugs are functions that can be used in the rule engine. +- name: Webscripts + description: Webscripts are functions that are securely exposed to an http endpoint. - name: Jobs description: Jobs represent the ongoing asynchronous operations in the function registry. - name: Runtimes description: "Runtimes are the available base infrastructure for functions, and\ \ define how \n the plug gets build and deployed." +- name: Schemas + description: Schemas referenced in the API. +- name: About + description: Version and Health information. externalDocs: url: https://docs.waylay.io/#/api/registry/ description: Waylay Documentation diff --git a/openapi/registry.transformed.openapi.yaml b/openapi/registry.transformed.openapi.yaml index 7c2846a7..4606daca 100644 --- a/openapi/registry.transformed.openapi.yaml +++ b/openapi/registry.transformed.openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Waylay Function Registry - version: 2.12.4 + version: 2.13.0 x-visibility: stable description: >- V2 API to build and deploy Waylay functions (plugs, webscripts, BYOML @@ -27,17 +27,6 @@ components: '415': description: Unsupported Media Type schemas: - JobReferenceParams: - type: object - properties: - type: - $ref: '#/components/schemas/JobType' - id: - type: string - required: - - type - - id - additionalProperties: false JobType: type: string enum: @@ -48,32 +37,7 @@ components: - batch - scale - cleanup - - other - JobEventsFilterQuery: - type: object - properties: - type: - $ref: '#/components/schemas/JobType' - description: The type of the job. - id: - type: string - description: The id of the job. - children: - type: boolean - description: >- - If set to true, the event stream will include events of - the job's dependants. E.g., when subscribing to a verify job with - `children=true`, you will also receive the events of the underlying - build and deploy jobs. Defaults to false. - additionalProperties: false - Name: - type: object - properties: - name: - type: string - description: The name of the function. - required: - - name + - notify FunctionType: type: string enum: @@ -81,18 +45,6 @@ components: - webscripts - kfserving description: Type of functions supported by the registry service. - NameAndVersion: - type: object - properties: - name: - type: string - description: The name of the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The version of the function. - required: - - name - - version SemanticVersion: type: string description: >- @@ -110,81 +62,6 @@ components: description: >- The policy to select a new runtime version when a rebuild is issued. - RebuildQueryParams: - type: object - properties: - upgrade: - $ref: '#/components/schemas/RebuildPolicy' - description: >- - If set, force a rebuild with the given runtime version - selection policy.
    • same patch - version. This should only include backward compatible upgrades. -
    • minor major version. This might - include an upgrade of e.g. the language runtime and/or provided - dependencies that could break compatiblity with the function. .
      • -
    - dryRun: - type: boolean - description: >- - If set to true, checks whether rebuild jobs are needed, - but do not start any jobs. - forceVersion: - $ref: '#/components/schemas/SemanticVersion' - description: >- - If set, force a rebuild with the given runtime version (including - downgrades). This parameter is mutually exclusive to the `upgrade` - parameter. - ignoreChecks: - type: boolean - description: >- - If set to true, checks that normally prevent a rebuild are - overriden. These checks include: - - * function state in `pending`, `running`, `failed` or `undeployed` - - * backoff period due to recent failures - - * usage of deprecated dependencies - - * running jobs on entity - - * the `dryRun` option - scaleToZero: - type: boolean - description: >- - Indicates whether the function needs to be scaled down after - successful (re-)deployment. If not set, the function is scaled to - zero only if it was not active before this command. - skipRebuild: - type: boolean - description: >- - If set, the function will not be rebuild. Always uses the current - runtime version when re-deploying/re-verifying the function. - additionalProperties: false - LimitQuery: - type: object - properties: - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - additionalProperties: false - PagingQuery: - type: object - properties: - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - additionalProperties: false StatusInclude: type: string enum: @@ -200,6 +77,15 @@ components: example: running StatusExclude: type: string + enum: + - registered- + - running- + - pending- + - deployed- + - unhealthy- + - failed- + - undeploying- + - undeployed- description: >- Any status value with a `-` postfix appended, excludes that status as a filter. @@ -217,29 +103,12 @@ components: - $ref: '#/components/schemas/StatusExclude' - $ref: '#/components/schemas/StatusAny' description: Inclusion or exclusion filter on the `status` property. - FunctionEntityQuery: - type: object - properties: - name: - type: string - description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - additionalProperties: false - description: >- - Filter on function attributes that do not change across function - versions. + ShowRelatedType: + type: string + enum: + - embed + - link + - none ArchiveFormat: type: string enum: @@ -250,64 +119,6 @@ components: - native Runtime: type: string - FunctionVersionQuery: - type: object - properties: - version: - type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: - type: string - description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - additionalProperties: false - description: >- - Filter on function attributes that can change across function versions. - When these query parameters are used, the query is considered a - _function version_ listing and no HAL links to latest (_draft_, - _published_) versions are included. SemanticVersionRange: anyOf: - type: string @@ -349,3037 +160,2204 @@ components: description: An ISO8601 date expression. pattern: \d{4}-\d{2}-\d{2}(Z|([+-]\d\d:\d\d))? format: date - DeprecatedDraftFilter: - type: object - properties: - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - additionalProperties: false - DeployAttributesFilter: - type: object - properties: - endpoint: - type: string - description: >- - Filter on the openfaas endpoint. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - imageName: - type: string - description: >- - Filter on the container image name. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - storageLocation: - type: string - description: >- - Filter on the storageLocation. This is case-insensitive and supports - wild-cards `?` (any one character) and `*` (any sequence of - characters). - additionalProperties: false - VersionIncludes: - type: object - properties: - includeDraft: - type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: - type: boolean - description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - additionalProperties: false - NamedVersionsFilter: - type: object - properties: - nameVersion: - type: array - items: - $ref: '#/components/schemas/NamedVersion' - description: >- - Filter on exact `{name}@{version}` functions. Using this filter - implies a `latest=false` default, returning multiple versions of the - same named versions if they are filtered. - additionalProperties: false NamedVersion: type: string - description: A function reference represented by `name@version`. - pattern: ^.*@(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$ - LatestFunctionsQuery: - type: object - additionalProperties: false - properties: - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: - type: boolean - description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - name: - type: string - description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array + description: A function version reference represented as `@`. + pattern: ^[^@]*@(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$ + PlugType: + type: string + enum: + - sensor + - actuator + - transformer + TagsFilter: + anyOf: + - type: array items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. + type: string + - type: string + JobTypeSchema: + anyOf: + - $ref: '#/components/schemas/JobTypeBuild' + - $ref: '#/components/schemas/JobTypeDeploy' + - $ref: '#/components/schemas/JobTypeVerify' + - $ref: '#/components/schemas/JobTypeUndeploy' + - $ref: '#/components/schemas/JobTypeScale' + - $ref: '#/components/schemas/JobTypeBatch' + - $ref: '#/components/schemas/JobTypeNotify' + JobTypeBuild: + type: string + description: Build + enum: + - build + JobTypeDeploy: + type: string + description: A job that deploys a function image to the openfaas runtime. + enum: + - deploy + JobTypeVerify: + type: string + description: A job that checks the health of a deployed function. + enum: + - verify + JobTypeUndeploy: + type: string + description: >- + A job that undeploys a deployed function and removes it from the + registry. + enum: + - undeploy + JobTypeScale: + type: string + description: A job that scales a function to a target. + enum: + - scale + JobTypeBatch: + type: string + description: A job that groups other jobs as a parent. + enum: + - batch + JobTypeNotify: + type: string + description: A job to notify that an function version has changed. + enum: + - notify + JobStateResult: + anyOf: + - $ref: '#/components/schemas/JobState' + - $ref: '#/components/schemas/JobStateUnknown' + description: All reported job states + JobState: + anyOf: + - $ref: '#/components/schemas/JobStateFinished' + - $ref: '#/components/schemas/JobStateActive' + - $ref: '#/components/schemas/JobStateDelayed' + - $ref: '#/components/schemas/JobStateWaiting' + - $ref: '#/components/schemas/JobStateWaitingChildren' + description: Allowed job states + JobStateFinished: + anyOf: + - $ref: '#/components/schemas/JobStateCompleted' + - $ref: '#/components/schemas/JobStateFailed' + description: The job completed successfully or with failure. + JobStateCompleted: + type: string + description: The job has completed successfully. + enum: + - completed + JobStateFailed: + type: string + description: The job failed in execution. + enum: + - failed + JobStateActive: + type: string + description: The job is running. + enum: + - active + JobStateDelayed: + type: string + description: The job has been delayed for retry after a failure. + enum: + - delayed + JobStateWaiting: + type: string description: >- - Request to list latest function versions per named function. A request - that only uses these query parameters will include links to the _latest_ - draft/published versions. - LatestFunctionVersionsQuery: + The job has been queued for execution, but might be waiting because of + rate limiting. + enum: + - waiting + JobStateWaitingChildren: + type: string + description: The job is waiting for child jobs to be completed. + enum: + - waiting-children + JobStateUnknown: + type: string + description: The job state is unknown (undocument or inconsistent). + enum: + - unknown + LatestVersionLevel: + type: string + enum: + - major + - minor + - patch + - 'true' + - 'false' + description: Level of latest versions that should be included. + UpdateMetadataRequestV2: type: object + additionalProperties: false properties: - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: - type: boolean - description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - nameVersion: - type: array - items: - $ref: '#/components/schemas/NamedVersion' - description: >- - Filter on exact `{name}@{version}` functions. Using this filter - implies a `latest=false` default, returning multiple versions of the - same named versions if they are filtered. - version: + author: type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: + description: The author of the function. + description: type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: + description: A description of the function + iconURL: type: string - description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - name: + description: An url to an icon that represents this function. + category: type: string description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: + A category for this function (Deprecated: use tags to categorise + your functions) + deprecated: true + documentationURL: + type: string + description: External url that document this function. + tags: type: array items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - latest: - type: boolean - description: >- - When `true`, only the latest version per function name is returned. - If set to `false`, multiple versions per named function can be - returned. Defaults to `true`, except when specific versions are - selected with the `nameVersion` filter. - additionalProperties: false - description: Latest function versions listing query. - NamedFunctionVersionsQuery: + $ref: '#/components/schemas/Tag' + description: Tags associated with this function. + example: + - name: awaiting-review + color: '#4153ea' + - name: demo + color: '#e639a4' + friendlyName: + type: string + description: Display title for this function. + FunctionMeta: type: object - additionalProperties: false properties: - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - version: + author: type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: + description: The author of the function. + description: type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: + description: A description of the function + iconURL: + type: string + description: An url to an icon that represents this function. + category: type: string description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - description: Named function versions listing query. - VersionsQuery: + A category for this function (Deprecated: use tags to categorise + your functions) + deprecated: true + Tag: type: object - additionalProperties: false properties: - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - endpoint: + name: type: string - description: >- - Filter on the openfaas endpoint. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - imageName: + description: Name of the tag + color: type: string - description: >- - Filter on the container image name. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - storageLocation: + description: Color associated with the tag in an UI. + required: + - name + - color + description: >- + One or more tags can be assigned to a function entity to facilitate + grouping and searching. + DeprecatePreviousPolicy: + type: string + enum: + - none + - all + - patch + - minor + NamedVersionRange: + type: string + description: >- + A name reference with optional version range: `[@]`. + + + References (a version range of) a named and versioned entity like + _function_ or _runtime_. + pattern: ^[^@]*(@.*)?$ + ExampleReference: + type: string + description: |- + Example reference. + + References the example assets from the selected runtime. + enum: + - '!example' + AssetRole: + type: string + enum: + - manifest + - project + - main + - lib + - script + - other + description: Classification of assets with regard to their role. + DocumentationProperty: + type: object + properties: + name: type: string - description: >- - Filter on the storageLocation. This is case-insensitive and supports - wild-cards `?` (any one character) and `*` (any sequence of - characters). - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - nameVersion: - type: array - items: - $ref: '#/components/schemas/NamedVersion' - description: >- - Filter on exact `{name}@{version}` functions. Using this filter - implies a `latest=false` default, returning multiple versions of the - same named versions if they are filtered. - version: + description: Name of the documented property. + description: type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: + description: Documentation of the property. + required: + - name + - description + Documentation: + type: object + properties: + description: + type: string + states: type: array items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: - type: string - description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - name: - type: string - description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: + $ref: '#/components/schemas/DocumentationProperty' + description: Documentation of the plug states. + input: type: array items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: + $ref: '#/components/schemas/DocumentationProperty' + description: Documentation of the plug input parameters. + output: type: array items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - description: Function versions paged query - PlugTypeQuery: - type: object - properties: - type: - $ref: '#/components/schemas/PlugType' - description: If set, filters on the type of plug. - additionalProperties: false - PlugType: + $ref: '#/components/schemas/DocumentationProperty' + description: Documentation of the plug response parameters. + PlugPropertyDataType: type: string enum: - - sensor - - actuator - - transformer - LatestPlugsQuery: + - string + - integer + - long + - float + - double + - boolean + - object + description: Datatype supported in plug input or output properties. + PlugPropertyFormatType: + type: string + enum: + - enum + - resource + - vault + - duration + - code + - url + - date + - template + description: Value domain for a plug input or output property. + EnumValue: {} + DefaultValue: {} + FunctionDeployOverridesType: type: object - additionalProperties: false properties: - type: - $ref: '#/components/schemas/PlugType' - description: If set, filters on the type of plug. - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: - type: boolean - description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - name: - type: string - description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - description: >- - Latest plug versions listing query with latest links. A request that - only uses these query parameters will include links to the _latest_ - draft/published versions of the plug. - LatestPlugVersionsQuery: + envVars: + type: object + additionalProperties: + type: string + labels: + type: object + additionalProperties: + type: string + annotations: + type: object + additionalProperties: + type: string + limits: + $ref: '#/components/schemas/ResourceLimits' + requests: + $ref: '#/components/schemas/ResourceLimits' + ResourceLimits: type: object - additionalProperties: false properties: - tags: - $ref: '#/components/schemas/TagsFilter' - description: >- - Filter on the tags of the item. Can be a single tag, or a list of - tags. When multiple tags are specified, an item must have all of the - tags to be selected. - type: - $ref: '#/components/schemas/PlugType' - description: If set, filters on the type of plug. - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: - type: boolean - description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - nameVersion: - type: array - items: - $ref: '#/components/schemas/NamedVersion' - description: >- - Filter on exact `{name}@{version}` functions. Using this filter - implies a `latest=false` default, returning multiple versions of the - same named versions if they are filtered. - version: + memory: type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: + cpu: type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: + required: + - memory + - cpu + RegistryErrorResponse: + type: object + properties: + error: type: string - description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - name: + code: type: string - description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - latest: - type: boolean - description: >- - When `true`, only the latest version per function name is returned. - If set to `false`, multiple versions per named function can be - returned. Defaults to `true`, except when specific versions are - selected with the `nameVersion` filter. - description: Plug versions listing query. - TagsQuery: + statusCode: + type: number + data: + type: object + additionalProperties: + type: string + required: + - code + - error + - statusCode + JobHALLinks: type: object properties: - tags: - $ref: '#/components/schemas/TagsFilter' - description: >- - Filter on the tags of the item. Can be a single tag, or a list of - tags. When multiple tags are specified, an item must have all of the - tags to be selected. - additionalProperties: false - TagsFilter: - anyOf: - - type: array - items: - type: string - - type: string - TagQuery: + event: + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + example: + href: >- + https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + example: + href: >- + https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + description: HAL links to related actions. + JobStatusHALLink: type: object properties: - name: - type: string - description: >- - If set, filters on the name of a tag. Supports - * and ? wildcards and is case-insensitive. - example: '*-demo-??' - color: + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + example: + href: >- + https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + description: HAL links to related actions. + HALLink: + type: object + properties: + href: type: string - description: >- - If set, filters on the color of a tag. Uses an exact - match. - example: '#4153ea' - additionalProperties: false - FunctionDeleteQuery: + required: + - href + JobEventsHALLink: + type: object + properties: + event: + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + example: + href: >- + https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + description: HAL links to related actions. + JobCauses: + type: object + properties: + build: + $ref: '#/components/schemas/JobCause' + deploy: + $ref: '#/components/schemas/JobCause' + verify: + $ref: '#/components/schemas/JobCause' + undeploy: + $ref: '#/components/schemas/JobCause' + scale: + $ref: '#/components/schemas/JobCause' + description: >- + The motivations for including or excluding a job in response to a + rebuild request. + JobCause: type: object properties: - force: + changed: type: boolean description: >- - If true, the function version will be immediately - undeployed and removed. - - - Otherwise, the removal will be delayed to allow current invocations - to end. During that period, the function is marked _deprecated_. - undeploy: + If true, the argument configuration for this job has + changed in comparison to the previous job execution. A + false will prevent the job to be run. Use + forceVersion or upgrade parameter to force + a rebuild. + reason: + type: string + description: Human readable message describing the cause. + backoff: type: boolean description: >- - If `true`, the `DELETE` operation - - * undeploys the (openfaas) function: it becomes no longer available - for invocation. - - * does NOT remove the function from registry: it stays in an - `undeployed` status. All assets and definitions are retained, so - the version can be restored later with a _rebuild_ action. - - - If `false`, the `DELETE` operation - - * _only_ marks the plug function as _deprecated_, the function - remains active but is removed from the default listings. This also - applies to _draft_ versions. - - - This parameter is incompatible with `force=true`. - - - If not set the default behaviour applies: - - * _draft_ versions are _undeployed_ and _removed_ from registry. - - * non-_draft_ versions are marked _deprecated_ only. - additionalProperties: false - PlugDeleteForceQuery: + If true, recent failures of the job prevented the + re-execution. Use forceVersion or upgrade + parameter to force a rebuild. + newValue: + type: string + description: The new configuration value that causes the change. + oldValue: + type: string + description: The old configuration value used by the last succeeded job. + required: + - changed + - reason + description: >- + The motivation for including or excluding a job (build, + deploy, verify, ...) in response to a rebuild + request. + RootPageResponse: type: object properties: - force: - type: boolean - description: >- - If true, the plug version(s) will be undeployed and - removed. Otherwise, the plug version(s) will only be - deprecated, i.e removed from regular listings. - additionalProperties: false - PlugDeleteQuery: + name: + type: string + description: Name of the service. + version: + $ref: '#/components/schemas/SemanticVersion' + description: Semantic version of the service. + enabled: + type: object + description: Description of the features enabled on this service deployment. + revision: + type: string + description: Revision of the service source code. + required: + - name + - version + - enabled + - revision + description: Status Page + PlugHtmlResponse: + type: string + description: Successful Response + RuntimeSummary: type: object properties: - force: - type: boolean - description: >- - If true, the plug version(s) will be undeployed and - removed. Otherwise, the plug version(s) will only be - deprecated, i.e removed from regular listings. - undeploy: - type: boolean - description: >- - If `true`, the `DELETE` operation - - * undeploys the (openfaas) function for the plug: it becomes no - longer available for invocation. - - * does NOT remove the plug from registry: it stays in an - `undeployed` status. All assets and definitions are retained, so - the plug can be restored later with a _rebuild_ action. - - - If `false`, the `DELETE` operation - - * _only_ marks the plug version(s) as _deprecated_: the plug remains - active but is removed from the default listings. This also applies - to _draft_ versions. - - - This parameter is incompatible with `force=true`. - - - If not set the default behaviour applies: - - * _draft_ versions are _undeployed_ and _removed_ from registry. - - * non-_draft_ versions are marked _deprecated_ only. - additionalProperties: false - AsyncQueryDefaultFalse: + name: + $ref: '#/components/schemas/Runtime' + title: + type: string + description: + type: string + functionType: + $ref: '#/components/schemas/FunctionType' + archiveFormat: + $ref: '#/components/schemas/ArchiveFormat' + versions: + type: array + items: + $ref: '#/components/schemas/RuntimeVersionInfo' + required: + - archiveFormat + - functionType + - name + - title + - versions + description: A summary representation of the runtime, and (selected) versions of it. + RuntimeVersionInfo: type: object properties: - async: + deprecated: type: boolean - description: >- - If this is set to true, the server will start the - required job actions asynchronously and return a 202 - Accepted response. Otherwise, the request will block until - the job actions are completed, or a timeout occurs. - default: false - additionalProperties: false - AsyncQueryDefaultTrue: - type: object - properties: - async: + description: If true, the function uses a deprecated runtime. + upgradable: type: boolean description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. - default: true - additionalProperties: false - AsyncVerifyQuery: + If true, a newer runtime for this function is available using the + `rebuild` API. + version: + $ref: '#/components/schemas/SemanticVersion' + title: + type: string + description: + type: string + required: + - deprecated + - title + - upgradable + - version + description: A summary of a selected version for a runtime + RuntimeSummaryResponse: type: object properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - async: - type: boolean - description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. - default: true - scaleToZero: - type: boolean - description: >- - Indicates whether the function needs to be scaled down after - successful verification. If not set, the function is scaled to zero - only if it was not active before this command. - additionalProperties: false - UpdateComment: + runtimes: + type: array + items: + $ref: '#/components/schemas/RuntimeSummary' + required: + - runtimes + description: Runtimes Found + RuntimeVersionResponse: type: object properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - AsyncDeployQuery: + runtime: + $ref: '#/components/schemas/CompiledRuntimeVersion' + required: + - runtime + description: ': Runtime Version Found' + CompiledRuntimeVersion: type: object properties: - deprecatePrevious: - $ref: '#/components/schemas/DeprecatePreviousPolicy' - description: >- - Set the cleanup policy used to automatically deprecate/delete - previous versions. - dryRun: - type: boolean - description: >- - If set to true, validates the deployment conditions, - but does not change anything. - async: + deprecated: type: boolean - description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. - default: true - scaleToZero: + description: If true, this runtime should no longer be used for new functions. + upgradable: type: boolean description: >- - If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources - when the function is not to be used immediately. - default: false - additionalProperties: false - DryRunQuery: + If true, a newer runtime for this function is available using the + `rebuild` API. + name: + type: string + functionType: + $ref: '#/components/schemas/FunctionType' + archiveFormat: + $ref: '#/components/schemas/ArchiveFormat' + build: + $ref: '#/components/schemas/BuildSpec' + deploy: + $ref: '#/components/schemas/DeploySpec' + language: + $ref: '#/components/schemas/LanguageRelease' + description: Description of the language release + providedDependencies: + type: array + items: + $ref: '#/components/schemas/ProvidedDependency' + description: Description of dependencies provided by this runtime version. + assets: + $ref: '#/components/schemas/AssetsConditions' + description: Restrictions on the assets in the function archive. + title: + type: string + description: + type: string + version: + $ref: '#/components/schemas/SemanticVersion' + required: + - archiveFormat + - deprecated + - functionType + - name + - title + - upgradable + - version + description: >- + Compiled build and deployment information for a runtime version. + Contains all defaults applied on the _global_, _functionType_, + _archiveFormat_, _runtime_ and _runtime version_ level. + BuildSpec: type: object properties: - dryRun: - type: boolean - description: >- - If set to true, validates the deployment conditions, - but does not change anything. - additionalProperties: false - DeprecatePreviousQuery: + context: + type: string + args: + type: object + additionalProperties: + type: string + required: + - context + - args + DeploySpec: type: object properties: - deprecatePrevious: - $ref: '#/components/schemas/DeprecatePreviousPolicy' - description: >- - Set the cleanup policy used to automatically deprecate/delete - previous versions. - additionalProperties: false - DeprecatePreviousPolicy: - type: string - enum: - - none - - all - - patch - - minor - JobQuery: + openfaasSpec: + type: object + properties: + service: + type: string + image: + type: string + namespace: + type: string + envProcess: + type: string + network: + type: string + envVars: + type: object + additionalProperties: + type: string + constraints: + type: array + items: + type: string + labels: + type: object + additionalProperties: + type: string + annotations: + type: object + additionalProperties: + type: string + secrets: + type: array + items: + type: string + registryAuth: + type: string + limits: + $ref: '#/components/schemas/ResourceLimits' + requests: + $ref: '#/components/schemas/ResourceLimits' + readOnlyRootFilesystem: + type: boolean + description: >- + If specified, it overrides the properties in `default`. + Non-specified properties are taken from `default` + LanguageRelease: type: object properties: - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - type: - type: array - items: - $ref: '#/components/schemas/JobTypeSchema' - description: Filter on job type - state: - type: array - items: - $ref: '#/components/schemas/JobStateResult' - description: Filter on job state - functionType: - type: array - items: - $ref: '#/components/schemas/FunctionType' - description: Filter on function type - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on jobs that created before the given timestamp or age - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: Filter on jobs that created after the given timestamp or age - additionalProperties: false - JobTypeSchema: - anyOf: - - $ref: '#/components/schemas/JobTypeBuild' - - $ref: '#/components/schemas/JobTypeDeploy' - - $ref: '#/components/schemas/JobTypeVerify' - - $ref: '#/components/schemas/JobTypeUndeploy' - - $ref: '#/components/schemas/JobTypeScale' - - $ref: '#/components/schemas/JobTypeBatch' - JobTypeBuild: - type: string - description: Build - enum: - - build - JobTypeDeploy: - type: string - description: A job that deploys a function image to the openfaas runtime. - enum: - - deploy - JobTypeVerify: - type: string - description: A job that checks the health of a deployed function. - enum: - - verify - JobTypeUndeploy: - type: string - description: >- - A job that undeploys a deployed function and removes it from the - registry. - enum: - - undeploy - JobTypeScale: - type: string - description: A job that scales a function to a target. - enum: - - scale - JobTypeBatch: - type: string - description: A job that groups other jobs as a parent. - enum: - - batch - JobStateResult: - anyOf: - - $ref: '#/components/schemas/JobState' - - $ref: '#/components/schemas/JobStateUnknown' - description: All reported job states - JobState: - anyOf: - - $ref: '#/components/schemas/JobStateFinished' - - $ref: '#/components/schemas/JobStateActive' - - $ref: '#/components/schemas/JobStateDelayed' - - $ref: '#/components/schemas/JobStateWaiting' - - $ref: '#/components/schemas/JobStateWaitingChildren' - description: Allowed job states - JobStateFinished: - anyOf: - - $ref: '#/components/schemas/JobStateCompleted' - - $ref: '#/components/schemas/JobStateFailed' - description: The job completed successfully or with failure. - JobStateCompleted: - type: string - description: The job has completed successfully. - enum: - - completed - JobStateFailed: - type: string - description: The job failed in execution. - enum: - - failed - JobStateActive: - type: string - description: The job is running. - enum: - - active - JobStateDelayed: - type: string - description: The job has been delayed for retry after a failure. - enum: - - delayed - JobStateWaiting: - type: string + name: + type: string + description: Short technical name of the language or framework used. + version: + type: string + description: Release version of the language or framework. + title: + type: string + description: Display title. + description: + type: string + required: + - name + - version + - title description: >- - The job has been queued for execution, but might be waiting because of - rate limiting. - enum: - - waiting - JobStateWaitingChildren: - type: string - description: The job is waiting for child jobs to be completed. - enum: - - waiting-children - JobStateUnknown: - type: string - description: The job state is unknown (undocument or inconsistent). - enum: - - unknown - RuntimeNameQuery: + Description of the language or framework release used by a runtime + (version). + ProvidedDependency: type: object properties: name: type: string + description: Name of a provided dependency. + title: + type: string + description: Optional display title. + description: + type: string + description: Optional description. + version: + type: string + description: Versions specification of a provided dependency + deprecated: + type: boolean description: >- - If set, filters on the name of a runtime. Supports - * and ? wildcards and is case-insensitive. - example: node* - functionType: + If true, this provided dependency is scheduled for removal (or + incompatible upgrade) in a next runtime version. + default: false + removed: + type: boolean + description: If true, this dependency has been removed from the runtime (version) + default: false + globals: type: array items: - $ref: '#/components/schemas/FunctionType' + type: string description: >- - If set, filters on the functionType of a runtime. Uses - an exact match. - example: plugs - archiveFormat: + Global variables that expose this library to the user code. As the + usage of these globals is deprecated, any usage of such global will + pose issues in an next runtime version. + native: + type: boolean + description: >- + If true, the library is provided natively by the runtime: e.g. node + for javascript. + required: + - name + description: Library dependency that is provided by this runtime. + AssetsConditions: + type: object + properties: + conditions: type: array items: - $ref: '#/components/schemas/ArchiveFormat' + $ref: '#/components/schemas/AssetCondition' description: >- - If set, filters on the archiveFormat of a runtime. Uses - an exact match. - example: node - additionalProperties: false - RuntimeVersionQuery: + All files in a function archive are checked against these + conditions. A file that is not matched is ignored. + maxSize: + type: string + description: The maximum size of the archive (in bytes, unless unit is provided) + description: Describes the assets that are required/allowed/supported for a function. + AssetCondition: type: object properties: - version: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - If set, filters on the version of a runtime. Supports - [version ranges](https://devhints.io/semver). - default: '*' - latest: - $ref: '#/components/schemas/LatestVersionLevel' - description: >- - If set, filters on the level of latest versions that will be - included in the query. - - * `major`: include at most one latest version per name and major - release. - - * `minor`: include at most one latest version per name and minor - release. - - * `patch`: include each matching patch version. - - * `true`: include the latest matching version. - - * `false`: include any matching version (same as `patch`). - - - This filter is applied after all other selection criteria. - default: minor - example: minor - includeDeprecated: - type: boolean - description: If set to `true`, deprecated runtimes will be included in the query. - default: false - additionalProperties: false - LatestVersionLevel: - type: string - enum: - - major - - minor - - patch - - 'true' - - 'false' - description: Level of latest versions that should be included. - RuntimeQuery: - type: object - additionalProperties: false - properties: - version: - $ref: '#/components/schemas/SemanticVersionRange' + title: + type: string + description: + type: string + role: + $ref: '#/components/schemas/AssetRole' + description: Role in the function deployment + pattern: + anyOf: + - type: string + - type: array + items: + type: string + description: Pattern that selects a file in a function archive + contentType: + anyOf: + - type: string + - type: array + items: + type: string + description: Allowed content type(s) of matching files. + min: + type: number description: >- - If set, filters on the version of a runtime. Supports - [version ranges](https://devhints.io/semver). - default: '*' - latest: - $ref: '#/components/schemas/LatestVersionLevel' + The minimal number of files that must match this pattern. Use `0` + for an optional file. + example: 0 + max: + type: number description: >- - If set, filters on the level of latest versions that will be - included in the query. - - * `major`: include at most one latest version per name and major - release. - - * `minor`: include at most one latest version per name and minor - release. - - * `patch`: include each matching patch version. - - * `true`: include the latest matching version. - - * `false`: include any matching version (same as `patch`). - - - This filter is applied after all other selection criteria. - default: minor - example: minor - includeDeprecated: - type: boolean - description: If set to `true`, deprecated runtimes will be included in the query. - default: false - name: + The maximal number of files that can match this pattern. Use `0` for + a disallowed file. This condition only raises an error if there are + no other conditions that + example: 1 + maxSize: type: string description: >- - If set, filters on the name of a runtime. Supports - * and ? wildcards and is case-insensitive. - example: node* - functionType: - type: array - items: - $ref: '#/components/schemas/FunctionType' - description: >- - If set, filters on the functionType of a runtime. Uses - an exact match. - example: plugs - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' + The maximum size for each file matching this pattern (in bytes, + unless unit is provided) + schema: description: >- - If set, filters on the archiveFormat of a runtime. Uses - an exact match. - example: node - GetRuntimeByNameQuery: + The json schema validator that applies (in case of + `application/json` entries). + required: + - role + - pattern + description: Describes conditions on the set of files that match a file pattern. + PlugResponseV2: type: object - additionalProperties: false properties: - version: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - If set, filters on the version of a runtime. Supports - [version ranges](https://devhints.io/semver). - default: '*' - includeDeprecated: - type: boolean - description: If set to `true`, deprecated runtimes will be included in the query. - default: false - functionType: - type: array - items: - $ref: '#/components/schemas/FunctionType' - description: >- - If set, filters on the functionType of a runtime. Uses - an exact match. - example: plugs - archiveFormat: + createdBy: + type: string + description: The user that created this entity. + createdAt: + type: string + format: date-time + description: The timestamp at which this entity was created. + updatedBy: + type: string + description: The user that last updated this entity. + updatedAt: + type: string + format: date-time + description: The timestamp at which this entity was last updated. + updates: type: array items: - $ref: '#/components/schemas/ArchiveFormat' - description: >- - If set, filters on the archiveFormat of a runtime. Uses - an exact match. - example: node - GetRuntimeVersionsQuery: - type: object - additionalProperties: false - properties: - version: - $ref: '#/components/schemas/SemanticVersionRange' + $ref: '#/components/schemas/UpdateRecord' description: >- - If set, filters on the version of a runtime. Supports - [version ranges](https://devhints.io/semver). - default: '*' - latest: - $ref: '#/components/schemas/LatestVersionLevel' + The audit logs corresponding to the latest modifying operations on + this entity. + status: + $ref: '#/components/schemas/Status' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function entity. + runtime: + $ref: '#/components/schemas/RuntimeAttributes' description: >- - If set, filters on the level of latest versions that will be - included in the query. - - * `major`: include at most one latest version per name and major - release. - - * `minor`: include at most one latest version per name and minor - release. - - * `patch`: include each matching patch version. - - * `true`: include the latest matching version. - - * `false`: include any matching version (same as `patch`). - - - This filter is applied after all other selection criteria. - default: minor - example: minor - includeDeprecated: + Information about the current runtime used by this function + deployment. + deprecated: type: boolean - description: If set to `true`, deprecated runtimes will be included in the query. - default: false - functionType: - type: array - items: - $ref: '#/components/schemas/FunctionType' - description: >- - If set, filters on the functionType of a runtime. Uses - an exact match. - example: plugs - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' description: >- - If set, filters on the archiveFormat of a runtime. Uses - an exact match. - example: node - GetRuntimeByNameAndVersionQuery: - type: object - properties: - includeDeprecated: - type: boolean - description: If set to `true`, deprecated runtimes will be included in the query. - default: true - additionalProperties: false - GetRuntimeExampleQuery: - type: object - additionalProperties: false - properties: - ls: + If true this plug is removed from regular listings, as + a result of a DELETE with force=false. + draft: type: boolean description: >- - If set to `true`, the result will be a listing of the files in the - asset, annotated with metadata and validation report from the asset - conditions of the functions runtime. - default: false - includeDeprecated: - type: boolean - description: If set to `true`, deprecated runtimes will be included in the query. - default: true - ContentQueryV2: - type: object - properties: - ls: - type: boolean + If true this function is a draft function and it's + assets are still mutable. + plug: + $ref: '#/components/schemas/PlugManifest' description: >- - If set to `true`, the result will be a listing of the files in the - asset, annotated with metadata and validation report from the asset - conditions of the functions runtime. - default: false - additionalProperties: false - RuntimeParams: - type: object - properties: - name: - $ref: '#/components/schemas/Runtime' - description: The name of a runtime + The plug specification as provided by the plug.json + asset. required: - - name - additionalProperties: false - RuntimeVersionParams: + - createdAt + - createdBy + - deprecated + - draft + - plug + - runtime + - status + - updatedAt + - updatedBy + - updates + UpdateRecord: type: object properties: - name: - $ref: '#/components/schemas/Runtime' - description: The name of a runtime - version: - $ref: '#/components/schemas/SemanticVersionRange' - description: A version range for a runtime - required: - - name - - version - additionalProperties: false - RuntimeVersionAndPathParams: - type: object - additionalProperties: false - properties: - '*': + comment: type: string - description: Full path or path prefix of the asset within the archive - name: - $ref: '#/components/schemas/Runtime' - description: The name of a runtime - version: - $ref: '#/components/schemas/SemanticVersionRange' - description: A version range for a runtime + description: An optional user-specified comment corresponding to the operation. + operation: + $ref: '#/components/schemas/RequestOperation' + description: The type of modifying operation. + jobs: + type: array + items: + type: string + description: The job id's of the corresponding jobs, if applicable. + at: + type: string + format: date-time + by: + type: string + description: The user that initiated this operation. required: - - '*' - - name - - version - AssetPathParamsV2: + - at + - by + - operation + description: >- + An update report corresponding to a modifying operation initiated by a + user/administrator on the entity. + RequestOperation: + type: string + enum: + - create + - metadata-update + - assets-update + - rebuild + - verify + - publish + - deprecate + - undeploy + description: A modifying operation on the function. + Status: + type: string + enum: + - registered + - running + - pending + - deployed + - unhealthy + - killed + - failed + - undeploying + - undeployed + description: Status for a deployed function. + FailureReason: type: object properties: - '*': + log: + type: array + items: + type: string + description: Log lines associated with this failure. + events: + type: array + items: + type: string + description: Events associated with this failure. + cause: type: string - description: Full path or path prefix of the asset within the archive + description: Main cause for the failure. required: - - '*' - additionalProperties: false - LatestPlugVersionsQueryV2: - anyOf: - - $ref: '#/components/schemas/LatestPlugVersionsQuery' - - $ref: '#/components/schemas/LatestPlugsQuery' - description: Latest plug versions listing query. - LatestPlugVersionQueryV2: + - log + - events + RuntimeAttributes: type: object - additionalProperties: false properties: - type: - $ref: '#/components/schemas/PlugType' - description: If set, filters on the type of plug. - includeDraft: + deprecated: type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: + description: If true, the function uses a deprecated runtime. + upgradable: type: boolean description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - description: Latest named plug version listing query - NamedPlugVersionsQueryV2: + If true, a newer runtime for this function is available using the + `rebuild` API. + name: + $ref: '#/components/schemas/Runtime' + description: The name of a runtime + version: + $ref: '#/components/schemas/SemanticVersion' + description: The version of a runtime + required: + - deprecated + - name + - upgradable + - version + PlugManifest: type: object - additionalProperties: false properties: - tags: - $ref: '#/components/schemas/TagsFilter' - description: >- - Filter on the tags of the item. Can be a single tag, or a list of - tags. When multiple tags are specified, an item must have all of the - tags to be selected. - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - version: + deploy: + $ref: '#/components/schemas/FunctionDeployOverridesType' + description: Deployment overrides of the function. + name: type: string + description: The logical name for the function. + version: + $ref: '#/components/schemas/SemanticVersion' + description: The semantic version of the function. + runtime: + $ref: '#/components/schemas/Runtime' description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. + The runtime that specifies how this function should be built and + deployed. This could be overridden or modified on initial deployment + or later rebuild. runtimeVersion: $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: - type: string - description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' + An optional runtime version constraint for deployment of the + function. When not set, the latest runtime version is used for build + and deployment. When set, the latest available patch + version with the same minor version is used. Note that, + after deployment, this runtime version can become obsolete with a + rebuild action. + metadata: + $ref: '#/components/schemas/PlugMeta' description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' + Metadata describing the function. Note that, after deployment, this + metadata can be patched for the deployed plug, as long it does not + affect the runtime behaviour. + type: + $ref: '#/components/schemas/PlugType' + description: Type of the plug. + interface: + $ref: '#/components/schemas/PlugInterface' description: >- - Filter on funtions that were updated after the given timestamp or - age. - archiveFormat: + Description of the user interface of the plug, as visible to + end-users when configuring plug nodes in the rule engine. + required: + - interface + - metadata + - name + - runtime + - type + - version + PlugInterface: + type: object + properties: + states: type: array items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: + type: string + description: The states of a plug as implemented in the plug code. + input: type: array items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - description: Named plug version listing query - KFServingLatestVersionsQueryV2: - anyOf: - - $ref: '#/components/schemas/LatestFunctionVersionsQuery' - - $ref: '#/components/schemas/LatestFunctionsQuery' - description: Latest model versions listing query. - KFServingLatestVersionQueryV2: + $ref: '#/components/schemas/PlugProperty' + description: The named input parameters of a plug + output: + type: array + items: + $ref: '#/components/schemas/PlugProperty' + description: The named output parameters of a plug + PlugProperty: type: object - additionalProperties: false properties: - includeDraft: - type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: + name: + type: string + description: The name of a plug input or output property. + dataType: + $ref: '#/components/schemas/PlugPropertyDataType' + description: The datatype of the property + mandatory: type: boolean - description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - description: Named Model latest version query. - NamedKFServingVersionsQueryV2: - type: object - additionalProperties: false - properties: - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - deprecated: - type: boolean - description: Filter on the deprecation status of the function. - draft: - type: boolean - description: Filter on the draft status of the function. - version: - type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: + description: If true this property is required. + example: true + format: + $ref: '#/components/schemas/PlugPropertyFormat' + description: If present, refines the value domain of the property. + defaultValue: + $ref: '#/components/schemas/DefaultValue' + description: Default value assumed to be used when no value is given. + required: + - name + description: Interface specification of a plug property. + PlugPropertyFormat: + type: object + properties: + type: + $ref: '#/components/schemas/PlugPropertyFormatType' + description: The value domain type for a plug property. + example: enum + values: type: array items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: + $ref: '#/components/schemas/EnumValue' + description: The enumerated value domain when type="enum" + example: + - low + - high + PlugMeta: + type: object + properties: + author: type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: + description: The author of the function. + description: + type: string + description: A description of the function + iconURL: + type: string + description: An url to an icon that represents this function. + category: type: string description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: + A category for this function (Deprecated: use tags to categorise + your functions) + deprecated: true + documentationURL: + type: string + description: External url that document this function. + tags: type: array items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - description: Named Model versions query. - KFServingDeleteQueryV2: - type: object - additionalProperties: false - properties: - comment: + $ref: '#/components/schemas/Tag' + description: Tags associated with this function. + example: + - name: awaiting-review + color: '#4153ea' + - name: demo + color: '#e639a4' + friendlyName: type: string - description: An optional user-specified comment corresponding to the operation. - force: - type: boolean - description: >- - If true, the function version will be immediately - undeployed and removed. - - - Otherwise, the removal will be delayed to allow current invocations - to end. During that period, the function is marked _deprecated_. - undeploy: - type: boolean - description: >- - If `true`, the `DELETE` operation - - * undeploys the (openfaas) function: it becomes no longer available - for invocation. - - * does NOT remove the function from registry: it stays in an - `undeployed` status. All assets and definitions are retained, so - the version can be restored later with a _rebuild_ action. - - - If `false`, the `DELETE` operation - - * _only_ marks the plug function as _deprecated_, the function - remains active but is removed from the default listings. This also - applies to _draft_ versions. - - - This parameter is incompatible with `force=true`. - - - If not set the default behaviour applies: - - * _draft_ versions are _undeployed_ and _removed_ from registry. - - * non-_draft_ versions are marked _deprecated_ only. - async: - type: boolean - description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. - default: true - VersionsQueryV2: + description: Display title for this function. + documentation: + $ref: '#/components/schemas/Documentation' + description: Documentation of the plug interface. + KfservingResponseV2: type: object - additionalProperties: false properties: - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - endpoint: + createdBy: type: string - description: >- - Filter on the openfaas endpoint. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - imageName: + description: The user that created this entity. + createdAt: type: string - description: >- - Filter on the container image name. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - storageLocation: + format: date-time + description: The timestamp at which this entity was created. + updatedBy: + type: string + description: The user that last updated this entity. + updatedAt: type: string + format: date-time + description: The timestamp at which this entity was last updated. + updates: + type: array + items: + $ref: '#/components/schemas/UpdateRecord' description: >- - Filter on the storageLocation. This is case-insensitive and supports - wild-cards `?` (any one character) and `*` (any sequence of - characters). + The audit logs corresponding to the latest modifying operations on + this entity. + status: + $ref: '#/components/schemas/Status' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function entity. + runtime: + $ref: '#/components/schemas/RuntimeAttributes' + description: >- + Information about the current runtime used by this function + deployment. deprecated: type: boolean - description: Filter on the deprecation status of the function. + description: >- + If true this function is deprecated and removed from + regular listings. draft: type: boolean - description: Filter on the draft status of the function. - nameVersion: - type: array - items: - $ref: '#/components/schemas/NamedVersion' description: >- - Filter on exact `{name}@{version}` functions. Using this filter - implies a `latest=false` default, returning multiple versions of the - same named versions if they are filtered. - version: - type: string + If true this function is a draft function and it's + assets are still mutable. + model: + $ref: '#/components/schemas/KFServingManifest' description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/StatusFilter' + The model specification as provided by the model.json + asset. + required: + - createdAt + - createdBy + - deprecated + - draft + - model + - runtime + - status + - updatedAt + - updatedBy + - updates + KFServingManifest: + type: object + properties: + deploy: + $ref: '#/components/schemas/FunctionDeployOverridesType' + description: Deployment overrides of the function. + name: + type: string + description: The logical name for the function. + version: + $ref: '#/components/schemas/SemanticVersion' + description: The semantic version of the function. + runtime: + $ref: '#/components/schemas/Runtime' description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. + The runtime that specifies how this function should be built and + deployed. This could be overridden or modified on initial deployment + or later rebuild. runtimeVersion: $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' + An optional runtime version constraint for deployment of the + function. When not set, the latest runtime version is used for build + and deployment. When set, the latest available patch + version with the same minor version is used. Note that, + after deployment, this runtime version can become obsolete with a + rebuild action. + metadata: + $ref: '#/components/schemas/FunctionMeta' + description: >- + Metadata describing the function. Note that, after deployment, this + metadata can be updated for the deployed function, without affecting + the runtime behaviour of the function itself. + required: + - metadata + - name + - runtime + - version + WebscriptResponseV2: + type: object + properties: + createdBy: + type: string + description: The user that created this entity. + createdAt: + type: string + format: date-time + description: The timestamp at which this entity was created. updatedBy: type: string + description: The user that last updated this entity. + updatedAt: + type: string + format: date-time + description: The timestamp at which this entity was last updated. + updates: + type: array + items: + $ref: '#/components/schemas/UpdateRecord' description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' + The audit logs corresponding to the latest modifying operations on + this entity. + status: + $ref: '#/components/schemas/Status' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function entity. + runtime: + $ref: '#/components/schemas/RuntimeAttributes' description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' + Information about the current runtime used by this function + deployment. + deprecated: + type: boolean description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' + If true this function is deprecated and removed from + regular listings. + draft: + type: boolean description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' + If true this function is a draft function and it's + assets are still mutable. + webscript: + $ref: '#/components/schemas/WebscriptManifest' description: >- - Filter on funtions that were updated after the given timestamp or - age. - name: + The webscript specification as provided by the + webscript.json asset. + secret: type: string description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - description: Function versions paged query - WebscriptLatestVersionsQueryV2: - anyOf: - - $ref: '#/components/schemas/LatestFunctionVersionsQuery' - - $ref: '#/components/schemas/LatestFunctionsQuery' - description: Webscript lastest versions listing query. - WebscriptLatestVersionQueryV2: + The secret for this webscript deployment. This is null + when allowHmac=false in the webscript specificaton. + required: + - createdAt + - createdBy + - deprecated + - draft + - runtime + - status + - updatedAt + - updatedBy + - updates + - webscript + WebscriptManifest: type: object - additionalProperties: false properties: - includeDraft: - type: boolean + deploy: + $ref: '#/components/schemas/FunctionDeployOverridesType' + description: Deployment overrides of the function. + name: + type: string + description: The logical name for the function. + version: + $ref: '#/components/schemas/SemanticVersion' + description: The semantic version of the function. + runtime: + $ref: '#/components/schemas/Runtime' description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: - type: boolean + The runtime that specifies how this function should be built and + deployed. This could be overridden or modified on initial deployment + or later rebuild. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersionRange' description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - description: Webscript latest named version query. - NamedWebscriptVersionsQueryV2: - type: object - additionalProperties: false - properties: - limit: - type: number + An optional runtime version constraint for deployment of the + function. When not set, the latest runtime version is used for build + and deployment. When set, the latest available patch + version with the same minor version is used. Note that, + after deployment, this runtime version can become obsolete with a + rebuild action. + metadata: + $ref: '#/components/schemas/FunctionMeta' description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - deprecated: + Metadata describing the function. Note that, after deployment, this + metadata can be updated for the deployed function, without affecting + the runtime behaviour of the function itself. + private: type: boolean - description: Filter on the deprecation status of the function. - draft: + description: If true this webscript will require authentication. + allowHmac: type: boolean - description: Filter on the draft status of the function. - version: - type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/StatusFilter' description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. + If true this webscript will support authentication with + a HMAC key, available as the secret attribute + of the deployed webscript entity. + required: + - allowHmac + - metadata + - name + - private + - runtime + - version + WebscriptResponseWithInvokeLinkV2: + type: object + properties: createdBy: type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' + description: The user that created this entity. + createdAt: + type: string + format: date-time + description: The timestamp at which this entity was created. updatedBy: type: string - description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - archiveFormat: + description: The user that last updated this entity. + updatedAt: + type: string + format: date-time + description: The timestamp at which this entity was last updated. + updates: type: array items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. + $ref: '#/components/schemas/UpdateRecord' + description: >- + The audit logs corresponding to the latest modifying operations on + this entity. + status: + $ref: '#/components/schemas/Status' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function entity. runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - description: Webscript named versions listing query. - RebuildQueryV2: - type: object - properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - dryRun: - type: boolean + $ref: '#/components/schemas/RuntimeAttributes' description: >- - If set to true, checks whether rebuild jobs are needed, - but do not start any jobs. - async: + Information about the current runtime used by this function + deployment. + deprecated: type: boolean description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. - default: true - upgrade: - $ref: '#/components/schemas/RebuildPolicy' + If true this function is deprecated and removed from + regular listings. + draft: + type: boolean description: >- - If set, force a rebuild with the given runtime version - selection policy.
    • same patch - version. This should only include backward compatible upgrades. -
    • minor major version. This might - include an upgrade of e.g. the language runtime and/or provided - dependencies that could break compatiblity with the function. .
      • -
    - forceVersion: - $ref: '#/components/schemas/SemanticVersion' - description: >- - If set, force a rebuild with the given runtime version (including - downgrades). This parameter is mutually exclusive to the `upgrade` - parameter. - ignoreChecks: - type: boolean - description: >- - If set to true, checks that normally prevent a rebuild are - overriden. These checks include: - - * function state in `pending`, `running`, `failed` or `undeployed` - - * backoff period due to recent failures - - * usage of deprecated dependencies - - * running jobs on entity - - * the `dryRun` option - scaleToZero: - type: boolean - description: >- - Indicates whether the function needs to be scaled down after - successful (re-)deployment. If not set, the function is scaled to - zero only if it was not active before this command. - skipRebuild: - type: boolean + If true this function is a draft function and it's + assets are still mutable. + webscript: + $ref: '#/components/schemas/WebscriptManifest' description: >- - If set, the function will not be rebuild. Always uses the current - runtime version when re-deploying/re-verifying the function. - additionalProperties: false - RemovePlugQueryV2: - type: object - additionalProperties: false - properties: - comment: + The webscript specification as provided by the + webscript.json asset. + secret: type: string - description: An optional user-specified comment corresponding to the operation. - async: - type: boolean - description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. - default: true - force: - type: boolean - description: >- - If true, the plug version(s) will be undeployed and - removed. Otherwise, the plug version(s) will only be - deprecated, i.e removed from regular listings. - undeploy: - type: boolean description: >- - If `true`, the `DELETE` operation - - * undeploys the (openfaas) function for the plug: it becomes no - longer available for invocation. - - * does NOT remove the plug from registry: it stays in an - `undeployed` status. All assets and definitions are retained, so - the plug can be restored later with a _rebuild_ action. - - - If `false`, the `DELETE` operation - - * _only_ marks the plug version(s) as _deprecated_: the plug remains - active but is removed from the default listings. This also applies - to _draft_ versions. - - - This parameter is incompatible with `force=true`. - - - If not set the default behaviour applies: - - * _draft_ versions are _undeployed_ and _removed_ from registry. - - * non-_draft_ versions are marked _deprecated_ only. - RemoveFunctionQueryV2: + The secret for this webscript deployment. This is null + when allowHmac=false in the webscript specificaton. + _links: + $ref: '#/components/schemas/InvokeHALLink' + description: HAL links to related actions. + required: + - createdAt + - createdBy + - deprecated + - draft + - runtime + - status + - updatedAt + - updatedBy + - updates + - webscript + InvokeHALLink: type: object - additionalProperties: false properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - async: - type: boolean - description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. - default: true - force: - type: boolean - description: >- - If true, the function version will be immediately - undeployed and removed. - - - Otherwise, the removal will be delayed to allow current invocations - to end. During that period, the function is marked _deprecated_. - undeploy: - type: boolean - description: >- - If `true`, the `DELETE` operation - - * undeploys the (openfaas) function: it becomes no longer available - for invocation. - - * does NOT remove the function from registry: it stays in an - `undeployed` status. All assets and definitions are retained, so - the version can be restored later with a _rebuild_ action. - - - If `false`, the `DELETE` operation - - * _only_ marks the plug function as _deprecated_, the function - remains active but is removed from the default listings. This also - applies to _draft_ versions. - - - This parameter is incompatible with `force=true`. - - - If not set the default behaviour applies: - - * _draft_ versions are _undeployed_ and _removed_ from registry. - - * non-_draft_ versions are marked _deprecated_ only. - UpdateMetadataRequestV2: + invoke: + $ref: '#/components/schemas/HALLink' + description: HAL link to the endpoint where the webscript is exposed. + example: + href: https://api-aws-dev.waylay.io/functions/v1//myWebscript + UndeploySubmittedResponseV2: type: object - additionalProperties: false properties: - author: - type: string - description: The author of the function. - description: - type: string - description: A description of the function - iconURL: - type: string - description: An url to an icon that represents this function. - category: - type: string - description: >- - A category for this function (Deprecated: use tags to categorise - your functions) - deprecated: true - documentationURL: + message: type: string - description: External url that document this function. - tags: + _links: + $ref: '#/components/schemas/JobHALLinks' + versions: type: array items: - $ref: '#/components/schemas/Tag' - description: Tags associated with this function. - example: - - name: awaiting-review - color: '#4153ea' - - name: demo - color: '#e639a4' - friendlyName: - type: string - description: Display title for this function. - UserPlugMeta: + $ref: '#/components/schemas/SemanticVersion' + description: The versions for which undeployment and/or removal is initiated. + required: + - _links + - message + - versions + description: Undeployment Initiated + UndeployedResponseV2: type: object properties: - author: - type: string - description: The author of the function. - description: - type: string - description: A description of the function - iconURL: - type: string - description: An url to an icon that represents this function. - category: - type: string - description: >- - A category for this function (Deprecated: use tags to categorise - your functions) - deprecated: true - documentationURL: + message: type: string - description: External url that document this function. - tags: + versions: type: array items: - $ref: '#/components/schemas/Tag' - description: Tags associated with this function. - example: - - name: awaiting-review - color: '#4153ea' - - name: demo - color: '#e639a4' - friendlyName: - type: string - description: Display title for this function. - description: Plug metadata that the user can update as `metadata` - FunctionMeta: + $ref: '#/components/schemas/SemanticVersion' + description: The versions that where deprecated, undeployed and/or removed. + required: + - message + - versions + description: Undeployed + ContentValidationListing: type: object properties: - author: - type: string - description: The author of the function. - description: - type: string - description: A description of the function - iconURL: - type: string - description: An url to an icon that represents this function. - category: - type: string - description: >- - A category for this function (Deprecated: use tags to categorise - your functions) - deprecated: true - Tag: + assets: + type: array + items: + $ref: '#/components/schemas/AssetSummaryWithHALLink' + required: + - assets + description: Content listing + AssetSummaryWithHALLink: type: object properties: - name: + _links: + type: object + properties: + asset: + $ref: '#/components/schemas/HALLink' + description: Link to the asset content page for the related entity. + example: + href: >- + https://api.waylay.io/registry/v2/plugs/myPlug/versions/1.0.0/content/index.js + required: + - asset + description: HAL links to the asset + name: type: string - description: Name of the tag - color: + description: File name + title: type: string - description: Color associated with the tag in an UI. + description: + type: string + role: + $ref: '#/components/schemas/AssetRole' required: + - _links - name - - color - description: >- - One or more tags can be assigned to a function entity to facilitate - grouping and searching. - GetContentParamsV2: + GetPlugResponseV2: type: object - additionalProperties: false properties: - '*': - type: string - description: Full path or path prefix of the asset within the archive - name: - type: string - description: The name of the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The version of the function. + entity: + $ref: '#/components/schemas/PlugResponseV2' + description: The specification and deployment status of the function + _links: + type: object + properties: + draft: + type: object + properties: + draft: + type: boolean + enum: + - true + href: + type: string + version: + type: string + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest draft version. + example: + href: >- + https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.0.1 + draft: true + deprecated: false + published: + type: object + properties: + draft: + type: boolean + enum: + - false + href: + type: string + version: + type: string + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest published version. + example: + href: >- + https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.2.0 + draft: false + deprecated: false + jobs: + $ref: '#/components/schemas/HALLink' + description: HAL link to all active jobs for this function (if any) + description: HAL links to related jobs and plugs required: - - '*' - - name - - version - GetInvokableWebscriptQuery: + - _links + - entity + description: Plug Found + AltVersionHALLink: type: object properties: - includeDraft: - type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: - type: boolean - description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - version: - $ref: '#/components/schemas/SemanticVersionRange' + draft: + type: object + properties: + draft: + type: boolean + enum: + - true + href: + type: string + version: + type: string + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest draft version. + example: + href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.0.1 + draft: true + deprecated: false + published: + type: object + properties: + draft: + type: boolean + enum: + - false + href: + type: string + version: + type: string + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest published version. + example: + href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.2.0 + draft: false + deprecated: false + LatestPlugsResponseV2: + type: object + properties: + limit: + type: number + description: The page size used for this query result. + count: + type: number description: >- - If set, filters on the `version` of the webscript. Supports [version - ranges](https://devhints.io/semver) - status: + The total count of matching items, from which this result is one + page. + page: + type: number + description: The page number of a paged query result. + entities: type: array items: - $ref: '#/components/schemas/StatusFilter' - description: If set, filters on the `status` of the webscript. - default: - - running - - deployed - - unhealthy - additionalProperties: false - CreateFunctionQueryV2: + $ref: '#/components/schemas/EntityWithLinks_IPlugResponseV2_' + description: The specification and deployment status of the queried functions + required: + - count + - entities + description: Plugs Found + EntityWithLinks_IPlugResponseV2_: type: object properties: - deprecatePrevious: - $ref: '#/components/schemas/DeprecatePreviousPolicy' - description: >- - Set the cleanup policy used to automatically deprecate/delete - previous versions. - dryRun: - type: boolean + _embedded: + $ref: '#/components/schemas/AltEmbeddedVersion_IPlugResponseV2_' + description: Embedded representations of the _latest_ draft/published versions. + _links: + $ref: '#/components/schemas/AltVersionHALLink' + createdBy: + type: string + description: The user that created this entity. + createdAt: + type: string + format: date-time + description: The timestamp at which this entity was created. + updatedBy: + type: string + description: The user that last updated this entity. + updatedAt: + type: string + format: date-time + description: The timestamp at which this entity was last updated. + updates: + type: array + items: + $ref: '#/components/schemas/UpdateRecord' description: >- - If set to true, validates the deployment conditions, - but does not change anything. - async: - type: boolean + The audit logs corresponding to the latest modifying operations on + this entity. + status: + $ref: '#/components/schemas/Status' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function entity. + runtime: + $ref: '#/components/schemas/RuntimeAttributes' description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. - default: true - scaleToZero: + Information about the current runtime used by this function + deployment. + deprecated: type: boolean description: >- - If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources - when the function is not to be used immediately. - default: false - version: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - If set, the function version will be an increment of the latest - existing version that satisfies the `version` range. Note that this - increment always takes precedence over an explicit `version` in the - function manifest. - name: - type: string - description: >- - If set, the value will be used as the function name instead of the - one specified in the manifest. + If true this plug is removed from regular listings, as + a result of a DELETE with force=false. draft: type: boolean description: >- - If set, the created function will be a draft function and its assets - are still mutable. A build and deploy is initiated only in the case - when all necessary assets are present and valid. - default: false - additionalProperties: false - PublishFunctionQuery: - type: object - additionalProperties: false - properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - deprecatePrevious: - $ref: '#/components/schemas/DeprecatePreviousPolicy' - description: >- - Set the cleanup policy used to automatically deprecate/delete - previous versions. - async: - type: boolean + If true this function is a draft function and it's + assets are still mutable. + plug: + $ref: '#/components/schemas/PlugManifest' description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. - default: true - PatchMetadataQuery: - type: object - additionalProperties: false - properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - PatchInterfaceQuery: + The plug specification as provided by the plug.json + asset. + required: + - createdAt + - createdBy + - deprecated + - draft + - plug + - runtime + - status + - updatedAt + - updatedBy + - updates + AltEmbeddedVersion_IPlugResponseV2_: type: object - additionalProperties: false properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - SchemaParams: + draft: + $ref: '#/components/schemas/PlugResponseV2' + description: Embedded representation of the lastest draft version. + published: + $ref: '#/components/schemas/PlugResponseV2' + description: Embedded representation of the lastest published version. + description: Embedded representations of the _latest_ draft/published versions. + PlugVersionsResponseV2: type: object properties: - functionType: - $ref: '#/components/schemas/FunctionType' - description: Function type - role: - $ref: '#/components/schemas/AssetRole' - description: Asset role + limit: + type: number + description: The page size used for this query result. + count: + type: number + description: >- + The total count of matching items, from which this result is one + page. + page: + type: number + description: The page number of a paged query result. + entities: + type: array + items: + $ref: '#/components/schemas/PlugResponseV2' + description: The specification and deployment status of the queried functions required: - - functionType - - role - additionalProperties: false - AssetRole: - type: string - enum: - - manifest - - project - - main - - lib - - script - - other - description: Classification of assets with regard to their role. - SchemaByIdParams: + - count + - entities + description: Plugs Versions Found + PostPlugJobAsyncResponseV2: type: object properties: - schemaId: + message: type: string - description: Schema id + _links: + $ref: '#/components/schemas/JobHALLinks' + entity: + $ref: '#/components/schemas/PlugResponseV2' + description: >- + The specification and deployment status of the function for which a + task was initiated. required: - - schemaId - additionalProperties: false - UpdateDraftQuery: + - _links + - entity + - message + description: Plug Deployment Initiated + PostPlugJobSyncResponseV2: type: object properties: - comment: + message: type: string - description: An optional user-specified comment corresponding to the operation. - async: - type: boolean - description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. - default: true - chown: - type: boolean + entity: + $ref: '#/components/schemas/PlugResponseV2' description: >- - If set, ownership of the draft function is transferred to the - current user. - default: false + The specification and deployment status of the function for which a + task was completed. required: - - chown - additionalProperties: false - LatestPlugQuery: + - entity + - message + description: Plug Deployed + RebuildPlugAsyncResponseV2: type: object properties: - tags: - $ref: '#/components/schemas/TagsFilter' - description: >- - Filter on the tags of the item. Can be a single tag, or a list of - tags. When multiple tags are specified, an item must have all of the - tags to be selected. - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: - type: boolean - description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - version: - type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: + message: type: string + _links: + $ref: '#/components/schemas/JobHALLinks' + causes: + $ref: '#/components/schemas/JobCauses' + description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/PlugResponseV2' description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: + The specification and deployment status of the function for which + rebuild jobs were initiated. + required: + - _links + - causes + - entity + - message + description: Plug Rebuild Initiated + RebuildPlugSyncResponseV2: + type: object + properties: + message: type: string + causes: + $ref: '#/components/schemas/JobCauses' + description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/PlugResponseV2' description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - name: + The specification and deployment status of the function for which + rebuild status is computed. + required: + - causes + - entity + - message + description: Plug Rebuild Ignored + VerifyPlugSyncResponseV2: + type: object + properties: + message: type: string + entity: + $ref: '#/components/schemas/PlugResponseV2' description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - type: - $ref: '#/components/schemas/PlugType' - description: Filter on the type of the plug. + The specification and deployment status of the function for which a + task was completed. + result: + $ref: '#/components/schemas/VerifyResult' required: - - type - additionalProperties: false - LegacyPlugQuery: + - entity + - message + - result + description: Plug Health Verified + VerifyResult: type: object properties: - name: - type: string + healthy: + type: boolean + description: If true, the deployment check succeeded. + replicas: + type: number description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - version: - type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: + The number of replicas this function was running at the time of the + check. + required: + - healthy + description: The result data for a completed verification job. + JobsForPlugResponseV2: + type: object + properties: + jobs: type: array items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: - type: string - description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - includeDraft: - type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: - type: boolean - description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - tags: - $ref: '#/components/schemas/TagsFilter' + $ref: '#/components/schemas/AnyJobForFunction' description: >- - Filter on the tags of the item. Can be a single tag, or a list of - tags. When multiple tags are specified, an item must have all of the - tags to be selected. - additionalProperties: false - LegacyPlugRequest: - type: object - properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - script: - type: string - dependencies: - $ref: '#/components/schemas/LegacyPlugDependencies' - metadata: + Listing of jobs related to the function deployment. This includes + active jobs, and the most recently failed job (per type) that was + archived on the entity. + function: + $ref: '#/components/schemas/FunctionRef' + description: Function reference. + _links: type: object + properties: + plug: + $ref: '#/components/schemas/HALLink' additionalProperties: false + description: Link to the function entity. + required: + - function + - jobs + description: Plug Jobs Found + AnyJobForFunction: + anyOf: + - type: object properties: - requiredProperties: - $ref: '#/components/schemas/LegacyRequiredProperties' - supportedStates: - type: array - items: - type: string - rawData: - type: array - items: - type: object - properties: - parameter: - type: string - dataType: - $ref: '#/components/schemas/PlugPropertyDataType' - required: - - parameter - additionalProperties: false - configuration: - $ref: '#/components/schemas/LegacyConfiguration' - author: + _links: + $ref: '#/components/schemas/JobHALLinks' + description: Links to events if the job is still active. + type: type: string - description: + description: The type of the background task. + enum: + - build + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/BuildArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/BuildResult' + description: The result of the job if completed. + createdAt: type: string - category: + format: date-time + description: The timestamp of creation of this job + createdBy: type: string - tags: - type: array - items: - $ref: '#/components/schemas/Tag' - iconURL: + description: The user that created this job + operation: type: string - friendlyName: + description: Request operation + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be missing for + batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job, if available. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: Failure reason if available + required: + - createdAt + - createdBy + - operation + - state + - type + title: Build + - type: object + properties: + _links: + $ref: '#/components/schemas/JobHALLinks' + description: Links to events if the job is still active. + type: type: string - documentation: - anyOf: - - type: object - properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - additionalProperties: false - - $ref: '#/components/schemas/Documentation' - documentationURL: + description: The type of the background task. + enum: + - deploy + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/DeployArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/DeployResult' + description: The result of the job if completed. + createdAt: type: string - type: - $ref: '#/components/schemas/PlugType' - required: - - metadata - - name - - script - - type - - version - additionalProperties: false - LegacyPlugDependencies: - type: object - additionalProperties: - type: string - LegacyPlugMetaRequest: - type: object - properties: - author: - type: string - description: - type: string - category: - type: string - tags: - type: array - items: - $ref: '#/components/schemas/Tag' - iconURL: - type: string - friendlyName: - type: string - documentation: - anyOf: - - type: object - properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - additionalProperties: false - - $ref: '#/components/schemas/Documentation' - documentationURL: - type: string - additionalProperties: false - LegacyFunctionMeta: - type: object - properties: - author: - type: string - description: - type: string - category: - type: string - tags: - type: array - items: - $ref: '#/components/schemas/Tag' - iconURL: - type: string - friendlyName: - type: string - DocumentationProperty: - type: object - properties: - name: - type: string - description: Name of the documented property. - description: - type: string - description: Documentation of the property. - required: - - name - - description - Documentation: - type: object - properties: - description: - type: string - states: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - description: Documentation of the plug states. - input: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - description: Documentation of the plug input parameters. - output: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - description: Documentation of the plug response parameters. - PlugPropertyDataType: - type: string - enum: - - string - - integer - - long - - float - - double - - boolean - - object - description: Datatype supported in plug input or output properties. - LegacyConfiguration: - type: array - items: - $ref: '#/components/schemas/LegacyConfigurationObject' - LegacyConfigurationObject: - type: object - properties: - name: - type: string - type: - $ref: '#/components/schemas/PlugPropertyDataType' - mandatory: - type: boolean - format: - type: object + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be missing for + batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job, if available. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: Failure reason if available + required: + - createdAt + - createdBy + - operation + - state + - type + title: Deploy + - type: object properties: + _links: + $ref: '#/components/schemas/JobHALLinks' + description: Links to events if the job is still active. type: - $ref: '#/components/schemas/PlugPropertyFormatType' - values: - type: array - items: - $ref: '#/components/schemas/EnumValue' - defaultValue: - $ref: '#/components/schemas/DefaultValue' - required: - - name - - type - PlugPropertyFormatType: - type: string - enum: - - enum - - resource - - vault - - duration - - code - - url - - date - - template - description: Value domain for a plug input or output property. - EnumValue: {} - DefaultValue: {} - LegacyRequiredProperties: - type: array - items: - anyOf: - - type: string - - $ref: '#/components/schemas/LegacyRequiredPropertyObject' - LegacyRequiredPropertyObject: - type: object - properties: - name: - type: string - type: - $ref: '#/components/schemas/PlugPropertyDataType' - mandatory: - type: boolean - sensitive: - type: boolean - required: - - name - - type - - mandatory - - sensitive - LegacyPlugCreateRequest: - type: object - properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - script: - type: string - dependencies: - $ref: '#/components/schemas/LegacyPlugDependencies' - metadata: - type: object - additionalProperties: false + type: string + description: The type of the background task. + enum: + - verify + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/VerifyArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/VerifyResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be missing for + batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job, if available. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: Failure reason if available + required: + - createdAt + - createdBy + - operation + - state + - type + title: Verify + - type: object properties: - requiredProperties: - $ref: '#/components/schemas/LegacyRequiredProperties' - supportedStates: - type: array - items: - type: string - rawData: - type: array - items: - type: object - properties: - parameter: - type: string - dataType: - $ref: '#/components/schemas/PlugPropertyDataType' - required: - - parameter - additionalProperties: false - configuration: - $ref: '#/components/schemas/LegacyConfiguration' - author: + _links: + $ref: '#/components/schemas/JobHALLinks' + description: Links to events if the job is still active. + type: + type: string + description: The type of the background task. + enum: + - undeploy + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/UndeployArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/UndeployResult' + description: The result of the job if completed. + createdAt: type: string - description: + format: date-time + description: The timestamp of creation of this job + createdBy: type: string - category: + description: The user that created this job + operation: type: string - tags: - type: array - items: - $ref: '#/components/schemas/Tag' - iconURL: + description: Request operation + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be missing for + batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job, if available. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: Failure reason if available + required: + - createdAt + - createdBy + - operation + - state + - type + title: Undeploy + - type: object + properties: + _links: + $ref: '#/components/schemas/JobHALLinks' + description: Links to events if the job is still active. + type: type: string - friendlyName: + description: The type of the background task. + enum: + - scale + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/ScaleArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/ScaleResult' + description: The result of the job if completed. + createdAt: type: string - documentation: - anyOf: - - type: object - properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - additionalProperties: false - - $ref: '#/components/schemas/Documentation' - documentationURL: + format: date-time + description: The timestamp of creation of this job + createdBy: type: string - type: - $ref: '#/components/schemas/PlugType' - additionalProperties: false - required: - - metadata - - name - - script - - version - NamedParameters_typeof_isNotLegacy_: + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be missing for + batch jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job, if available. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: Failure reason if available + required: + - createdAt + - createdBy + - operation + - state + - type + title: Scale + BuildArgs: type: object properties: - documentation: - anyOf: - - type: object - properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - additionalProperties: false - - $ref: '#/components/schemas/Documentation' - additionalProperties: false - NamedParameters_typeof_fromLegacyDocumentation_: - type: object - properties: - legacyDocumentation: - anyOf: - - type: object - properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - additionalProperties: false - - $ref: '#/components/schemas/Documentation' - currentInterface: - $ref: '#/components/schemas/PlugInterface' - additionalProperties: false - PlugInterface: - type: object - properties: - states: - type: array - items: - type: string - description: The states of a plug as implemented in the plug code. - input: - type: array - items: - $ref: '#/components/schemas/PlugProperty' - description: The named input parameters of a plug - output: - type: array - items: - $ref: '#/components/schemas/PlugProperty' - description: The named output parameters of a plug - PlugProperty: - type: object - properties: - name: + runtimeName: + $ref: '#/components/schemas/Runtime' + description: Provided (or defaulted) name of the runtime configuration. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersion' + description: Provided (or defaulted) version of the runtime configuration. + revision: type: string - description: The name of a plug input or output property. - dataType: - $ref: '#/components/schemas/PlugPropertyDataType' - description: The datatype of the property - mandatory: - type: boolean - description: If true this property is required. - example: true - format: - $ref: '#/components/schemas/PlugPropertyFormat' - description: If present, refines the value domain of the property. - defaultValue: - $ref: '#/components/schemas/DefaultValue' - description: Default value assumed to be used when no value is given. - required: - - name - description: Interface specification of a plug property. - PlugPropertyFormat: - type: object - properties: - type: - $ref: '#/components/schemas/PlugPropertyFormatType' - description: The value domain type for a plug property. - example: enum - values: - type: array - items: - $ref: '#/components/schemas/EnumValue' - description: The enumerated value domain when type="enum" - example: - - low - - high - NamedParameters_typeof_fromLegacy_: - type: object - properties: - metadata: - $ref: '#/components/schemas/LegacyPlugMetaRequest' - currentInterface: - $ref: '#/components/schemas/PlugInterface' - required: - - metadata - additionalProperties: false - LegacyDocumentationRequest: - type: object - additionalProperties: false - properties: - description: + description: The revision hash of the current (draft) function revision + storageLocation: type: string - supportedStates: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - rawData: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' + description: Location of the function assets. + imageName: + type: string + description: Provided (or defaulted) image name to publish the function image. + args: + type: object + additionalProperties: + type: string + description: Parameters to the runtime configuration. required: - - configuration - - rawData - - supportedStates - LegacyDocumentation: + - args + - imageName + - revision + - runtimeName + - runtimeVersion + - storageLocation + description: Input arguments to a job that builds a function. + BuildResult: type: object properties: - supportedStates: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - configuration: - type: array - items: - $ref: '#/components/schemas/DocumentationProperty' - rawData: + digest: + type: string + description: SHA digest of the built image. + log: type: array items: - $ref: '#/components/schemas/DocumentationProperty' - required: - - supportedStates - - configuration - - rawData - LegacyDebugPlugRequest: - type: object - properties: - type: - $ref: '#/components/schemas/PlugType' - script: + type: string + description: Detailed logs of the build steps. + status: type: string - dependencies: - $ref: '#/components/schemas/LegacyPlugDependencies' - metadata: - $ref: '#/components/schemas/FunctionMeta' + description: Outcome of the build. required: - - script - additionalProperties: false - LegacyDebugPlugManifest: + - digest + FunctionRef: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. + functionType: + $ref: '#/components/schemas/FunctionType' + description: Function type name: type: string description: The logical name for the function. version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. + type: string + description: The semantic version of the function (all versions if undefined) runtime: $ref: '#/components/schemas/Runtime' - description: >- - The runtime that specifies how this function should be built and - deployed. This could be overridden or modified on initial deployment - or later rebuild. + description: Runtime id runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build - and deployment. When set, the latest available patch - version with the same minor version is used. Note that, - after deployment, this runtime version can become obsolete with a - rebuild action. - metadata: - $ref: '#/components/schemas/FunctionMeta' - description: >- - Metadata describing the function. Note that, after deployment, this - metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - tenant: - $ref: '#/components/schemas/TenantId' - dependencies: - $ref: '#/components/schemas/LegacyPlugDependencies' - script: - type: string + $ref: '#/components/schemas/SemanticVersion' + description: Runtime version required: - - metadata + - functionType - name - - runtime - - script - - tenant - - version - additionalProperties: false - FunctionManifest: + JobStatus: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. + id: + type: string name: type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/Runtime' - description: >- - The runtime that specifies how this function should be built and - deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build - and deployment. When set, the latest available patch - version with the same minor version is used. Note that, - after deployment, this runtime version can become obsolete with a - rebuild action. - metadata: - $ref: '#/components/schemas/FunctionMeta' - description: >- - Metadata describing the function. Note that, after deployment, this - metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. + progress: + anyOf: + - type: number + - type: object + attemptsMade: + type: number + finishedOn: + type: string + format: date-time + processedOn: + type: string + format: date-time + failedReason: + type: string + parent: + $ref: '#/components/schemas/ParentKeys' + delay: + type: number required: - - metadata + - id - name - - runtime - - version - FunctionSpec: + - progress + - attemptsMade + ParentKeys: type: object properties: - name: + id: type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/Runtime' - description: >- - The runtime that specifies how this function should be built and - deployed. This could be overridden or modified on initial deployment - or later rebuild. required: - - name - - runtime - - version - FunctionNameVersion: + - id + DeployArgs: type: object properties: - name: + namespace: type: string - description: The logical name for the function. - version: + description: The (openfaas) namespace for the target function. + endpoint: + type: string + description: The (openfaas) endpoint service name + imageName: + type: string + description: The image name to use for deploying this function + runtimeName: + $ref: '#/components/schemas/Runtime' + description: Provided (or defaulted) name of the runtime configuration. + runtimeVersion: $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. + description: Provided (or defaulted) version of the runtime configuration. + revision: + type: string + description: The revision hash of the current (draft) function revision + deploySpecOverrides: + type: object + properties: + service: + type: string + image: + type: string + namespace: + type: string + envProcess: + type: string + network: + type: string + envVars: + type: object + additionalProperties: + type: string + constraints: + type: array + items: + type: string + labels: + type: object + additionalProperties: + type: string + annotations: + type: object + additionalProperties: + type: string + secrets: + type: array + items: + type: string + registryAuth: + type: string + limits: + $ref: '#/components/schemas/ResourceLimits' + requests: + $ref: '#/components/schemas/ResourceLimits' + readOnlyRootFilesystem: + type: boolean + description: Overrides on the deployment specification. required: - - name - - version - FunctionDeployOverrides: + - deploySpecOverrides + - endpoint + - imageName + - namespace + - revision + - runtimeName + - runtimeVersion + description: Input argument to an (openfaas) deployment job for a function. + DeployResult: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - FunctionDeployOverridesType: + deploySpec: + $ref: '#/components/schemas/ExposedOpenfaasDeploySpec' + description: The deployment parameters used for this function deployment. + required: + - deploySpec + description: The result data for a completed deployment job. + ExposedOpenfaasDeploySpec: type: object properties: - envVars: - type: object - additionalProperties: - type: string + service: + type: string + image: + type: string + namespace: + type: string labels: type: object additionalProperties: @@ -3392,628 +2370,599 @@ components: $ref: '#/components/schemas/ResourceLimits' requests: $ref: '#/components/schemas/ResourceLimits' - ResourceLimits: + required: + - image + - namespace + - service + VerifyArgs: type: object properties: - memory: + namespace: type: string - cpu: + description: The (openfaas) namespace for the target function. + endpoint: + type: string + description: The (openfaas) endpoint service name + runtimeName: + $ref: '#/components/schemas/Runtime' + description: Provided (or defaulted) name of the runtime configuration. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersion' + description: Provided (or defaulted) version of the runtime configuration. + revision: type: string + description: The revision hash of the current (draft) function revision required: - - memory - - cpu - TenantId: - type: string - LegacyPlugCreateQuery: + - endpoint + - namespace + - revision + - runtimeName + - runtimeVersion + description: Input arguments for an (openfaas) deployment verification job. + UndeployArgs: type: object properties: - async: - type: boolean - description: >- - If this is set to true, the server will start the - required job actions asynchronously and return a 202 - Accepted response. Otherwise, the request will block until - the job actions are completed, or a timeout occurs. - default: false - dryRun: + namespace: + type: string + description: The (openfaas) namespace for the target function. + endpoint: + type: string + description: The (openfaas) endpoint service name + runtimeName: + $ref: '#/components/schemas/Runtime' + description: Provided (or defaulted) name of the runtime configuration. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersion' + description: Provided (or defaulted) version of the runtime configuration. + revision: + type: string + description: The revision hash of the current (draft) function revision + isNativePlug: type: boolean - description: If set to true, only validates the incoming request. - scaleToZero: + description: If true, the function is not expected to be deployed on openfaas. + deleteEntity: type: boolean - description: >- - If set to true, scales the function to zero after - successful deployment. - additionalProperties: false - KFServingLatestVersionsQueryV1: + required: + - deleteEntity + - endpoint + - isNativePlug + - namespace + - revision + - runtimeName + - runtimeVersion + description: Input argument to an (openfaas) undeployment job for a function. + UndeployResult: type: object - additionalProperties: false properties: - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: + deployment: type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: + assets: type: boolean - description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - version: - type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: - type: string - description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - name: - type: string - description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - description: Model listing query - KFServingVersionsQueryV1: + registration: + type: boolean + required: + - deployment + - assets + - registration + description: The result data for a completed undeployment job. + ScaleArgs: type: object - additionalProperties: false properties: - limit: - type: number - description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - version: + namespace: type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: + description: The (openfaas) namespace for the target function. + endpoint: type: string - description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - name: + description: The (openfaas) endpoint service name + runtimeName: + $ref: '#/components/schemas/Runtime' + description: Provided (or defaulted) name of the runtime configuration. + runtimeVersion: + $ref: '#/components/schemas/SemanticVersion' + description: Provided (or defaulted) version of the runtime configuration. + revision: type: string - description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - description: Named model versions query - KFServingDeleteQueryV1: + description: The revision hash of the current (draft) function revision + replicas: + type: number + description: Number of target replicas + required: + - endpoint + - namespace + - replicas + - revision + - runtimeName + - runtimeVersion + description: Input argument to an (openfaas) scale job for a function. + ScaleResult: + type: object + description: The result data for a completed scale job. + GetModelResponseV2: + type: object + properties: + entity: + $ref: '#/components/schemas/KfservingResponseV2' + description: The specification and deployment status of the function + _links: + type: object + properties: + draft: + type: object + properties: + draft: + type: boolean + enum: + - true + href: + type: string + version: + type: string + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest draft version. + example: + href: >- + https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.0.1 + draft: true + deprecated: false + published: + type: object + properties: + draft: + type: boolean + enum: + - false + href: + type: string + version: + type: string + deprecated: + type: boolean + required: + - deprecated + - draft + - href + - version + description: Link to the lastest published version. + example: + href: >- + https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + version: 1.2.0 + draft: false + deprecated: false + jobs: + $ref: '#/components/schemas/HALLink' + description: HAL link to all active jobs for this function (if any) + description: HAL links to related jobs and plugs + required: + - _links + - entity + description: Model Found + LatestModelsResponseV2: type: object - additionalProperties: false properties: - async: - type: boolean - description: >- - If this is set to true, the server will start the - required job actions asynchronously and return a 202 - Accepted response. Otherwise, the request will block until - the job actions are completed, or a timeout occurs. - default: false limit: + type: number + description: The page size used for this query result. + count: type: number description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 + The total count of matching items, from which this result is one + page. page: type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: - type: boolean - description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - version: - type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: + description: The page number of a paged query result. + entities: type: array items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. + $ref: '#/components/schemas/EntityWithLinks_IKfservingResponseV2_' + description: The specification and deployment status of the queried functions + required: + - count + - entities + description: Models Found + EntityWithLinks_IKfservingResponseV2_: + type: object + properties: + _embedded: + $ref: '#/components/schemas/AltEmbeddedVersion_IKfservingResponseV2_' + description: Embedded representations of the _latest_ draft/published versions. + _links: + $ref: '#/components/schemas/AltVersionHALLink' createdBy: type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' + description: The user that created this entity. + createdAt: + type: string + format: date-time + description: The timestamp at which this entity was created. updatedBy: type: string - description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated after the given timestamp or - age. - name: + description: The user that last updated this entity. + updatedAt: type: string - description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: + format: date-time + description: The timestamp at which this entity was last updated. + updates: type: array items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. + $ref: '#/components/schemas/UpdateRecord' + description: >- + The audit logs corresponding to the latest modifying operations on + this entity. + status: + $ref: '#/components/schemas/Status' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function entity. runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - WebscriptLatestVersionsQueryV1: - type: object - additionalProperties: false - properties: - limit: - type: number + $ref: '#/components/schemas/RuntimeAttributes' description: >- - The maximum number of items to be return from this query. Has a - deployment-defined default and maximum value. - minimum: 0 - page: - type: number - description: The number of pages to skip when returning result to this query. - minimum: 0 - includeDraft: - type: boolean - description: >- - Configures the inclusion of _draft_ versions when selecting latest - versions per name. By default, draft versions are only considered - when no other versions are available. If set to `true`, draft - versions are **included**. If set to `false`, draft versions are - **excluded**. - includeDeprecated: + Information about the current runtime used by this function + deployment. + deprecated: type: boolean description: >- - Configures the inclusion of _deprecated_ versions when selecting - latest versions per name. By default, deprecated versions are only - considered when no other versions are available. If set to `true`, - deprecated versions are **included**. If set to `false`, deprecated - versions are **excluded**. - version: - type: string - description: >- - Filter on the version of the function (case-sensitive, supports - wildcards). - status: - type: array - items: - $ref: '#/components/schemas/StatusFilter' - description: >- - Filter on the status of the plug. Filter values with a `-` postfix - exclude the status. Use the `any` filter value to include all - states. When not specified, a default `undeployed-` filter excludes - _undeployed_ functions. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: Filter on the runtime version. - createdBy: - type: string - description: >- - Filter on the user that create the plug. You can use the `@me` token - to indicate your own plugs. - example: '@me' - updatedBy: - type: string - description: >- - Filter on the user that last updated the plug. You can use the `@me` - token to indicate your own plugs. - example: '@me' - createdBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created before the given timestamp or - age. - createdAfter: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were created after the given timestamp or - age. - updatedBefore: - $ref: '#/components/schemas/TimestampSpec' - description: >- - Filter on funtions that were updated before the given timestamp or - age. - updatedAfter: - $ref: '#/components/schemas/TimestampSpec' + If true this function is deprecated and removed from + regular listings. + draft: + type: boolean description: >- - Filter on funtions that were updated after the given timestamp or - age. - name: - type: string + If true this function is a draft function and it's + assets are still mutable. + model: + $ref: '#/components/schemas/KFServingManifest' description: >- - Filter on the name of the function. This is case-insensitive and - supports wild-cards `?` (any one character) and `*` (any sequence of - characters). - archiveFormat: - type: array - items: - $ref: '#/components/schemas/ArchiveFormat' - description: Filter on the archive format of the function. - runtime: - type: array - items: - $ref: '#/components/schemas/Runtime' - description: Filter on the runtime of the function. - description: Webscript lastest versions listing query - ForceDeleteQueryV1: + The model specification as provided by the model.json + asset. + required: + - createdAt + - createdBy + - deprecated + - draft + - model + - runtime + - status + - updatedAt + - updatedBy + - updates + AltEmbeddedVersion_IKfservingResponseV2_: type: object - additionalProperties: false properties: - async: - type: boolean - description: >- - If this is set to true, the server will start the - required job actions asynchronously and return a 202 - Accepted response. Otherwise, the request will block until - the job actions are completed, or a timeout occurs. - default: false - force: - type: boolean - description: >- - If true, the plug version(s) will be undeployed and - removed. Otherwise, the plug version(s) will only be - deprecated, i.e removed from regular listings. - UpdateMetadataRequestV1: + draft: + $ref: '#/components/schemas/KfservingResponseV2' + description: Embedded representation of the lastest draft version. + published: + $ref: '#/components/schemas/KfservingResponseV2' + description: Embedded representation of the lastest published version. + description: Embedded representations of the _latest_ draft/published versions. + ModelVersionsResponseV2: type: object - additionalProperties: false properties: - author: - type: string - description: The author of the function. - description: - type: string - description: A description of the function - iconURL: - type: string - description: An url to an icon that represents this function. - category: - type: string + limit: + type: number + description: The page size used for this query result. + count: + type: number description: >- - A category for this function (Deprecated: use tags to categorise - your functions) - deprecated: true - documentationURL: - type: string - description: External url that document this function. - tags: + The total count of matching items, from which this result is one + page. + page: + type: number + description: The page number of a paged query result. + entities: type: array items: - $ref: '#/components/schemas/Tag' - description: Tags associated with this function. - example: - - name: awaiting-review - color: '#4153ea' - - name: demo - color: '#e639a4' - friendlyName: - type: string - description: Display title for this function. - PatchPlugRequestV1: - type: object - properties: - metadata: - $ref: '#/components/schemas/UserPlugMeta' + $ref: '#/components/schemas/KfservingResponseV2' + description: The specification and deployment status of the queried functions required: - - metadata - additionalProperties: false - VerifyQueryV1: + - count + - entities + description: Model Versions Found + PostModelJobAsyncResponseV2: type: object properties: - scaleToZero: - type: boolean + message: + type: string + _links: + $ref: '#/components/schemas/JobHALLinks' + entity: + $ref: '#/components/schemas/KfservingResponseV2' description: >- - Indicates whether the function needs to be scaled down after - successful verification. If not set, the function is scaled to zero - only if it was not active before this command. - additionalProperties: false - AsyncDeployQueryV1: + The specification and deployment status of the function for which a + task was initiated. + required: + - _links + - entity + - message + description: Model Deployment Initiated + PostModelJobSyncResponseV2: type: object - additionalProperties: false properties: - scaleToZero: - type: boolean - description: >- - If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources - when the function is not to be used immediately. - default: false - async: - type: boolean - description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. - default: true - dryRun: - type: boolean + message: + type: string + entity: + $ref: '#/components/schemas/KfservingResponseV2' description: >- - If set to true, validates the deployment conditions, - but does not change anything. - MessageResponse: + The specification and deployment status of the function for which a + task was completed. + required: + - entity + - message + description: Model Deployed + RebuildModelAsyncResponseV2: type: object properties: message: type: string + _links: + $ref: '#/components/schemas/JobHALLinks' + causes: + $ref: '#/components/schemas/JobCauses' + description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/KfservingResponseV2' + description: >- + The specification and deployment status of the function for which + rebuild jobs were initiated. required: + - _links + - causes + - entity - message - ErrorResponse: + description: Model Rebuild Initiated + RebuildModelSyncResponseV2: type: object properties: - error: + message: type: string + causes: + $ref: '#/components/schemas/JobCauses' + description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/KfservingResponseV2' + description: >- + The specification and deployment status of the function for which + rebuild status is computed. required: - - error - Operation: + - causes + - entity + - message + description: Model Rebuild Ignored + VerifyModelSyncResponseV2: type: object properties: - id: - type: string - description: - type: string - name: + message: type: string - deprecated: true - type: - $ref: '#/components/schemas/JobType' + entity: + $ref: '#/components/schemas/KfservingResponseV2' + description: >- + The specification and deployment status of the function for which a + task was completed. + result: + $ref: '#/components/schemas/VerifyResult' required: - - id - - description - - name - - type - OperationStatus: + - entity + - message + - result + description: Model Health Verified + JobsForModelResponseV2: type: object properties: - id: - type: string - description: - type: string - name: - type: string - deprecated: true - type: - $ref: '#/components/schemas/JobType' - done: - type: boolean - error: + jobs: + type: array + items: + $ref: '#/components/schemas/AnyJobForFunction' + description: >- + Listing of jobs related to the function deployment. This includes + active jobs, and the most recently failed job (per type) that was + archived on the entity. + function: + $ref: '#/components/schemas/FunctionRef' + description: Function reference. + _links: type: object properties: - name: - type: string - message: - type: string - stack: - type: string - code: - type: string - required: - - code - - message - - name + model: + $ref: '#/components/schemas/HALLink' + additionalProperties: false + description: Link to the function entity. required: - - description - - done - - id - - name - - type - JobSubmittedResponse: + - function + - jobs + description: Model Jobs Found + GetWebscriptResponseV2: type: object properties: - message: - type: string + entity: + $ref: '#/components/schemas/WebscriptResponseV2' + description: The specification and deployment status of the function _links: - $ref: '#/components/schemas/JobHALLinks' + type: object + properties: + invoke: + $ref: '#/components/schemas/HALLink' + description: HAL link to the endpoint where the webscript is exposed. + example: + href: >- + https://api-aws-dev.waylay.io/functions/v1//myWebscript + jobs: + $ref: '#/components/schemas/HALLink' + description: HAL link to all active jobs for this function (if any) + description: HAL links to related actions. required: - _links - - message - JobHALLinks: + - entity + description: Webscript Found + LatestWebscriptsResponseV2: type: object properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - example: - href: >- - https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - example: - href: >- - https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - description: HAL links to related actions. - JobStatusHALLink: + limit: + type: number + description: The page size used for this query result. + count: + type: number + description: >- + The total count of matching items, from which this result is one + page. + page: + type: number + description: The page number of a paged query result. + entities: + type: array + items: + $ref: >- + #/components/schemas/EntityWithLinks_IWebscriptResponseWithInvokeLinkV2_ + description: The specification and deployment status of the queried functions + required: + - count + - entities + description: Webscripts Found + EntityWithLinks_IWebscriptResponseWithInvokeLinkV2_: type: object properties: - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - example: - href: >- - https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - description: HAL links to related actions. - HALLink: + _embedded: + $ref: >- + #/components/schemas/AltEmbeddedVersion_IWebscriptResponseWithInvokeLinkV2_ + description: Embedded representations of the _latest_ draft/published versions. + _links: + $ref: '#/components/schemas/InvokeHALLink' + description: HAL links to related actions. + createdBy: + type: string + description: The user that created this entity. + createdAt: + type: string + format: date-time + description: The timestamp at which this entity was created. + updatedBy: + type: string + description: The user that last updated this entity. + updatedAt: + type: string + format: date-time + description: The timestamp at which this entity was last updated. + updates: + type: array + items: + $ref: '#/components/schemas/UpdateRecord' + description: >- + The audit logs corresponding to the latest modifying operations on + this entity. + status: + $ref: '#/components/schemas/Status' + description: The current status of this function entity. + failureReason: + $ref: '#/components/schemas/FailureReason' + description: A description of the last failure related to this function entity. + runtime: + $ref: '#/components/schemas/RuntimeAttributes' + description: >- + Information about the current runtime used by this function + deployment. + deprecated: + type: boolean + description: >- + If true this function is deprecated and removed from + regular listings. + draft: + type: boolean + description: >- + If true this function is a draft function and it's + assets are still mutable. + webscript: + $ref: '#/components/schemas/WebscriptManifest' + description: >- + The webscript specification as provided by the + webscript.json asset. + secret: + type: string + description: >- + The secret for this webscript deployment. This is null + when allowHmac=false in the webscript specificaton. + required: + - createdAt + - createdBy + - deprecated + - draft + - runtime + - status + - updatedAt + - updatedBy + - updates + - webscript + AltEmbeddedVersion_IWebscriptResponseWithInvokeLinkV2_: type: object properties: - href: + draft: + $ref: '#/components/schemas/WebscriptResponseWithInvokeLinkV2' + description: Embedded representation of the lastest draft version. + published: + $ref: '#/components/schemas/WebscriptResponseWithInvokeLinkV2' + description: Embedded representation of the lastest published version. + description: Embedded representations of the _latest_ draft/published versions. + WebscriptVersionsResponseV2: + type: object + properties: + limit: + type: number + description: The page size used for this query result. + count: + type: number + description: >- + The total count of matching items, from which this result is one + page. + page: + type: number + description: The page number of a paged query result. + entities: + type: array + items: + $ref: '#/components/schemas/WebscriptResponseWithInvokeLinkV2' + description: The specification and deployment status of the queried functions + required: + - count + - entities + description: Webscript Versions Found + PostWebscriptJobAsyncResponseV2: + type: object + properties: + message: type: string + _links: + $ref: '#/components/schemas/JobHALLinks' + entity: + $ref: '#/components/schemas/WebscriptResponseV2' + description: >- + The specification and deployment status of the function for which a + task was initiated. required: - - href - JobEventsHALLink: + - _links + - entity + - message + description: Webscript Deployment Initiated + PostWebscriptJobSyncResponseV2: type: object properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - example: - href: >- - https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - description: HAL links to related actions. - RebuildSubmittedResponse: + message: + type: string + entity: + $ref: '#/components/schemas/WebscriptResponseV2' + description: >- + The specification and deployment status of the function for which a + task was completed. + required: + - entity + - message + description: Webscript Deployed + RebuildWebscriptAsyncResponseV2: type: object properties: message: @@ -4023,61 +2972,18 @@ components: causes: $ref: '#/components/schemas/JobCauses' description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/WebscriptResponseV2' + description: >- + The specification and deployment status of the function for which + rebuild jobs were initiated. required: - _links - causes + - entity - message - description: Rebuild Initiated - JobCauses: - type: object - properties: - build: - $ref: '#/components/schemas/JobCause' - deploy: - $ref: '#/components/schemas/JobCause' - verify: - $ref: '#/components/schemas/JobCause' - undeploy: - $ref: '#/components/schemas/JobCause' - scale: - $ref: '#/components/schemas/JobCause' - description: >- - The motivations for including or excluding a job in response to a - rebuild request. - JobCause: - type: object - properties: - changed: - type: boolean - description: >- - If true, the argument configuration for this job has - changed in comparison to the previous job execution. A - false will prevent the job to be run. Use - forceVersion or upgrade parameter to force - a rebuild. - reason: - type: string - description: Human readable message describing the cause. - backoff: - type: boolean - description: >- - If true, recent failures of the job prevented the - re-execution. Use forceVersion or upgrade - parameter to force a rebuild. - newValue: - type: string - description: The new configuration value that causes the change. - oldValue: - type: string - description: The old configuration value used by the last succeeded job. - required: - - changed - - reason - description: >- - The motivation for including or excluding a job (build, - deploy, verify, ...) in response to a rebuild - request. - RebuildComputedResponse: + description: Webscript Rebuild Initiated + RebuildWebscriptSyncResponseV2: type: object properties: message: @@ -4085,4779 +2991,1214 @@ components: causes: $ref: '#/components/schemas/JobCauses' description: Motivation for (not) scheduling rebuild actions + entity: + $ref: '#/components/schemas/WebscriptResponseV2' + description: >- + The specification and deployment status of the function for which + rebuild status is computed. required: - causes + - entity - message - description: Rebuild Ignored - RootPageResponse: - type: object - properties: - name: - type: string - description: Name of the service. - version: - $ref: '#/components/schemas/SemanticVersion' - description: Semantic version of the service. - enabled: - type: object - description: Description of the features enabled on this service deployment. - revision: - type: string - description: Revision of the service source code. - required: - - name - - version - - enabled - - revision - description: Status Page - PlugHtmlResponse: - type: string - description: Successful Response - RuntimeSummaryAttrs: + description: Webscript Rebuild Ignored + VerifyWebscriptSyncResponseV2: type: object properties: - name: - $ref: '#/components/schemas/Runtime' - title: - type: string - description: + message: type: string - functionType: - $ref: '#/components/schemas/FunctionType' - archiveFormat: - $ref: '#/components/schemas/ArchiveFormat' + entity: + $ref: '#/components/schemas/WebscriptResponseV2' + description: >- + The specification and deployment status of the function for which a + task was completed. + result: + $ref: '#/components/schemas/VerifyResult' required: - - name - - title - - functionType - - archiveFormat - RuntimeSummary: + - entity + - message + - result + description: Webscript Health Verified + JobsForWebscriptResponseV2: type: object properties: - name: - $ref: '#/components/schemas/Runtime' - title: - type: string - description: - type: string - functionType: - $ref: '#/components/schemas/FunctionType' - archiveFormat: - $ref: '#/components/schemas/ArchiveFormat' - versions: + jobs: type: array items: - $ref: '#/components/schemas/RuntimeVersionInfo' + $ref: '#/components/schemas/AnyJobForFunction' + description: >- + Listing of jobs related to the function deployment. This includes + active jobs, and the most recently failed job (per type) that was + archived on the entity. + function: + $ref: '#/components/schemas/FunctionRef' + description: Function reference. + _links: + type: object + properties: + webscript: + $ref: '#/components/schemas/HALLink' + additionalProperties: false + description: Link to the function entity. required: - - archiveFormat - - functionType - - name - - title - - versions - description: A summary representation of the runtime, and (selected) versions of it. - RuntimeVersionInfo: + - function + - jobs + description: Webscript Jobs Found + BuildJobStatus: type: object properties: - deprecated: - type: boolean - description: If true, the function uses a deprecated runtime. - upgradable: - type: boolean - description: >- - If true, a newer runtime for this function is available using the - `rebuild` API. - version: - $ref: '#/components/schemas/SemanticVersion' - title: + type: type: string - description: + description: The type of the background task. + enum: + - build + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/BuildArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/BuildResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be missing for batch + jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. required: - - deprecated - - title - - upgradable - - version - description: A summary of a selected version for a runtime - RuntimeVersionStatus: + - createdAt + - createdBy + - job + - operation + - request + - state + - type + DeployJobStatus: type: object properties: - deprecated: - type: boolean - description: If true, the function uses a deprecated runtime. - upgradable: - type: boolean + type: + type: string + description: The type of the background task. + enum: + - deploy + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/DeployArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/DeployResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/FunctionRef' description: >- - If true, a newer runtime for this function is available using the - `rebuild` API. + The function entity that this job acts on, will be missing for batch + jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. required: - - deprecated - - upgradable - RuntimeVersionSummary: + - createdAt + - createdBy + - job + - operation + - request + - state + - type + VerifyJobStatus: type: object properties: - deprecated: - type: boolean - description: If true, the function uses a deprecated runtime. - upgradable: - type: boolean - description: >- - If true, a newer runtime for this function is available using the - `rebuild` API. - version: - $ref: '#/components/schemas/SemanticVersion' - title: - type: string - description: + type: type: string - name: - $ref: '#/components/schemas/Runtime' - functionType: - $ref: '#/components/schemas/FunctionType' - archiveFormat: - $ref: '#/components/schemas/ArchiveFormat' - required: - - archiveFormat - - deprecated - - functionType - - name - - title - - upgradable - - version - RuntimeSummaryResponse: + description: The type of the background task. + enum: + - verify + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/VerifyArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/VerifyResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be missing for batch + jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. + required: + - createdAt + - createdBy + - job + - operation + - request + - state + - type + UndeployJobStatus: type: object properties: - runtimes: - type: array - items: - $ref: '#/components/schemas/RuntimeSummary' + type: + type: string + description: The type of the background task. + enum: + - undeploy + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/UndeployArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/UndeployResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be missing for batch + jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. required: - - runtimes - description: Runtimes Found - RuntimeVersionResponse: + - createdAt + - createdBy + - job + - operation + - request + - state + - type + ScaleJobStatus: type: object properties: - runtime: - $ref: '#/components/schemas/CompiledRuntimeVersion' + type: + type: string + description: The type of the background task. + enum: + - scale + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/ScaleArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/ScaleResult' + description: The result of the job if completed. + createdAt: + type: string + format: date-time + description: The timestamp of creation of this job + createdBy: + type: string + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be missing for batch + jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. required: - - runtime - description: ': Runtime Version Found' - CompiledRuntimeVersion: + - createdAt + - createdBy + - job + - operation + - request + - state + - type + BatchJobStatus: type: object properties: - deprecated: - type: boolean - description: If true, this runtime should no longer be used for new functions. - upgradable: - type: boolean - description: >- - If true, a newer runtime for this function is available using the - `rebuild` API. - name: + type: type: string - functionType: - $ref: '#/components/schemas/FunctionType' - archiveFormat: - $ref: '#/components/schemas/ArchiveFormat' - build: - $ref: '#/components/schemas/BuildSpec' - deploy: - $ref: '#/components/schemas/DeploySpec' - language: - $ref: '#/components/schemas/LanguageRelease' - description: Description of the language release - providedDependencies: - type: array - items: - $ref: '#/components/schemas/ProvidedDependency' - description: Description of dependencies provided by this runtime version. - assets: - $ref: '#/components/schemas/AssetsConditions' - description: Restrictions on the assets in the function archive. - title: + description: The type of the background task. + enum: + - batch + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + request: + $ref: '#/components/schemas/BatchArgs' + description: The request that initiated this job. + result: + $ref: '#/components/schemas/BatchResult' + description: The result of the job if completed. + createdAt: type: string - description: + format: date-time + description: The timestamp of creation of this job + createdBy: type: string - version: - $ref: '#/components/schemas/SemanticVersion' + description: The user that created this job + operation: + type: string + description: Request operation + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be missing for batch + jobs. + job: + $ref: '#/components/schemas/JobStatus' + description: Detailed technical status of the job. required: - - archiveFormat - - deprecated - - functionType - - name - - title - - upgradable - - version - description: >- - Compiled build and deployment information for a runtime version. - Contains all defaults applied on the _global_, _functionType_, - _archiveFormat_, _runtime_ and _runtime version_ level. - RuntimeVersionSpecification: + - createdAt + - createdBy + - job + - operation + - request + - state + - type + BatchArgs: type: object properties: - build: - $ref: '#/components/schemas/BuildSpec' - deploy: - $ref: '#/components/schemas/DeploySpec' - language: - $ref: '#/components/schemas/LanguageRelease' - description: Description of the language release - providedDependencies: - type: array - items: - $ref: '#/components/schemas/ProvidedDependency' - description: Description of dependencies provided by this runtime version. - assets: - $ref: '#/components/schemas/AssetsConditions' - description: Restrictions on the assets in the function archive. - deprecated: - type: boolean - description: If true, this runtime should no longer be used for new functions. - title: + plugName: type: string - description: + functionType: + $ref: '#/components/schemas/FunctionType' + childType: type: string - version: - $ref: '#/components/schemas/SemanticVersion' required: - - title - - version - RuntimeSpecification: + - plugName + - functionType + BatchResult: type: object properties: - build: - $ref: '#/components/schemas/BuildSpec' - deploy: - $ref: '#/components/schemas/DeploySpec' - language: - $ref: '#/components/schemas/LanguageRelease' - description: Description of the language release - providedDependencies: - type: array - items: - $ref: '#/components/schemas/ProvidedDependency' - description: Description of dependencies provided by this runtime version. - assets: - $ref: '#/components/schemas/AssetsConditions' - description: Restrictions on the assets in the function archive. - deprecated: - type: boolean - description: If true, this runtime should no longer be used for new functions. - description: |- - Runtime (version) specification that says - * what assets are required/allowed to build the function - * what build parameters are used - * what deployment parameters are used - * which dependencies are provided by the runtime - BuildSpec: + jobCount: + type: number + AnyJobStatus: + anyOf: + - $ref: '#/components/schemas/BuildJobStatus' + - $ref: '#/components/schemas/DeployJobStatus' + - $ref: '#/components/schemas/VerifyJobStatus' + - $ref: '#/components/schemas/UndeployJobStatus' + - $ref: '#/components/schemas/ScaleJobStatus' + - $ref: '#/components/schemas/BatchJobStatus' + JobResponse: type: object properties: - context: - type: string - args: - type: object - additionalProperties: - type: string + job: + $ref: '#/components/schemas/AnyJobStatus' + description: Information about the job. + _links: + $ref: '#/components/schemas/JobEventsAndFunctionHALLink' required: - - context - - args - DeploySpec: - type: object - properties: - openfaasSpec: - type: object + - job + - _links + description: Job Found + JobEventsAndFunctionHALLink: + anyOf: + - type: object properties: - service: + event: + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + example: + href: >- + https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + plug: + $ref: '#/components/schemas/HALLink' + description: Link to the plug. + example: + href: >- + https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 + required: + - plug + title: Plug + - type: object + properties: + event: + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + example: + href: >- + https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + webscript: + $ref: '#/components/schemas/HALLink' + description: Link to the webscript. + example: + href: >- + https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 + required: + - webscript + title: Webscript + - type: object + properties: + event: + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + example: + href: >- + https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + model: + $ref: '#/components/schemas/HALLink' + description: Link to the model. + example: + href: >- + https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + required: + - model + title: Model + - $ref: '#/components/schemas/JobEventsHALLink' + title: No Function + description: HAL links to related actions. + AnyJobStatusSummary: + anyOf: + - type: object + properties: + type: type: string - image: + description: The type of the background task. + enum: + - build + operation: type: string - namespace: + description: The operation name for the background task. + id: type: string - envProcess: + description: The id of the background job, or the constant `_unknown_` + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + createdAt: type: string - network: + format: date-time + description: The creation time of this job + createdBy: type: string - envVars: - type: object - additionalProperties: - type: string - constraints: - type: array - items: - type: string - labels: - type: object - additionalProperties: - type: string - annotations: - type: object - additionalProperties: - type: string - secrets: - type: array - items: - type: string - registryAuth: + description: The user that initiated this job + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be `undefined` + for batch jobs. + _links: + $ref: '#/components/schemas/JobAndFunctionHALLink' + description: >- + HAL links to related the job status, SSE stream, and function + entity if relevant. + required: + - _links + - createdAt + - createdBy + - id + - operation + - state + - type + title: Build + - type: object + properties: + type: type: string - limits: - $ref: '#/components/schemas/ResourceLimits' - requests: - $ref: '#/components/schemas/ResourceLimits' - readOnlyRootFilesystem: - type: boolean - description: >- - If specified, it overrides the properties in `default`. - Non-specified properties are taken from `default` - LanguageRelease: - type: object - properties: - name: - type: string - description: Short technical name of the language or framework used. - version: - type: string - description: Release version of the language or framework. - title: - type: string - description: Display title. - description: - type: string - required: - - name - - version - - title - description: >- - Description of the language or framework release used by a runtime - (version). - ProvidedDependency: - type: object - properties: - name: - type: string - description: Name of a provided dependency. - title: - type: string - description: Optional display title. - description: - type: string - description: Optional description. - version: - type: string - description: Versions specification of a provided dependency - deprecated: - type: boolean - description: >- - If true, this provided dependency is scheduled for removal (or - incompatible upgrade) in a next runtime version. - default: false - removed: - type: boolean - description: If true, this dependency has been removed from the runtime (version) - default: false - globals: - type: array - items: - type: string - description: >- - Global variables that expose this library to the user code. As the - usage of these globals is deprecated, any usage of such global will - pose issues in an next runtime version. - native: - type: boolean - description: >- - If true, the library is provided natively by the runtime: e.g. node - for javascript. - required: - - name - description: Library dependency that is provided by this runtime. - AssetsConditions: - type: object - properties: - conditions: - type: array - items: - $ref: '#/components/schemas/AssetCondition' - description: >- - All files in a function archive are checked against these - conditions. A file that is not matched is ignored. - maxSize: - type: string - description: The maximum size of the archive (in bytes, unless unit is provided) - description: Describes the assets that are required/allowed/supported for a function. - AssetCondition: - type: object - properties: - title: - type: string - description: - type: string - role: - $ref: '#/components/schemas/AssetRole' - description: Role in the function deployment - pattern: - anyOf: - - type: string - - type: array - items: - type: string - description: Pattern that selects a file in a function archive - contentType: - anyOf: - - type: string - - type: array - items: - type: string - description: Allowed content type(s) of matching files. - min: - type: number - description: >- - The minimal number of files that must match this pattern. Use `0` - for an optional file. - example: 0 - max: - type: number - description: >- - The maximal number of files that can match this pattern. Use `0` for - a disallowed file. This condition only raises an error if there are - no other conditions that - example: 1 - maxSize: - type: string - description: >- - The maximum size for each file matching this pattern (in bytes, - unless unit is provided) - schema: - description: >- - The json schema validator that applies (in case of - `application/json` entries). - required: - - role - - pattern - description: Describes conditions on the set of files that match a file pattern. - RuntimeInfo: - type: object - properties: - name: - type: string - functionType: - $ref: '#/components/schemas/FunctionType' - archiveFormat: - $ref: '#/components/schemas/ArchiveFormat' - required: - - name - - functionType - - archiveFormat - description: Runtime attributes that are the same for all versions of a runtime. - PlugResponseV2: - type: object - properties: - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/UpdateRecord' - description: >- - The audit logs corresponding to the latest modifying operations on - this entity. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function entity. - runtime: - $ref: '#/components/schemas/RuntimeAttributes' - description: >- - Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: >- - If true this plug is removed from regular listings, as - a result of a DELETE with force=false. - draft: - type: boolean - description: >- - If true this function is a draft function and it's - assets are still mutable. - plug: - $ref: '#/components/schemas/PlugManifest' - description: >- - The plug specification as provided by the plug.json - asset. - required: - - createdAt - - createdBy - - deprecated - - draft - - plug - - runtime - - status - - updatedAt - - updatedBy - - updates - WithEntityAttributes: - type: object - properties: - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/UpdateRecord' - description: >- - The audit logs corresponding to the latest modifying operations on - this entity. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function entity. - runtime: - $ref: '#/components/schemas/RuntimeAttributes' - description: >- - Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: >- - If true this function is deprecated and removed from - regular listings. - draft: - type: boolean - description: >- - If true this function is a draft function and it's - assets are still mutable. - required: - - createdBy - - createdAt - - updatedBy - - updatedAt - - updates - - status - - runtime - - deprecated - - draft - UpdateRecord: - type: object - properties: - comment: - type: string - description: An optional user-specified comment corresponding to the operation. - operation: - $ref: '#/components/schemas/RequestOperation' - description: The type of modifying operation. - jobs: - type: array - items: - type: string - description: The job id's of the corresponding jobs, if applicable. - at: - type: string - format: date-time - by: - type: string - description: The user that initiated this operation. - required: - - at - - by - - operation - description: >- - An update report corresponding to a modifying operation initiated by a - user/administrator on the entity. - RequestOperation: - type: string - enum: - - create - - metadata-update - - assets-update - - rebuild - - verify - - publish - - deprecate - - undeploy - description: A modifying operation on the function. - Status: - type: string - enum: - - registered - - running - - pending - - deployed - - unhealthy - - killed - - failed - - undeploying - - undeployed - description: Status for a deployed function. - FailureReason: - type: object - properties: - log: - type: array - items: - type: string - description: Log lines associated with this failure. - events: - type: array - items: - type: string - description: Events associated with this failure. - cause: - type: string - description: Main cause for the failure. - required: - - log - - events - RuntimeAttributes: - type: object - properties: - deprecated: - type: boolean - description: If true, the function uses a deprecated runtime. - upgradable: - type: boolean - description: >- - If true, a newer runtime for this function is available using the - `rebuild` API. - name: - $ref: '#/components/schemas/Runtime' - description: The name of a runtime - version: - $ref: '#/components/schemas/SemanticVersion' - description: The version of a runtime - required: - - deprecated - - name - - upgradable - - version - RuntimeReference: - type: object - properties: - name: - $ref: '#/components/schemas/Runtime' - description: The name of a runtime - version: - $ref: '#/components/schemas/SemanticVersion' - description: The version of a runtime - required: - - name - - version - description: Reference to a runtime version. - PlugManifest: - type: object - properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/Runtime' - description: >- - The runtime that specifies how this function should be built and - deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build - and deployment. When set, the latest available patch - version with the same minor version is used. Note that, - after deployment, this runtime version can become obsolete with a - rebuild action. - metadata: - $ref: '#/components/schemas/PlugMeta' - description: >- - Metadata describing the function. Note that, after deployment, this - metadata can be patched for the deployed plug, as long it does not - affect the runtime behaviour. - type: - $ref: '#/components/schemas/PlugType' - description: Type of the plug. - interface: - $ref: '#/components/schemas/PlugInterface' - description: >- - Description of the user interface of the plug, as visible to - end-users when configuring plug nodes in the rule engine. - required: - - interface - - metadata - - name - - runtime - - type - - version - PlugMeta: - type: object - properties: - author: - type: string - description: The author of the function. - description: - type: string - description: A description of the function - iconURL: - type: string - description: An url to an icon that represents this function. - category: - type: string - description: >- - A category for this function (Deprecated: use tags to categorise - your functions) - deprecated: true - documentationURL: - type: string - description: External url that document this function. - tags: - type: array - items: - $ref: '#/components/schemas/Tag' - description: Tags associated with this function. - example: - - name: awaiting-review - color: '#4153ea' - - name: demo - color: '#e639a4' - friendlyName: - type: string - description: Display title for this function. - documentation: - $ref: '#/components/schemas/Documentation' - description: Documentation of the plug interface. - KfservingResponseV2: - type: object - properties: - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/UpdateRecord' - description: >- - The audit logs corresponding to the latest modifying operations on - this entity. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function entity. - runtime: - $ref: '#/components/schemas/RuntimeAttributes' - description: >- - Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: >- - If true this function is deprecated and removed from - regular listings. - draft: - type: boolean - description: >- - If true this function is a draft function and it's - assets are still mutable. - model: - $ref: '#/components/schemas/KFServingManifest' - description: >- - The model specification as provided by the model.json - asset. - required: - - createdAt - - createdBy - - deprecated - - draft - - model - - runtime - - status - - updatedAt - - updatedBy - - updates - KFServingManifest: - type: object - properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/Runtime' - description: >- - The runtime that specifies how this function should be built and - deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build - and deployment. When set, the latest available patch - version with the same minor version is used. Note that, - after deployment, this runtime version can become obsolete with a - rebuild action. - metadata: - $ref: '#/components/schemas/FunctionMeta' - description: >- - Metadata describing the function. Note that, after deployment, this - metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - required: - - metadata - - name - - runtime - - version - WebscriptResponseV2: - type: object - properties: - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/UpdateRecord' - description: >- - The audit logs corresponding to the latest modifying operations on - this entity. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function entity. - runtime: - $ref: '#/components/schemas/RuntimeAttributes' - description: >- - Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: >- - If true this function is deprecated and removed from - regular listings. - draft: - type: boolean - description: >- - If true this function is a draft function and it's - assets are still mutable. - webscript: - $ref: '#/components/schemas/WebscriptManifest' - description: >- - The webscript specification as provided by the - webscript.json asset. - secret: - type: string - description: >- - The secret for this webscript deployment. This is null - when allowHmac=false in the webscript specificaton. - required: - - createdAt - - createdBy - - deprecated - - draft - - runtime - - status - - updatedAt - - updatedBy - - updates - - webscript - WebscriptManifest: - type: object - properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/Runtime' - description: >- - The runtime that specifies how this function should be built and - deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build - and deployment. When set, the latest available patch - version with the same minor version is used. Note that, - after deployment, this runtime version can become obsolete with a - rebuild action. - metadata: - $ref: '#/components/schemas/FunctionMeta' - description: >- - Metadata describing the function. Note that, after deployment, this - metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - private: - type: boolean - description: If true this webscript will require authentication. - allowHmac: - type: boolean - description: >- - If true this webscript will support authentication with - a HMAC key, available as the secret attribute - of the deployed webscript entity. - required: - - allowHmac - - metadata - - name - - private - - runtime - - version - WebscriptResponseWithInvokeLinkV2: - type: object - properties: - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/UpdateRecord' - description: >- - The audit logs corresponding to the latest modifying operations on - this entity. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function entity. - runtime: - $ref: '#/components/schemas/RuntimeAttributes' - description: >- - Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: >- - If true this function is deprecated and removed from - regular listings. - draft: - type: boolean - description: >- - If true this function is a draft function and it's - assets are still mutable. - webscript: - $ref: '#/components/schemas/WebscriptManifest' - description: >- - The webscript specification as provided by the - webscript.json asset. - secret: - type: string - description: >- - The secret for this webscript deployment. This is null - when allowHmac=false in the webscript specificaton. - _links: - $ref: '#/components/schemas/InvokeHALLink' - description: HAL links to related actions. - required: - - createdAt - - createdBy - - deprecated - - draft - - runtime - - status - - updatedAt - - updatedBy - - updates - - webscript - InvokeHALLink: - type: object - properties: - invoke: - $ref: '#/components/schemas/HALLink' - description: HAL link to the endpoint where the webscript is exposed. - example: - href: https://api-aws-dev.waylay.io/functions/v1//myWebscript - UndeploySubmittedResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/JobHALLinks' - versions: - type: array - items: - $ref: '#/components/schemas/SemanticVersion' - description: The versions for which undeployment and/or removal is initiated. - required: - - _links - - message - - versions - description: Undeployment Initiated - UndeployedResponseV2: - type: object - properties: - message: - type: string - versions: - type: array - items: - $ref: '#/components/schemas/SemanticVersion' - description: The versions that where deprecated, undeployed and/or removed. - required: - - message - - versions - description: Undeployed - ContentValidationListing: - type: object - properties: - assets: - type: array - items: - $ref: '#/components/schemas/AssetSummaryWithHALLink' - required: - - assets - description: Content listing - AssetSummaryWithHALLink: - type: object - properties: - _links: - type: object - properties: - asset: - $ref: '#/components/schemas/HALLink' - description: Link to the asset content page for the related entity. - example: - href: >- - https://api.waylay.io/registry/v2/plugs/myPlug/versions/1.0.0/content/index.js - required: - - asset - description: HAL links to the asset - name: - type: string - description: File name - title: - type: string - description: - type: string - role: - $ref: '#/components/schemas/AssetRole' - required: - - _links - - name - AssetSummary: - type: object - properties: - name: - type: string - description: File name - title: - type: string - description: - type: string - role: - $ref: '#/components/schemas/AssetRole' - required: - - name - WithAssetHALLink: - type: object - properties: - _links: - type: object - properties: - asset: - $ref: '#/components/schemas/HALLink' - description: Link to the asset content page for the related entity. - example: - href: >- - https://api.waylay.io/registry/v2/plugs/myPlug/versions/1.0.0/content/index.js - required: - - asset - description: HAL links to the asset - required: - - _links - GetPlugResponseV2: - type: object - properties: - entity: - $ref: '#/components/schemas/PlugResponseV2' - description: The specification and deployment status of the function - _links: - type: object - properties: - draft: - type: object - properties: - draft: - type: boolean - enum: - - true - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest draft version. - example: - href: >- - https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.0.1 - draft: true - deprecated: false - published: - type: object - properties: - draft: - type: boolean - enum: - - false - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest published version. - example: - href: >- - https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.2.0 - draft: false - deprecated: false - jobs: - $ref: '#/components/schemas/HALLink' - description: HAL link to all active jobs for this function (if any) - description: HAL links to related jobs and plugs - required: - - _links - - entity - description: Plug Found - JobsHALLink: - type: object - properties: - jobs: - $ref: '#/components/schemas/HALLink' - description: HAL link to all active jobs for this function (if any) - AltVersionHALLink: - type: object - properties: - draft: - type: object - properties: - draft: - type: boolean - enum: - - true - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest draft version. - example: - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.0.1 - draft: true - deprecated: false - published: - type: object - properties: - draft: - type: boolean - enum: - - false - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest published version. - example: - href: https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.2.0 - draft: false - deprecated: false - LatestPlugsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: >- - The total count of matching items, from which this result is one - page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - type: object - properties: - _links: - $ref: '#/components/schemas/AltVersionHALLink' - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/UpdateRecord' - description: >- - The audit logs corresponding to the latest modifying - operations on this entity. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: >- - A description of the last failure related to this function - entity. - runtime: - $ref: '#/components/schemas/RuntimeAttributes' - description: >- - Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: >- - If true this plug is removed from regular - listings, as a result of a DELETE with - force=false. - draft: - type: boolean - description: >- - If true this function is a draft function and - it's assets are still mutable. - plug: - $ref: '#/components/schemas/PlugManifest' - description: >- - The plug specification as provided by the - plug.json asset. - required: - - _links - - createdAt - - createdBy - - deprecated - - draft - - plug - - runtime - - status - - updatedAt - - updatedBy - - updates - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Plugs Found - WithPaging: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: >- - The total count of matching items, from which this result is one - page. - page: - type: number - description: The page number of a paged query result. - required: - - count - WithLimit: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - PlugVersionsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: >- - The total count of matching items, from which this result is one - page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - $ref: '#/components/schemas/PlugResponseV2' - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Plugs Versions Found - PostPlugJobAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/JobHALLinks' - entity: - $ref: '#/components/schemas/PlugResponseV2' - description: >- - The specification and deployment status of the function for which a - task was initiated. - required: - - _links - - entity - - message - description: Plug Deployment Initiated - PostPlugJobSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/PlugResponseV2' - description: >- - The specification and deployment status of the function for which a - task was completed. - required: - - entity - - message - description: Plug Deployed - RebuildPlugAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/JobHALLinks' - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/PlugResponseV2' - description: >- - The specification and deployment status of the function for which - rebuild jobs were initiated. - required: - - _links - - causes - - entity - - message - description: Plug Rebuild Initiated - RebuildPlugSyncResponseV2: - type: object - properties: - message: - type: string - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/PlugResponseV2' - description: >- - The specification and deployment status of the function for which - rebuild status is computed. - required: - - causes - - entity - - message - description: Plug Rebuild Ignored - VerifyPlugSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/PlugResponseV2' - description: >- - The specification and deployment status of the function for which a - task was completed. - result: - $ref: '#/components/schemas/VerifyResult' - required: - - entity - - message - - result - description: Plug Health Verified - VerifyResult: - type: object - properties: - healthy: - type: boolean - description: If true, the deployment check succeeded. - replicas: - type: number - description: >- - The number of replicas this function was running at the time of the - check. - required: - - healthy - description: The result data for a completed verification job. - JobsForPlugResponseV2: - type: object - properties: - jobs: - type: array - items: - $ref: '#/components/schemas/AnyJobForFunction' - description: >- - Listing of jobs related to the function deployment. This includes - active jobs, and the most recently failed job (per type) that was - archived on the entity. - function: - $ref: '#/components/schemas/FunctionRef' - description: Function reference. - _links: - type: object - properties: - plug: - $ref: '#/components/schemas/HALLink' - additionalProperties: false - description: Link to the function entity. - required: - - function - - jobs - description: Plug Jobs Found - AnyJobForFunction: - anyOf: - - type: object - properties: - _links: - $ref: '#/components/schemas/JobHALLinks' - description: Links to events if the job is still active. - type: - type: string - description: The type of the background task. - enum: - - build - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/BuildArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/BuildResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for - batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available - required: - - createdAt - - createdBy - - operation - - state - - type - title: Build - - type: object - properties: - _links: - $ref: '#/components/schemas/JobHALLinks' - description: Links to events if the job is still active. - type: - type: string - description: The type of the background task. - enum: - - deploy - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/DeployArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/DeployResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for - batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available - required: - - createdAt - - createdBy - - operation - - state - - type - title: Deploy - - type: object - properties: - _links: - $ref: '#/components/schemas/JobHALLinks' - description: Links to events if the job is still active. - type: - type: string - description: The type of the background task. - enum: - - verify - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/VerifyArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/VerifyResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for - batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available - required: - - createdAt - - createdBy - - operation - - state - - type - title: Verify - - type: object - properties: - _links: - $ref: '#/components/schemas/JobHALLinks' - description: Links to events if the job is still active. - type: - type: string - description: The type of the background task. - enum: - - undeploy - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/UndeployArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/UndeployResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for - batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available - required: - - createdAt - - createdBy - - operation - - state - - type - title: Undeploy - - type: object - properties: - _links: - $ref: '#/components/schemas/JobHALLinks' - description: Links to events if the job is still active. - type: - type: string - description: The type of the background task. - enum: - - scale - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/ScaleArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/ScaleResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for - batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available - required: - - createdAt - - createdBy - - operation - - state - - type - title: Scale - BuildArgs: - type: object - properties: - runtimeName: - $ref: '#/components/schemas/Runtime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - storageLocation: - type: string - description: Location of the function assets. - imageName: - type: string - description: Provided (or defaulted) image name to publish the function image. - args: - type: object - additionalProperties: - type: string - description: Parameters to the runtime configuration. - required: - - args - - imageName - - runtimeName - - runtimeVersion - - storageLocation - description: Input arguments to a job that builds a function. - FunctionJobArgs: - type: object - properties: - runtimeName: - $ref: '#/components/schemas/Runtime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - required: - - runtimeName - - runtimeVersion - description: Job arguments shared by all function jobs - BuildResult: - type: object - properties: - digest: - type: string - description: SHA digest of the built image. - log: - type: array - items: - type: string - description: Detailed logs of the build steps. - status: - type: string - description: Outcome of the build. - required: - - digest - FunctionRef: - type: object - properties: - functionType: - $ref: '#/components/schemas/FunctionType' - description: Function type - name: - type: string - description: The logical name for the function. - version: - type: string - description: The semantic version of the function (all versions if undefined) - runtime: - $ref: '#/components/schemas/Runtime' - description: Runtime id - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Runtime version - required: - - functionType - - name - JobStatus: - type: object - properties: - id: - type: string - name: - type: string - progress: - anyOf: - - type: number - - type: object - attemptsMade: - type: number - finishedOn: - type: string - format: date-time - processedOn: - type: string - format: date-time - failedReason: - type: string - parent: - $ref: '#/components/schemas/ParentKeys' - delay: - type: number - required: - - id - - name - - progress - - attemptsMade - ParentKeys: - type: object - properties: - id: - type: string - required: - - id - DeployArgs: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - imageName: - type: string - description: The image name to use for deploying this function - runtimeName: - $ref: '#/components/schemas/Runtime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - deploySpecOverrides: - type: object - properties: - service: - type: string - image: - type: string - namespace: - type: string - envProcess: - type: string - network: - type: string - envVars: - type: object - additionalProperties: - type: string - constraints: - type: array - items: - type: string - labels: - type: object - additionalProperties: - type: string - annotations: - type: object - additionalProperties: - type: string - secrets: - type: array - items: - type: string - registryAuth: - type: string - limits: - $ref: '#/components/schemas/ResourceLimits' - requests: - $ref: '#/components/schemas/ResourceLimits' - readOnlyRootFilesystem: - type: boolean - description: Overrides on the deployment specification. - required: - - deploySpecOverrides - - endpoint - - imageName - - namespace - - runtimeName - - runtimeVersion - description: Input argument to an (openfaas) deployment job for a function. - OpenfaasDeployArgs: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - imageName: - type: string - description: The image name to use for deploying this function - required: - - endpoint - - imageName - - namespace - OpenfaasFunctionRef: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - required: - - namespace - - endpoint - DeployResult: - type: object - properties: - deploySpec: - $ref: '#/components/schemas/ExposedOpenfaasDeploySpec' - description: The deployment parameters used for this function deployment. - required: - - deploySpec - description: The result data for a completed deployment job. - ExposedOpenfaasDeploySpec: - type: object - properties: - service: - type: string - image: - type: string - namespace: - type: string - labels: - type: object - additionalProperties: - type: string - annotations: - type: object - additionalProperties: - type: string - limits: - $ref: '#/components/schemas/ResourceLimits' - requests: - $ref: '#/components/schemas/ResourceLimits' - required: - - image - - namespace - - service - VerifyArgs: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - runtimeName: - $ref: '#/components/schemas/Runtime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - required: - - endpoint - - namespace - - runtimeName - - runtimeVersion - description: Input arguments for an (openfaas) deployment verification job. - UndeployArgs: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - runtimeName: - $ref: '#/components/schemas/Runtime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - isNativePlug: - type: boolean - description: If true, the function is not expected to be deployed on openfaas. - deleteEntity: - type: boolean - required: - - deleteEntity - - endpoint - - isNativePlug - - namespace - - runtimeName - - runtimeVersion - description: Input argument to an (openfaas) undeployment job for a function. - UndeployResult: - type: object - properties: - deployment: - type: boolean - assets: - type: boolean - registration: - type: boolean - required: - - deployment - - assets - - registration - description: The result data for a completed undeployment job. - ScaleArgs: - type: object - properties: - namespace: - type: string - description: The (openfaas) namespace for the target function. - endpoint: - type: string - description: The (openfaas) endpoint service name - runtimeName: - $ref: '#/components/schemas/Runtime' - description: Provided (or defaulted) name of the runtime configuration. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersion' - description: Provided (or defaulted) version of the runtime configuration. - revision: - type: string - description: The revision hash of the current (draft) function revision - replicas: - type: number - description: Number of target replicas - required: - - endpoint - - namespace - - replicas - - runtimeName - - runtimeVersion - description: Input argument to an (openfaas) scale job for a function. - ScaleResult: - type: object - description: The result data for a completed scale job. - GetModelResponseV2: - type: object - properties: - entity: - $ref: '#/components/schemas/KfservingResponseV2' - description: The specification and deployment status of the function - _links: - type: object - properties: - draft: - type: object - properties: - draft: - type: boolean - enum: - - true - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest draft version. - example: - href: >- - https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.0.1 - draft: true - deprecated: false - published: - type: object - properties: - draft: - type: boolean - enum: - - false - href: - type: string - version: - type: string - deprecated: - type: boolean - required: - - deprecated - - draft - - href - - version - description: Link to the lastest published version. - example: - href: >- - https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - version: 1.2.0 - draft: false - deprecated: false - jobs: - $ref: '#/components/schemas/HALLink' - description: HAL link to all active jobs for this function (if any) - description: HAL links to related jobs and plugs - required: - - _links - - entity - description: Model Found - LatestModelsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: >- - The total count of matching items, from which this result is one - page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - type: object - properties: - _links: - $ref: '#/components/schemas/AltVersionHALLink' - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/UpdateRecord' - description: >- - The audit logs corresponding to the latest modifying - operations on this entity. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: >- - A description of the last failure related to this function - entity. - runtime: - $ref: '#/components/schemas/RuntimeAttributes' - description: >- - Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: >- - If true this function is deprecated and removed - from regular listings. - draft: - type: boolean - description: >- - If true this function is a draft function and - it's assets are still mutable. - model: - $ref: '#/components/schemas/KFServingManifest' - description: >- - The model specification as provided by the - model.json asset. - required: - - _links - - createdAt - - createdBy - - deprecated - - draft - - model - - runtime - - status - - updatedAt - - updatedBy - - updates - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Models Found - ModelVersionsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: >- - The total count of matching items, from which this result is one - page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - $ref: '#/components/schemas/KfservingResponseV2' - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Model Versions Found - PostModelJobAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/JobHALLinks' - entity: - $ref: '#/components/schemas/KfservingResponseV2' - description: >- - The specification and deployment status of the function for which a - task was initiated. - required: - - _links - - entity - - message - description: Model Deployment Initiated - PostModelJobSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/KfservingResponseV2' - description: >- - The specification and deployment status of the function for which a - task was completed. - required: - - entity - - message - description: Model Deployed - RebuildModelAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/JobHALLinks' - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/KfservingResponseV2' - description: >- - The specification and deployment status of the function for which - rebuild jobs were initiated. - required: - - _links - - causes - - entity - - message - description: Model Rebuild Initiated - RebuildModelSyncResponseV2: - type: object - properties: - message: - type: string - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/KfservingResponseV2' - description: >- - The specification and deployment status of the function for which - rebuild status is computed. - required: - - causes - - entity - - message - description: Model Rebuild Ignored - VerifyModelSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/KfservingResponseV2' - description: >- - The specification and deployment status of the function for which a - task was completed. - result: - $ref: '#/components/schemas/VerifyResult' - required: - - entity - - message - - result - description: Model Health Verified - JobsForModelResponseV2: - type: object - properties: - jobs: - type: array - items: - $ref: '#/components/schemas/AnyJobForFunction' - description: >- - Listing of jobs related to the function deployment. This includes - active jobs, and the most recently failed job (per type) that was - archived on the entity. - function: - $ref: '#/components/schemas/FunctionRef' - description: Function reference. - _links: - type: object - properties: - model: - $ref: '#/components/schemas/HALLink' - additionalProperties: false - description: Link to the function entity. - required: - - function - - jobs - description: Model Jobs Found - GetWebscriptResponseV2: - type: object - properties: - entity: - $ref: '#/components/schemas/WebscriptResponseV2' - description: The specification and deployment status of the function - _links: - type: object - properties: - invoke: - $ref: '#/components/schemas/HALLink' - description: HAL link to the endpoint where the webscript is exposed. - example: - href: >- - https://api-aws-dev.waylay.io/functions/v1//myWebscript - jobs: - $ref: '#/components/schemas/HALLink' - description: HAL link to all active jobs for this function (if any) - description: HAL links to related actions. - required: - - _links - - entity - description: Webscript Found - LatestWebscriptsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: >- - The total count of matching items, from which this result is one - page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - type: object - properties: - _links: - $ref: '#/components/schemas/InvokeHALLink' - description: HAL links to related actions. - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - updates: - type: array - items: - $ref: '#/components/schemas/UpdateRecord' - description: >- - The audit logs corresponding to the latest modifying - operations on this entity. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: >- - A description of the last failure related to this function - entity. - runtime: - $ref: '#/components/schemas/RuntimeAttributes' - description: >- - Information about the current runtime used by this function - deployment. - deprecated: - type: boolean - description: >- - If true this function is deprecated and removed - from regular listings. - draft: - type: boolean - description: >- - If true this function is a draft function and - it's assets are still mutable. - webscript: - $ref: '#/components/schemas/WebscriptManifest' - description: >- - The webscript specification as provided by the - webscript.json asset. - secret: - type: string - description: >- - The secret for this webscript deployment. This is - null when allowHmac=false in the - webscript specificaton. - required: - - _links - - createdAt - - createdBy - - deprecated - - draft - - runtime - - status - - updatedAt - - updatedBy - - updates - - webscript - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Webscripts Found - WebscriptVersionsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: >- - The total count of matching items, from which this result is one - page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - $ref: '#/components/schemas/WebscriptResponseWithInvokeLinkV2' - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Webscript Versions Found - PostWebscriptJobAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/JobHALLinks' - entity: - $ref: '#/components/schemas/WebscriptResponseV2' - description: >- - The specification and deployment status of the function for which a - task was initiated. - required: - - _links - - entity - - message - description: Webscript Deployment Initiated - PostWebscriptJobSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/WebscriptResponseV2' - description: >- - The specification and deployment status of the function for which a - task was completed. - required: - - entity - - message - description: Webscript Deployed - RebuildWebscriptAsyncResponseV2: - type: object - properties: - message: - type: string - _links: - $ref: '#/components/schemas/JobHALLinks' - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/WebscriptResponseV2' - description: >- - The specification and deployment status of the function for which - rebuild jobs were initiated. - required: - - _links - - causes - - entity - - message - description: Webscript Rebuild Initiated - RebuildWebscriptSyncResponseV2: - type: object - properties: - message: - type: string - causes: - $ref: '#/components/schemas/JobCauses' - description: Motivation for (not) scheduling rebuild actions - entity: - $ref: '#/components/schemas/WebscriptResponseV2' - description: >- - The specification and deployment status of the function for which - rebuild status is computed. - required: - - causes - - entity - - message - description: Webscript Rebuild Ignored - VerifyWebscriptSyncResponseV2: - type: object - properties: - message: - type: string - entity: - $ref: '#/components/schemas/WebscriptResponseV2' - description: >- - The specification and deployment status of the function for which a - task was completed. - result: - $ref: '#/components/schemas/VerifyResult' - required: - - entity - - message - - result - description: Webscript Health Verified - JobsForWebscriptResponseV2: - type: object - properties: - jobs: - type: array - items: - $ref: '#/components/schemas/AnyJobForFunction' - description: >- - Listing of jobs related to the function deployment. This includes - active jobs, and the most recently failed job (per type) that was - archived on the entity. - function: - $ref: '#/components/schemas/FunctionRef' - description: Function reference. - _links: - type: object - properties: - webscript: - $ref: '#/components/schemas/HALLink' - additionalProperties: false - description: Link to the function entity. - required: - - function - - jobs - description: Webscript Jobs Found - InvokableWebscriptResponse: - type: object - properties: - entity: - type: object - properties: - status: - $ref: '#/components/schemas/Status' - draft: - type: boolean - webscript: - type: object - properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - private: - type: boolean - allowHmac: - type: boolean - required: - - name - - version - - private - - allowHmac - secret: - type: string - required: - - status - - draft - - webscript - _links: - $ref: '#/components/schemas/InvokeInternalHALLink' - required: - - entity - - _links - description: Webscript Found - InvokeInternalHALLink: - type: object - properties: - invoke-internal: - $ref: '#/components/schemas/HALLink' - description: HAL link to the Openfaas endpoint. - example: - href: >- - openfaas:/functions/web-a7420ffdf5ffe5b573a57f766aed38552a4e1421.openfaas-fn-740799ef-d515-4704-8718-903851c9899e - UnhealthyInvokableWebscriptError: - type: object - properties: - entity: - type: object - properties: - status: - $ref: '#/components/schemas/Status' - draft: - type: boolean - webscript: - type: object - properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - private: - type: boolean - allowHmac: - type: boolean - required: - - name - - version - - private - - allowHmac - secret: - type: string - required: - - status - - draft - - webscript - _links: - $ref: '#/components/schemas/InvokeInternalHALLink' - error: - type: string - code: - type: string - required: - - _links - - code - - entity - - error - description: Webscript Not Healthy - AnyFunctionResponse: - anyOf: - - $ref: '#/components/schemas/PlugResponseV2' - - $ref: '#/components/schemas/KfservingResponseV2' - - $ref: '#/components/schemas/WebscriptResponseV2' - VersionsResponseV2: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - count: - type: number - description: >- - The total count of matching items, from which this result is one - page. - page: - type: number - description: The page number of a paged query result. - entities: - type: array - items: - $ref: '#/components/schemas/AnyFunctionResponse' - description: The specification and deployment status of the queried functions - required: - - count - - entities - description: Version Listing Response - NamedParameters_typeof_asJobReference_: - type: object - properties: - jobStatus: - type: object - properties: - _links: - $ref: '#/components/schemas/JobHALLinks' - description: Links to events if the job is still active. - type: - description: The type of the background task. - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - description: The request that initiated this job. - result: - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for - batch jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job, if available. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: Failure reason if available - required: - - createdAt - - createdBy - - operation - - state - - type - required: - - jobStatus - additionalProperties: false - BuildJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - build - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/BuildArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/BuildResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for batch - jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - DeployJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - deploy - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/DeployArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/DeployResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for batch - jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - VerifyJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - verify - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/VerifyArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/VerifyResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for batch - jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - UndeployJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - undeploy - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/UndeployArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/UndeployResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for batch - jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - ScaleJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - scale - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/ScaleArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/ScaleResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for batch - jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - BatchJobStatus: - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - batch - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - request: - $ref: '#/components/schemas/BatchArgs' - description: The request that initiated this job. - result: - $ref: '#/components/schemas/BatchResult' - description: The result of the job if completed. - createdAt: - type: string - format: date-time - description: The timestamp of creation of this job - createdBy: - type: string - description: The user that created this job - operation: - type: string - description: Request operation - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be missing for batch - jobs. - job: - $ref: '#/components/schemas/JobStatus' - description: Detailed technical status of the job. - required: - - createdAt - - createdBy - - job - - operation - - request - - state - - type - BatchArgs: - type: object - properties: - plugName: - type: string - functionType: - $ref: '#/components/schemas/FunctionType' - childType: - type: string - required: - - plugName - - functionType - BatchResult: - type: object - properties: - jobCount: - type: number - AnyJobStatus: - anyOf: - - $ref: '#/components/schemas/BuildJobStatus' - - $ref: '#/components/schemas/DeployJobStatus' - - $ref: '#/components/schemas/VerifyJobStatus' - - $ref: '#/components/schemas/UndeployJobStatus' - - $ref: '#/components/schemas/ScaleJobStatus' - - $ref: '#/components/schemas/BatchJobStatus' - JobResponse: - type: object - properties: - job: - $ref: '#/components/schemas/AnyJobStatus' - description: Information about the job. - _links: - $ref: '#/components/schemas/JobEventsAndFunctionHALLink' - required: - - job - - _links - description: Job Found - JobEventsAndFunctionHALLink: - anyOf: - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - example: - href: >- - https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - plug: - $ref: '#/components/schemas/HALLink' - description: Link to the plug. - example: - href: >- - https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 - required: - - plug - title: Plug - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - example: - href: >- - https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - webscript: - $ref: '#/components/schemas/HALLink' - description: Link to the webscript. - example: - href: >- - https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 - required: - - webscript - title: Webscript - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - example: - href: >- - https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - model: - $ref: '#/components/schemas/HALLink' - description: Link to the model. - example: - href: >- - https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - required: - - model - title: Model - - $ref: '#/components/schemas/JobEventsHALLink' - title: No Function - description: HAL links to related actions. - AnyJobStatusSummary: - anyOf: - - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - build - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/JobAndFunctionHALLink' - description: >- - HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Build - - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - deploy - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/JobAndFunctionHALLink' - description: >- - HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Deploy - - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - verify - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/JobAndFunctionHALLink' - description: >- - HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Verify - - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - undeploy - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/JobAndFunctionHALLink' - description: >- - HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Undeploy - - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - scale - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/JobAndFunctionHALLink' - description: >- - HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Scale - - type: object - properties: - type: - type: string - description: The type of the background task. - enum: - - batch - operation: - type: string - description: The operation name for the background task. - id: - type: string - description: The id of the background job, or the constant `_unknown_` - state: - $ref: '#/components/schemas/JobStateResult' - description: The current processing state of the job - createdAt: - type: string - format: date-time - description: The creation time of this job - createdBy: - type: string - description: The user that initiated this job - function: - $ref: '#/components/schemas/FunctionRef' - description: >- - The function entity that this job acts on, will be `undefined` - for batch jobs. - _links: - $ref: '#/components/schemas/JobHALLinks' - description: >- - HAL links to related the job status, SSE stream, and function - entity if relevant. - required: - - _links - - createdAt - - createdBy - - id - - operation - - state - - type - title: Batch - JobAndFunctionHALLink: - anyOf: - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - example: - href: >- - https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - example: - href: >- - https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - plug: - $ref: '#/components/schemas/HALLink' - description: Link to the plug. - example: - href: >- - https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 - required: - - plug - title: Plug - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - example: - href: >- - https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - example: - href: >- - https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - webscript: - $ref: '#/components/schemas/HALLink' - description: Link to the webscript. - example: - href: >- - https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 - required: - - webscript - title: Webscript - - type: object - properties: - event: - $ref: '#/components/schemas/HALLink' - description: Link to an SSE stream of job events for the submitted job(s). - example: - href: >- - https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - example: - href: >- - https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - model: - $ref: '#/components/schemas/HALLink' - description: Link to the model. - example: - href: >- - https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - required: - - model - title: Model - - $ref: '#/components/schemas/JobHALLinks' - title: No Function - description: HAL links to related actions. - JobsResponse: - type: object - properties: - limit: - type: number - description: The page size used for this query result. - jobs: - type: array - items: - $ref: '#/components/schemas/AnyJobStatusSummary' - description: Listing of jobs that satisfy the query. - required: - - jobs - description: Jobs Found - EventAck: - type: string - enum: - - ack - EventClose: - type: string - enum: - - close - EventKeepAlive: - type: string - enum: - - keep-alive - EventTypeSSE: - anyOf: - - $ref: '#/components/schemas/SupportedEvents' - - $ref: '#/components/schemas/EventAck' - - $ref: '#/components/schemas/EventClose' - - $ref: '#/components/schemas/EventKeepAlive' - SupportedEvents: - type: string - enum: - - completed - - failed - - active - - delayed - - waiting - - waiting-children - ActiveEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - active - data: - $ref: '#/components/schemas/JobEventResponse_ActiveEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - JobEventResponse_ActiveEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/JobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/ActiveEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/FunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - JobEventPayload_ActiveEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/ActiveEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - JobReference: - type: object - properties: - type: - $ref: '#/components/schemas/JobType' - id: - type: string - required: - - type - ActiveEventData: - type: object - properties: - prev: - $ref: '#/components/schemas/QueueEvents' - description: The previous state of the job - QueueEvents: - type: string - enum: - - completed - - failed - - active - - delayed - - waiting - - waiting-children - - added - - cleaned - - drained - - error - - paused - - progress - - removed - - resumed - - retries-exhausted - - stalled - JobStatusAndEntityHALLinks: - anyOf: - - type: object - properties: - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - example: - href: >- - https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - plug: - $ref: '#/components/schemas/HALLink' - description: Link to the plug. - example: - href: >- - https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 - required: - - plug - title: Plug - - type: object - properties: - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - example: - href: >- - https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - webscript: - $ref: '#/components/schemas/HALLink' - description: Link to the webscript. - example: - href: >- - https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 - required: - - webscript - title: Webscript - - type: object - properties: - job: - $ref: '#/components/schemas/HALLink' - description: Link to the job status page for the related entity. - example: - href: >- - https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht - model: - $ref: '#/components/schemas/HALLink' - description: Link to the model. - example: - href: >- - https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 - required: - - model - title: Model - - $ref: '#/components/schemas/JobStatusHALLink' - title: No Function - description: HAL links to related actions. - CompletedEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - completed - data: - $ref: '#/components/schemas/JobEventResponse_CompletedEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - JobEventResponse_CompletedEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/JobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/CompletedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/FunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - JobEventPayload_CompletedEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/CompletedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - CompletedEventData: - type: object - properties: - prev: - $ref: '#/components/schemas/QueueEvents' - description: The previous state of the job - returnValue: - $ref: '#/components/schemas/AnyJobResult' - description: The return value of the job - required: - - returnValue - AnyJobResult: - anyOf: - - $ref: '#/components/schemas/BuildResult' - - $ref: '#/components/schemas/DeployResult' - - $ref: '#/components/schemas/VerifyResult' - - $ref: '#/components/schemas/UndeployResult' - - $ref: '#/components/schemas/ScaleResult' - - $ref: '#/components/schemas/BatchResult' - - $ref: '#/components/schemas/CleanupResult' - CleanupResult: - type: object - properties: - scheduledJob: - $ref: '#/components/schemas/JobReference' - description: The result data for a completed cleanup job. - FailedEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - failed - data: - $ref: '#/components/schemas/JobEventResponse_FailedEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - JobEventResponse_FailedEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/JobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/FailedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/FunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - JobEventPayload_FailedEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/FailedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - FailedEventData: - type: object - properties: - prev: - $ref: '#/components/schemas/QueueEvents' - description: The previous state of the job - failedReason: - type: string - description: The failure reason of the job - required: - - failedReason - DelayedEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - delayed - data: - $ref: '#/components/schemas/JobEventResponse_DelayedEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - JobEventResponse_DelayedEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/JobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/DelayedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/FunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - JobEventPayload_DelayedEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/DelayedEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - DelayedEventData: - type: object - properties: - delay: - type: number - required: - - delay - WaitingEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - waiting - data: - $ref: '#/components/schemas/JobEventResponse_WaitingEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - JobEventResponse_WaitingEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/JobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/WaitingEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/FunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - JobEventPayload_WaitingEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/WaitingEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - WaitingEventData: - type: object - properties: - prev: - $ref: '#/components/schemas/QueueEvents' - description: The previous state of the job - WaitingChildrenEventSSE: - type: object - properties: - event: - type: string - description: The job queue event that trigged this message - enum: - - waiting-children - data: - $ref: '#/components/schemas/JobEventResponse_WaitingChildrenEventData_' - description: The payload message (json-encoded in the `text/eventstream`). - required: - - event - - data - description: A message that notifies a state change in a background job. - JobEventResponse_WaitingChildrenEventData_: - type: object - properties: - _links: - $ref: '#/components/schemas/JobStatusAndEntityHALLinks' - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/WaitingChildrenEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - function: - $ref: '#/components/schemas/FunctionRef' - description: Information of entity for which this job is executing . - required: - - _links - - data - - function - - job - - timestamp - description: Event object describing a state change of a background job. - JobEventPayload_WaitingChildrenEventData_: - type: object - properties: - job: - $ref: '#/components/schemas/JobReference' - description: A reference to the background job - data: - $ref: '#/components/schemas/WaitingChildrenEventData' - description: Additional data for the event - timestamp: - type: string - format: date-time - description: Timestamp of the event - required: - - job - - data - - timestamp - WaitingChildrenEventData: - type: object - JobEventSSE: - anyOf: - - $ref: '#/components/schemas/ActiveEventSSE' - - $ref: '#/components/schemas/CompletedEventSSE' - - $ref: '#/components/schemas/FailedEventSSE' - - $ref: '#/components/schemas/DelayedEventSSE' - - $ref: '#/components/schemas/WaitingEventSSE' - - $ref: '#/components/schemas/WaitingChildrenEventSSE' - KeepAliveEventSSE: - type: object - properties: - event: - $ref: '#/components/schemas/EventKeepAlive' - data: - type: string - description: A text message acknowledging that events will be forwarded. - required: - - event - description: A message that acknowledges that the stream is still alive. - EventSSE: + description: The type of the background task. + enum: + - deploy + operation: + type: string + description: The operation name for the background task. + id: + type: string + description: The id of the background job, or the constant `_unknown_` + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + createdAt: + type: string + format: date-time + description: The creation time of this job + createdBy: + type: string + description: The user that initiated this job + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be `undefined` + for batch jobs. + _links: + $ref: '#/components/schemas/JobAndFunctionHALLink' + description: >- + HAL links to related the job status, SSE stream, and function + entity if relevant. + required: + - _links + - createdAt + - createdBy + - id + - operation + - state + - type + title: Deploy + - type: object + properties: + type: + type: string + description: The type of the background task. + enum: + - verify + operation: + type: string + description: The operation name for the background task. + id: + type: string + description: The id of the background job, or the constant `_unknown_` + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + createdAt: + type: string + format: date-time + description: The creation time of this job + createdBy: + type: string + description: The user that initiated this job + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be `undefined` + for batch jobs. + _links: + $ref: '#/components/schemas/JobAndFunctionHALLink' + description: >- + HAL links to related the job status, SSE stream, and function + entity if relevant. + required: + - _links + - createdAt + - createdBy + - id + - operation + - state + - type + title: Verify + - type: object + properties: + type: + type: string + description: The type of the background task. + enum: + - undeploy + operation: + type: string + description: The operation name for the background task. + id: + type: string + description: The id of the background job, or the constant `_unknown_` + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + createdAt: + type: string + format: date-time + description: The creation time of this job + createdBy: + type: string + description: The user that initiated this job + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be `undefined` + for batch jobs. + _links: + $ref: '#/components/schemas/JobAndFunctionHALLink' + description: >- + HAL links to related the job status, SSE stream, and function + entity if relevant. + required: + - _links + - createdAt + - createdBy + - id + - operation + - state + - type + title: Undeploy + - type: object + properties: + type: + type: string + description: The type of the background task. + enum: + - scale + operation: + type: string + description: The operation name for the background task. + id: + type: string + description: The id of the background job, or the constant `_unknown_` + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + createdAt: + type: string + format: date-time + description: The creation time of this job + createdBy: + type: string + description: The user that initiated this job + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be `undefined` + for batch jobs. + _links: + $ref: '#/components/schemas/JobAndFunctionHALLink' + description: >- + HAL links to related the job status, SSE stream, and function + entity if relevant. + required: + - _links + - createdAt + - createdBy + - id + - operation + - state + - type + title: Scale + - type: object + properties: + type: + type: string + description: The type of the background task. + enum: + - batch + operation: + type: string + description: The operation name for the background task. + id: + type: string + description: The id of the background job, or the constant `_unknown_` + state: + $ref: '#/components/schemas/JobStateResult' + description: The current processing state of the job + createdAt: + type: string + format: date-time + description: The creation time of this job + createdBy: + type: string + description: The user that initiated this job + function: + $ref: '#/components/schemas/FunctionRef' + description: >- + The function entity that this job acts on, will be `undefined` + for batch jobs. + _links: + $ref: '#/components/schemas/JobHALLinks' + description: >- + HAL links to related the job status, SSE stream, and function + entity if relevant. + required: + - _links + - createdAt + - createdBy + - id + - operation + - state + - type + title: Batch + JobAndFunctionHALLink: anyOf: - type: object properties: event: - $ref: '#/components/schemas/EventAck' - data: - type: string - description: A text message acknowledging what events will be forwarded. + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + example: + href: >- + https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + example: + href: >- + https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + plug: + $ref: '#/components/schemas/HALLink' + description: Link to the plug. + example: + href: >- + https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 required: - - event - - data - description: >- - A message that acknowledges that the server will sent job state - changes. - title: Stream Ready - - $ref: '#/components/schemas/JobEventSSE' - - $ref: '#/components/schemas/KeepAliveEventSSE' - description: SSE stream events without closing protocol - EventWithCloseSSE: - anyOf: + - plug + title: Plug - type: object properties: event: - $ref: '#/components/schemas/EventAck' - data: - type: string - description: A text message acknowledging what events will be forwarded. + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + example: + href: >- + https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + example: + href: >- + https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + webscript: + $ref: '#/components/schemas/HALLink' + description: Link to the webscript. + example: + href: >- + https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 required: - - event - - data - description: >- - A message that acknowledges that the server will sent job state - changes. - title: Stream Ready - - $ref: '#/components/schemas/JobEventSSE' - - $ref: '#/components/schemas/KeepAliveEventSSE' + - webscript + title: Webscript - type: object properties: event: - $ref: '#/components/schemas/EventClose' - data: - type: string - description: A text message describing the cause for closing the stream. + $ref: '#/components/schemas/HALLink' + description: Link to an SSE stream of job events for the submitted job(s). + example: + href: >- + https://api.waylay.io/registry/v2/jobs/events?type=undeploy&id=6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht&children=true + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + example: + href: >- + https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + model: + $ref: '#/components/schemas/HALLink' + description: Link to the model. + example: + href: >- + https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 required: - - event - - data - description: >- - A message that notifies that the server will not send more events, - and that the client should close. - title: Stream Closing - description: SSE stream events with closing protocol - LegacyPlugCreateResponse: - type: object - properties: - statusCode: - type: number - uri: - type: string - entity: - $ref: '#/components/schemas/LegacyPlugScriptResponse' - required: - - entity - - statusCode - - uri - StatusResponse: + - model + title: Model + - $ref: '#/components/schemas/JobHALLinks' + title: No Function + description: HAL links to related actions. + JobsResponse: type: object properties: - statusCode: + limit: type: number - required: - - statusCode - LegacyPlugScriptResponse: - type: object - properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - type: - $ref: '#/components/schemas/PlugType' - script: - type: string - metadata: - $ref: '#/components/schemas/LegacyPlugScriptMeta' - dependencies: - type: object - required: - - name - - version - - type - - script - - metadata - - dependencies - LegacyPlugScriptMeta: - type: object - properties: - author: - type: string - description: - type: string - category: - type: string - tags: - type: array - items: - $ref: '#/components/schemas/Tag' - iconURL: - type: string - friendlyName: - type: string - supportedStates: - type: array - items: - type: string - rawData: - type: array - items: - type: object - properties: - parameter: - type: string - dataType: - type: string - required: - - parameter - requiredProperties: - $ref: '#/components/schemas/LegacyRequiredProperties' - required: - - supportedStates - - rawData - LegacyPlugResponse: - type: object - properties: - name: - type: string - version: - $ref: '#/components/schemas/SemanticVersion' - author: - type: string - category: - type: string - iconURL: - type: string - documentationURL: - type: string - isDeprecated: - type: boolean - description: - type: string - states: - type: array - items: - type: string - rawData: - type: array - items: - type: object - mediaType: - $ref: '#/components/schemas/MediaType' - configuration: - type: array - items: - $ref: '#/components/schemas/LegacyConfigurationResponseObject' - commands: + description: The page size used for this query result. + jobs: type: array items: - type: string - status: - $ref: '#/components/schemas/Status' - failureReason: - $ref: '#/components/schemas/FailureReason' - metadata: - type: object - properties: - documentation: - $ref: '#/components/schemas/LegacyDocumentation' - author: - type: string - description: - type: string - category: - type: string - tags: - type: array - items: - $ref: '#/components/schemas/Tag' - iconURL: - type: string - friendlyName: - type: string + $ref: '#/components/schemas/AnyJobStatusSummary' + description: Listing of jobs that satisfy the query. required: - - name - - version - - isDeprecated - - mediaType - - commands - - status - - metadata - MediaType: + - jobs + description: Jobs Found + EventAck: + type: string + enum: + - ack + EventClose: + type: string + enum: + - close + EventKeepAlive: type: string enum: - - application/javascript - - application/java-vm - - text/x-python - - text/x-golang - LegacyConfigurationResponseObject: + - keep-alive + ActiveEventSSE: type: object properties: - name: + event: type: string - type: - $ref: '#/components/schemas/PlugPropertyDataType' - mandatory: - type: boolean - format: - type: object - properties: - type: - $ref: '#/components/schemas/PlugPropertyFormatType' - values: - type: array - items: - $ref: '#/components/schemas/EnumValue' - defaultValue: - $ref: '#/components/schemas/DefaultValue' - sensitive: - type: boolean + description: The job queue event that trigged this message + enum: + - active + data: + $ref: '#/components/schemas/JobEventResponse_ActiveEventData_' + description: The payload message (json-encoded in the `text/event-stream`). required: - - name - - type - LegacyPlugHtmlResponse: - type: string - description: The documentation html of a plug. - LegacyCreateDebugResponse: + - event + - data + description: A message that notifies a state change in a background job. + JobEventResponse_ActiveEventData_: type: object properties: - functionName: + _links: + $ref: '#/components/schemas/JobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/ActiveEventData' + description: Additional data for the event + timestamp: type: string + format: date-time + description: Timestamp of the event + function: + $ref: '#/components/schemas/FunctionRef' + description: Information of entity for which this job is executing . required: - - functionName - MessageAndStatusResponse: + - _links + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + JobReference: type: object properties: - message: + type: + $ref: '#/components/schemas/JobType' + id: type: string - statusCode: - type: number required: - - message - - statusCode - ErrorAndStatusResponse: + - type + ActiveEventData: type: object properties: - error: - type: string - statusCode: - type: number - required: + prev: + $ref: '#/components/schemas/QueueEvents' + description: The previous state of the job + QueueEvents: + type: string + enum: + - completed + - failed + - active + - delayed + - waiting + - waiting-children + - added + - cleaned + - drained - error - - statusCode - EntityResponse: + - paused + - progress + - removed + - resumed + - retries-exhausted + - stalled + JobStatusAndEntityHALLinks: + anyOf: + - type: object + properties: + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + example: + href: >- + https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + plug: + $ref: '#/components/schemas/HALLink' + description: Link to the plug. + example: + href: >- + https://api.waylay.io/registry/v2/plugs/plugName/versions/1.0.1 + required: + - plug + title: Plug + - type: object + properties: + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + example: + href: >- + https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + webscript: + $ref: '#/components/schemas/HALLink' + description: Link to the webscript. + example: + href: >- + https://api.waylay.io/registry/v2/webscripts/webscriptName/versions/1.0.1 + required: + - webscript + title: Webscript + - type: object + properties: + job: + $ref: '#/components/schemas/HALLink' + description: Link to the job status page for the related entity. + example: + href: >- + https://api.waylay.io/registry/v2/jobs/undeploy/6ccc8843-d78d-49e8-84c4-3734a4af9929$IfM2FyNLQ8CEjQGA9w7Ht + model: + $ref: '#/components/schemas/HALLink' + description: Link to the model. + example: + href: >- + https://api.waylay.io/registry/v2/models/modelName/versions/1.0.1 + required: + - model + title: Model + - $ref: '#/components/schemas/JobStatusHALLink' + title: No Function + description: HAL links to related actions. + CompletedEventSSE: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/Runtime' - description: >- - The runtime that specifies how this function should be built and - deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build - and deployment. When set, the latest available patch - version with the same minor version is used. Note that, - after deployment, this runtime version can become obsolete with a - rebuild action. - metadata: - $ref: '#/components/schemas/FunctionMeta' - description: >- - Metadata describing the function. Note that, after deployment, this - metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: + event: type: string - format: date-time - description: The timestamp at which this entity was last updated. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function entity. - _links: - type: array - items: - $ref: '#/components/schemas/JobHALLinks' - description: Links to related entities. + description: The job queue event that trigged this message + enum: + - completed + data: + $ref: '#/components/schemas/JobEventResponse_CompletedEventData_' + description: The payload message (json-encoded in the `text/event-stream`). required: - - createdAt - - createdBy - - metadata - - name - - runtime - - status - - updatedAt - - updatedBy - - version - PlugResponse: + - event + - data + description: A message that notifies a state change in a background job. + JobEventResponse_CompletedEventData_: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/Runtime' - description: >- - The runtime that specifies how this function should be built and - deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build - and deployment. When set, the latest available patch - version with the same minor version is used. Note that, - after deployment, this runtime version can become obsolete with a - rebuild action. - metadata: - $ref: '#/components/schemas/FunctionMeta' - description: >- - Metadata describing the function. Note that, after deployment, this - metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: + _links: + $ref: '#/components/schemas/JobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/CompletedEventData' + description: Additional data for the event + timestamp: type: string format: date-time - description: The timestamp at which this entity was last updated. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function entity. - _links: - type: array - items: - $ref: '#/components/schemas/JobHALLinks' - description: Links to related entities. - isDeprecated: - type: boolean - required: - - createdAt - - createdBy - - isDeprecated - - metadata - - name - - runtime - - status - - updatedAt - - updatedBy - - version - PlugListingResponse: + description: Timestamp of the event + function: + $ref: '#/components/schemas/FunctionRef' + description: Information of entity for which this job is executing . + required: + - _links + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + CompletedEventData: type: object properties: - plugs: - type: array - items: - $ref: '#/components/schemas/PlugResponse' + prev: + $ref: '#/components/schemas/QueueEvents' + description: The previous state of the job + returnvalue: + $ref: '#/components/schemas/AnyJobResult' + description: The return value of the job required: - - plugs - description: Successful Response - PagingResponse: + - returnvalue + AnyJobResult: + anyOf: + - $ref: '#/components/schemas/BuildResult' + - $ref: '#/components/schemas/DeployResult' + - $ref: '#/components/schemas/VerifyResult' + - $ref: '#/components/schemas/UndeployResult' + - $ref: '#/components/schemas/ScaleResult' + - $ref: '#/components/schemas/BatchResult' + - $ref: '#/components/schemas/CleanupResult' + - $ref: '#/components/schemas/NotifyResult' + CleanupResult: type: object properties: - count: - type: number - description: >- - The total count of matching items, from which this result is one - page. - limit: - type: number - description: The page size used for this query result. - page: - type: number - description: The page number of a paged query result. - PlugListingAndQueryResponse: + scheduledJob: + $ref: '#/components/schemas/JobReference' + description: The result data for a completed cleanup job. + NotifyResult: type: object properties: - count: - type: number - description: >- - The total count of matching items, from which this result is one - page. - limit: - type: number - description: The page size used for this query result. - page: - type: number - description: The page number of a paged query result. - plugs: - type: array - items: - $ref: '#/components/schemas/PlugResponse' + operation: + $ref: '#/components/schemas/RequestOperation' required: - - plugs - description: Successful Response - CreatePlugAsyncResponse: + - operation + description: The result data for a change notification. + FailedEventSSE: type: object properties: - message: + event: type: string - _links: - $ref: '#/components/schemas/JobHALLinks' - entity: - $ref: '#/components/schemas/PlugManifest' + description: The job queue event that trigged this message + enum: + - failed + data: + $ref: '#/components/schemas/JobEventResponse_FailedEventData_' + description: The payload message (json-encoded in the `text/event-stream`). required: - - _links - - entity - - message - description: Successful Response - WebscriptResponse: + - event + - data + description: A message that notifies a state change in a background job. + JobEventResponse_FailedEventData_: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/Runtime' - description: >- - The runtime that specifies how this function should be built and - deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build - and deployment. When set, the latest available patch - version with the same minor version is used. Note that, - after deployment, this runtime version can become obsolete with a - rebuild action. - metadata: - $ref: '#/components/schemas/FunctionMeta' - description: >- - Metadata describing the function. Note that, after deployment, this - metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: - type: string - format: date-time - description: The timestamp at which this entity was last updated. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function entity. _links: - type: array - items: - $ref: '#/components/schemas/JobHALLinks' - description: Links to related entities. - secret: - type: string - nullable: true - required: - - createdAt - - createdBy - - metadata - - name - - runtime - - secret - - status - - updatedAt - - updatedBy - - version - description: Successful Response - CreateWebscriptAsyncResponse: - type: object - properties: - message: + $ref: '#/components/schemas/JobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/FailedEventData' + description: Additional data for the event + timestamp: type: string - _links: - $ref: '#/components/schemas/JobHALLinks' - entity: - $ref: '#/components/schemas/WebscriptManifest' + format: date-time + description: Timestamp of the event + function: + $ref: '#/components/schemas/FunctionRef' + description: Information of entity for which this job is executing . required: - _links - - entity - - message - description: Successful Response - KFServingResponse: + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + FailedEventData: type: object properties: - deploy: - $ref: '#/components/schemas/FunctionDeployOverridesType' - description: Deployment overrides of the function. - name: - type: string - description: The logical name for the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The semantic version of the function. - runtime: - $ref: '#/components/schemas/Runtime' - description: >- - The runtime that specifies how this function should be built and - deployed. This could be overridden or modified on initial deployment - or later rebuild. - runtimeVersion: - $ref: '#/components/schemas/SemanticVersionRange' - description: >- - An optional runtime version constraint for deployment of the - function. When not set, the latest runtime version is used for build - and deployment. When set, the latest available patch - version with the same minor version is used. Note that, - after deployment, this runtime version can become obsolete with a - rebuild action. - metadata: - $ref: '#/components/schemas/FunctionMeta' - description: >- - Metadata describing the function. Note that, after deployment, this - metadata can be updated for the deployed function, without affecting - the runtime behaviour of the function itself. - createdBy: - type: string - description: The user that created this entity. - createdAt: - type: string - format: date-time - description: The timestamp at which this entity was created. - updatedBy: - type: string - description: The user that last updated this entity. - updatedAt: + prev: + $ref: '#/components/schemas/QueueEvents' + description: The previous state of the job + failedReason: type: string - format: date-time - description: The timestamp at which this entity was last updated. - status: - $ref: '#/components/schemas/Status' - description: The current status of this function entity. - failureReason: - $ref: '#/components/schemas/FailureReason' - description: A description of the last failure related to this function entity. - _links: - type: array - items: - $ref: '#/components/schemas/JobHALLinks' - description: Links to related entities. + description: The failure reason of the job required: - - createdAt - - createdBy - - metadata - - name - - runtime - - status - - updatedAt - - updatedBy - - version - description: Successful Response - KFServingModelsResponse: + - failedReason + DelayedEventSSE: type: object properties: - models: - type: array - items: - $ref: '#/components/schemas/KFServingResponse' - paging: - $ref: '#/components/schemas/PagingResponse' + event: + type: string + description: The job queue event that trigged this message + enum: + - delayed + data: + $ref: '#/components/schemas/JobEventResponse_DelayedEventData_' + description: The payload message (json-encoded in the `text/event-stream`). required: - - models - description: Successful Response - CreateKFServingAsyncResponse: + - event + - data + description: A message that notifies a state change in a background job. + JobEventResponse_DelayedEventData_: type: object properties: - message: - type: string _links: - $ref: '#/components/schemas/JobHALLinks' - entity: - $ref: '#/components/schemas/KFServingManifest' + $ref: '#/components/schemas/JobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/DelayedEventData' + description: Additional data for the event + timestamp: + type: string + format: date-time + description: Timestamp of the event + function: + $ref: '#/components/schemas/FunctionRef' + description: Information of entity for which this job is executing . required: - _links - - entity - - message - description: Model Deployment Initiated - KFServingDeleteMultipleResponse: + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + DelayedEventData: type: object properties: - name: - type: string - versions: - type: array - items: - type: string + delay: + type: number required: - - name - - versions - description: Models Deleted - KFServingDeleteMultipleWithJobResponse: + - delay + WaitingEventSSE: type: object properties: - name: - type: string - versions: - type: array - items: - type: string - message: + event: type: string + description: The job queue event that trigged this message + enum: + - waiting + data: + $ref: '#/components/schemas/JobEventResponse_WaitingEventData_' + description: The payload message (json-encoded in the `text/event-stream`). + required: + - event + - data + description: A message that notifies a state change in a background job. + JobEventResponse_WaitingEventData_: + type: object + properties: _links: - $ref: '#/components/schemas/JobHALLinks' + $ref: '#/components/schemas/JobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/WaitingEventData' + description: Additional data for the event + timestamp: + type: string + format: date-time + description: Timestamp of the event + function: + $ref: '#/components/schemas/FunctionRef' + description: Information of entity for which this job is executing . required: - _links - - message - - name - - versions - description: Model Deletions Initiated - KFServingDeleteResponse: + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + WaitingEventData: type: object properties: - name: + prev: + $ref: '#/components/schemas/QueueEvents' + description: The previous state of the job + WaitingChildrenEventSSE: + type: object + properties: + event: type: string - description: The name of the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The version of the function. + description: The job queue event that trigged this message + enum: + - waiting-children + data: + $ref: '#/components/schemas/JobEventResponse_WaitingChildrenEventData_' + description: The payload message (json-encoded in the `text/event-stream`). required: - - name - - version - description: Model Deleted - KFServingDeleteWithJobResponse: + - event + - data + description: A message that notifies a state change in a background job. + JobEventResponse_WaitingChildrenEventData_: type: object properties: - message: - type: string _links: - $ref: '#/components/schemas/JobHALLinks' - name: + $ref: '#/components/schemas/JobStatusAndEntityHALLinks' + job: + $ref: '#/components/schemas/JobReference' + description: A reference to the background job + data: + $ref: '#/components/schemas/WaitingChildrenEventData' + description: Additional data for the event + timestamp: type: string - description: The name of the function. - version: - $ref: '#/components/schemas/SemanticVersion' - description: The version of the function. + format: date-time + description: Timestamp of the event + function: + $ref: '#/components/schemas/FunctionRef' + description: Information of entity for which this job is executing . required: - _links - - message - - name - - version - description: Model Delete Initiated + - data + - function + - job + - timestamp + description: Event object describing a state change of a background job. + WaitingChildrenEventData: + type: object + JobEventSSE: + anyOf: + - $ref: '#/components/schemas/ActiveEventSSE' + - $ref: '#/components/schemas/CompletedEventSSE' + - $ref: '#/components/schemas/FailedEventSSE' + - $ref: '#/components/schemas/DelayedEventSSE' + - $ref: '#/components/schemas/WaitingEventSSE' + - $ref: '#/components/schemas/WaitingChildrenEventSSE' + KeepAliveEventSSE: + type: object + properties: + event: + $ref: '#/components/schemas/EventKeepAlive' + data: + type: string + description: A text message acknowledging that events will be forwarded. + required: + - event + description: A message that acknowledges that the stream is still alive. + EventWithCloseSSE: + anyOf: + - type: object + properties: + event: + $ref: '#/components/schemas/EventAck' + data: + type: string + description: A text message acknowledging what events will be forwarded. + required: + - event + - data + description: >- + A message that acknowledges that the server will sent job state + changes. + title: Stream Ready + - $ref: '#/components/schemas/JobEventSSE' + - $ref: '#/components/schemas/KeepAliveEventSSE' + - type: object + properties: + event: + $ref: '#/components/schemas/EventClose' + data: + type: string + description: A text message describing the cause for closing the stream. + required: + - event + - data + description: >- + A message that notifies that the server will not send more events, + and that the client should close. + title: Stream Closing + description: SSE stream events with closing protocol paths: /registry/v2/: get: - summary: Version - description: Get the version of this function registry deployment. + operationId: get_about + summary: Get Service Status + tags: + - About + description: Get the status and version of the function registry service. x-version: v2 responses: default: @@ -8866,7 +4207,6 @@ paths: application/json: schema: $ref: '#/components/schemas/RootPageResponse' - operationId: get_registry_v2 security: - waylayApiKeySecret: [] x-py-method: get @@ -9027,7 +4367,7 @@ paths: '200': description: Events Streaming content: - text/eventstream: + text/event-stream: schema: $ref: '#/components/schemas/EventWithCloseSSE' x-is-event-stream: true @@ -9416,6 +4756,12 @@ paths: description: Runtime example archive type: string format: binary + application/tar: + schema: + title: Archive + description: Runtime example archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -9509,6 +4855,12 @@ paths: description: Runtime example archive type: string format: binary + application/tar: + schema: + title: Archive + description: Runtime example archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -9545,20 +4897,21 @@ paths: x-consumes-other: false /registry/v2/webscripts/: post: - operationId: create_webscript_functions + operationId: create_webscripts summary: Create Webscript Version tags: - - Webscript Functions + - Webscripts description: |- Creates a new webscript function by uploading its assets. - The assets for a webscript function can be provided as either + The assets for a webscript function can be provided as
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • +
    • A single tar archive (optionally compressed), with one of the content types + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • +
    • Separate files in a multipart/form-data request
      • +
    • A reference to the assets of another webscript in the copy argument
    - + The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). @@ -9570,192 +4923,133 @@ paths: content: application/octet-stream: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required webscript.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=webscripts). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required webscript.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=webscripts). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required webscript.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=webscripts). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required webscript.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=webscripts). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required webscript.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=webscripts). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required webscript.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=webscripts). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: Multipart file upload. + description: >- + A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset + path. + type: object + properties: + assets: + type: array + items: + type: string + format: binary + application/json: + schema: + title: Empty Upload + description: >- + Empty object request body, only allowed when using the `copy` + query parameter. + type: object + maxProperties: 0 + '*/*+json': + schema: + title: Empty Upload + description: >- + Empty object request body, only allowed when using the `copy` + query parameter. + type: object + maxProperties: 0 description: | - The assets for a webscript function can be provided as either + The assets for a webscript function can be provided as
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • +
    • A single tar archive (optionally compressed), with one of the content types + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • +
    • Separate files in a multipart/form-data request
      • +
    • A reference to the assets of another webscript in the copy argument
    - + The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. parameters: + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: >- + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. + x-showExample: true + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: patch @@ -9787,17 +5081,6 @@ paths: Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. x-showExample: true - - schema: - type: boolean - default: false - in: query - name: scaleToZero - required: false - description: >- - If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources - when the function is not to be used immediately. - x-showExample: true - schema: $ref: '#/components/schemas/SemanticVersionRange' in: query @@ -9829,6 +5112,100 @@ paths: are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. x-showExample: true + - schema: + $ref: '#/components/schemas/NamedVersionRange' + in: query + name: runtime + required: false + description: >- + If set, the created function will use the indicated runtime (latest + version within specified range). + + + This takes precedence over the runtime specified in a function + manifest (copied or from request body). + x-showExample: false + - schema: + anyOf: + - $ref: '#/components/schemas/NamedVersionRange' + - $ref: '#/components/schemas/ExampleReference' + in: query + name: copy + required: false + description: >- + Indicates the _source_ of initial assets for a _new function_. + + + When using this query parameter, the request body does not need to + contain assets, but any assets in the request body will overwrite + the copied assets. + + + #### Selection of _assets_ source + + + * If set as `[@]`, the _new + function_ will be created with copied assets of the selected _source + function_. + + * If set as `!example`, a `runtime` query parameter is required, and + the _new function_ will be initialized with assets of the _runtime + example_. + + + #### Selection of the _source function_ + + + When `` is a range (or is not given), the latest + _published_ version (in that range) is used. + + + If no _published_ version exists, the latest _draft_ is selected. + + + If no versions in the range exist, a `404` _Not Found_ error is + returned. + + + #### The `name` of the _new function_ + + + If a `name` is NOT specified (either as query parameter, or in an + optional manifest asset in the request body), the `name` of the _new + function_ will be that of the _source function_. + + + #### The `version` of the _new function_ + + + When the _target_ and _source_ name are equal, the `version` query + parameters is defaulted to `` + (`~` when it's an exact version) + + + The version of the _new function_ will be: + + * If a `version` is NOT specified (either as query parameter, in an + optional manifest asset, or as `` _default_) + + * a **patch increment** (`..+1`) of the latest **existing version** with the target `name` + + * **`1.0.0`** otherwise + + * If a `version` is specified: + + * the **lowest version** in that range **if no existing version** is in that range. + + * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. + + * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. + + #### Deployment overrides + + + The new function will use the deployment overrides of the copied + function, unless a _manifest_ was specified in the request body. + x-showExample: false x-version: v2 responses: '201': @@ -9848,13 +5225,13 @@ paths: x-py-method: create x-consumes-multipart: true x-consumes-urlencoded: false - x-consumes-json: false + x-consumes-json: true x-consumes-other: true get: - operationId: list_webscript_functions + operationId: list_webscripts summary: List Webscripts tags: - - Webscript Functions + - Webscripts description: > List the (latest) versions of available webscripts. @@ -9875,11 +5252,15 @@ paths: - As long as no _version filters_ are used, each listed webscript - version item will contain a HAL **link to the + As long as no version filters are used, each listed webscript + version contains representations of the latest draft + (`entities[]._links.draft`) - latest** _draft_ (`entities[]._links.draft`) or latest _published_ - (`entities[]._links.publisned`) version (if existing and different). + or latest published (`entities[]._links.published`) version (if existing + and different). + + Use the query parameter `showRelated` to include only a link (default + `showRelated=link`) or a full representation (`showRelated=embed`). ### List Latest Webscript Versions (with filter) @@ -10121,6 +5502,21 @@ paths: returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. x-showExample: true + - schema: + $ref: '#/components/schemas/ShowRelatedType' + in: query + name: showRelated + required: false + description: >- + Sets the representation of related function versions (like the + _latest_ draft and/or published) in the response. + + - `embed`: as full summary representation (in `_embedded`). + + - `link`: as HAL link in (in `_links`). + + - `none`: omitted. + x-showExample: true x-version: v2 responses: '200': @@ -10138,10 +5534,10 @@ paths: x-consumes-other: false /registry/v2/webscripts/{name}/versions: get: - operationId: listVersions_webscript_functions + operationId: listVersions_webscripts summary: List Webscript Versions tags: - - Webscript Functions + - Webscripts description: List all deployed versions of a webscript. parameters: - schema: @@ -10305,10 +5701,10 @@ paths: x-consumes-other: false /registry/v2/webscripts/{name}/versions/{version}: get: - operationId: get_webscript_functions + operationId: get_webscripts summary: Get Webscript Version tags: - - Webscript Functions + - Webscripts description: Get the webscript version. parameters: - schema: @@ -10341,10 +5737,10 @@ paths: x-consumes-json: false x-consumes-other: false delete: - operationId: removeVersion_webscript_functions + operationId: removeVersion_webscripts summary: Remove Webscript Version tags: - - Webscript Functions + - Webscripts description: | Deprecate, undeploy and/or remove a webscript version. @@ -10460,12 +5856,22 @@ paths: x-consumes-other: false /registry/v2/webscripts/{name}/versions/{version}/rebuild: post: - operationId: rebuild_webscript_functions + operationId: rebuild_webscripts summary: Rebuild Webscript tags: - - Webscript Functions + - Webscripts description: Rebuild and deploy a webscript with the original or updated base image. parameters: + - schema: + type: boolean + in: query + name: scaleToZero + required: false + description: >- + Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero + only if it was not active before this command. + x-showExample: true - schema: type: string in: query @@ -10537,16 +5943,6 @@ paths: * the `dryRun` option x-showExample: true - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: >- - Indicates whether the function needs to be scaled down after - successful (re-)deployment. If not set, the function is scaled to - zero only if it was not active before this command. - x-showExample: true - schema: type: boolean in: query @@ -10593,10 +5989,10 @@ paths: x-consumes-other: false /registry/v2/webscripts/{name}: get: - operationId: getLatest_webscript_functions + operationId: getLatest_webscripts summary: Get Latest Webscript Version tags: - - Webscript Functions + - Webscripts description: |- Fetch the latest version of a webscript. @@ -10662,10 +6058,10 @@ paths: x-consumes-json: false x-consumes-other: false delete: - operationId: removeVersions_webscript_functions + operationId: removeVersions_webscripts summary: Remove Webscript tags: - - Webscript Functions + - Webscripts description: > Deprecate, undeploy and/or remove all versions of this named webscript. @@ -10775,10 +6171,10 @@ paths: x-consumes-other: false /registry/v2/webscripts/{name}/versions/{version}/metadata: patch: - operationId: patchMetadata_webscript_functions + operationId: patchMetadata_webscripts summary: Patch Webscript Metadata tags: - - Webscript Functions + - Webscripts description: Patch the metadata of a webscript version. requestBody: content: @@ -10824,10 +6220,10 @@ paths: x-consumes-other: false /registry/v2/webscripts/{name}/versions/{version}/content: get: - operationId: getArchive_webscript_functions + operationId: getArchive_webscripts summary: Get Webscript Archive tags: - - Webscript Functions + - Webscripts description: Get the specification archive of a webscript. parameters: - schema: @@ -10866,6 +6262,12 @@ paths: description: Webscript archive type: string format: binary + application/tar: + schema: + title: Archive + description: Webscript archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -10901,17 +6303,17 @@ paths: x-consumes-json: false x-consumes-other: false put: - operationId: updateAssets_webscript_functions + operationId: updateAssets_webscripts summary: Update Webscript Assets tags: - - Webscript Functions + - Webscripts description: |- Update a draft webscript function by updating its assets. The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    @@ -10928,195 +6330,60 @@ paths: content: application/octet-stream: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the webscript function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the webscript.json     json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the webscript function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the webscript.json     json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the webscript function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the webscript.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the webscript function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the webscript.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the webscript function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the webscript.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Webscript Function Assets - description: > - The assets for a webscript function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the webscript function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the webscript.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: Multipart file upload. + description: >- + A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset + path. + type: object + properties: + assets: + type: array + items: + type: string + format: binary description: | The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    @@ -11129,34 +6396,74 @@ paths: For each runtime other files are supported. parameters: - schema: - type: string + type: boolean + default: false in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: type: boolean default: true in: query - name: async + name: deploy required: false description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. x-showExample: true - schema: type: boolean default: false in: query name: chown - required: true + required: false description: >- If set, ownership of the draft function is transferred to the current user. x-showExample: true + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: boolean + default: true + in: query + name: async + required: false + description: >- + Unless this is set to false, the server will start the + required job actions asynchronously and return a 202 + Accepted response. If false the request will + block until the job actions are completed, or a timeout occurs. + x-showExample: true - schema: type: string in: path @@ -11185,6 +6492,12 @@ paths: application/json: schema: $ref: '#/components/schemas/PostWebscriptJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/RegistryErrorResponse' security: - waylayApiKeySecret: [] x-py-method: update_assets @@ -11194,10 +6507,10 @@ paths: x-consumes-other: true /registry/v2/webscripts/{name}/versions/{version}/content/{wildcard}: get: - operationId: getAsset_webscript_functions + operationId: getAsset_webscripts summary: Get File From Webscript Archive tags: - - Webscript Functions + - Webscripts description: Get a file from the specification archive of a webscript. parameters: - schema: @@ -11243,6 +6556,12 @@ paths: description: Webscript archive type: string format: binary + application/tar: + schema: + title: Archive + description: Webscript archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -11278,10 +6597,10 @@ paths: x-consumes-json: false x-consumes-other: false put: - operationId: updateAsset_webscript_functions + operationId: updateAsset_webscripts summary: Update Webscript Asset tags: - - Webscript Functions + - Webscripts description: >- The provided asset will be added to the webscript function's collection of existing assets, @@ -11294,7 +6613,7 @@ paths: requestBody: content: - application/octet-stream: + '*/*': schema: title: File Upload description: A single asset file. @@ -11306,34 +6625,74 @@ paths: description: A single asset file. parameters: - schema: - type: string + type: boolean + default: false in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: type: boolean default: true in: query - name: async + name: deploy required: false description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. x-showExample: true - schema: type: boolean default: false in: query name: chown - required: true + required: false description: >- If set, ownership of the draft function is transferred to the current user. x-showExample: true + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: boolean + default: true + in: query + name: async + required: false + description: >- + Unless this is set to false, the server will start the + required job actions asynchronously and return a 202 + Accepted response. If false the request will + block until the job actions are completed, or a timeout occurs. + x-showExample: true - schema: type: string in: path @@ -11369,6 +6728,12 @@ paths: application/json: schema: $ref: '#/components/schemas/PostWebscriptJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/RegistryErrorResponse' security: - waylayApiKeySecret: [] x-py-method: update_asset @@ -11377,41 +6742,81 @@ paths: x-consumes-json: false x-consumes-other: true delete: - operationId: deleteAsset_webscript_functions + operationId: deleteAsset_webscripts summary: Delete Webscript Asset tags: - - Webscript Functions + - Webscripts description: Delete an asset from the webscript's collection of existing assets. parameters: - schema: - type: string + type: boolean + default: false in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: type: boolean default: true in: query - name: async + name: deploy required: false description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. x-showExample: true - schema: type: boolean default: false in: query name: chown - required: true + required: false description: >- If set, ownership of the draft function is transferred to the current user. x-showExample: true + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: boolean + default: true + in: query + name: async + required: false + description: >- + Unless this is set to false, the server will start the + required job actions asynchronously and return a 202 + Accepted response. If false the request will + block until the job actions are completed, or a timeout occurs. + x-showExample: true - schema: type: string in: path @@ -11447,6 +6852,12 @@ paths: application/json: schema: $ref: '#/components/schemas/PostWebscriptJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/RegistryErrorResponse' security: - waylayApiKeySecret: [] x-py-method: delete_asset @@ -11456,10 +6867,10 @@ paths: x-consumes-other: false /registry/v2/webscripts/{name}/versions/{version}/publish: post: - operationId: publish_webscript_functions + operationId: publish_webscripts summary: Publish Draft Webscript tags: - - Webscript Functions + - Webscripts description: >- Mark the webscript to be ready and stable, taking it out of draft mode., @@ -11469,6 +6880,16 @@ paths: In other statuses, plug-registry may need to initiate a new build and deployment procedure. parameters: + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: >- + If set, ownership of the draft function is transferred to the + current user. + x-showExample: true - schema: type: string in: query @@ -11476,6 +6897,13 @@ paths: required: false description: An optional user-specified comment corresponding to the operation. x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: patch @@ -11537,10 +6965,10 @@ paths: x-consumes-other: false /registry/v2/webscripts/{name}/versions/{version}/jobs: get: - operationId: jobs_webscript_functions + operationId: jobs_webscripts summary: List Webscript Jobs tags: - - Webscript Functions + - Webscripts description: List the ongoing and completed operations on a specific webscript. parameters: - schema: @@ -11625,19 +7053,22 @@ paths: x-consumes-other: false /registry/v2/webscripts/{name}/versions/{version}/verify: post: - operationId: verify_webscript_functions + operationId: verify_webscripts summary: Verify Health Of Webscript tags: - - Webscript Functions + - Webscripts description: Verify health of webscript deployed on openfaas. parameters: - schema: - type: string + type: boolean in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero + only if it was not active before this command. + x-showExample: true - schema: type: boolean default: true @@ -11650,16 +7081,6 @@ paths: Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. x-showExample: true - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: >- - Indicates whether the function needs to be scaled down after - successful verification. If not set, the function is scaled to zero - only if it was not active before this command. - x-showExample: true - schema: type: string in: path @@ -11768,20 +7189,21 @@ paths: x-consumes-other: false /registry/v2/plugs/: post: - operationId: create_plug_functions + operationId: create_plugs summary: Create Plug tags: - - Plug Functions + - Plugs description: |- Creates a new plug function by uploading its assets. - The assets for a plug function can be provided as either + The assets for a plug function can be provided as
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • +
    • A single tar archive (optionally compressed), with one of the content types + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • +
    • Separate files in a multipart/form-data request
      • +
    • A reference to the assets of another plug in the copy argument
    - + The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). @@ -11793,192 +7215,133 @@ paths: content: application/octet-stream: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required plug.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=plugs). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required plug.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=plugs). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required plug.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=plugs). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required plug.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=plugs). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required plug.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=plugs). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required plug.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=plugs). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: Multipart file upload. + description: >- + A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset + path. + type: object + properties: + assets: + type: array + items: + type: string + format: binary + application/json: + schema: + title: Empty Upload + description: >- + Empty object request body, only allowed when using the `copy` + query parameter. + type: object + maxProperties: 0 + '*/*+json': + schema: + title: Empty Upload + description: >- + Empty object request body, only allowed when using the `copy` + query parameter. + type: object + maxProperties: 0 description: | - The assets for a plug function can be provided as either + The assets for a plug function can be provided as
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • +
    • A single tar archive (optionally compressed), with one of the content types + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • +
    • Separate files in a multipart/form-data request
      • +
    • A reference to the assets of another plug in the copy argument
    - + The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. parameters: + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: >- + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. + x-showExample: true + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: none @@ -12010,17 +7373,6 @@ paths: Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. x-showExample: true - - schema: - type: boolean - default: false - in: query - name: scaleToZero - required: false - description: >- - If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources - when the function is not to be used immediately. - x-showExample: true - schema: $ref: '#/components/schemas/SemanticVersionRange' in: query @@ -12052,6 +7404,100 @@ paths: are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. x-showExample: true + - schema: + $ref: '#/components/schemas/NamedVersionRange' + in: query + name: runtime + required: false + description: >- + If set, the created function will use the indicated runtime (latest + version within specified range). + + + This takes precedence over the runtime specified in a function + manifest (copied or from request body). + x-showExample: false + - schema: + anyOf: + - $ref: '#/components/schemas/NamedVersionRange' + - $ref: '#/components/schemas/ExampleReference' + in: query + name: copy + required: false + description: >- + Indicates the _source_ of initial assets for a _new function_. + + + When using this query parameter, the request body does not need to + contain assets, but any assets in the request body will overwrite + the copied assets. + + + #### Selection of _assets_ source + + + * If set as `[@]`, the _new + function_ will be created with copied assets of the selected _source + function_. + + * If set as `!example`, a `runtime` query parameter is required, and + the _new function_ will be initialized with assets of the _runtime + example_. + + + #### Selection of the _source function_ + + + When `` is a range (or is not given), the latest + _published_ version (in that range) is used. + + + If no _published_ version exists, the latest _draft_ is selected. + + + If no versions in the range exist, a `404` _Not Found_ error is + returned. + + + #### The `name` of the _new function_ + + + If a `name` is NOT specified (either as query parameter, or in an + optional manifest asset in the request body), the `name` of the _new + function_ will be that of the _source function_. + + + #### The `version` of the _new function_ + + + When the _target_ and _source_ name are equal, the `version` query + parameters is defaulted to `` + (`~` when it's an exact version) + + + The version of the _new function_ will be: + + * If a `version` is NOT specified (either as query parameter, in an + optional manifest asset, or as `` _default_) + + * a **patch increment** (`..+1`) of the latest **existing version** with the target `name` + + * **`1.0.0`** otherwise + + * If a `version` is specified: + + * the **lowest version** in that range **if no existing version** is in that range. + + * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. + + * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. + + #### Deployment overrides + + + The new function will use the deployment overrides of the copied + function, unless a _manifest_ was specified in the request body. + x-showExample: false x-version: v2 responses: '201': @@ -12071,13 +7517,13 @@ paths: x-py-method: create x-consumes-multipart: true x-consumes-urlencoded: false - x-consumes-json: false + x-consumes-json: true x-consumes-other: true get: - operationId: list_plug_functions + operationId: list_plugs summary: List Plugs tags: - - Plug Functions + - Plugs description: > List the (latest) versions of available plugs. @@ -12098,11 +7544,15 @@ paths: - As long as no _version filters_ are used, each listed plug - version item will contain a HAL **link to the + As long as no version filters are used, each listed plug + version contains representations of the latest draft + (`entities[]._links.draft`) - latest** _draft_ (`entities[]._links.draft`) or latest _published_ - (`entities[]._links.publisned`) version (if existing and different). + or latest published (`entities[]._links.published`) version (if existing + and different). + + Use the query parameter `showRelated` to include only a link (default + `showRelated=link`) or a full representation (`showRelated=embed`). ### List Latest Plug Versions (with filter) @@ -12361,6 +7811,21 @@ paths: returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. x-showExample: true + - schema: + $ref: '#/components/schemas/ShowRelatedType' + in: query + name: showRelated + required: false + description: >- + Sets the representation of related function versions (like the + _latest_ draft and/or published) in the response. + + - `embed`: as full summary representation (in `_embedded`). + + - `link`: as HAL link in (in `_links`). + + - `none`: omitted. + x-showExample: true x-version: v2 responses: '200': @@ -12378,10 +7843,10 @@ paths: x-consumes-other: false /registry/v2/plugs/{name}: get: - operationId: getLatest_plug_functions + operationId: getLatest_plugs summary: Get Latest Plug Version tags: - - Plug Functions + - Plugs description: |- Fetch the latest version of a plug. @@ -12457,10 +7922,10 @@ paths: x-consumes-json: false x-consumes-other: false delete: - operationId: removeVersions_plug_functions + operationId: removeVersions_plugs summary: Remove Plug tags: - - Plug Functions + - Plugs description: > Deprecate, undeploy and/or remove all versions of this named plug. @@ -12581,10 +8046,10 @@ paths: x-consumes-other: false /registry/v2/plugs/{name}/versions: get: - operationId: listVersions_plug_functions + operationId: listVersions_plugs summary: List Plug Versions tags: - - Plug Functions + - Plugs description: List all versions of a plug, including deprecated versions or not. parameters: - schema: @@ -12758,10 +8223,10 @@ paths: x-consumes-other: false /registry/v2/plugs/{name}/versions/{version}: get: - operationId: get_plug_functions + operationId: get_plugs summary: Get Plug Version tags: - - Plug Functions + - Plugs description: Get a specific version of a plug. parameters: - schema: @@ -12797,10 +8262,10 @@ paths: x-consumes-json: false x-consumes-other: false delete: - operationId: removeVersion_plug_functions + operationId: removeVersion_plugs summary: Remove Plug Version tags: - - Plug Functions + - Plugs description: > Deprecate, undeploy and/or remove a plug version. @@ -12927,12 +8392,22 @@ paths: x-consumes-other: false /registry/v2/plugs/{name}/versions/{version}/rebuild: post: - operationId: rebuild_plug_functions + operationId: rebuild_plugs summary: Rebuild Plug tags: - - Plug Functions + - Plugs description: Rebuild and deploy a plug with the original or updated base image. parameters: + - schema: + type: boolean + in: query + name: scaleToZero + required: false + description: >- + Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero + only if it was not active before this command. + x-showExample: true - schema: type: string in: query @@ -13004,16 +8479,6 @@ paths: * the `dryRun` option x-showExample: true - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: >- - Indicates whether the function needs to be scaled down after - successful (re-)deployment. If not set, the function is scaled to - zero only if it was not active before this command. - x-showExample: true - schema: type: boolean in: query @@ -13060,10 +8525,10 @@ paths: x-consumes-other: false /registry/v2/plugs/{name}/versions/{version}/content: get: - operationId: getArchive_plug_functions + operationId: getArchive_plugs summary: Get Plug Archive tags: - - Plug Functions + - Plugs description: Get the specification archive of a plug. parameters: - schema: @@ -13102,6 +8567,12 @@ paths: description: Plug archive type: string format: binary + application/tar: + schema: + title: Archive + description: Plug archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -13137,17 +8608,17 @@ paths: x-consumes-json: false x-consumes-other: false put: - operationId: updateAssets_plug_functions + operationId: updateAssets_plugs summary: Update Plug Assets tags: - - Plug Functions + - Plugs description: |- Update a draft plug function by updating its assets. The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    @@ -13164,195 +8635,60 @@ paths: content: application/octet-stream: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the plug function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the plug.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the plug function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the plug.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the plug function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the plug.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the plug function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the plug.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the plug function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the plug.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Plug Function Assets - description: > - The assets for a plug function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the plug function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the plug.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: Multipart file upload. + description: >- + A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset + path. + type: object + properties: + assets: + type: array + items: + type: string + format: binary description: | The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    @@ -13365,34 +8701,74 @@ paths: For each runtime other files are supported. parameters: - schema: - type: string + type: boolean + default: false in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: type: boolean default: true in: query - name: async + name: deploy required: false description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. x-showExample: true - schema: type: boolean default: false in: query name: chown - required: true + required: false description: >- If set, ownership of the draft function is transferred to the current user. x-showExample: true + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: boolean + default: true + in: query + name: async + required: false + description: >- + Unless this is set to false, the server will start the + required job actions asynchronously and return a 202 + Accepted response. If false the request will + block until the job actions are completed, or a timeout occurs. + x-showExample: true - schema: type: string in: path @@ -13421,6 +8797,12 @@ paths: application/json: schema: $ref: '#/components/schemas/PostPlugJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/RegistryErrorResponse' security: - waylayApiKeySecret: [] x-py-method: update_assets @@ -13430,10 +8812,10 @@ paths: x-consumes-other: true /registry/v2/plugs/{name}/versions/{version}/content/{wildcard}: get: - operationId: getAsset_plug_functions + operationId: getAsset_plugs summary: Get File From Plug Archive tags: - - Plug Functions + - Plugs description: Get a file from the specification archive of a plug. parameters: - schema: @@ -13479,6 +8861,12 @@ paths: description: Plug archive type: string format: binary + application/tar: + schema: + title: Archive + description: Plug archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -13514,10 +8902,10 @@ paths: x-consumes-json: false x-consumes-other: false put: - operationId: updateAsset_plug_functions + operationId: updateAsset_plugs summary: Update Plug Asset tags: - - Plug Functions + - Plugs description: >- The provided asset will be added to the plug function's collection of existing assets, @@ -13530,7 +8918,7 @@ paths: requestBody: content: - application/octet-stream: + '*/*': schema: title: File Upload description: A single asset file. @@ -13542,34 +8930,74 @@ paths: description: A single asset file. parameters: - schema: - type: string + type: boolean + default: false in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: type: boolean default: true in: query - name: async + name: deploy required: false description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. x-showExample: true - schema: type: boolean default: false in: query name: chown - required: true + required: false description: >- If set, ownership of the draft function is transferred to the current user. x-showExample: true + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: boolean + default: true + in: query + name: async + required: false + description: >- + Unless this is set to false, the server will start the + required job actions asynchronously and return a 202 + Accepted response. If false the request will + block until the job actions are completed, or a timeout occurs. + x-showExample: true - schema: type: string in: path @@ -13605,6 +9033,12 @@ paths: application/json: schema: $ref: '#/components/schemas/PostPlugJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/RegistryErrorResponse' security: - waylayApiKeySecret: [] x-py-method: update_asset @@ -13613,41 +9047,81 @@ paths: x-consumes-json: false x-consumes-other: true delete: - operationId: deleteAsset_plug_functions + operationId: deleteAsset_plugs summary: Delete Plug Asset tags: - - Plug Functions + - Plugs description: Delete an asset from the plug's collection of existing assets. parameters: - schema: - type: string + type: boolean + default: false in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: type: boolean default: true in: query - name: async + name: deploy required: false description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. x-showExample: true - schema: type: boolean default: false in: query name: chown - required: true + required: false description: >- If set, ownership of the draft function is transferred to the current user. x-showExample: true + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: boolean + default: true + in: query + name: async + required: false + description: >- + Unless this is set to false, the server will start the + required job actions asynchronously and return a 202 + Accepted response. If false the request will + block until the job actions are completed, or a timeout occurs. + x-showExample: true - schema: type: string in: path @@ -13683,6 +9157,12 @@ paths: application/json: schema: $ref: '#/components/schemas/PostPlugJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/RegistryErrorResponse' security: - waylayApiKeySecret: [] x-py-method: delete_asset @@ -13692,10 +9172,10 @@ paths: x-consumes-other: false /registry/v2/plugs/{name}/versions/{version}/publish: post: - operationId: publish_plug_functions + operationId: publish_plugs summary: Publish Draft Plug tags: - - Plug Functions + - Plugs description: >- Mark the plug to be ready and stable, taking it out of draft mode., @@ -13705,6 +9185,16 @@ paths: In other statuses, plug-registry may need to initiate a new build and deployment procedure. parameters: + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: >- + If set, ownership of the draft function is transferred to the + current user. + x-showExample: true - schema: type: string in: query @@ -13712,6 +9202,13 @@ paths: required: false description: An optional user-specified comment corresponding to the operation. x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: none @@ -13773,10 +9270,10 @@ paths: x-consumes-other: false /registry/v2/plugs/{name}/versions/{version}/interface: patch: - operationId: patchInterface_plug_functions + operationId: patchInterface_plugs summary: Patch Plug Interface tags: - - Plug Functions + - Plugs description: Patch the interface documentation of a plug version. requestBody: content: @@ -13822,10 +9319,10 @@ paths: x-consumes-other: false /registry/v2/plugs/{name}/versions/{version}/metadata: patch: - operationId: patchMetadata_plug_functions + operationId: patchMetadata_plugs summary: Patch Plug Metadata tags: - - Plug Functions + - Plugs description: Patch the metadata of a plug version. requestBody: content: @@ -13871,10 +9368,10 @@ paths: x-consumes-other: false /registry/v2/plugs/{name}/versions/{version}/jobs: get: - operationId: jobs_plug_functions + operationId: jobs_plugs summary: List Plug Jobs tags: - - Plug Functions + - Plugs description: List the ongoing and completed operations on a specific plug. parameters: - schema: @@ -13959,19 +9456,22 @@ paths: x-consumes-other: false /registry/v2/plugs/{name}/versions/{version}/verify: post: - operationId: verify_plug_functions + operationId: verify_plugs summary: Verify Health Of Plug tags: - - Plug Functions + - Plugs description: Verify health of plug deployed on openfaas. parameters: - schema: - type: string + type: boolean in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero + only if it was not active before this command. + x-showExample: true - schema: type: boolean default: true @@ -13984,16 +9484,6 @@ paths: Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. x-showExample: true - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: >- - Indicates whether the function needs to be scaled down after - successful verification. If not set, the function is scaled to zero - only if it was not active before this command. - x-showExample: true - schema: type: string in: path @@ -14032,20 +9522,21 @@ paths: x-consumes-other: false /registry/v2/models/: post: - operationId: create_model_functions + operationId: create_models summary: Create Model tags: - - Model Functions + - Models description: |- Creates a new model function by uploading its assets. - The assets for a model function can be provided as either + The assets for a model function can be provided as
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • +
    • A single tar archive (optionally compressed), with one of the content types + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • +
    • Separate files in a multipart/form-data request
      • +
    • A reference to the assets of another model in the copy argument
    - + The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). @@ -14057,192 +9548,133 @@ paths: content: application/octet-stream: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required model.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=kfserving). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required model.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=kfserving). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required model.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=kfserving). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required model.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=kfserving). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required model.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=kfserving). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The required model.json json file contains the function metadata, - and must have a runtime attribute that is one of the supported runtimes - (see GET /registry/v2/runtimes?functionType=kfserving). - - For each runtime other files will be required or supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: Multipart file upload. + description: >- + A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset + path. + type: object + properties: + assets: + type: array + items: + type: string + format: binary + application/json: + schema: + title: Empty Upload + description: >- + Empty object request body, only allowed when using the `copy` + query parameter. + type: object + maxProperties: 0 + '*/*+json': + schema: + title: Empty Upload + description: >- + Empty object request body, only allowed when using the `copy` + query parameter. + type: object + maxProperties: 0 description: | - The assets for a model function can be provided as either + The assets for a model function can be provided as
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • +
    • A single tar archive (optionally compressed), with one of the content types + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • +
    • Separate files in a multipart/form-data request
      • +
    • A reference to the assets of another model in the copy argument
    - + The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. parameters: + - schema: + type: boolean + default: true + in: query + name: deploy + required: false + description: >- + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. + x-showExample: true + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: boolean + default: false + in: query + name: scaleToZero + required: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: patch @@ -14274,17 +9706,6 @@ paths: Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. x-showExample: true - - schema: - type: boolean - default: false - in: query - name: scaleToZero - required: false - description: >- - If set to true, after successful deployment, the - deployed function will be scaled to zero. Saves computing resources - when the function is not to be used immediately. - x-showExample: true - schema: $ref: '#/components/schemas/SemanticVersionRange' in: query @@ -14305,17 +9726,111 @@ paths: If set, the value will be used as the function name instead of the one specified in the manifest. x-showExample: false - - schema: - type: boolean - default: false - in: query - name: draft - required: false - description: >- - If set, the created function will be a draft function and its assets - are still mutable. A build and deploy is initiated only in the case - when all necessary assets are present and valid. - x-showExample: true + - schema: + type: boolean + default: false + in: query + name: draft + required: false + description: >- + If set, the created function will be a draft function and its assets + are still mutable. A build and deploy is initiated only in the case + when all necessary assets are present and valid. + x-showExample: true + - schema: + $ref: '#/components/schemas/NamedVersionRange' + in: query + name: runtime + required: false + description: >- + If set, the created function will use the indicated runtime (latest + version within specified range). + + + This takes precedence over the runtime specified in a function + manifest (copied or from request body). + x-showExample: false + - schema: + anyOf: + - $ref: '#/components/schemas/NamedVersionRange' + - $ref: '#/components/schemas/ExampleReference' + in: query + name: copy + required: false + description: >- + Indicates the _source_ of initial assets for a _new function_. + + + When using this query parameter, the request body does not need to + contain assets, but any assets in the request body will overwrite + the copied assets. + + + #### Selection of _assets_ source + + + * If set as `[@]`, the _new + function_ will be created with copied assets of the selected _source + function_. + + * If set as `!example`, a `runtime` query parameter is required, and + the _new function_ will be initialized with assets of the _runtime + example_. + + + #### Selection of the _source function_ + + + When `` is a range (or is not given), the latest + _published_ version (in that range) is used. + + + If no _published_ version exists, the latest _draft_ is selected. + + + If no versions in the range exist, a `404` _Not Found_ error is + returned. + + + #### The `name` of the _new function_ + + + If a `name` is NOT specified (either as query parameter, or in an + optional manifest asset in the request body), the `name` of the _new + function_ will be that of the _source function_. + + + #### The `version` of the _new function_ + + + When the _target_ and _source_ name are equal, the `version` query + parameters is defaulted to `` + (`~` when it's an exact version) + + + The version of the _new function_ will be: + + * If a `version` is NOT specified (either as query parameter, in an + optional manifest asset, or as `` _default_) + + * a **patch increment** (`..+1`) of the latest **existing version** with the target `name` + + * **`1.0.0`** otherwise + + * If a `version` is specified: + + * the **lowest version** in that range **if no existing version** is in that range. + + * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. + + * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. + + #### Deployment overrides + + + The new function will use the deployment overrides of the copied + function, unless a _manifest_ was specified in the request body. + x-showExample: false x-version: v2 responses: '201': @@ -14335,13 +9850,13 @@ paths: x-py-method: create x-consumes-multipart: true x-consumes-urlencoded: false - x-consumes-json: false + x-consumes-json: true x-consumes-other: true get: - operationId: list_model_functions + operationId: list_models summary: List Models tags: - - Model Functions + - Models description: > List the (latest) versions of available models. @@ -14362,11 +9877,15 @@ paths: - As long as no _version filters_ are used, each listed model - version item will contain a HAL **link to the + As long as no version filters are used, each listed model + version contains representations of the latest draft + (`entities[]._links.draft`) - latest** _draft_ (`entities[]._links.draft`) or latest _published_ - (`entities[]._links.publisned`) version (if existing and different). + or latest published (`entities[]._links.published`) version (if existing + and different). + + Use the query parameter `showRelated` to include only a link (default + `showRelated=link`) or a full representation (`showRelated=embed`). ### List Latest Model Versions (with filter) @@ -14608,6 +10127,21 @@ paths: returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. x-showExample: true + - schema: + $ref: '#/components/schemas/ShowRelatedType' + in: query + name: showRelated + required: false + description: >- + Sets the representation of related function versions (like the + _latest_ draft and/or published) in the response. + + - `embed`: as full summary representation (in `_embedded`). + + - `link`: as HAL link in (in `_links`). + + - `none`: omitted. + x-showExample: true x-version: v2 responses: '200': @@ -14625,10 +10159,10 @@ paths: x-consumes-other: false /registry/v2/models/{name}: get: - operationId: getLatest_model_functions + operationId: getLatest_models summary: Get Latest Model Version tags: - - Model Functions + - Models description: |- Fetch the latest version of a model. @@ -14694,10 +10228,10 @@ paths: x-consumes-json: false x-consumes-other: false delete: - operationId: removeVersions_model_functions + operationId: removeVersions_models summary: Remove Model tags: - - Model Functions + - Models description: > Deprecate, undeploy and/or remove all versions of this named model. @@ -14807,10 +10341,10 @@ paths: x-consumes-other: false /registry/v2/models/{name}/versions: get: - operationId: listVersions_model_functions + operationId: listVersions_models summary: List Model Versions tags: - - Model Functions + - Models description: List all deployed versions of a model. parameters: - schema: @@ -14974,10 +10508,10 @@ paths: x-consumes-other: false /registry/v2/models/{name}/versions/{version}: get: - operationId: get_model_functions + operationId: get_models summary: Get Model Version tags: - - Model Functions + - Models description: Get a model by name and version. parameters: - schema: @@ -15010,10 +10544,10 @@ paths: x-consumes-json: false x-consumes-other: false delete: - operationId: removeVersion_model_functions + operationId: removeVersion_models summary: Remove Model Version tags: - - Model Functions + - Models description: | Deprecate, undeploy and/or remove a model version. @@ -15129,10 +10663,10 @@ paths: x-consumes-other: false /registry/v2/models/{name}/versions/{version}/content: get: - operationId: getArchive_model_functions + operationId: getArchive_models summary: Get Model Archive tags: - - Model Functions + - Models description: Get the specification archive of a model. parameters: - schema: @@ -15171,6 +10705,12 @@ paths: description: Model archive type: string format: binary + application/tar: + schema: + title: Archive + description: Model archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -15206,17 +10746,17 @@ paths: x-consumes-json: false x-consumes-other: false put: - operationId: updateAssets_model_functions + operationId: updateAssets_models summary: Update Model Assets tags: - - Model Functions + - Models description: |- Update a draft model function by updating its assets. The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    @@ -15233,195 +10773,60 @@ paths: content: application/octet-stream: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the model function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the model.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary + application/tar: + schema: + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/tar+gzip: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the model function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the model.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-gzip: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the model function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the model.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/x-tar: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the model function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the model.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary application/gzip: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the model function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the model.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: TAR Archive Upload + description: A single file archive containing multiple assets. + type: string + format: binary multipart/form-data: schema: - title: Model Function Assets - description: > - The assets for a model function can be provided as - either -
      -
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • -
    • separate files in a multipart/form-data request
      • -
    - - The provided assets will be added to the model function's collection of existing assets, - replacing any existing assets with the same name. - - Please note that it is not allowed to update the model.json json file with a changed value for any of the - name, version and/or runtime attributes. - - For each runtime other files are supported. - anyOf: - - title: Multipart file upload. - description: A multi-part upload containing one or more file assets. - type: object - properties: - filename: - type: array - items: - type: string - format: binary - - title: TAR Achive Upload - description: A single file archive containing multiple assets. + title: Multipart file upload. + description: >- + A multi-part upload containing one or more file assets. + + Each part should specify a filename corresponding to the asset + path. + type: object + properties: + assets: + type: array + items: + type: string + format: binary description: | The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types - application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
      • + application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    @@ -15434,34 +10839,74 @@ paths: For each runtime other files are supported. parameters: - schema: - type: string + type: boolean + default: false in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: type: boolean default: true in: query - name: async + name: deploy required: false description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. x-showExample: true - schema: type: boolean default: false in: query name: chown - required: true + required: false description: >- If set, ownership of the draft function is transferred to the current user. x-showExample: true + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: boolean + default: true + in: query + name: async + required: false + description: >- + Unless this is set to false, the server will start the + required job actions asynchronously and return a 202 + Accepted response. If false the request will + block until the job actions are completed, or a timeout occurs. + x-showExample: true - schema: type: string in: path @@ -15490,6 +10935,12 @@ paths: application/json: schema: $ref: '#/components/schemas/PostModelJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/RegistryErrorResponse' security: - waylayApiKeySecret: [] x-py-method: update_assets @@ -15499,10 +10950,10 @@ paths: x-consumes-other: true /registry/v2/models/{name}/versions/{version}/content/{wildcard}: get: - operationId: getAsset_model_functions + operationId: getAsset_models summary: Get File From Model Archive tags: - - Model Functions + - Models description: Get a file from the specification archive of a model. parameters: - schema: @@ -15548,6 +10999,12 @@ paths: description: Model archive type: string format: binary + application/tar: + schema: + title: Archive + description: Model archive + type: string + format: binary application/tar+gzip: schema: title: Archive @@ -15583,10 +11040,10 @@ paths: x-consumes-json: false x-consumes-other: false put: - operationId: updateAsset_model_functions + operationId: updateAsset_models summary: Update Model Asset tags: - - Model Functions + - Models description: >- The provided asset will be added to the model function's collection of existing assets, @@ -15599,7 +11056,7 @@ paths: requestBody: content: - application/octet-stream: + '*/*': schema: title: File Upload description: A single asset file. @@ -15611,34 +11068,74 @@ paths: description: A single asset file. parameters: - schema: - type: string + type: boolean + default: false in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: type: boolean default: true in: query - name: async + name: deploy required: false description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. x-showExample: true - schema: type: boolean default: false in: query name: chown - required: true + required: false description: >- If set, ownership of the draft function is transferred to the current user. x-showExample: true + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: boolean + default: true + in: query + name: async + required: false + description: >- + Unless this is set to false, the server will start the + required job actions asynchronously and return a 202 + Accepted response. If false the request will + block until the job actions are completed, or a timeout occurs. + x-showExample: true - schema: type: string in: path @@ -15674,6 +11171,12 @@ paths: application/json: schema: $ref: '#/components/schemas/PostModelJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/RegistryErrorResponse' security: - waylayApiKeySecret: [] x-py-method: update_asset @@ -15682,41 +11185,81 @@ paths: x-consumes-json: false x-consumes-other: true delete: - operationId: deleteAsset_model_functions + operationId: deleteAsset_models summary: Delete Model Asset tags: - - Model Functions + - Models description: Delete an asset from the model's collection of existing assets. parameters: - schema: - type: string + type: boolean + default: false in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + If set to true, after successful deployment, the + deployed function will be scaled to zero. This saves computing + resources when the function is not to be used immediately. + x-showExample: true - schema: type: boolean default: true in: query - name: async + name: deploy required: false description: >- - Unless this is set to false, the server will start the - required job actions asynchronously and return a 202 - Accepted response. If false the request will - block until the job actions are completed, or a timeout occurs. + Indicates that a function should be _deployed_ when its assets are + valid. + + + * If `true` (default), jobs to build and deploy the function will be + initiated after it is checked that the assets are valid. Invalid + assets lead to a validation error, and the function and its assets + are not created or updated. + + * If `false`, the uploaded assets are stored and the function is + created/updated in `registered` state. Asset validation errors are + only returned as warning, and stored as `failureReason` on the + function entity. Use an _asset update_ or _rebuild_ to initiate a + build and deploy at a later stage. x-showExample: true - schema: type: boolean default: false in: query name: chown - required: true + required: false description: >- If set, ownership of the draft function is transferred to the current user. x-showExample: true + - schema: + type: string + in: query + name: comment + required: false + description: An optional user-specified comment corresponding to the operation. + x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false + - schema: + type: boolean + default: true + in: query + name: async + required: false + description: >- + Unless this is set to false, the server will start the + required job actions asynchronously and return a 202 + Accepted response. If false the request will + block until the job actions are completed, or a timeout occurs. + x-showExample: true - schema: type: string in: path @@ -15752,6 +11295,12 @@ paths: application/json: schema: $ref: '#/components/schemas/PostModelJobAsyncResponseV2' + '403': + description: Default Response + content: + application/json: + schema: + $ref: '#/components/schemas/RegistryErrorResponse' security: - waylayApiKeySecret: [] x-py-method: delete_asset @@ -15761,10 +11310,10 @@ paths: x-consumes-other: false /registry/v2/models/{name}/versions/{version}/publish: post: - operationId: publish_model_functions + operationId: publish_models summary: Publish Draft Model tags: - - Model Functions + - Models description: >- Mark the model to be ready and stable, taking it out of draft mode., @@ -15774,6 +11323,16 @@ paths: In other statuses, plug-registry may need to initiate a new build and deployment procedure. parameters: + - schema: + type: boolean + default: false + in: query + name: chown + required: false + description: >- + If set, ownership of the draft function is transferred to the + current user. + x-showExample: true - schema: type: string in: query @@ -15781,6 +11340,13 @@ paths: required: false description: An optional user-specified comment corresponding to the operation. x-showExample: false + - schema: + type: string + in: query + name: author + required: false + description: Optionally changes the author metadata when updating a function. + x-showExample: false - schema: $ref: '#/components/schemas/DeprecatePreviousPolicy' default: patch @@ -15842,10 +11408,10 @@ paths: x-consumes-other: false /registry/v2/models/{name}/versions/{version}/metadata: patch: - operationId: patchMetadata_model_functions + operationId: patchMetadata_models summary: Patch Model Metadata tags: - - Model Functions + - Models description: Patch the metadata of a model version. requestBody: content: @@ -15891,10 +11457,10 @@ paths: x-consumes-other: false /registry/v2/models/{name}/versions/{version}/jobs: get: - operationId: jobs_model_functions + operationId: jobs_models summary: List Model Jobs tags: - - Model Functions + - Models description: List the ongoing and completed operations on a model. parameters: - schema: @@ -15979,12 +11545,22 @@ paths: x-consumes-other: false /registry/v2/models/{name}/versions/{version}/rebuild: post: - operationId: rebuild_model_functions + operationId: rebuild_models summary: Rebuild Model tags: - - Model Functions + - Models description: Rebuild and deploy a model with the original or updated base image. parameters: + - schema: + type: boolean + in: query + name: scaleToZero + required: false + description: >- + Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero + only if it was not active before this command. + x-showExample: true - schema: type: string in: query @@ -16056,16 +11632,6 @@ paths: * the `dryRun` option x-showExample: true - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: >- - Indicates whether the function needs to be scaled down after - successful (re-)deployment. If not set, the function is scaled to - zero only if it was not active before this command. - x-showExample: true - schema: type: boolean in: query @@ -16112,19 +11678,22 @@ paths: x-consumes-other: false /registry/v2/models/{name}/versions/{version}/verify: post: - operationId: verify_model_functions + operationId: verify_models summary: Verify Health Of Model tags: - - Model Functions + - Models description: Verify health of model deployed on openfaas. parameters: - schema: - type: string + type: boolean in: query - name: comment + name: scaleToZero required: false - description: An optional user-specified comment corresponding to the operation. - x-showExample: false + description: >- + Indicates whether the function needs to be scaled down after + successful verification. If not set, the function is scaled to zero + only if it was not active before this command. + x-showExample: true - schema: type: boolean default: true @@ -16137,16 +11706,6 @@ paths: Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. x-showExample: true - - schema: - type: boolean - in: query - name: scaleToZero - required: false - description: >- - Indicates whether the function needs to be scaled down after - successful verification. If not set, the function is scaled to zero - only if it was not active before this command. - x-showExample: true - schema: type: string in: path @@ -16184,6 +11743,15 @@ paths: x-consumes-json: false x-consumes-other: false tags: + - name: Models + description: BYOML Models are functions that wrap a machine learning model. + externalDocs: + url: https://docs.waylay.io/#/features/byoml/ + description: Waylay Documentation + - name: Plugs + description: Plugs are functions that can be used in the rule engine. + - name: Webscripts + description: Webscripts are functions that are securely exposed to an http endpoint. - name: Jobs description: >- Jobs represent the ongoing asynchronous operations in the function @@ -16193,6 +11761,10 @@ tags: Runtimes are the available base infrastructure for functions, and define how the plug gets build and deployed. + - name: Schemas + description: Schemas referenced in the API. + - name: About + description: Version and Health information. externalDocs: url: https://docs.waylay.io/#/api/registry/ description: Waylay Documentation diff --git a/test/api/default_api_test.py b/test/api/about_api_test.py similarity index 83% rename from test/api/default_api_test.py rename to test/api/about_api_test.py index a95b1fbc..14b34f11 100644 --- a/test/api/default_api_test.py +++ b/test/api/about_api_test.py @@ -18,7 +18,7 @@ from typeguard import check_type from waylay.sdk import ApiClient, WaylayClient from waylay.sdk.api._models import Model -from waylay.services.registry.api import DefaultApi +from waylay.services.registry.api import AboutApi from waylay.services.registry.service import RegistryService from ..types.root_page_response_stub import RootPageResponseStub @@ -36,13 +36,13 @@ @pytest.fixture -def default_api(waylay_api_client: ApiClient) -> DefaultApi: - return DefaultApi(waylay_api_client) +def about_api(waylay_api_client: ApiClient) -> AboutApi: + return AboutApi(waylay_api_client) def test_registered(waylay_client: WaylayClient): - """Test that DefaultApi api is registered in the sdk client.""" - assert isinstance(waylay_client.registry.default, DefaultApi) + """Test that AboutApi api is registered in the sdk client.""" + assert isinstance(waylay_client.registry.about, AboutApi) def _get_set_mock_response(httpx_mock: HTTPXMock, gateway_url: str): @@ -60,12 +60,12 @@ def _get_set_mock_response(httpx_mock: HTTPXMock, gateway_url: str): @pytest.mark.skipif(not MODELS_AVAILABLE, reason="Types not installed.") async def test_get(service: RegistryService, gateway_url: str, httpx_mock: HTTPXMock): """Test case for get - Version + Get Service Status """ # set path params kwargs = {} _get_set_mock_response(httpx_mock, gateway_url) - resp = await service.default.get(**kwargs) + resp = await service.about.get(**kwargs) check_type(resp, Union[RootPageResponse,]) @@ -75,10 +75,10 @@ async def test_get_without_types( service: RegistryService, gateway_url: str, httpx_mock: HTTPXMock ): """Test case for get with models not installed - Version + Get Service Status """ # set path params kwargs = {} _get_set_mock_response(httpx_mock, gateway_url) - resp = await service.default.get(**kwargs) + resp = await service.about.get(**kwargs) check_type(resp, Model) diff --git a/test/api/model_functions_api_test.py b/test/api/models_api_test.py similarity index 90% rename from test/api/model_functions_api_test.py rename to test/api/models_api_test.py index 316e3499..300c1936 100644 --- a/test/api/model_functions_api_test.py +++ b/test/api/models_api_test.py @@ -19,9 +19,12 @@ from typeguard import check_type from waylay.sdk import ApiClient, WaylayClient from waylay.sdk.api._models import Model -from waylay.services.registry.api import ModelFunctionsApi +from waylay.services.registry.api import ModelsApi from waylay.services.registry.service import RegistryService +from ..types.create_webscripts_copy_parameter_stub import ( + CreateWebscriptsCopyParameterStub, +) from ..types.function_meta_stub import FunctionMetaStub from ..types.get_model_response_v2_stub import GetModelResponseV2Stub from ..types.jobs_for_model_response_v2_stub import JobsForModelResponseV2Stub @@ -52,7 +55,7 @@ UndeploySubmittedResponseV2, VerifyModelSyncResponseV2, ) - from waylay.services.registry.queries.model_functions_api import ( + from waylay.services.registry.queries.models_api import ( CreateQuery, DeleteAssetQuery, GetArchiveQuery, @@ -77,13 +80,13 @@ @pytest.fixture -def model_functions_api(waylay_api_client: ApiClient) -> ModelFunctionsApi: - return ModelFunctionsApi(waylay_api_client) +def models_api(waylay_api_client: ApiClient) -> ModelsApi: + return ModelsApi(waylay_api_client) def test_registered(waylay_client: WaylayClient): - """Test that ModelFunctionsApi api is registered in the sdk client.""" - assert isinstance(waylay_client.registry.model_functions, ModelFunctionsApi) + """Test that ModelsApi api is registered in the sdk client.""" + assert isinstance(waylay_client.registry.models, ModelsApi) def _create_set_mock_response(httpx_mock: HTTPXMock, gateway_url: str): @@ -109,14 +112,20 @@ async def test_create( kwargs = { # optionally use CreateQuery to validate and reuse parameters "query": CreateQuery( + deploy=True, + author="author_example", + comment="comment_example", + scale_to_zero=False, deprecate_previous="none", dry_run=True, var_async=True, - scale_to_zero=False, version=SemanticVersionRangeStub.create_json(), name="name_example", draft=False, + runtime="runtime_example", + copy_from=CreateWebscriptsCopyParameterStub.create_json(), ), + "json": None, "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, "files": { @@ -125,7 +134,7 @@ async def test_create( }, } _create_set_mock_response(httpx_mock, gateway_url) - resp = await service.model_functions.create(**kwargs) + resp = await service.models.create(**kwargs) check_type( resp, Union[ @@ -146,23 +155,29 @@ async def test_create_without_types( # set path params kwargs = { "query": { + "deploy": True, + "author": "author_example", + "comment": "comment_example", + "scaleToZero": False, "deprecatePrevious": "none", "dryRun": True, "async": True, - "scaleToZero": False, "version": SemanticVersionRangeStub.create_json(), "name": "name_example", "draft": False, + "runtime": "runtime_example", + "copy": CreateWebscriptsCopyParameterStub.create_json(), }, "files": { "myFile1": b"...first file content...", "myFile2": b"...second file content...", }, + "json": None, "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, } _create_set_mock_response(httpx_mock, gateway_url) - resp = await service.model_functions.create(**kwargs) + resp = await service.models.create(**kwargs) check_type(resp, Model) @@ -199,9 +214,12 @@ async def test_delete_asset( kwargs = { # optionally use DeleteAssetQuery to validate and reuse parameters "query": DeleteAssetQuery( + scale_to_zero=False, + deploy=True, + chown=False, comment="comment_example", + author="author_example", var_async=True, - chown=False, ), } _delete_asset_set_mock_response( @@ -211,7 +229,7 @@ async def test_delete_asset( quote(str(version)), quote(str(wildcard)), ) - resp = await service.model_functions.delete_asset(name, version, wildcard, **kwargs) + resp = await service.models.delete_asset(name, version, wildcard, **kwargs) check_type( resp, Union[ @@ -238,9 +256,12 @@ async def test_delete_asset_without_types( kwargs = { "query": { + "scaleToZero": False, + "deploy": True, + "chown": False, "comment": "comment_example", + "author": "author_example", "async": True, - "chown": False, }, } _delete_asset_set_mock_response( @@ -250,7 +271,7 @@ async def test_delete_asset_without_types( quote(str(version)), quote(str(wildcard)), ) - resp = await service.model_functions.delete_asset(name, version, wildcard, **kwargs) + resp = await service.models.delete_asset(name, version, wildcard, **kwargs) check_type(resp, Model) @@ -291,7 +312,7 @@ async def test_get_archive( _get_archive_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.get_archive(name, version, **kwargs) + resp = await service.models.get_archive(name, version, **kwargs) check_type(resp, bytes) @@ -316,7 +337,7 @@ async def test_get_archive_without_types( _get_archive_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.get_archive(name, version, **kwargs) + resp = await service.models.get_archive(name, version, **kwargs) check_type(resp, bytes) @@ -363,7 +384,7 @@ async def test_get_asset( quote(str(version)), quote(str(wildcard)), ) - resp = await service.model_functions.get_asset(name, version, wildcard, **kwargs) + resp = await service.models.get_asset(name, version, wildcard, **kwargs) check_type(resp, bytes) @@ -394,7 +415,7 @@ async def test_get_asset_without_types( quote(str(version)), quote(str(wildcard)), ) - resp = await service.model_functions.get_asset(name, version, wildcard, **kwargs) + resp = await service.models.get_asset(name, version, wildcard, **kwargs) check_type(resp, bytes) @@ -428,7 +449,7 @@ async def test_get_latest( ), } _get_latest_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.model_functions.get_latest(name, **kwargs) + resp = await service.models.get_latest(name, **kwargs) check_type(resp, Union[GetModelResponseV2,]) @@ -450,7 +471,7 @@ async def test_get_latest_without_types( }, } _get_latest_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.model_functions.get_latest(name, **kwargs) + resp = await service.models.get_latest(name, **kwargs) check_type(resp, Model) @@ -484,7 +505,7 @@ async def test_get(service: RegistryService, gateway_url: str, httpx_mock: HTTPX _get_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.get(name, version, **kwargs) + resp = await service.models.get(name, version, **kwargs) check_type(resp, Union[GetModelResponseV2,]) @@ -505,7 +526,7 @@ async def test_get_without_types( _get_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.get(name, version, **kwargs) + resp = await service.models.get(name, version, **kwargs) check_type(resp, Model) @@ -549,7 +570,7 @@ async def test_jobs(service: RegistryService, gateway_url: str, httpx_mock: HTTP _jobs_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.jobs(name, version, **kwargs) + resp = await service.models.jobs(name, version, **kwargs) check_type(resp, Union[JobsForModelResponseV2,]) @@ -579,7 +600,7 @@ async def test_jobs_without_types( _jobs_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.jobs(name, version, **kwargs) + resp = await service.models.jobs(name, version, **kwargs) check_type(resp, Model) @@ -624,10 +645,11 @@ async def test_list(service: RegistryService, gateway_url: str, httpx_mock: HTTP archive_format=[], runtime=[], latest=True, + show_related="embed", ), } _list_set_mock_response(httpx_mock, gateway_url) - resp = await service.model_functions.list(**kwargs) + resp = await service.models.list(**kwargs) check_type(resp, Union[LatestModelsResponseV2,]) @@ -662,10 +684,11 @@ async def test_list_without_types( "archiveFormat": [], "runtime": [], "latest": True, + "showRelated": "embed", }, } _list_set_mock_response(httpx_mock, gateway_url) - resp = await service.model_functions.list(**kwargs) + resp = await service.models.list(**kwargs) check_type(resp, Model) @@ -714,7 +737,7 @@ async def test_list_versions( ), } _list_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.model_functions.list_versions(name, **kwargs) + resp = await service.models.list_versions(name, **kwargs) check_type(resp, Union[ModelVersionsResponseV2,]) @@ -749,7 +772,7 @@ async def test_list_versions_without_types( }, } _list_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.model_functions.list_versions(name, **kwargs) + resp = await service.models.list_versions(name, **kwargs) check_type(resp, Model) @@ -791,7 +814,7 @@ async def test_patch_metadata( _patch_metadata_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.patch_metadata(name, version, **kwargs) + resp = await service.models.patch_metadata(name, version, **kwargs) check_type(resp, Union[GetModelResponseV2,]) @@ -817,7 +840,7 @@ async def test_patch_metadata_without_types( _patch_metadata_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.patch_metadata(name, version, **kwargs) + resp = await service.models.patch_metadata(name, version, **kwargs) check_type(resp, Model) @@ -852,7 +875,9 @@ async def test_publish( kwargs = { # optionally use PublishQuery to validate and reuse parameters "query": PublishQuery( + chown=False, comment="comment_example", + author="author_example", deprecate_previous="none", var_async=True, ), @@ -860,7 +885,7 @@ async def test_publish( _publish_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.publish(name, version, **kwargs) + resp = await service.models.publish(name, version, **kwargs) check_type( resp, Union[ @@ -885,7 +910,9 @@ async def test_publish_without_types( kwargs = { "query": { + "chown": False, "comment": "comment_example", + "author": "author_example", "deprecatePrevious": "none", "async": True, }, @@ -893,7 +920,7 @@ async def test_publish_without_types( _publish_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.publish(name, version, **kwargs) + resp = await service.models.publish(name, version, **kwargs) check_type(resp, Model) @@ -928,20 +955,20 @@ async def test_rebuild( kwargs = { # optionally use RebuildQuery to validate and reuse parameters "query": RebuildQuery( + scale_to_zero=True, comment="comment_example", dry_run=True, var_async=True, upgrade="patch", force_version="force_version_example", ignore_checks=True, - scale_to_zero=True, skip_rebuild=True, ), } _rebuild_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.rebuild(name, version, **kwargs) + resp = await service.models.rebuild(name, version, **kwargs) check_type( resp, Union[ @@ -966,20 +993,20 @@ async def test_rebuild_without_types( kwargs = { "query": { + "scaleToZero": True, "comment": "comment_example", "dryRun": True, "async": True, "upgrade": "patch", "forceVersion": "force_version_example", "ignoreChecks": True, - "scaleToZero": True, "skipRebuild": True, }, } _rebuild_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.rebuild(name, version, **kwargs) + resp = await service.models.rebuild(name, version, **kwargs) check_type(resp, Model) @@ -1023,7 +1050,7 @@ async def test_remove_version( _remove_version_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.remove_version(name, version, **kwargs) + resp = await service.models.remove_version(name, version, **kwargs) check_type( resp, Union[ @@ -1057,7 +1084,7 @@ async def test_remove_version_without_types( _remove_version_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.remove_version(name, version, **kwargs) + resp = await service.models.remove_version(name, version, **kwargs) check_type(resp, Model) @@ -1095,7 +1122,7 @@ async def test_remove_versions( ), } _remove_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.model_functions.remove_versions(name, **kwargs) + resp = await service.models.remove_versions(name, **kwargs) check_type( resp, Union[ @@ -1125,7 +1152,7 @@ async def test_remove_versions_without_types( }, } _remove_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.model_functions.remove_versions(name, **kwargs) + resp = await service.models.remove_versions(name, **kwargs) check_type(resp, Model) @@ -1162,9 +1189,12 @@ async def test_update_asset( kwargs = { # optionally use UpdateAssetQuery to validate and reuse parameters "query": UpdateAssetQuery( + scale_to_zero=False, + deploy=True, + chown=False, comment="comment_example", + author="author_example", var_async=True, - chown=False, ), "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, @@ -1176,7 +1206,7 @@ async def test_update_asset( quote(str(version)), quote(str(wildcard)), ) - resp = await service.model_functions.update_asset(name, version, wildcard, **kwargs) + resp = await service.models.update_asset(name, version, wildcard, **kwargs) check_type( resp, Union[ @@ -1203,9 +1233,12 @@ async def test_update_asset_without_types( kwargs = { "query": { + "scaleToZero": False, + "deploy": True, + "chown": False, "comment": "comment_example", + "author": "author_example", "async": True, - "chown": False, }, "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, @@ -1217,7 +1250,7 @@ async def test_update_asset_without_types( quote(str(version)), quote(str(wildcard)), ) - resp = await service.model_functions.update_asset(name, version, wildcard, **kwargs) + resp = await service.models.update_asset(name, version, wildcard, **kwargs) check_type(resp, Model) @@ -1252,9 +1285,12 @@ async def test_update_assets( kwargs = { # optionally use UpdateAssetsQuery to validate and reuse parameters "query": UpdateAssetsQuery( + scale_to_zero=False, + deploy=True, + chown=False, comment="comment_example", + author="author_example", var_async=True, - chown=False, ), "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, @@ -1266,7 +1302,7 @@ async def test_update_assets( _update_assets_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.update_assets(name, version, **kwargs) + resp = await service.models.update_assets(name, version, **kwargs) check_type( resp, Union[ @@ -1291,9 +1327,12 @@ async def test_update_assets_without_types( kwargs = { "query": { + "scaleToZero": False, + "deploy": True, + "chown": False, "comment": "comment_example", + "author": "author_example", "async": True, - "chown": False, }, "files": { "myFile1": b"...first file content...", @@ -1305,7 +1344,7 @@ async def test_update_assets_without_types( _update_assets_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.update_assets(name, version, **kwargs) + resp = await service.models.update_assets(name, version, **kwargs) check_type(resp, Model) @@ -1340,15 +1379,14 @@ async def test_verify( kwargs = { # optionally use VerifyQuery to validate and reuse parameters "query": VerifyQuery( - comment="comment_example", - var_async=True, scale_to_zero=True, + var_async=True, ), } _verify_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.verify(name, version, **kwargs) + resp = await service.models.verify(name, version, **kwargs) check_type( resp, Union[ @@ -1373,13 +1411,12 @@ async def test_verify_without_types( kwargs = { "query": { - "comment": "comment_example", - "async": True, "scaleToZero": True, + "async": True, }, } _verify_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.model_functions.verify(name, version, **kwargs) + resp = await service.models.verify(name, version, **kwargs) check_type(resp, Model) diff --git a/test/api/plug_functions_api_test.py b/test/api/plugs_api_test.py similarity index 91% rename from test/api/plug_functions_api_test.py rename to test/api/plugs_api_test.py index b7ed38b3..2e990974 100644 --- a/test/api/plug_functions_api_test.py +++ b/test/api/plugs_api_test.py @@ -19,9 +19,12 @@ from typeguard import check_type from waylay.sdk import ApiClient, WaylayClient from waylay.sdk.api._models import Model -from waylay.services.registry.api import PlugFunctionsApi +from waylay.services.registry.api import PlugsApi from waylay.services.registry.service import RegistryService +from ..types.create_webscripts_copy_parameter_stub import ( + CreateWebscriptsCopyParameterStub, +) from ..types.documentation_stub import DocumentationStub from ..types.get_plug_response_v2_stub import GetPlugResponseV2Stub from ..types.jobs_for_plug_response_v2_stub import JobsForPlugResponseV2Stub @@ -54,7 +57,7 @@ UndeploySubmittedResponseV2, VerifyPlugSyncResponseV2, ) - from waylay.services.registry.queries.plug_functions_api import ( + from waylay.services.registry.queries.plugs_api import ( CreateQuery, DeleteAssetQuery, GetArchiveQuery, @@ -80,13 +83,13 @@ @pytest.fixture -def plug_functions_api(waylay_api_client: ApiClient) -> PlugFunctionsApi: - return PlugFunctionsApi(waylay_api_client) +def plugs_api(waylay_api_client: ApiClient) -> PlugsApi: + return PlugsApi(waylay_api_client) def test_registered(waylay_client: WaylayClient): - """Test that PlugFunctionsApi api is registered in the sdk client.""" - assert isinstance(waylay_client.registry.plug_functions, PlugFunctionsApi) + """Test that PlugsApi api is registered in the sdk client.""" + assert isinstance(waylay_client.registry.plugs, PlugsApi) def _create_set_mock_response(httpx_mock: HTTPXMock, gateway_url: str): @@ -112,14 +115,20 @@ async def test_create( kwargs = { # optionally use CreateQuery to validate and reuse parameters "query": CreateQuery( + deploy=True, + author="author_example", + comment="comment_example", + scale_to_zero=False, deprecate_previous="none", dry_run=True, var_async=True, - scale_to_zero=False, version=SemanticVersionRangeStub.create_json(), name="name_example", draft=False, + runtime="runtime_example", + copy_from=CreateWebscriptsCopyParameterStub.create_json(), ), + "json": None, "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, "files": { @@ -128,7 +137,7 @@ async def test_create( }, } _create_set_mock_response(httpx_mock, gateway_url) - resp = await service.plug_functions.create(**kwargs) + resp = await service.plugs.create(**kwargs) check_type( resp, Union[ @@ -149,23 +158,29 @@ async def test_create_without_types( # set path params kwargs = { "query": { + "deploy": True, + "author": "author_example", + "comment": "comment_example", + "scaleToZero": False, "deprecatePrevious": "none", "dryRun": True, "async": True, - "scaleToZero": False, "version": SemanticVersionRangeStub.create_json(), "name": "name_example", "draft": False, + "runtime": "runtime_example", + "copy": CreateWebscriptsCopyParameterStub.create_json(), }, "files": { "myFile1": b"...first file content...", "myFile2": b"...second file content...", }, + "json": None, "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, } _create_set_mock_response(httpx_mock, gateway_url) - resp = await service.plug_functions.create(**kwargs) + resp = await service.plugs.create(**kwargs) check_type(resp, Model) @@ -202,9 +217,12 @@ async def test_delete_asset( kwargs = { # optionally use DeleteAssetQuery to validate and reuse parameters "query": DeleteAssetQuery( + scale_to_zero=False, + deploy=True, + chown=False, comment="comment_example", + author="author_example", var_async=True, - chown=False, ), } _delete_asset_set_mock_response( @@ -214,7 +232,7 @@ async def test_delete_asset( quote(str(version)), quote(str(wildcard)), ) - resp = await service.plug_functions.delete_asset(name, version, wildcard, **kwargs) + resp = await service.plugs.delete_asset(name, version, wildcard, **kwargs) check_type( resp, Union[ @@ -241,9 +259,12 @@ async def test_delete_asset_without_types( kwargs = { "query": { + "scaleToZero": False, + "deploy": True, + "chown": False, "comment": "comment_example", + "author": "author_example", "async": True, - "chown": False, }, } _delete_asset_set_mock_response( @@ -253,7 +274,7 @@ async def test_delete_asset_without_types( quote(str(version)), quote(str(wildcard)), ) - resp = await service.plug_functions.delete_asset(name, version, wildcard, **kwargs) + resp = await service.plugs.delete_asset(name, version, wildcard, **kwargs) check_type(resp, Model) @@ -294,7 +315,7 @@ async def test_get_archive( _get_archive_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.get_archive(name, version, **kwargs) + resp = await service.plugs.get_archive(name, version, **kwargs) check_type(resp, bytes) @@ -319,7 +340,7 @@ async def test_get_archive_without_types( _get_archive_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.get_archive(name, version, **kwargs) + resp = await service.plugs.get_archive(name, version, **kwargs) check_type(resp, bytes) @@ -366,7 +387,7 @@ async def test_get_asset( quote(str(version)), quote(str(wildcard)), ) - resp = await service.plug_functions.get_asset(name, version, wildcard, **kwargs) + resp = await service.plugs.get_asset(name, version, wildcard, **kwargs) check_type(resp, bytes) @@ -397,7 +418,7 @@ async def test_get_asset_without_types( quote(str(version)), quote(str(wildcard)), ) - resp = await service.plug_functions.get_asset(name, version, wildcard, **kwargs) + resp = await service.plugs.get_asset(name, version, wildcard, **kwargs) check_type(resp, bytes) @@ -432,7 +453,7 @@ async def test_get_latest( ), } _get_latest_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.plug_functions.get_latest(name, **kwargs) + resp = await service.plugs.get_latest(name, **kwargs) check_type(resp, Union[GetPlugResponseV2,]) @@ -455,7 +476,7 @@ async def test_get_latest_without_types( }, } _get_latest_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.plug_functions.get_latest(name, **kwargs) + resp = await service.plugs.get_latest(name, **kwargs) check_type(resp, Model) @@ -489,7 +510,7 @@ async def test_get(service: RegistryService, gateway_url: str, httpx_mock: HTTPX _get_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.get(name, version, **kwargs) + resp = await service.plugs.get(name, version, **kwargs) check_type(resp, Union[GetPlugResponseV2,]) @@ -510,7 +531,7 @@ async def test_get_without_types( _get_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.get(name, version, **kwargs) + resp = await service.plugs.get(name, version, **kwargs) check_type(resp, Model) @@ -554,7 +575,7 @@ async def test_jobs(service: RegistryService, gateway_url: str, httpx_mock: HTTP _jobs_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.jobs(name, version, **kwargs) + resp = await service.plugs.jobs(name, version, **kwargs) check_type(resp, Union[JobsForPlugResponseV2,]) @@ -584,7 +605,7 @@ async def test_jobs_without_types( _jobs_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.jobs(name, version, **kwargs) + resp = await service.plugs.jobs(name, version, **kwargs) check_type(resp, Model) @@ -631,10 +652,11 @@ async def test_list(service: RegistryService, gateway_url: str, httpx_mock: HTTP archive_format=[], runtime=[], latest=True, + show_related="embed", ), } _list_set_mock_response(httpx_mock, gateway_url) - resp = await service.plug_functions.list(**kwargs) + resp = await service.plugs.list(**kwargs) check_type(resp, Union[LatestPlugsResponseV2,]) @@ -671,10 +693,11 @@ async def test_list_without_types( "archiveFormat": [], "runtime": [], "latest": True, + "showRelated": "embed", }, } _list_set_mock_response(httpx_mock, gateway_url) - resp = await service.plug_functions.list(**kwargs) + resp = await service.plugs.list(**kwargs) check_type(resp, Model) @@ -724,7 +747,7 @@ async def test_list_versions( ), } _list_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.plug_functions.list_versions(name, **kwargs) + resp = await service.plugs.list_versions(name, **kwargs) check_type(resp, Union[PlugVersionsResponseV2,]) @@ -760,7 +783,7 @@ async def test_list_versions_without_types( }, } _list_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.plug_functions.list_versions(name, **kwargs) + resp = await service.plugs.list_versions(name, **kwargs) check_type(resp, Model) @@ -802,7 +825,7 @@ async def test_patch_interface( _patch_interface_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.patch_interface(name, version, **kwargs) + resp = await service.plugs.patch_interface(name, version, **kwargs) check_type(resp, Union[GetPlugResponseV2,]) @@ -828,7 +851,7 @@ async def test_patch_interface_without_types( _patch_interface_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.patch_interface(name, version, **kwargs) + resp = await service.plugs.patch_interface(name, version, **kwargs) check_type(resp, Model) @@ -870,7 +893,7 @@ async def test_patch_metadata( _patch_metadata_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.patch_metadata(name, version, **kwargs) + resp = await service.plugs.patch_metadata(name, version, **kwargs) check_type(resp, Union[GetPlugResponseV2,]) @@ -896,7 +919,7 @@ async def test_patch_metadata_without_types( _patch_metadata_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.patch_metadata(name, version, **kwargs) + resp = await service.plugs.patch_metadata(name, version, **kwargs) check_type(resp, Model) @@ -931,7 +954,9 @@ async def test_publish( kwargs = { # optionally use PublishQuery to validate and reuse parameters "query": PublishQuery( + chown=False, comment="comment_example", + author="author_example", deprecate_previous="none", var_async=True, ), @@ -939,7 +964,7 @@ async def test_publish( _publish_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.publish(name, version, **kwargs) + resp = await service.plugs.publish(name, version, **kwargs) check_type( resp, Union[ @@ -964,7 +989,9 @@ async def test_publish_without_types( kwargs = { "query": { + "chown": False, "comment": "comment_example", + "author": "author_example", "deprecatePrevious": "none", "async": True, }, @@ -972,7 +999,7 @@ async def test_publish_without_types( _publish_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.publish(name, version, **kwargs) + resp = await service.plugs.publish(name, version, **kwargs) check_type(resp, Model) @@ -1007,20 +1034,20 @@ async def test_rebuild( kwargs = { # optionally use RebuildQuery to validate and reuse parameters "query": RebuildQuery( + scale_to_zero=True, comment="comment_example", dry_run=True, var_async=True, upgrade="patch", force_version="force_version_example", ignore_checks=True, - scale_to_zero=True, skip_rebuild=True, ), } _rebuild_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.rebuild(name, version, **kwargs) + resp = await service.plugs.rebuild(name, version, **kwargs) check_type( resp, Union[ @@ -1045,20 +1072,20 @@ async def test_rebuild_without_types( kwargs = { "query": { + "scaleToZero": True, "comment": "comment_example", "dryRun": True, "async": True, "upgrade": "patch", "forceVersion": "force_version_example", "ignoreChecks": True, - "scaleToZero": True, "skipRebuild": True, }, } _rebuild_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.rebuild(name, version, **kwargs) + resp = await service.plugs.rebuild(name, version, **kwargs) check_type(resp, Model) @@ -1102,7 +1129,7 @@ async def test_remove_version( _remove_version_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.remove_version(name, version, **kwargs) + resp = await service.plugs.remove_version(name, version, **kwargs) check_type( resp, Union[ @@ -1136,7 +1163,7 @@ async def test_remove_version_without_types( _remove_version_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.remove_version(name, version, **kwargs) + resp = await service.plugs.remove_version(name, version, **kwargs) check_type(resp, Model) @@ -1174,7 +1201,7 @@ async def test_remove_versions( ), } _remove_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.plug_functions.remove_versions(name, **kwargs) + resp = await service.plugs.remove_versions(name, **kwargs) check_type( resp, Union[ @@ -1204,7 +1231,7 @@ async def test_remove_versions_without_types( }, } _remove_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.plug_functions.remove_versions(name, **kwargs) + resp = await service.plugs.remove_versions(name, **kwargs) check_type(resp, Model) @@ -1241,9 +1268,12 @@ async def test_update_asset( kwargs = { # optionally use UpdateAssetQuery to validate and reuse parameters "query": UpdateAssetQuery( + scale_to_zero=False, + deploy=True, + chown=False, comment="comment_example", + author="author_example", var_async=True, - chown=False, ), "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, @@ -1255,7 +1285,7 @@ async def test_update_asset( quote(str(version)), quote(str(wildcard)), ) - resp = await service.plug_functions.update_asset(name, version, wildcard, **kwargs) + resp = await service.plugs.update_asset(name, version, wildcard, **kwargs) check_type( resp, Union[ @@ -1282,9 +1312,12 @@ async def test_update_asset_without_types( kwargs = { "query": { + "scaleToZero": False, + "deploy": True, + "chown": False, "comment": "comment_example", + "author": "author_example", "async": True, - "chown": False, }, "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, @@ -1296,7 +1329,7 @@ async def test_update_asset_without_types( quote(str(version)), quote(str(wildcard)), ) - resp = await service.plug_functions.update_asset(name, version, wildcard, **kwargs) + resp = await service.plugs.update_asset(name, version, wildcard, **kwargs) check_type(resp, Model) @@ -1331,9 +1364,12 @@ async def test_update_assets( kwargs = { # optionally use UpdateAssetsQuery to validate and reuse parameters "query": UpdateAssetsQuery( + scale_to_zero=False, + deploy=True, + chown=False, comment="comment_example", + author="author_example", var_async=True, - chown=False, ), "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, @@ -1345,7 +1381,7 @@ async def test_update_assets( _update_assets_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.update_assets(name, version, **kwargs) + resp = await service.plugs.update_assets(name, version, **kwargs) check_type( resp, Union[ @@ -1370,9 +1406,12 @@ async def test_update_assets_without_types( kwargs = { "query": { + "scaleToZero": False, + "deploy": True, + "chown": False, "comment": "comment_example", + "author": "author_example", "async": True, - "chown": False, }, "files": { "myFile1": b"...first file content...", @@ -1384,7 +1423,7 @@ async def test_update_assets_without_types( _update_assets_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.update_assets(name, version, **kwargs) + resp = await service.plugs.update_assets(name, version, **kwargs) check_type(resp, Model) @@ -1419,15 +1458,14 @@ async def test_verify( kwargs = { # optionally use VerifyQuery to validate and reuse parameters "query": VerifyQuery( - comment="comment_example", - var_async=True, scale_to_zero=True, + var_async=True, ), } _verify_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.verify(name, version, **kwargs) + resp = await service.plugs.verify(name, version, **kwargs) check_type( resp, Union[ @@ -1452,13 +1490,12 @@ async def test_verify_without_types( kwargs = { "query": { - "comment": "comment_example", - "async": True, "scaleToZero": True, + "async": True, }, } _verify_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.plug_functions.verify(name, version, **kwargs) + resp = await service.plugs.verify(name, version, **kwargs) check_type(resp, Model) diff --git a/test/api/webscript_functions_api_test.py b/test/api/webscripts_api_test.py similarity index 90% rename from test/api/webscript_functions_api_test.py rename to test/api/webscripts_api_test.py index 0db6296f..58f473a9 100644 --- a/test/api/webscript_functions_api_test.py +++ b/test/api/webscripts_api_test.py @@ -19,9 +19,12 @@ from typeguard import check_type from waylay.sdk import ApiClient, WaylayClient from waylay.sdk.api._models import Model -from waylay.services.registry.api import WebscriptFunctionsApi +from waylay.services.registry.api import WebscriptsApi from waylay.services.registry.service import RegistryService +from ..types.create_webscripts_copy_parameter_stub import ( + CreateWebscriptsCopyParameterStub, +) from ..types.function_meta_stub import FunctionMetaStub from ..types.get_webscript_response_v2_stub import GetWebscriptResponseV2Stub from ..types.jobs_for_webscript_response_v2_stub import JobsForWebscriptResponseV2Stub @@ -58,7 +61,7 @@ VerifyWebscriptSyncResponseV2, WebscriptVersionsResponseV2, ) - from waylay.services.registry.queries.webscript_functions_api import ( + from waylay.services.registry.queries.webscripts_api import ( CreateQuery, DeleteAssetQuery, GetArchiveQuery, @@ -83,13 +86,13 @@ @pytest.fixture -def webscript_functions_api(waylay_api_client: ApiClient) -> WebscriptFunctionsApi: - return WebscriptFunctionsApi(waylay_api_client) +def webscripts_api(waylay_api_client: ApiClient) -> WebscriptsApi: + return WebscriptsApi(waylay_api_client) def test_registered(waylay_client: WaylayClient): - """Test that WebscriptFunctionsApi api is registered in the sdk client.""" - assert isinstance(waylay_client.registry.webscript_functions, WebscriptFunctionsApi) + """Test that WebscriptsApi api is registered in the sdk client.""" + assert isinstance(waylay_client.registry.webscripts, WebscriptsApi) def _create_set_mock_response(httpx_mock: HTTPXMock, gateway_url: str): @@ -115,14 +118,20 @@ async def test_create( kwargs = { # optionally use CreateQuery to validate and reuse parameters "query": CreateQuery( + deploy=True, + author="author_example", + comment="comment_example", + scale_to_zero=False, deprecate_previous="none", dry_run=True, var_async=True, - scale_to_zero=False, version=SemanticVersionRangeStub.create_json(), name="name_example", draft=False, + runtime="runtime_example", + copy_from=CreateWebscriptsCopyParameterStub.create_json(), ), + "json": None, "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, "files": { @@ -131,7 +140,7 @@ async def test_create( }, } _create_set_mock_response(httpx_mock, gateway_url) - resp = await service.webscript_functions.create(**kwargs) + resp = await service.webscripts.create(**kwargs) check_type( resp, Union[ @@ -152,23 +161,29 @@ async def test_create_without_types( # set path params kwargs = { "query": { + "deploy": True, + "author": "author_example", + "comment": "comment_example", + "scaleToZero": False, "deprecatePrevious": "none", "dryRun": True, "async": True, - "scaleToZero": False, "version": SemanticVersionRangeStub.create_json(), "name": "name_example", "draft": False, + "runtime": "runtime_example", + "copy": CreateWebscriptsCopyParameterStub.create_json(), }, "files": { "myFile1": b"...first file content...", "myFile2": b"...second file content...", }, + "json": None, "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, } _create_set_mock_response(httpx_mock, gateway_url) - resp = await service.webscript_functions.create(**kwargs) + resp = await service.webscripts.create(**kwargs) check_type(resp, Model) @@ -205,9 +220,12 @@ async def test_delete_asset( kwargs = { # optionally use DeleteAssetQuery to validate and reuse parameters "query": DeleteAssetQuery( + scale_to_zero=False, + deploy=True, + chown=False, comment="comment_example", + author="author_example", var_async=True, - chown=False, ), } _delete_asset_set_mock_response( @@ -217,9 +235,7 @@ async def test_delete_asset( quote(str(version)), quote(str(wildcard)), ) - resp = await service.webscript_functions.delete_asset( - name, version, wildcard, **kwargs - ) + resp = await service.webscripts.delete_asset(name, version, wildcard, **kwargs) check_type( resp, Union[ @@ -246,9 +262,12 @@ async def test_delete_asset_without_types( kwargs = { "query": { + "scaleToZero": False, + "deploy": True, + "chown": False, "comment": "comment_example", + "author": "author_example", "async": True, - "chown": False, }, } _delete_asset_set_mock_response( @@ -258,9 +277,7 @@ async def test_delete_asset_without_types( quote(str(version)), quote(str(wildcard)), ) - resp = await service.webscript_functions.delete_asset( - name, version, wildcard, **kwargs - ) + resp = await service.webscripts.delete_asset(name, version, wildcard, **kwargs) check_type(resp, Model) @@ -301,7 +318,7 @@ async def test_get_archive( _get_archive_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.get_archive(name, version, **kwargs) + resp = await service.webscripts.get_archive(name, version, **kwargs) check_type(resp, bytes) @@ -326,7 +343,7 @@ async def test_get_archive_without_types( _get_archive_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.get_archive(name, version, **kwargs) + resp = await service.webscripts.get_archive(name, version, **kwargs) check_type(resp, bytes) @@ -373,9 +390,7 @@ async def test_get_asset( quote(str(version)), quote(str(wildcard)), ) - resp = await service.webscript_functions.get_asset( - name, version, wildcard, **kwargs - ) + resp = await service.webscripts.get_asset(name, version, wildcard, **kwargs) check_type(resp, bytes) @@ -406,9 +421,7 @@ async def test_get_asset_without_types( quote(str(version)), quote(str(wildcard)), ) - resp = await service.webscript_functions.get_asset( - name, version, wildcard, **kwargs - ) + resp = await service.webscripts.get_asset(name, version, wildcard, **kwargs) check_type(resp, bytes) @@ -442,7 +455,7 @@ async def test_get_latest( ), } _get_latest_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.webscript_functions.get_latest(name, **kwargs) + resp = await service.webscripts.get_latest(name, **kwargs) check_type(resp, Union[GetWebscriptResponseV2,]) @@ -464,7 +477,7 @@ async def test_get_latest_without_types( }, } _get_latest_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.webscript_functions.get_latest(name, **kwargs) + resp = await service.webscripts.get_latest(name, **kwargs) check_type(resp, Model) @@ -498,7 +511,7 @@ async def test_get(service: RegistryService, gateway_url: str, httpx_mock: HTTPX _get_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.get(name, version, **kwargs) + resp = await service.webscripts.get(name, version, **kwargs) check_type(resp, Union[GetWebscriptResponseV2,]) @@ -519,7 +532,7 @@ async def test_get_without_types( _get_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.get(name, version, **kwargs) + resp = await service.webscripts.get(name, version, **kwargs) check_type(resp, Model) @@ -563,7 +576,7 @@ async def test_jobs(service: RegistryService, gateway_url: str, httpx_mock: HTTP _jobs_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.jobs(name, version, **kwargs) + resp = await service.webscripts.jobs(name, version, **kwargs) check_type(resp, Union[JobsForWebscriptResponseV2,]) @@ -593,7 +606,7 @@ async def test_jobs_without_types( _jobs_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.jobs(name, version, **kwargs) + resp = await service.webscripts.jobs(name, version, **kwargs) check_type(resp, Model) @@ -644,7 +657,7 @@ async def test_list_versions( ), } _list_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.webscript_functions.list_versions(name, **kwargs) + resp = await service.webscripts.list_versions(name, **kwargs) check_type(resp, Union[WebscriptVersionsResponseV2,]) @@ -679,7 +692,7 @@ async def test_list_versions_without_types( }, } _list_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.webscript_functions.list_versions(name, **kwargs) + resp = await service.webscripts.list_versions(name, **kwargs) check_type(resp, Model) @@ -724,10 +737,11 @@ async def test_list(service: RegistryService, gateway_url: str, httpx_mock: HTTP archive_format=[], runtime=[], latest=True, + show_related="embed", ), } _list_set_mock_response(httpx_mock, gateway_url) - resp = await service.webscript_functions.list(**kwargs) + resp = await service.webscripts.list(**kwargs) check_type(resp, Union[LatestWebscriptsResponseV2,]) @@ -762,10 +776,11 @@ async def test_list_without_types( "archiveFormat": [], "runtime": [], "latest": True, + "showRelated": "embed", }, } _list_set_mock_response(httpx_mock, gateway_url) - resp = await service.webscript_functions.list(**kwargs) + resp = await service.webscripts.list(**kwargs) check_type(resp, Model) @@ -807,7 +822,7 @@ async def test_patch_metadata( _patch_metadata_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.patch_metadata(name, version, **kwargs) + resp = await service.webscripts.patch_metadata(name, version, **kwargs) check_type(resp, Union[GetWebscriptResponseV2,]) @@ -833,7 +848,7 @@ async def test_patch_metadata_without_types( _patch_metadata_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.patch_metadata(name, version, **kwargs) + resp = await service.webscripts.patch_metadata(name, version, **kwargs) check_type(resp, Model) @@ -868,7 +883,9 @@ async def test_publish( kwargs = { # optionally use PublishQuery to validate and reuse parameters "query": PublishQuery( + chown=False, comment="comment_example", + author="author_example", deprecate_previous="none", var_async=True, ), @@ -876,7 +893,7 @@ async def test_publish( _publish_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.publish(name, version, **kwargs) + resp = await service.webscripts.publish(name, version, **kwargs) check_type( resp, Union[ @@ -901,7 +918,9 @@ async def test_publish_without_types( kwargs = { "query": { + "chown": False, "comment": "comment_example", + "author": "author_example", "deprecatePrevious": "none", "async": True, }, @@ -909,7 +928,7 @@ async def test_publish_without_types( _publish_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.publish(name, version, **kwargs) + resp = await service.webscripts.publish(name, version, **kwargs) check_type(resp, Model) @@ -944,20 +963,20 @@ async def test_rebuild( kwargs = { # optionally use RebuildQuery to validate and reuse parameters "query": RebuildQuery( + scale_to_zero=True, comment="comment_example", dry_run=True, var_async=True, upgrade="patch", force_version="force_version_example", ignore_checks=True, - scale_to_zero=True, skip_rebuild=True, ), } _rebuild_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.rebuild(name, version, **kwargs) + resp = await service.webscripts.rebuild(name, version, **kwargs) check_type( resp, Union[ @@ -982,20 +1001,20 @@ async def test_rebuild_without_types( kwargs = { "query": { + "scaleToZero": True, "comment": "comment_example", "dryRun": True, "async": True, "upgrade": "patch", "forceVersion": "force_version_example", "ignoreChecks": True, - "scaleToZero": True, "skipRebuild": True, }, } _rebuild_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.rebuild(name, version, **kwargs) + resp = await service.webscripts.rebuild(name, version, **kwargs) check_type(resp, Model) @@ -1039,7 +1058,7 @@ async def test_remove_version( _remove_version_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.remove_version(name, version, **kwargs) + resp = await service.webscripts.remove_version(name, version, **kwargs) check_type( resp, Union[ @@ -1073,7 +1092,7 @@ async def test_remove_version_without_types( _remove_version_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.remove_version(name, version, **kwargs) + resp = await service.webscripts.remove_version(name, version, **kwargs) check_type(resp, Model) @@ -1111,7 +1130,7 @@ async def test_remove_versions( ), } _remove_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.webscript_functions.remove_versions(name, **kwargs) + resp = await service.webscripts.remove_versions(name, **kwargs) check_type( resp, Union[ @@ -1141,7 +1160,7 @@ async def test_remove_versions_without_types( }, } _remove_versions_set_mock_response(httpx_mock, gateway_url, quote(str(name))) - resp = await service.webscript_functions.remove_versions(name, **kwargs) + resp = await service.webscripts.remove_versions(name, **kwargs) check_type(resp, Model) @@ -1178,9 +1197,12 @@ async def test_update_asset( kwargs = { # optionally use UpdateAssetQuery to validate and reuse parameters "query": UpdateAssetQuery( + scale_to_zero=False, + deploy=True, + chown=False, comment="comment_example", + author="author_example", var_async=True, - chown=False, ), "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, @@ -1192,9 +1214,7 @@ async def test_update_asset( quote(str(version)), quote(str(wildcard)), ) - resp = await service.webscript_functions.update_asset( - name, version, wildcard, **kwargs - ) + resp = await service.webscripts.update_asset(name, version, wildcard, **kwargs) check_type( resp, Union[ @@ -1221,9 +1241,12 @@ async def test_update_asset_without_types( kwargs = { "query": { + "scaleToZero": False, + "deploy": True, + "chown": False, "comment": "comment_example", + "author": "author_example", "async": True, - "chown": False, }, "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, @@ -1235,9 +1258,7 @@ async def test_update_asset_without_types( quote(str(version)), quote(str(wildcard)), ) - resp = await service.webscript_functions.update_asset( - name, version, wildcard, **kwargs - ) + resp = await service.webscripts.update_asset(name, version, wildcard, **kwargs) check_type(resp, Model) @@ -1272,9 +1293,12 @@ async def test_update_assets( kwargs = { # optionally use UpdateAssetsQuery to validate and reuse parameters "query": UpdateAssetsQuery( + scale_to_zero=False, + deploy=True, + chown=False, comment="comment_example", + author="author_example", var_async=True, - chown=False, ), "content": b"some_binary_content", "headers": {"content-type": "application/octet-stream"}, @@ -1286,7 +1310,7 @@ async def test_update_assets( _update_assets_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.update_assets(name, version, **kwargs) + resp = await service.webscripts.update_assets(name, version, **kwargs) check_type( resp, Union[ @@ -1311,9 +1335,12 @@ async def test_update_assets_without_types( kwargs = { "query": { + "scaleToZero": False, + "deploy": True, + "chown": False, "comment": "comment_example", + "author": "author_example", "async": True, - "chown": False, }, "files": { "myFile1": b"...first file content...", @@ -1325,7 +1352,7 @@ async def test_update_assets_without_types( _update_assets_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.update_assets(name, version, **kwargs) + resp = await service.webscripts.update_assets(name, version, **kwargs) check_type(resp, Model) @@ -1360,15 +1387,14 @@ async def test_verify( kwargs = { # optionally use VerifyQuery to validate and reuse parameters "query": VerifyQuery( - comment="comment_example", - var_async=True, scale_to_zero=True, + var_async=True, ), } _verify_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.verify(name, version, **kwargs) + resp = await service.webscripts.verify(name, version, **kwargs) check_type( resp, Union[ @@ -1393,13 +1419,12 @@ async def test_verify_without_types( kwargs = { "query": { - "comment": "comment_example", - "async": True, "scaleToZero": True, + "async": True, }, } _verify_set_mock_response( httpx_mock, gateway_url, quote(str(name)), quote(str(version)) ) - resp = await service.webscript_functions.verify(name, version, **kwargs) + resp = await service.webscripts.verify(name, version, **kwargs) check_type(resp, Model) diff --git a/test/openapi.py b/test/openapi.py index 7dd97240..412886e2 100644 --- a/test/openapi.py +++ b/test/openapi.py @@ -75,37 +75,87 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"ActiveEventSSE_event": _active_event_sse_event_model_schema}) -_alt_version_hal_link_model_schema = json.loads( +_alt_embedded_version_i_kfserving_response_v2__model_schema = json.loads( r"""{ + "title" : "AltEmbeddedVersion_IKfservingResponseV2_", "type" : "object", "properties" : { "draft" : { - "$ref" : "#/components/schemas/GetPlugResponseV2__links_draft" + "$ref" : "#/components/schemas/KfservingResponseV2" }, "published" : { - "$ref" : "#/components/schemas/GetPlugResponseV2__links_published" + "$ref" : "#/components/schemas/KfservingResponseV2" } - } + }, + "description" : "Embedded representations of the _latest_ draft/published versions." } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"AltVersionHALLink": _alt_version_hal_link_model_schema}) +MODEL_DEFINITIONS.update({ + "AltEmbeddedVersion_IKfservingResponseV2_": _alt_embedded_version_i_kfserving_response_v2__model_schema +}) -_any_function_response_model_schema = json.loads( +_alt_embedded_version_i_plug_response_v2__model_schema = json.loads( r"""{ - "anyOf" : [ { - "$ref" : "#/components/schemas/PlugResponseV2" - }, { - "$ref" : "#/components/schemas/KfservingResponseV2" - }, { - "$ref" : "#/components/schemas/WebscriptResponseV2" - } ] + "title" : "AltEmbeddedVersion_IPlugResponseV2_", + "type" : "object", + "properties" : { + "draft" : { + "$ref" : "#/components/schemas/PlugResponseV2" + }, + "published" : { + "$ref" : "#/components/schemas/PlugResponseV2" + } + }, + "description" : "Embedded representations of the _latest_ draft/published versions." +} +""", + object_hook=with_example_provider, +) +MODEL_DEFINITIONS.update({ + "AltEmbeddedVersion_IPlugResponseV2_": _alt_embedded_version_i_plug_response_v2__model_schema +}) + +_alt_embedded_version_i_webscript_response_with_invoke_link_v2__model_schema = ( + json.loads( + r"""{ + "title" : "AltEmbeddedVersion_IWebscriptResponseWithInvokeLinkV2_", + "type" : "object", + "properties" : { + "draft" : { + "$ref" : "#/components/schemas/WebscriptResponseWithInvokeLinkV2" + }, + "published" : { + "$ref" : "#/components/schemas/WebscriptResponseWithInvokeLinkV2" + } + }, + "description" : "Embedded representations of the _latest_ draft/published versions." +} +""", + object_hook=with_example_provider, + ) +) +MODEL_DEFINITIONS.update({ + "AltEmbeddedVersion_IWebscriptResponseWithInvokeLinkV2_": _alt_embedded_version_i_webscript_response_with_invoke_link_v2__model_schema +}) + +_alt_version_hal_link_model_schema = json.loads( + r"""{ + "type" : "object", + "properties" : { + "draft" : { + "$ref" : "#/components/schemas/GetPlugResponseV2__links_draft" + }, + "published" : { + "$ref" : "#/components/schemas/GetPlugResponseV2__links_published" + } + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"AnyFunctionResponse": _any_function_response_model_schema}) +MODEL_DEFINITIONS.update({"AltVersionHALLink": _alt_version_hal_link_model_schema}) _any_job_for_function_model_schema = json.loads( r"""{ @@ -144,6 +194,8 @@ def with_example_provider(dct): "$ref" : "#/components/schemas/BatchResult" }, { "$ref" : "#/components/schemas/CleanupResult" + }, { + "$ref" : "#/components/schemas/NotifyResult" } ] } """, @@ -195,7 +247,6 @@ def with_example_provider(dct): _archive_format_model_schema = json.loads( r"""{ - "title" : "ArchiveFormat", "type" : "string", "enum" : [ "node", "python", "golang", "byoml", "native" ] } @@ -296,26 +347,8 @@ def with_example_provider(dct): "AssetCondition_pattern": _asset_condition_pattern_model_schema }) -_asset_path_params_v2_model_schema = json.loads( - r"""{ - "required" : [ "*" ], - "type" : "object", - "properties" : { - "*" : { - "type" : "string", - "description" : "Full path or path prefix of the asset within the archive" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"AssetPathParamsV2": _asset_path_params_v2_model_schema}) - _asset_role_model_schema = json.loads( r"""{ - "title" : "AssetRole", "type" : "string", "description" : "Classification of assets with regard to their role.", "enum" : [ "manifest", "project", "main", "lib", "script", "other" ] @@ -325,31 +358,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"AssetRole": _asset_role_model_schema}) -_asset_summary_model_schema = json.loads( - r"""{ - "required" : [ "name" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "File name" - }, - "title" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "role" : { - "$ref" : "#/components/schemas/AssetRole" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"AssetSummary": _asset_summary_model_schema}) - _asset_summary_with_hal_link_model_schema = json.loads( r"""{ "title" : "AssetSummaryWithHALLink", @@ -429,124 +437,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"AssetsConditions": _assets_conditions_model_schema}) -_async_deploy_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "deprecatePrevious" : { - "$ref" : "#/components/schemas/DeprecatePreviousPolicy" - }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, validates the deployment conditions, but does not change anything." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "scaleToZero" : { - "type" : "boolean", - "description" : "If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately.", - "default" : false - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"AsyncDeployQuery": _async_deploy_query_model_schema}) - -_async_deploy_query_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "scaleToZero" : { - "type" : "boolean", - "description" : "If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately.", - "default" : false - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, validates the deployment conditions, but does not change anything." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"AsyncDeployQueryV1": _async_deploy_query_v1_model_schema}) - -_async_query_default_false_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "async" : { - "type" : "boolean", - "description" : "If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - "default" : false - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "AsyncQueryDefaultFalse": _async_query_default_false_model_schema -}) - -_async_query_default_true_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "AsyncQueryDefaultTrue": _async_query_default_true_model_schema -}) - -_async_verify_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "scaleToZero" : { - "type" : "boolean", - "description" : "Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"AsyncVerifyQuery": _async_verify_query_model_schema}) - _batch_model_schema = json.loads( r"""{ "title" : "Batch", @@ -790,7 +680,7 @@ def with_example_provider(dct): _build_args_model_schema = json.loads( r"""{ "title" : "BuildArgs", - "required" : [ "args", "imageName", "runtimeName", "runtimeVersion", "storageLocation" ], + "required" : [ "args", "imageName", "revision", "runtimeName", "runtimeVersion", "storageLocation" ], "type" : "object", "properties" : { "runtimeName" : { @@ -1026,13 +916,13 @@ def with_example_provider(dct): _completed_event_data_model_schema = json.loads( r"""{ "title" : "CompletedEventData", - "required" : [ "returnValue" ], + "required" : [ "returnvalue" ], "type" : "object", "properties" : { "prev" : { "$ref" : "#/components/schemas/QueueEvents" }, - "returnValue" : { + "returnvalue" : { "$ref" : "#/components/schemas/AnyJobResult" } } @@ -1075,23 +965,6 @@ def with_example_provider(dct): "CompletedEventSSE_event": _completed_event_sse_event_model_schema }) -_content_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "ls" : { - "type" : "boolean", - "description" : "If set to `true`, the result will be a listing of the files in the asset, annotated with metadata and validation report from the asset conditions of the functions runtime.", - "default" : false - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"ContentQueryV2": _content_query_v2_model_schema}) - _content_validation_listing_model_schema = json.loads( r"""{ "required" : [ "assets" ], @@ -1113,158 +986,58 @@ def with_example_provider(dct): "ContentValidationListing": _content_validation_listing_model_schema }) -_create_function_query_v2_model_schema = json.loads( +_create_webscripts_copy_parameter_model_schema = json.loads( r"""{ - "type" : "object", - "properties" : { - "deprecatePrevious" : { - "$ref" : "#/components/schemas/DeprecatePreviousPolicy" - }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, validates the deployment conditions, but does not change anything." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "scaleToZero" : { - "type" : "boolean", - "description" : "If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately.", - "default" : false - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "name" : { - "type" : "string", - "description" : "If set, the value will be used as the function name instead of the one specified in the manifest." - }, - "draft" : { - "type" : "boolean", - "description" : "If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid.", - "default" : false - } - }, - "additionalProperties" : false + "anyOf" : [ { + "$ref" : "#/components/schemas/NamedVersionRange" + }, { + "$ref" : "#/components/schemas/ExampleReference" + } ] } """, object_hook=with_example_provider, ) MODEL_DEFINITIONS.update({ - "CreateFunctionQueryV2": _create_function_query_v2_model_schema + "create_webscripts_copy_parameter": _create_webscripts_copy_parameter_model_schema }) -_create_kf_serving_async_response_model_schema = json.loads( +_delayed_event_data_model_schema = json.loads( r"""{ - "required" : [ "_links", "entity", "message" ], + "title" : "DelayedEventData", + "required" : [ "delay" ], "type" : "object", "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "entity" : { - "$ref" : "#/components/schemas/KFServingManifest" + "delay" : { + "title" : "delay", + "type" : "number" } - }, - "description" : "Model Deployment Initiated" + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "CreateKFServingAsyncResponse": _create_kf_serving_async_response_model_schema -}) +MODEL_DEFINITIONS.update({"DelayedEventData": _delayed_event_data_model_schema}) -_create_plug_async_response_model_schema = json.loads( +_delayed_event_sse_model_schema = json.loads( r"""{ - "required" : [ "_links", "entity", "message" ], + "required" : [ "data", "event" ], "type" : "object", "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" + "event" : { + "$ref" : "#/components/schemas/DelayedEventSSE_event" }, - "entity" : { - "$ref" : "#/components/schemas/PlugManifest" + "data" : { + "$ref" : "#/components/schemas/JobEventResponse_DelayedEventData_" } }, - "description" : "Successful Response" + "description" : "A message that notifies a state change in a background job." } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "CreatePlugAsyncResponse": _create_plug_async_response_model_schema -}) +MODEL_DEFINITIONS.update({"DelayedEventSSE": _delayed_event_sse_model_schema}) -_create_webscript_async_response_model_schema = json.loads( - r"""{ - "required" : [ "_links", "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "entity" : { - "$ref" : "#/components/schemas/WebscriptManifest" - } - }, - "description" : "Successful Response" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "CreateWebscriptAsyncResponse": _create_webscript_async_response_model_schema -}) - -_delayed_event_data_model_schema = json.loads( - r"""{ - "title" : "DelayedEventData", - "required" : [ "delay" ], - "type" : "object", - "properties" : { - "delay" : { - "title" : "delay", - "type" : "number" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"DelayedEventData": _delayed_event_data_model_schema}) - -_delayed_event_sse_model_schema = json.loads( - r"""{ - "required" : [ "data", "event" ], - "type" : "object", - "properties" : { - "event" : { - "$ref" : "#/components/schemas/DelayedEventSSE_event" - }, - "data" : { - "$ref" : "#/components/schemas/JobEventResponse_DelayedEventData_" - } - }, - "description" : "A message that notifies a state change in a background job." -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"DelayedEventSSE": _delayed_event_sse_model_schema}) - -_delayed_event_sse_event_model_schema = json.loads( +_delayed_event_sse_event_model_schema = json.loads( r"""{ "title" : "DelayedEventSSE_event", "type" : "string", @@ -1380,7 +1153,7 @@ def with_example_provider(dct): _deploy_args_model_schema = json.loads( r"""{ "title" : "DeployArgs", - "required" : [ "deploySpecOverrides", "endpoint", "imageName", "namespace", "runtimeName", "runtimeVersion" ], + "required" : [ "deploySpecOverrides", "endpoint", "imageName", "namespace", "revision", "runtimeName", "runtimeVersion" ], "type" : "object", "properties" : { "namespace" : { @@ -1504,32 +1277,6 @@ def with_example_provider(dct): "DeployArgs_deploySpecOverrides": _deploy_args_deploy_spec_overrides_model_schema }) -_deploy_attributes_filter_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "endpoint" : { - "type" : "string", - "description" : "Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "imageName" : { - "type" : "string", - "description" : "Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "storageLocation" : { - "type" : "string", - "description" : "Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "DeployAttributesFilter": _deploy_attributes_filter_model_schema -}) - _deploy_job_status_model_schema = json.loads( r"""{ "required" : [ "createdAt", "createdBy", "job", "operation", "request", "state", "type" ], @@ -1703,7 +1450,6 @@ def with_example_provider(dct): _deprecate_previous_policy_model_schema = json.loads( r"""{ - "title" : "DeprecatePreviousPolicy", "type" : "string", "enum" : [ "none", "all", "patch", "minor" ] } @@ -1714,45 +1460,6 @@ def with_example_provider(dct): "DeprecatePreviousPolicy": _deprecate_previous_policy_model_schema }) -_deprecate_previous_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "deprecatePrevious" : { - "$ref" : "#/components/schemas/DeprecatePreviousPolicy" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "DeprecatePreviousQuery": _deprecate_previous_query_model_schema -}) - -_deprecated_draft_filter_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "DeprecatedDraftFilter": _deprecated_draft_filter_model_schema -}) - _documentation_model_schema = json.loads( r"""{ "type" : "object", @@ -1810,94 +1517,142 @@ def with_example_provider(dct): "DocumentationProperty": _documentation_property_model_schema }) -_dry_run_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, validates the deployment conditions, but does not change anything." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"DryRunQuery": _dry_run_query_model_schema}) - -_entity_response_model_schema = json.loads( +_entity_with_links_i_kfserving_response_v2__model_schema = json.loads( r"""{ - "required" : [ "createdAt", "createdBy", "metadata", "name", "runtime", "status", "updatedAt", "updatedBy", "version" ], + "title" : "EntityWithLinks_IKfservingResponseV2_", + "required" : [ "createdAt", "createdBy", "deprecated", "draft", "model", "runtime", "status", "updatedAt", "updatedBy", "updates" ], "type" : "object", "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" + "_embedded" : { + "$ref" : "#/components/schemas/AltEmbeddedVersion_IKfservingResponseV2_" }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" + "_links" : { + "$ref" : "#/components/schemas/AltVersionHALLink" }, "createdBy" : { + "title" : "createdBy", "type" : "string", "description" : "The user that created this entity." }, "createdAt" : { + "title" : "createdAt", "type" : "string", "description" : "The timestamp at which this entity was created.", "format" : "date-time" }, "updatedBy" : { + "title" : "updatedBy", "type" : "string", "description" : "The user that last updated this entity." }, "updatedAt" : { + "title" : "updatedAt", "type" : "string", "description" : "The timestamp at which this entity was last updated.", "format" : "date-time" }, + "updates" : { + "title" : "updates", + "type" : "array", + "description" : "The audit logs corresponding to the latest modifying operations on this entity.", + "items" : { + "$ref" : "#/components/schemas/UpdateRecord" + } + }, "status" : { "$ref" : "#/components/schemas/Status" }, "failureReason" : { "$ref" : "#/components/schemas/FailureReason" }, - "_links" : { - "type" : "array", - "description" : "Links to related entities.", - "items" : { - "$ref" : "#/components/schemas/JobHALLinks" - } + "runtime" : { + "$ref" : "#/components/schemas/RuntimeAttributes" + }, + "deprecated" : { + "title" : "deprecated", + "type" : "boolean", + "description" : "If true this function is deprecated and removed from regular listings." + }, + "draft" : { + "title" : "draft", + "type" : "boolean", + "description" : "If true this function is a draft function and it's assets are still mutable." + }, + "model" : { + "$ref" : "#/components/schemas/KFServingManifest" } } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"EntityResponse": _entity_response_model_schema}) +MODEL_DEFINITIONS.update({ + "EntityWithLinks_IKfservingResponseV2_": _entity_with_links_i_kfserving_response_v2__model_schema +}) -_error_and_status_response_model_schema = json.loads( +_entity_with_links_i_plug_response_v2__model_schema = json.loads( r"""{ - "required" : [ "error", "statusCode" ], + "title" : "EntityWithLinks_IPlugResponseV2_", + "required" : [ "createdAt", "createdBy", "deprecated", "draft", "plug", "runtime", "status", "updatedAt", "updatedBy", "updates" ], "type" : "object", "properties" : { - "error" : { - "type" : "string" + "_embedded" : { + "$ref" : "#/components/schemas/AltEmbeddedVersion_IPlugResponseV2_" }, - "statusCode" : { - "type" : "number" + "_links" : { + "$ref" : "#/components/schemas/AltVersionHALLink" + }, + "createdBy" : { + "title" : "createdBy", + "type" : "string", + "description" : "The user that created this entity." + }, + "createdAt" : { + "title" : "createdAt", + "type" : "string", + "description" : "The timestamp at which this entity was created.", + "format" : "date-time" + }, + "updatedBy" : { + "title" : "updatedBy", + "type" : "string", + "description" : "The user that last updated this entity." + }, + "updatedAt" : { + "title" : "updatedAt", + "type" : "string", + "description" : "The timestamp at which this entity was last updated.", + "format" : "date-time" + }, + "updates" : { + "title" : "updates", + "type" : "array", + "description" : "The audit logs corresponding to the latest modifying operations on this entity.", + "items" : { + "$ref" : "#/components/schemas/UpdateRecord" + } + }, + "status" : { + "$ref" : "#/components/schemas/Status" + }, + "failureReason" : { + "$ref" : "#/components/schemas/FailureReason" + }, + "runtime" : { + "$ref" : "#/components/schemas/RuntimeAttributes" + }, + "deprecated" : { + "title" : "deprecated", + "type" : "boolean", + "description" : "If true this plug is removed from regular listings, as a result of a DELETE with force=false." + }, + "draft" : { + "title" : "draft", + "type" : "boolean", + "description" : "If true this function is a draft function and it's assets are still mutable." + }, + "plug" : { + "$ref" : "#/components/schemas/PlugManifest" } } } @@ -1905,86 +1660,116 @@ def with_example_provider(dct): object_hook=with_example_provider, ) MODEL_DEFINITIONS.update({ - "ErrorAndStatusResponse": _error_and_status_response_model_schema + "EntityWithLinks_IPlugResponseV2_": _entity_with_links_i_plug_response_v2__model_schema }) -_error_response_model_schema = json.loads( +_entity_with_links_i_webscript_response_with_invoke_link_v2__model_schema = json.loads( r"""{ - "required" : [ "error" ], + "title" : "EntityWithLinks_IWebscriptResponseWithInvokeLinkV2_", + "required" : [ "createdAt", "createdBy", "deprecated", "draft", "runtime", "status", "updatedAt", "updatedBy", "updates", "webscript" ], "type" : "object", "properties" : { - "error" : { - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"ErrorResponse": _error_response_model_schema}) - -_event_ack_model_schema = json.loads( - r"""{ - "type" : "string", - "enum" : [ "ack" ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"EventAck": _event_ack_model_schema}) - -_event_close_model_schema = json.loads( - r"""{ - "type" : "string", - "enum" : [ "close" ] -} -""", - object_hook=with_example_provider, + "_embedded" : { + "$ref" : "#/components/schemas/AltEmbeddedVersion_IWebscriptResponseWithInvokeLinkV2_" + }, + "_links" : { + "$ref" : "#/components/schemas/InvokeHALLink" + }, + "createdBy" : { + "title" : "createdBy", + "type" : "string", + "description" : "The user that created this entity." + }, + "createdAt" : { + "title" : "createdAt", + "type" : "string", + "description" : "The timestamp at which this entity was created.", + "format" : "date-time" + }, + "updatedBy" : { + "title" : "updatedBy", + "type" : "string", + "description" : "The user that last updated this entity." + }, + "updatedAt" : { + "title" : "updatedAt", + "type" : "string", + "description" : "The timestamp at which this entity was last updated.", + "format" : "date-time" + }, + "updates" : { + "title" : "updates", + "type" : "array", + "description" : "The audit logs corresponding to the latest modifying operations on this entity.", + "items" : { + "$ref" : "#/components/schemas/UpdateRecord" + } + }, + "status" : { + "$ref" : "#/components/schemas/Status" + }, + "failureReason" : { + "$ref" : "#/components/schemas/FailureReason" + }, + "runtime" : { + "$ref" : "#/components/schemas/RuntimeAttributes" + }, + "deprecated" : { + "title" : "deprecated", + "type" : "boolean", + "description" : "If true this function is deprecated and removed from regular listings." + }, + "draft" : { + "title" : "draft", + "type" : "boolean", + "description" : "If true this function is a draft function and it's assets are still mutable." + }, + "webscript" : { + "$ref" : "#/components/schemas/WebscriptManifest" + }, + "secret" : { + "title" : "secret", + "type" : "string", + "description" : "The secret for this webscript deployment. This is null when allowHmac=false in the webscript specificaton." + } + } +} +""", + object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"EventClose": _event_close_model_schema}) +MODEL_DEFINITIONS.update({ + "EntityWithLinks_IWebscriptResponseWithInvokeLinkV2_": _entity_with_links_i_webscript_response_with_invoke_link_v2__model_schema +}) -_event_keep_alive_model_schema = json.loads( +_event_ack_model_schema = json.loads( r"""{ "type" : "string", - "enum" : [ "keep-alive" ] + "enum" : [ "ack" ] } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"EventKeepAlive": _event_keep_alive_model_schema}) +MODEL_DEFINITIONS.update({"EventAck": _event_ack_model_schema}) -_event_sse_model_schema = json.loads( +_event_close_model_schema = json.loads( r"""{ - "description" : "SSE stream events without closing protocol", - "anyOf" : [ { - "$ref" : "#/components/schemas/Stream_Ready" - }, { - "$ref" : "#/components/schemas/JobEventSSE" - }, { - "$ref" : "#/components/schemas/KeepAliveEventSSE" - } ] + "type" : "string", + "enum" : [ "close" ] } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"EventSSE": _event_sse_model_schema}) +MODEL_DEFINITIONS.update({"EventClose": _event_close_model_schema}) -_event_type_sse_model_schema = json.loads( +_event_keep_alive_model_schema = json.loads( r"""{ - "anyOf" : [ { - "$ref" : "#/components/schemas/SupportedEvents" - }, { - "$ref" : "#/components/schemas/EventAck" - }, { - "$ref" : "#/components/schemas/EventClose" - }, { - "$ref" : "#/components/schemas/EventKeepAlive" - } ] + "type" : "string", + "enum" : [ "keep-alive" ] } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"EventTypeSSE": _event_type_sse_model_schema}) +MODEL_DEFINITIONS.update({"EventKeepAlive": _event_keep_alive_model_schema}) _event_with_close_sse_model_schema = json.loads( r"""{ @@ -2004,6 +1789,17 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"EventWithCloseSSE": _event_with_close_sse_model_schema}) +_example_reference_model_schema = json.loads( + r"""{ + "type" : "string", + "description" : "Example reference.\n\nReferences the example assets from the selected runtime.", + "enum" : [ "!example" ] +} +""", + object_hook=with_example_provider, +) +MODEL_DEFINITIONS.update({"ExampleReference": _example_reference_model_schema}) + _exposed_openfaas_deploy_spec_model_schema = json.loads( r"""{ "title" : "ExposedOpenfaasDeploySpec", @@ -2154,84 +1950,23 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"File_Upload": _file_upload_model_schema}) -_force_delete_query_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "async" : { - "type" : "boolean", - "description" : "If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - "default" : false - }, - "force" : { - "type" : "boolean", - "description" : "If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"ForceDeleteQueryV1": _force_delete_query_v1_model_schema}) - -_function_delete_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "force" : { - "type" : "boolean", - "description" : "If true, the function version will be immediately undeployed and removed.\n\nOtherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_." - }, - "undeploy" : { - "type" : "boolean", - "description" : "If `true`, the `DELETE` operation\n* undeploys the (openfaas) function: it becomes no longer available for invocation.\n* does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action.\n\nIf `false`, the `DELETE` operation\n* _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions.\n\nThis parameter is incompatible with `force=true`.\n\nIf not set the default behaviour applies:\n* _draft_ versions are _undeployed_ and _removed_ from registry.\n* non-_draft_ versions are marked _deprecated_ only." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"FunctionDeleteQuery": _function_delete_query_model_schema}) - -_function_deploy_overrides_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "FunctionDeployOverrides": _function_deploy_overrides_model_schema -}) - _function_deploy_overrides_type_model_schema = json.loads( r"""{ - "title" : "FunctionDeployOverridesType", "type" : "object", "properties" : { "envVars" : { - "title" : "envVars", "type" : "object", "additionalProperties" : { "type" : "string" } }, "labels" : { - "title" : "labels", "type" : "object", "additionalProperties" : { "type" : "string" } }, "annotations" : { - "title" : "annotations", "type" : "object", "additionalProperties" : { "type" : "string" @@ -2252,91 +1987,6 @@ def with_example_provider(dct): "FunctionDeployOverridesType": _function_deploy_overrides_type_model_schema }) -_function_entity_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Filter on function attributes that do not change across function versions." -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"FunctionEntityQuery": _function_entity_query_model_schema}) - -_function_job_args_model_schema = json.loads( - r"""{ - "required" : [ "runtimeName", "runtimeVersion" ], - "type" : "object", - "properties" : { - "runtimeName" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "revision" : { - "type" : "string", - "description" : "The revision hash of the current (draft) function revision" - } - }, - "description" : "Job arguments shared by all function jobs" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"FunctionJobArgs": _function_job_args_model_schema}) - -_function_manifest_model_schema = json.loads( - r"""{ - "required" : [ "metadata", "name", "runtime", "version" ], - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"FunctionManifest": _function_manifest_model_schema}) - _function_meta_model_schema = json.loads( r"""{ "type" : "object", @@ -2365,25 +2015,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"FunctionMeta": _function_meta_model_schema}) -_function_name_version_model_schema = json.loads( - r"""{ - "required" : [ "name", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"FunctionNameVersion": _function_name_version_model_schema}) - _function_ref_model_schema = json.loads( r"""{ "title" : "FunctionRef", @@ -2416,28 +2047,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"FunctionRef": _function_ref_model_schema}) -_function_spec_model_schema = json.loads( - r"""{ - "required" : [ "name", "runtime", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"FunctionSpec": _function_spec_model_schema}) - _function_type_model_schema = json.loads( r"""{ "type" : "string", @@ -2449,115 +2058,9 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"FunctionType": _function_type_model_schema}) -_function_version_query_model_schema = json.loads( +_get_model_response_v2_model_schema = json.loads( r"""{ - "type" : "object", - "properties" : { - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - } - }, - "additionalProperties" : false, - "description" : "Filter on function attributes that can change across function versions. When these query parameters are used, the query is considered a _function version_ listing and no HAL links to latest (_draft_, _published_) versions are included." -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"FunctionVersionQuery": _function_version_query_model_schema}) - -_get_content_params_v2_model_schema = json.loads( - r"""{ - "required" : [ "*", "name", "version" ], - "type" : "object", - "properties" : { - "*" : { - "type" : "string", - "description" : "Full path or path prefix of the asset within the archive" - }, - "name" : { - "type" : "string", - "description" : "The name of the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"GetContentParamsV2": _get_content_params_v2_model_schema}) - -_get_invokable_webscript_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "status" : { - "type" : "array", - "description" : "If set, filters on the `status` of the webscript.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - }, - "default" : [ "running", "deployed", "unhealthy" ] - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "GetInvokableWebscriptQuery": _get_invokable_webscript_query_model_schema -}) - -_get_model_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "_links", "entity" ], + "required" : [ "_links", "entity" ], "type" : "object", "properties" : { "entity" : { @@ -2685,128 +2188,6 @@ def with_example_provider(dct): "GetPlugResponseV2__links_published": _get_plug_response_v2__links_published_model_schema }) -_get_runtime_by_name_and_version_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : true - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "GetRuntimeByNameAndVersionQuery": _get_runtime_by_name_and_version_query_model_schema -}) - -_get_runtime_by_name_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : false - }, - "functionType" : { - "type" : "array", - "description" : "If set, filters on the functionType of a runtime. Uses an exact match.", - "example" : "plugs", - "items" : { - "$ref" : "#/components/schemas/FunctionType" - } - }, - "archiveFormat" : { - "type" : "array", - "description" : "If set, filters on the archiveFormat of a runtime. Uses an exact match.", - "example" : "node", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "GetRuntimeByNameQuery": _get_runtime_by_name_query_model_schema -}) - -_get_runtime_example_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "ls" : { - "type" : "boolean", - "description" : "If set to `true`, the result will be a listing of the files in the asset, annotated with metadata and validation report from the asset conditions of the functions runtime.", - "default" : false - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : true - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "GetRuntimeExampleQuery": _get_runtime_example_query_model_schema -}) - -_get_runtime_versions_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "latest" : { - "$ref" : "#/components/schemas/LatestVersionLevel" - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : false - }, - "functionType" : { - "type" : "array", - "description" : "If set, filters on the functionType of a runtime. Uses an exact match.", - "example" : "plugs", - "items" : { - "$ref" : "#/components/schemas/FunctionType" - } - }, - "archiveFormat" : { - "type" : "array", - "description" : "If set, filters on the archiveFormat of a runtime. Uses an exact match.", - "example" : "node", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "GetRuntimeVersionsQuery": _get_runtime_versions_query_model_schema -}) - _get_webscript_response_v2_model_schema = json.loads( r"""{ "required" : [ "_links", "entity" ], @@ -2866,86 +2247,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"HALLink": _hal_link_model_schema}) -_invokable_webscript_response_model_schema = json.loads( - r"""{ - "required" : [ "_links", "entity" ], - "type" : "object", - "properties" : { - "entity" : { - "$ref" : "#/components/schemas/InvokableWebscriptResponse_entity" - }, - "_links" : { - "$ref" : "#/components/schemas/InvokeInternalHALLink" - } - }, - "description" : "Webscript Found" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "InvokableWebscriptResponse": _invokable_webscript_response_model_schema -}) - -_invokable_webscript_response_entity_model_schema = json.loads( - r"""{ - "title" : "InvokableWebscriptResponse_entity", - "required" : [ "draft", "status", "webscript" ], - "type" : "object", - "properties" : { - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "draft" : { - "title" : "draft", - "type" : "boolean" - }, - "webscript" : { - "$ref" : "#/components/schemas/InvokableWebscriptResponse_entity_webscript" - }, - "secret" : { - "title" : "secret", - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "InvokableWebscriptResponse_entity": _invokable_webscript_response_entity_model_schema -}) - -_invokable_webscript_response_entity_webscript_model_schema = json.loads( - r"""{ - "title" : "InvokableWebscriptResponse_entity_webscript", - "required" : [ "allowHmac", "name", "private", "version" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "private" : { - "title" : "private", - "type" : "boolean" - }, - "allowHmac" : { - "title" : "allowHmac", - "type" : "boolean" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "InvokableWebscriptResponse_entity_webscript": _invokable_webscript_response_entity_webscript_model_schema -}) - _invoke_hal_link_model_schema = json.loads( r"""{ "title" : "InvokeHALLink", @@ -2961,23 +2262,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"InvokeHALLink": _invoke_hal_link_model_schema}) -_invoke_internal_hal_link_model_schema = json.loads( - r"""{ - "title" : "InvokeInternalHALLink", - "type" : "object", - "properties" : { - "invoke-internal" : { - "$ref" : "#/components/schemas/HALLink" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "InvokeInternalHALLink": _invoke_internal_hal_link_model_schema -}) - _job_and_function_hal_link_model_schema = json.loads( r"""{ "title" : "JobAndFunctionHALLink", @@ -3040,7 +2324,6 @@ def with_example_provider(dct): _job_causes_model_schema = json.loads( r"""{ - "title" : "JobCauses", "type" : "object", "properties" : { "build" : { @@ -3066,11 +2349,15 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"JobCauses": _job_causes_model_schema}) -_job_event_payload_active_event_data__model_schema = json.loads( +_job_event_response_active_event_data__model_schema = json.loads( r"""{ - "required" : [ "data", "job", "timestamp" ], + "title" : "JobEventResponse_ActiveEventData_", + "required" : [ "_links", "data", "function", "job", "timestamp" ], "type" : "object", "properties" : { + "_links" : { + "$ref" : "#/components/schemas/JobStatusAndEntityHALLinks" + }, "job" : { "$ref" : "#/components/schemas/JobReference" }, @@ -3078,170 +2365,16 @@ def with_example_provider(dct): "$ref" : "#/components/schemas/ActiveEventData" }, "timestamp" : { + "title" : "timestamp", "type" : "string", "description" : "Timestamp of the event", "format" : "date-time" + }, + "function" : { + "$ref" : "#/components/schemas/FunctionRef" } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "JobEventPayload_ActiveEventData_": _job_event_payload_active_event_data__model_schema -}) - -_job_event_payload_completed_event_data__model_schema = json.loads( - r"""{ - "required" : [ "data", "job", "timestamp" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/JobReference" - }, - "data" : { - "$ref" : "#/components/schemas/CompletedEventData" - }, - "timestamp" : { - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "JobEventPayload_CompletedEventData_": _job_event_payload_completed_event_data__model_schema -}) - -_job_event_payload_delayed_event_data__model_schema = json.loads( - r"""{ - "required" : [ "data", "job", "timestamp" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/JobReference" - }, - "data" : { - "$ref" : "#/components/schemas/DelayedEventData" - }, - "timestamp" : { - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "JobEventPayload_DelayedEventData_": _job_event_payload_delayed_event_data__model_schema -}) - -_job_event_payload_failed_event_data__model_schema = json.loads( - r"""{ - "required" : [ "data", "job", "timestamp" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/JobReference" - }, - "data" : { - "$ref" : "#/components/schemas/FailedEventData" - }, - "timestamp" : { - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "JobEventPayload_FailedEventData_": _job_event_payload_failed_event_data__model_schema -}) - -_job_event_payload_waiting_children_event_data__model_schema = json.loads( - r"""{ - "required" : [ "data", "job", "timestamp" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/JobReference" - }, - "data" : { - "$ref" : "#/components/schemas/WaitingChildrenEventData" - }, - "timestamp" : { - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "JobEventPayload_WaitingChildrenEventData_": _job_event_payload_waiting_children_event_data__model_schema -}) - -_job_event_payload_waiting_event_data__model_schema = json.loads( - r"""{ - "required" : [ "data", "job", "timestamp" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/JobReference" - }, - "data" : { - "$ref" : "#/components/schemas/WaitingEventData" - }, - "timestamp" : { - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "JobEventPayload_WaitingEventData_": _job_event_payload_waiting_event_data__model_schema -}) - -_job_event_response_active_event_data__model_schema = json.loads( - r"""{ - "title" : "JobEventResponse_ActiveEventData_", - "required" : [ "_links", "data", "function", "job", "timestamp" ], - "type" : "object", - "properties" : { - "_links" : { - "$ref" : "#/components/schemas/JobStatusAndEntityHALLinks" - }, - "job" : { - "$ref" : "#/components/schemas/JobReference" - }, - "data" : { - "$ref" : "#/components/schemas/ActiveEventData" - }, - "timestamp" : { - "title" : "timestamp", - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" - }, - "function" : { - "$ref" : "#/components/schemas/FunctionRef" - } - }, - "description" : "Event object describing a state change of a background job." + }, + "description" : "Event object describing a state change of a background job." } """, object_hook=with_example_provider, @@ -3462,31 +2595,6 @@ def with_example_provider(dct): "JobEventsAndFunctionHALLink": _job_events_and_function_hal_link_model_schema }) -_job_events_filter_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/JobType" - }, - "id" : { - "type" : "string", - "description" : "The id of the job." - }, - "children" : { - "type" : "boolean", - "description" : "If set to true, the event stream will include events of the job's dependants. E.g., when subscribing to a verify job with `children=true`, you will also receive the events of the underlying build and deploy jobs. Defaults to false." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "JobEventsFilterQuery": _job_events_filter_query_model_schema -}) - _job_events_hal_link_model_schema = json.loads( r"""{ "type" : "object", @@ -3504,7 +2612,6 @@ def with_example_provider(dct): _job_hal_links_model_schema = json.loads( r"""{ - "title" : "JobHALLinks", "type" : "object", "properties" : { "event" : { @@ -3521,50 +2628,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"JobHALLinks": _job_hal_links_model_schema}) -_job_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "type" : { - "type" : "array", - "description" : "Filter on job type", - "items" : { - "$ref" : "#/components/schemas/JobTypeSchema" - } - }, - "state" : { - "type" : "array", - "description" : "Filter on job state", - "items" : { - "$ref" : "#/components/schemas/JobStateResult" - } - }, - "functionType" : { - "type" : "array", - "description" : "Filter on function type", - "items" : { - "$ref" : "#/components/schemas/FunctionType" - } - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"JobQuery": _job_query_model_schema}) - _job_reference_model_schema = json.loads( r"""{ "title" : "JobReference", @@ -3585,25 +2648,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"JobReference": _job_reference_model_schema}) -_job_reference_params_model_schema = json.loads( - r"""{ - "required" : [ "id", "type" ], - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/JobType" - }, - "id" : { - "type" : "string" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"JobReferenceParams": _job_reference_params_model_schema}) - _job_response_model_schema = json.loads( r"""{ "required" : [ "_links", "job" ], @@ -3709,7 +2753,6 @@ def with_example_provider(dct): _job_state_result_model_schema = json.loads( r"""{ - "title" : "JobStateResult", "description" : "All reported job states", "anyOf" : [ { "$ref" : "#/components/schemas/JobState" @@ -3859,29 +2902,10 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"JobStatus_progress": _job_status_progress_model_schema}) -_job_submitted_response_model_schema = json.loads( - r"""{ - "required" : [ "_links", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"JobSubmittedResponse": _job_submitted_response_model_schema}) - _job_type_model_schema = json.loads( r"""{ - "title" : "JobType", "type" : "string", - "enum" : [ "build", "deploy", "verify", "undeploy", "batch", "scale", "cleanup", "other" ] + "enum" : [ "build", "deploy", "verify", "undeploy", "batch", "scale", "cleanup", "notify" ] } """, object_hook=with_example_provider, @@ -3924,6 +2948,18 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"JobTypeDeploy": _job_type_deploy_model_schema}) +_job_type_notify_model_schema = json.loads( + r"""{ + "title" : "JobTypeNotify", + "type" : "string", + "description" : "A job to notify that an function version has changed.", + "enum" : [ "notify" ] +} +""", + object_hook=with_example_provider, +) +MODEL_DEFINITIONS.update({"JobTypeNotify": _job_type_notify_model_schema}) + _job_type_scale_model_schema = json.loads( r"""{ "title" : "JobTypeScale", @@ -3938,7 +2974,6 @@ def with_example_provider(dct): _job_type_schema_model_schema = json.loads( r"""{ - "title" : "JobTypeSchema", "anyOf" : [ { "$ref" : "#/components/schemas/JobTypeBuild" }, { @@ -3951,6 +2986,8 @@ def with_example_provider(dct): "$ref" : "#/components/schemas/JobTypeScale" }, { "$ref" : "#/components/schemas/JobTypeBatch" + }, { + "$ref" : "#/components/schemas/JobTypeNotify" } ] } """, @@ -4123,20 +3160,6 @@ def with_example_provider(dct): "JobsForWebscriptResponseV2__links": _jobs_for_webscript_response_v2__links_model_schema }) -_jobs_hal_link_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "jobs" : { - "$ref" : "#/components/schemas/HALLink" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"JobsHALLink": _jobs_hal_link_model_schema}) - _jobs_response_model_schema = json.loads( r"""{ "required" : [ "jobs" ], @@ -4161,4944 +3184,1266 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"JobsResponse": _jobs_response_model_schema}) -_kf_serving_delete_multiple_response_model_schema = json.loads( +_kf_serving_manifest_model_schema = json.loads( r"""{ - "required" : [ "name", "versions" ], + "title" : "KFServingManifest", + "required" : [ "metadata", "name", "runtime", "version" ], "type" : "object", "properties" : { + "deploy" : { + "$ref" : "#/components/schemas/FunctionDeployOverridesType" + }, "name" : { - "type" : "string" + "title" : "name", + "type" : "string", + "description" : "The logical name for the function." }, - "versions" : { - "type" : "array", - "items" : { - "type" : "string" - } + "version" : { + "$ref" : "#/components/schemas/SemanticVersion" + }, + "runtime" : { + "$ref" : "#/components/schemas/Runtime" + }, + "runtimeVersion" : { + "$ref" : "#/components/schemas/SemanticVersionRange" + }, + "metadata" : { + "$ref" : "#/components/schemas/FunctionMeta" } - }, - "description" : "Models Deleted" + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "KFServingDeleteMultipleResponse": _kf_serving_delete_multiple_response_model_schema -}) +MODEL_DEFINITIONS.update({"KFServingManifest": _kf_serving_manifest_model_schema}) -_kf_serving_delete_multiple_with_job_response_model_schema = json.loads( +_keep_alive_event_sse_model_schema = json.loads( r"""{ - "required" : [ "_links", "message", "name", "versions" ], + "required" : [ "event" ], "type" : "object", "properties" : { - "name" : { - "type" : "string" - }, - "versions" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "message" : { - "type" : "string" + "event" : { + "$ref" : "#/components/schemas/EventKeepAlive" }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" + "data" : { + "type" : "string", + "description" : "A text message acknowledging that events will be forwarded." } }, - "description" : "Model Deletions Initiated" + "description" : "A message that acknowledges that the stream is still alive." } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "KFServingDeleteMultipleWithJobResponse": _kf_serving_delete_multiple_with_job_response_model_schema -}) +MODEL_DEFINITIONS.update({"KeepAliveEventSSE": _keep_alive_event_sse_model_schema}) -_kf_serving_delete_query_v1_model_schema = json.loads( +_kfserving_response_v2_model_schema = json.loads( r"""{ + "required" : [ "createdAt", "createdBy", "deprecated", "draft", "model", "runtime", "status", "updatedAt", "updatedBy", "updates" ], "type" : "object", "properties" : { - "async" : { - "type" : "boolean", - "description" : "If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - "default" : false - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "version" : { + "createdBy" : { "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" + "description" : "The user that created this entity." }, - "createdBy" : { + "createdAt" : { "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" + "description" : "The timestamp at which this entity was created.", + "format" : "date-time" }, "updatedBy" : { "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" + "description" : "The user that last updated this entity." }, - "name" : { + "updatedAt" : { "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." + "description" : "The timestamp at which this entity was last updated.", + "format" : "date-time" }, - "archiveFormat" : { + "updates" : { "type" : "array", - "description" : "Filter on the archive format of the function.", + "description" : "The audit logs corresponding to the latest modifying operations on this entity.", "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" + "$ref" : "#/components/schemas/UpdateRecord" } }, + "status" : { + "$ref" : "#/components/schemas/Status" + }, + "failureReason" : { + "$ref" : "#/components/schemas/FailureReason" + }, "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } + "$ref" : "#/components/schemas/RuntimeAttributes" + }, + "deprecated" : { + "type" : "boolean", + "description" : "If true this function is deprecated and removed from regular listings." + }, + "draft" : { + "type" : "boolean", + "description" : "If true this function is a draft function and it's assets are still mutable." + }, + "model" : { + "$ref" : "#/components/schemas/KFServingManifest" } - }, - "additionalProperties" : false + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "KFServingDeleteQueryV1": _kf_serving_delete_query_v1_model_schema -}) +MODEL_DEFINITIONS.update({"KfservingResponseV2": _kfserving_response_v2_model_schema}) -_kf_serving_delete_query_v2_model_schema = json.loads( +_language_release_model_schema = json.loads( r"""{ + "title" : "LanguageRelease", + "required" : [ "name", "title", "version" ], "type" : "object", "properties" : { - "comment" : { + "name" : { + "title" : "name", "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." + "description" : "Short technical name of the language or framework used." }, - "force" : { - "type" : "boolean", - "description" : "If true, the function version will be immediately undeployed and removed.\n\nOtherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_." + "version" : { + "title" : "version", + "type" : "string", + "description" : "Release version of the language or framework." }, - "undeploy" : { - "type" : "boolean", - "description" : "If `true`, the `DELETE` operation\n* undeploys the (openfaas) function: it becomes no longer available for invocation.\n* does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action.\n\nIf `false`, the `DELETE` operation\n* _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions.\n\nThis parameter is incompatible with `force=true`.\n\nIf not set the default behaviour applies:\n* _draft_ versions are _undeployed_ and _removed_ from registry.\n* non-_draft_ versions are marked _deprecated_ only." + "title" : { + "title" : "title", + "type" : "string", + "description" : "Display title." }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true + "description" : { + "title" : "description", + "type" : "string" } }, - "additionalProperties" : false + "description" : "Description of the language or framework release used by a runtime (version)." } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "KFServingDeleteQueryV2": _kf_serving_delete_query_v2_model_schema -}) +MODEL_DEFINITIONS.update({"LanguageRelease": _language_release_model_schema}) -_kf_serving_delete_response_model_schema = json.loads( +_latest_models_response_v2_model_schema = json.loads( r"""{ - "required" : [ "name", "version" ], + "required" : [ "count", "entities" ], "type" : "object", "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the function." + "limit" : { + "type" : "number", + "description" : "The page size used for this query result." }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" + "count" : { + "type" : "number", + "description" : "The total count of matching items, from which this result is one page." + }, + "page" : { + "type" : "number", + "description" : "The page number of a paged query result." + }, + "entities" : { + "type" : "array", + "description" : "The specification and deployment status of the queried functions", + "items" : { + "$ref" : "#/components/schemas/EntityWithLinks_IKfservingResponseV2_" + } } }, - "description" : "Model Deleted" + "description" : "Models Found" } """, object_hook=with_example_provider, ) MODEL_DEFINITIONS.update({ - "KFServingDeleteResponse": _kf_serving_delete_response_model_schema + "LatestModelsResponseV2": _latest_models_response_v2_model_schema }) -_kf_serving_delete_with_job_response_model_schema = json.loads( +_latest_plugs_response_v2_model_schema = json.loads( r"""{ - "required" : [ "_links", "message", "name", "version" ], + "required" : [ "count", "entities" ], "type" : "object", "properties" : { - "message" : { - "type" : "string" + "limit" : { + "type" : "number", + "description" : "The page size used for this query result." }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" + "count" : { + "type" : "number", + "description" : "The total count of matching items, from which this result is one page." }, - "name" : { - "type" : "string", - "description" : "The name of the function." + "page" : { + "type" : "number", + "description" : "The page number of a paged query result." }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" + "entities" : { + "type" : "array", + "description" : "The specification and deployment status of the queried functions", + "items" : { + "$ref" : "#/components/schemas/EntityWithLinks_IPlugResponseV2_" + } } }, - "description" : "Model Delete Initiated" + "description" : "Plugs Found" } """, object_hook=with_example_provider, ) MODEL_DEFINITIONS.update({ - "KFServingDeleteWithJobResponse": _kf_serving_delete_with_job_response_model_schema + "LatestPlugsResponseV2": _latest_plugs_response_v2_model_schema }) -_kf_serving_latest_version_query_v2_model_schema = json.loads( +_latest_version_level_model_schema = json.loads( r"""{ - "type" : "object", - "properties" : { - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - } - }, - "additionalProperties" : false, - "description" : "Named Model latest version query." + "type" : "string", + "description" : "Level of latest versions that should be included.", + "enum" : [ "major", "minor", "patch", "true", "false" ] } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "KFServingLatestVersionQueryV2": _kf_serving_latest_version_query_v2_model_schema -}) +MODEL_DEFINITIONS.update({"LatestVersionLevel": _latest_version_level_model_schema}) -_kf_serving_latest_versions_query_v1_model_schema = json.loads( +_latest_webscripts_response_v2_model_schema = json.loads( r"""{ + "required" : [ "count", "entities" ], "type" : "object", "properties" : { "limit" : { - "minimum" : 0, "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." + "description" : "The page size used for this query result." }, - "page" : { - "minimum" : 0, + "count" : { "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." + "description" : "The total count of matching items, from which this result is one page." }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } + "page" : { + "type" : "number", + "description" : "The page number of a paged query result." }, - "runtime" : { + "entities" : { "type" : "array", - "description" : "Filter on the runtime of the function.", + "description" : "The specification and deployment status of the queried functions", "items" : { - "$ref" : "#/components/schemas/Runtime" + "$ref" : "#/components/schemas/EntityWithLinks_IWebscriptResponseWithInvokeLinkV2_" } } }, - "additionalProperties" : false, - "description" : "Model listing query" + "description" : "Webscripts Found" } """, object_hook=with_example_provider, ) MODEL_DEFINITIONS.update({ - "KFServingLatestVersionsQueryV1": _kf_serving_latest_versions_query_v1_model_schema + "LatestWebscriptsResponseV2": _latest_webscripts_response_v2_model_schema }) -_kf_serving_latest_versions_query_v2_model_schema = json.loads( +_model_model_schema = json.loads( r"""{ - "description" : "Latest model versions listing query.", - "anyOf" : [ { - "$ref" : "#/components/schemas/LatestFunctionVersionsQuery" - }, { - "$ref" : "#/components/schemas/LatestFunctionsQuery" - } ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "KFServingLatestVersionsQueryV2": _kf_serving_latest_versions_query_v2_model_schema -}) - -_kf_serving_manifest_model_schema = json.loads( - r"""{ - "title" : "KFServingManifest", - "required" : [ "metadata", "name", "runtime", "version" ], + "title" : "Model", + "required" : [ "model" ], "type" : "object", "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "title" : "name", - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" + "event" : { + "$ref" : "#/components/schemas/HALLink" }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" + "model" : { + "$ref" : "#/components/schemas/HALLink" } } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"KFServingManifest": _kf_serving_manifest_model_schema}) +MODEL_DEFINITIONS.update({"Model": _model_model_schema}) -_kf_serving_models_response_model_schema = json.loads( +_model_1_model_schema = json.loads( r"""{ - "required" : [ "models" ], + "title" : "Model", + "required" : [ "model" ], "type" : "object", "properties" : { - "models" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/KFServingResponse" - } + "event" : { + "$ref" : "#/components/schemas/HALLink" + }, + "job" : { + "$ref" : "#/components/schemas/HALLink" }, - "paging" : { - "$ref" : "#/components/schemas/PagingResponse" + "model" : { + "$ref" : "#/components/schemas/HALLink" } - }, - "description" : "Successful Response" + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "KFServingModelsResponse": _kf_serving_models_response_model_schema -}) +MODEL_DEFINITIONS.update({"Model_1": _model_1_model_schema}) -_kf_serving_response_model_schema = json.loads( +_model_2_model_schema = json.loads( r"""{ - "required" : [ "createdAt", "createdBy", "metadata", "name", "runtime", "status", "updatedAt", "updatedBy", "version" ], + "title" : "Model", + "required" : [ "model" ], "type" : "object", "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - }, - "createdBy" : { - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" + "job" : { + "$ref" : "#/components/schemas/HALLink" }, - "_links" : { - "type" : "array", - "description" : "Links to related entities.", - "items" : { - "$ref" : "#/components/schemas/JobHALLinks" - } + "model" : { + "$ref" : "#/components/schemas/HALLink" } - }, - "description" : "Successful Response" + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"KFServingResponse": _kf_serving_response_model_schema}) +MODEL_DEFINITIONS.update({"Model_2": _model_2_model_schema}) -_kf_serving_versions_query_v1_model_schema = json.loads( +_model_versions_response_v2_model_schema = json.loads( r"""{ + "required" : [ "count", "entities" ], "type" : "object", "properties" : { "limit" : { - "minimum" : 0, "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." + "description" : "The page size used for this query result." }, - "page" : { - "minimum" : 0, + "count" : { "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." + "description" : "The total count of matching items, from which this result is one page." }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } + "page" : { + "type" : "number", + "description" : "The page number of a paged query result." }, - "runtime" : { + "entities" : { "type" : "array", - "description" : "Filter on the runtime of the function.", + "description" : "The specification and deployment status of the queried functions", "items" : { - "$ref" : "#/components/schemas/Runtime" + "$ref" : "#/components/schemas/KfservingResponseV2" } } }, - "additionalProperties" : false, - "description" : "Named model versions query" + "description" : "Model Versions Found" } """, object_hook=with_example_provider, ) MODEL_DEFINITIONS.update({ - "KFServingVersionsQueryV1": _kf_serving_versions_query_v1_model_schema + "ModelVersionsResponseV2": _model_versions_response_v2_model_schema }) -_keep_alive_event_sse_model_schema = json.loads( +_notify_result_model_schema = json.loads( r"""{ - "required" : [ "event" ], + "title" : "NotifyResult", + "required" : [ "operation" ], "type" : "object", "properties" : { - "event" : { - "$ref" : "#/components/schemas/EventKeepAlive" - }, - "data" : { - "type" : "string", - "description" : "A text message acknowledging that events will be forwarded." + "operation" : { + "$ref" : "#/components/schemas/RequestOperation" } }, - "description" : "A message that acknowledges that the stream is still alive." + "description" : "The result data for a change notification." } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"KeepAliveEventSSE": _keep_alive_event_sse_model_schema}) +MODEL_DEFINITIONS.update({"NotifyResult": _notify_result_model_schema}) -_kfserving_response_v2_model_schema = json.loads( +_parent_keys_model_schema = json.loads( r"""{ - "required" : [ "createdAt", "createdBy", "deprecated", "draft", "model", "runtime", "status", "updatedAt", "updatedBy", "updates" ], + "title" : "ParentKeys", + "required" : [ "id" ], "type" : "object", "properties" : { - "createdBy" : { - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "updates" : { - "type" : "array", - "description" : "The audit logs corresponding to the latest modifying operations on this entity.", - "items" : { - "$ref" : "#/components/schemas/UpdateRecord" - } - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "runtime" : { - "$ref" : "#/components/schemas/RuntimeAttributes" - }, - "deprecated" : { - "type" : "boolean", - "description" : "If true this function is deprecated and removed from regular listings." - }, - "draft" : { - "type" : "boolean", - "description" : "If true this function is a draft function and it's assets are still mutable." - }, - "model" : { - "$ref" : "#/components/schemas/KFServingManifest" + "id" : { + "title" : "id", + "type" : "string" } } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"KfservingResponseV2": _kfserving_response_v2_model_schema}) +MODEL_DEFINITIONS.update({"ParentKeys": _parent_keys_model_schema}) -_language_release_model_schema = json.loads( +_plug_model_schema = json.loads( r"""{ - "title" : "LanguageRelease", - "required" : [ "name", "title", "version" ], + "title" : "Plug", + "required" : [ "plug" ], "type" : "object", "properties" : { - "name" : { - "title" : "name", - "type" : "string", - "description" : "Short technical name of the language or framework used." - }, - "version" : { - "title" : "version", - "type" : "string", - "description" : "Release version of the language or framework." - }, - "title" : { - "title" : "title", - "type" : "string", - "description" : "Display title." + "event" : { + "$ref" : "#/components/schemas/HALLink" }, - "description" : { - "title" : "description", - "type" : "string" + "plug" : { + "$ref" : "#/components/schemas/HALLink" } - }, - "description" : "Description of the language or framework release used by a runtime (version)." + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"LanguageRelease": _language_release_model_schema}) +MODEL_DEFINITIONS.update({"Plug": _plug_model_schema}) -_latest_function_versions_query_model_schema = json.loads( +_plug_1_model_schema = json.loads( r"""{ - "type" : "object", + "title" : "Plug", + "required" : [ "plug" ], + "type" : "object", "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "nameVersion" : { - "type" : "array", - "description" : "Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - "items" : { - "$ref" : "#/components/schemas/NamedVersion" - } - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } + "event" : { + "$ref" : "#/components/schemas/HALLink" }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } + "job" : { + "$ref" : "#/components/schemas/HALLink" }, - "latest" : { - "type" : "boolean", - "description" : "When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter." + "plug" : { + "$ref" : "#/components/schemas/HALLink" } - }, - "additionalProperties" : false, - "description" : "Latest function versions listing query." + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "LatestFunctionVersionsQuery": _latest_function_versions_query_model_schema -}) +MODEL_DEFINITIONS.update({"Plug_1": _plug_1_model_schema}) -_latest_functions_query_model_schema = json.loads( +_plug_2_model_schema = json.loads( r"""{ + "title" : "Plug", + "required" : [ "plug" ], "type" : "object", "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } + "job" : { + "$ref" : "#/components/schemas/HALLink" }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } + "plug" : { + "$ref" : "#/components/schemas/HALLink" } - }, - "additionalProperties" : false, - "description" : "Request to list latest function versions per named function. A request that only uses these query parameters will include links to the _latest_ draft/published versions." + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"LatestFunctionsQuery": _latest_functions_query_model_schema}) +MODEL_DEFINITIONS.update({"Plug_2": _plug_2_model_schema}) -_latest_models_response_v2_model_schema = json.loads( +_plug_interface_model_schema = json.loads( r"""{ - "required" : [ "count", "entities" ], + "title" : "PlugInterface", "type" : "object", "properties" : { - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." + "states" : { + "title" : "states", + "type" : "array", + "description" : "The states of a plug as implemented in the plug code.", + "items" : { + "type" : "string" + } }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." + "input" : { + "title" : "input", + "type" : "array", + "description" : "The named input parameters of a plug", + "items" : { + "$ref" : "#/components/schemas/PlugProperty" + } }, - "entities" : { + "output" : { + "title" : "output", "type" : "array", - "description" : "The specification and deployment status of the queried functions", + "description" : "The named output parameters of a plug", "items" : { - "$ref" : "#/components/schemas/LatestModelsResponseV2_entities_inner" + "$ref" : "#/components/schemas/PlugProperty" } } - }, - "description" : "Models Found" + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "LatestModelsResponseV2": _latest_models_response_v2_model_schema -}) +MODEL_DEFINITIONS.update({"PlugInterface": _plug_interface_model_schema}) -_latest_models_response_v2_entities_inner_model_schema = json.loads( +_plug_manifest_model_schema = json.loads( r"""{ - "title" : "LatestModelsResponseV2_entities_inner", - "required" : [ "_links", "createdAt", "createdBy", "deprecated", "draft", "model", "runtime", "status", "updatedAt", "updatedBy", "updates" ], + "title" : "PlugManifest", + "required" : [ "interface", "metadata", "name", "runtime", "type", "version" ], "type" : "object", "properties" : { - "_links" : { - "$ref" : "#/components/schemas/AltVersionHALLink" - }, - "createdBy" : { - "title" : "createdBy", - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "title" : "createdAt", - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "title" : "updatedBy", - "type" : "string", - "description" : "The user that last updated this entity." + "deploy" : { + "$ref" : "#/components/schemas/FunctionDeployOverridesType" }, - "updatedAt" : { - "title" : "updatedAt", + "name" : { + "title" : "name", "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "updates" : { - "title" : "updates", - "type" : "array", - "description" : "The audit logs corresponding to the latest modifying operations on this entity.", - "items" : { - "$ref" : "#/components/schemas/UpdateRecord" - } - }, - "status" : { - "$ref" : "#/components/schemas/Status" + "description" : "The logical name for the function." }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" + "version" : { + "$ref" : "#/components/schemas/SemanticVersion" }, "runtime" : { - "$ref" : "#/components/schemas/RuntimeAttributes" + "$ref" : "#/components/schemas/Runtime" }, - "deprecated" : { - "title" : "deprecated", - "type" : "boolean", - "description" : "If true this function is deprecated and removed from regular listings." + "runtimeVersion" : { + "$ref" : "#/components/schemas/SemanticVersionRange" }, - "draft" : { - "title" : "draft", - "type" : "boolean", - "description" : "If true this function is a draft function and it's assets are still mutable." + "metadata" : { + "$ref" : "#/components/schemas/PlugMeta" }, - "model" : { - "$ref" : "#/components/schemas/KFServingManifest" + "type" : { + "$ref" : "#/components/schemas/PlugType" + }, + "interface" : { + "$ref" : "#/components/schemas/PlugInterface" } } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "LatestModelsResponseV2_entities_inner": _latest_models_response_v2_entities_inner_model_schema -}) +MODEL_DEFINITIONS.update({"PlugManifest": _plug_manifest_model_schema}) -_latest_plug_query_model_schema = json.loads( +_plug_meta_model_schema = json.loads( r"""{ - "required" : [ "type" ], + "title" : "PlugMeta", "type" : "object", "properties" : { - "tags" : { - "$ref" : "#/components/schemas/TagsFilter" - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." + "author" : { + "title" : "author", + "type" : "string", + "description" : "The author of the function." }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." + "description" : { + "title" : "description", + "type" : "string", + "description" : "A description of the function" }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." + "iconURL" : { + "title" : "iconURL", + "type" : "string", + "description" : "An url to an icon that represents this function." }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." + "category" : { + "title" : "category", + "type" : "string", + "description" : "A category for this function (Deprecated: use tags to categorise your functions)", + "deprecated" : true }, - "version" : { + "documentationURL" : { + "title" : "documentationURL", "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." + "description" : "External url that document this function." }, - "status" : { + "tags" : { + "title" : "tags", "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", + "description" : "Tags associated with this function.", + "example" : [ { + "name" : "awaiting-review", + "color" : "#4153ea" + }, { + "name" : "demo", + "color" : "#e639a4" + } ], "items" : { - "$ref" : "#/components/schemas/StatusFilter" + "$ref" : "#/components/schemas/Tag" } }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - }, - "type" : { - "$ref" : "#/components/schemas/PlugType" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"LatestPlugQuery": _latest_plug_query_model_schema}) - -_latest_plug_version_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/PlugType" - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - } - }, - "additionalProperties" : false, - "description" : "Latest named plug version listing query" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LatestPlugVersionQueryV2": _latest_plug_version_query_v2_model_schema -}) - -_latest_plug_versions_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "tags" : { - "$ref" : "#/components/schemas/TagsFilter" - }, - "type" : { - "$ref" : "#/components/schemas/PlugType" - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "nameVersion" : { - "type" : "array", - "description" : "Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - "items" : { - "$ref" : "#/components/schemas/NamedVersion" - } - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - }, - "latest" : { - "type" : "boolean", - "description" : "When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter." - } - }, - "additionalProperties" : false, - "description" : "Plug versions listing query." -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LatestPlugVersionsQuery": _latest_plug_versions_query_model_schema -}) - -_latest_plug_versions_query_v2_model_schema = json.loads( - r"""{ - "description" : "Latest plug versions listing query.", - "anyOf" : [ { - "$ref" : "#/components/schemas/LatestPlugVersionsQuery" - }, { - "$ref" : "#/components/schemas/LatestPlugsQuery" - } ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LatestPlugVersionsQueryV2": _latest_plug_versions_query_v2_model_schema -}) - -_latest_plugs_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/PlugType" - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Latest plug versions listing query with latest links. A request that only uses these query parameters will include links to the _latest_ draft/published versions of the plug." -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"LatestPlugsQuery": _latest_plugs_query_model_schema}) - -_latest_plugs_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "count", "entities" ], - "type" : "object", - "properties" : { - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." - }, - "entities" : { - "type" : "array", - "description" : "The specification and deployment status of the queried functions", - "items" : { - "$ref" : "#/components/schemas/LatestPlugsResponseV2_entities_inner" - } - } - }, - "description" : "Plugs Found" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LatestPlugsResponseV2": _latest_plugs_response_v2_model_schema -}) - -_latest_plugs_response_v2_entities_inner_model_schema = json.loads( - r"""{ - "title" : "LatestPlugsResponseV2_entities_inner", - "required" : [ "_links", "createdAt", "createdBy", "deprecated", "draft", "plug", "runtime", "status", "updatedAt", "updatedBy", "updates" ], - "type" : "object", - "properties" : { - "_links" : { - "$ref" : "#/components/schemas/AltVersionHALLink" - }, - "createdBy" : { - "title" : "createdBy", - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "title" : "createdAt", - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "title" : "updatedBy", - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "title" : "updatedAt", - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "updates" : { - "title" : "updates", - "type" : "array", - "description" : "The audit logs corresponding to the latest modifying operations on this entity.", - "items" : { - "$ref" : "#/components/schemas/UpdateRecord" - } - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "runtime" : { - "$ref" : "#/components/schemas/RuntimeAttributes" - }, - "deprecated" : { - "title" : "deprecated", - "type" : "boolean", - "description" : "If true this plug is removed from regular listings, as a result of a DELETE with force=false." - }, - "draft" : { - "title" : "draft", - "type" : "boolean", - "description" : "If true this function is a draft function and it's assets are still mutable." - }, - "plug" : { - "$ref" : "#/components/schemas/PlugManifest" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LatestPlugsResponseV2_entities_inner": _latest_plugs_response_v2_entities_inner_model_schema -}) - -_latest_version_level_model_schema = json.loads( - r"""{ - "title" : "LatestVersionLevel", - "type" : "string", - "description" : "Level of latest versions that should be included.", - "enum" : [ "major", "minor", "patch", "true", "false" ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"LatestVersionLevel": _latest_version_level_model_schema}) - -_latest_webscripts_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "count", "entities" ], - "type" : "object", - "properties" : { - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." - }, - "entities" : { - "type" : "array", - "description" : "The specification and deployment status of the queried functions", - "items" : { - "$ref" : "#/components/schemas/LatestWebscriptsResponseV2_entities_inner" - } - } - }, - "description" : "Webscripts Found" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LatestWebscriptsResponseV2": _latest_webscripts_response_v2_model_schema -}) - -_latest_webscripts_response_v2_entities_inner_model_schema = json.loads( - r"""{ - "title" : "LatestWebscriptsResponseV2_entities_inner", - "required" : [ "_links", "createdAt", "createdBy", "deprecated", "draft", "runtime", "status", "updatedAt", "updatedBy", "updates", "webscript" ], - "type" : "object", - "properties" : { - "_links" : { - "$ref" : "#/components/schemas/InvokeHALLink" - }, - "createdBy" : { - "title" : "createdBy", - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "title" : "createdAt", - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "title" : "updatedBy", - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "title" : "updatedAt", - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "updates" : { - "title" : "updates", - "type" : "array", - "description" : "The audit logs corresponding to the latest modifying operations on this entity.", - "items" : { - "$ref" : "#/components/schemas/UpdateRecord" - } - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "runtime" : { - "$ref" : "#/components/schemas/RuntimeAttributes" - }, - "deprecated" : { - "title" : "deprecated", - "type" : "boolean", - "description" : "If true this function is deprecated and removed from regular listings." - }, - "draft" : { - "title" : "draft", - "type" : "boolean", - "description" : "If true this function is a draft function and it's assets are still mutable." - }, - "webscript" : { - "$ref" : "#/components/schemas/WebscriptManifest" - }, - "secret" : { - "title" : "secret", - "type" : "string", - "description" : "The secret for this webscript deployment. This is null when allowHmac=false in the webscript specificaton." - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LatestWebscriptsResponseV2_entities_inner": _latest_webscripts_response_v2_entities_inner_model_schema -}) - -_legacy_configuration_object_model_schema = json.loads( - r"""{ - "title" : "LegacyConfigurationObject", - "required" : [ "name", "type" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string" - }, - "type" : { - "$ref" : "#/components/schemas/PlugPropertyDataType" - }, - "mandatory" : { - "title" : "mandatory", - "type" : "boolean" - }, - "format" : { - "$ref" : "#/components/schemas/LegacyConfigurationObject_format" - }, - "defaultValue" : { - "$ref" : "#/components/schemas/DefaultValue" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyConfigurationObject": _legacy_configuration_object_model_schema -}) - -_legacy_configuration_object_format_model_schema = json.loads( - r"""{ - "title" : "LegacyConfigurationObject_format", - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/PlugPropertyFormatType" - }, - "values" : { - "title" : "values", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/EnumValue" - } - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyConfigurationObject_format": _legacy_configuration_object_format_model_schema -}) - -_legacy_configuration_response_object_model_schema = json.loads( - r"""{ - "title" : "LegacyConfigurationResponseObject", - "required" : [ "name", "type" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string" - }, - "type" : { - "$ref" : "#/components/schemas/PlugPropertyDataType" - }, - "mandatory" : { - "title" : "mandatory", - "type" : "boolean" - }, - "format" : { - "$ref" : "#/components/schemas/LegacyConfigurationObject_format" - }, - "defaultValue" : { - "$ref" : "#/components/schemas/DefaultValue" - }, - "sensitive" : { - "title" : "sensitive", - "type" : "boolean" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyConfigurationResponseObject": _legacy_configuration_response_object_model_schema -}) - -_legacy_create_debug_response_model_schema = json.loads( - r"""{ - "required" : [ "functionName" ], - "type" : "object", - "properties" : { - "functionName" : { - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyCreateDebugResponse": _legacy_create_debug_response_model_schema -}) - -_legacy_debug_plug_manifest_model_schema = json.loads( - r"""{ - "required" : [ "metadata", "name", "runtime", "script", "tenant", "version" ], - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - }, - "tenant" : { - "$ref" : "#/components/schemas/TenantId" - }, - "dependencies" : { - "$ref" : "#/components/schemas/LegacyPlugDependencies" - }, - "script" : { - "type" : "string" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyDebugPlugManifest": _legacy_debug_plug_manifest_model_schema -}) - -_legacy_debug_plug_request_model_schema = json.loads( - r"""{ - "required" : [ "script" ], - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/PlugType" - }, - "script" : { - "type" : "string" - }, - "dependencies" : { - "$ref" : "#/components/schemas/LegacyPlugDependencies" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyDebugPlugRequest": _legacy_debug_plug_request_model_schema -}) - -_legacy_documentation_model_schema = json.loads( - r"""{ - "required" : [ "configuration", "rawData", "supportedStates" ], - "type" : "object", - "properties" : { - "supportedStates" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "configuration" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "rawData" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"LegacyDocumentation": _legacy_documentation_model_schema}) - -_legacy_documentation_request_model_schema = json.loads( - r"""{ - "required" : [ "configuration", "rawData", "supportedStates" ], - "type" : "object", - "properties" : { - "description" : { - "type" : "string" - }, - "supportedStates" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "configuration" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "rawData" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyDocumentationRequest": _legacy_documentation_request_model_schema -}) - -_legacy_function_meta_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "author" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "category" : { - "type" : "string" - }, - "tags" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "iconURL" : { - "type" : "string" - }, - "friendlyName" : { - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"LegacyFunctionMeta": _legacy_function_meta_model_schema}) - -_legacy_plug_create_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "async" : { - "type" : "boolean", - "description" : "If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - "default" : false - }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, only validates the incoming request." - }, - "scaleToZero" : { - "type" : "boolean", - "description" : "If set to true, scales the function to zero after successful deployment." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugCreateQuery": _legacy_plug_create_query_model_schema -}) - -_legacy_plug_create_request_model_schema = json.loads( - r"""{ - "required" : [ "metadata", "name", "script", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "script" : { - "type" : "string" - }, - "dependencies" : { - "$ref" : "#/components/schemas/LegacyPlugDependencies" - }, - "metadata" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata" - }, - "type" : { - "$ref" : "#/components/schemas/PlugType" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugCreateRequest": _legacy_plug_create_request_model_schema -}) - -_legacy_plug_create_response_model_schema = json.loads( - r"""{ - "required" : [ "entity", "statusCode", "uri" ], - "type" : "object", - "properties" : { - "statusCode" : { - "type" : "number" - }, - "uri" : { - "type" : "string" - }, - "entity" : { - "$ref" : "#/components/schemas/LegacyPlugScriptResponse" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugCreateResponse": _legacy_plug_create_response_model_schema -}) - -_legacy_plug_meta_request_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "author" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "category" : { - "type" : "string" - }, - "tags" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "iconURL" : { - "type" : "string" - }, - "friendlyName" : { - "type" : "string" - }, - "documentation" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_documentation" - }, - "documentationURL" : { - "type" : "string" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugMetaRequest": _legacy_plug_meta_request_model_schema -}) - -_legacy_plug_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "tags" : { - "$ref" : "#/components/schemas/TagsFilter" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"LegacyPlugQuery": _legacy_plug_query_model_schema}) - -_legacy_plug_request_model_schema = json.loads( - r"""{ - "required" : [ "metadata", "name", "script", "type", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "script" : { - "type" : "string" - }, - "dependencies" : { - "$ref" : "#/components/schemas/LegacyPlugDependencies" - }, - "metadata" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata" - }, - "type" : { - "$ref" : "#/components/schemas/PlugType" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"LegacyPlugRequest": _legacy_plug_request_model_schema}) - -_legacy_plug_request_metadata_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugRequest_metadata", - "type" : "object", - "properties" : { - "requiredProperties" : { - "$ref" : "#/components/schemas/LegacyRequiredProperties" - }, - "supportedStates" : { - "title" : "supportedStates", - "type" : "array", - "items" : { - "type" : "string" - } - }, - "rawData" : { - "title" : "rawData", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_rawData_inner" - } - }, - "configuration" : { - "$ref" : "#/components/schemas/LegacyConfiguration" - }, - "author" : { - "title" : "author", - "type" : "string" - }, - "description" : { - "title" : "description", - "type" : "string" - }, - "category" : { - "title" : "category", - "type" : "string" - }, - "tags" : { - "title" : "tags", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "iconURL" : { - "title" : "iconURL", - "type" : "string" - }, - "friendlyName" : { - "title" : "friendlyName", - "type" : "string" - }, - "documentation" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_documentation" - }, - "documentationURL" : { - "title" : "documentationURL", - "type" : "string" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugRequest_metadata": _legacy_plug_request_metadata_model_schema -}) - -_legacy_plug_request_metadata_documentation_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugRequest_metadata_documentation", - "anyOf" : [ { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_documentation_anyOf" - }, { - "$ref" : "#/components/schemas/Documentation" - } ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugRequest_metadata_documentation": _legacy_plug_request_metadata_documentation_model_schema -}) - -_legacy_plug_request_metadata_documentation_any_of_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "supportedStates" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "configuration" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "rawData" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugRequest_metadata_documentation_anyOf": _legacy_plug_request_metadata_documentation_any_of_model_schema -}) - -_legacy_plug_request_metadata_raw_data_inner_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugRequest_metadata_rawData_inner", - "required" : [ "parameter" ], - "type" : "object", - "properties" : { - "parameter" : { - "title" : "parameter", - "type" : "string" - }, - "dataType" : { - "$ref" : "#/components/schemas/PlugPropertyDataType" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugRequest_metadata_rawData_inner": _legacy_plug_request_metadata_raw_data_inner_model_schema -}) - -_legacy_plug_response_model_schema = json.loads( - r"""{ - "required" : [ "commands", "isDeprecated", "mediaType", "metadata", "name", "status", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "author" : { - "type" : "string" - }, - "category" : { - "type" : "string" - }, - "iconURL" : { - "type" : "string" - }, - "documentationURL" : { - "type" : "string" - }, - "isDeprecated" : { - "type" : "boolean" - }, - "description" : { - "type" : "string" - }, - "states" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "rawData" : { - "type" : "array", - "items" : { - "type" : "object" - } - }, - "mediaType" : { - "$ref" : "#/components/schemas/MediaType" - }, - "configuration" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LegacyConfigurationResponseObject" - } - }, - "commands" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "metadata" : { - "$ref" : "#/components/schemas/LegacyPlugResponse_metadata" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"LegacyPlugResponse": _legacy_plug_response_model_schema}) - -_legacy_plug_response_metadata_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugResponse_metadata", - "type" : "object", - "properties" : { - "documentation" : { - "$ref" : "#/components/schemas/LegacyDocumentation" - }, - "author" : { - "title" : "author", - "type" : "string" - }, - "description" : { - "title" : "description", - "type" : "string" - }, - "category" : { - "title" : "category", - "type" : "string" - }, - "tags" : { - "title" : "tags", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "iconURL" : { - "title" : "iconURL", - "type" : "string" - }, - "friendlyName" : { - "title" : "friendlyName", - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugResponse_metadata": _legacy_plug_response_metadata_model_schema -}) - -_legacy_plug_script_meta_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugScriptMeta", - "required" : [ "rawData", "supportedStates" ], - "type" : "object", - "properties" : { - "author" : { - "title" : "author", - "type" : "string" - }, - "description" : { - "title" : "description", - "type" : "string" - }, - "category" : { - "title" : "category", - "type" : "string" - }, - "tags" : { - "title" : "tags", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "iconURL" : { - "title" : "iconURL", - "type" : "string" - }, - "friendlyName" : { - "title" : "friendlyName", - "type" : "string" - }, - "supportedStates" : { - "title" : "supportedStates", - "type" : "array", - "items" : { - "type" : "string" - } - }, - "rawData" : { - "title" : "rawData", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LegacyPlugScriptMeta_rawData_inner" - } - }, - "requiredProperties" : { - "$ref" : "#/components/schemas/LegacyRequiredProperties" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugScriptMeta": _legacy_plug_script_meta_model_schema -}) - -_legacy_plug_script_meta_raw_data_inner_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugScriptMeta_rawData_inner", - "required" : [ "parameter" ], - "type" : "object", - "properties" : { - "parameter" : { - "title" : "parameter", - "type" : "string" - }, - "dataType" : { - "title" : "dataType", - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugScriptMeta_rawData_inner": _legacy_plug_script_meta_raw_data_inner_model_schema -}) - -_legacy_plug_script_response_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugScriptResponse", - "required" : [ "dependencies", "metadata", "name", "script", "type", "version" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "type" : { - "$ref" : "#/components/schemas/PlugType" - }, - "script" : { - "title" : "script", - "type" : "string" - }, - "metadata" : { - "$ref" : "#/components/schemas/LegacyPlugScriptMeta" - }, - "dependencies" : { - "title" : "dependencies", - "type" : "object" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyPlugScriptResponse": _legacy_plug_script_response_model_schema -}) - -_legacy_required_properties_inner_model_schema = json.loads( - r"""{ - "title" : "LegacyRequiredProperties_inner", - "anyOf" : [ { - "type" : "string" - }, { - "$ref" : "#/components/schemas/LegacyRequiredPropertyObject" - } ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyRequiredProperties_inner": _legacy_required_properties_inner_model_schema -}) - -_legacy_required_property_object_model_schema = json.loads( - r"""{ - "required" : [ "mandatory", "name", "sensitive", "type" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "type" : { - "$ref" : "#/components/schemas/PlugPropertyDataType" - }, - "mandatory" : { - "type" : "boolean" - }, - "sensitive" : { - "type" : "boolean" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "LegacyRequiredPropertyObject": _legacy_required_property_object_model_schema -}) - -_limit_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"LimitQuery": _limit_query_model_schema}) - -_media_type_model_schema = json.loads( - r"""{ - "title" : "MediaType", - "type" : "string", - "enum" : [ "application/javascript", "application/java-vm", "text/x-python", "text/x-golang" ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"MediaType": _media_type_model_schema}) - -_message_and_status_response_model_schema = json.loads( - r"""{ - "required" : [ "message", "statusCode" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "statusCode" : { - "type" : "number" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "MessageAndStatusResponse": _message_and_status_response_model_schema -}) - -_message_response_model_schema = json.loads( - r"""{ - "required" : [ "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"MessageResponse": _message_response_model_schema}) - -_model_model_schema = json.loads( - r"""{ - "title" : "Model", - "required" : [ "model" ], - "type" : "object", - "properties" : { - "event" : { - "$ref" : "#/components/schemas/HALLink" - }, - "model" : { - "$ref" : "#/components/schemas/HALLink" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"Model": _model_model_schema}) - -_model_1_model_schema = json.loads( - r"""{ - "title" : "Model", - "required" : [ "model" ], - "type" : "object", - "properties" : { - "event" : { - "$ref" : "#/components/schemas/HALLink" - }, - "job" : { - "$ref" : "#/components/schemas/HALLink" - }, - "model" : { - "$ref" : "#/components/schemas/HALLink" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"Model_1": _model_1_model_schema}) - -_model_2_model_schema = json.loads( - r"""{ - "title" : "Model", - "required" : [ "model" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/HALLink" - }, - "model" : { - "$ref" : "#/components/schemas/HALLink" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"Model_2": _model_2_model_schema}) - -_model_versions_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "count", "entities" ], - "type" : "object", - "properties" : { - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." - }, - "entities" : { - "type" : "array", - "description" : "The specification and deployment status of the queried functions", - "items" : { - "$ref" : "#/components/schemas/KfservingResponseV2" - } - } - }, - "description" : "Model Versions Found" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "ModelVersionsResponseV2": _model_versions_response_v2_model_schema -}) - -_multipart_file_upload__model_schema = json.loads( - r"""{ - "title" : "Multipart file upload.", - "type" : "object", - "properties" : { - "filename" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "binary" - } - } - }, - "description" : "A multi-part upload containing one or more file assets.", - "nullable" : true -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "Multipart_file_upload_": _multipart_file_upload__model_schema -}) - -_name_model_schema = json.loads( - r"""{ - "required" : [ "name" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the function." - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"Name": _name_model_schema}) - -_name_and_version_model_schema = json.loads( - r"""{ - "required" : [ "name", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"NameAndVersion": _name_and_version_model_schema}) - -_named_function_versions_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Named function versions listing query." -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "NamedFunctionVersionsQuery": _named_function_versions_query_model_schema -}) - -_named_kf_serving_versions_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Named Model versions query." -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "NamedKFServingVersionsQueryV2": _named_kf_serving_versions_query_v2_model_schema -}) - -_named_parameters_typeof_as_job_reference__model_schema = json.loads( - r"""{ - "required" : [ "jobStatus" ], - "type" : "object", - "properties" : { - "jobStatus" : { - "$ref" : "#/components/schemas/NamedParameters_typeof_asJobReference__jobStatus" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "NamedParameters_typeof_asJobReference_": _named_parameters_typeof_as_job_reference__model_schema -}) - -_named_parameters_typeof_as_job_reference__job_status_model_schema = json.loads( - r"""{ - "title" : "NamedParameters_typeof_asJobReference__jobStatus", - "required" : [ "createdAt", "createdBy", "operation", "state", "type" ], - "type" : "object", - "properties" : { - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "type" : { - "title" : "type", - "description" : "The type of the background task." - }, - "state" : { - "$ref" : "#/components/schemas/JobStateResult" - }, - "request" : { - "title" : "request", - "description" : "The request that initiated this job." - }, - "result" : { - "title" : "result", - "description" : "The result of the job if completed." - }, - "createdAt" : { - "title" : "createdAt", - "type" : "string", - "description" : "The timestamp of creation of this job", - "format" : "date-time" - }, - "createdBy" : { - "title" : "createdBy", - "type" : "string", - "description" : "The user that created this job" - }, - "operation" : { - "title" : "operation", - "type" : "string", - "description" : "Request operation" - }, - "function" : { - "$ref" : "#/components/schemas/FunctionRef" - }, - "job" : { - "$ref" : "#/components/schemas/JobStatus" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "NamedParameters_typeof_asJobReference__jobStatus": _named_parameters_typeof_as_job_reference__job_status_model_schema -}) - -_named_parameters_typeof_from_legacy__model_schema = json.loads( - r"""{ - "required" : [ "metadata" ], - "type" : "object", - "properties" : { - "metadata" : { - "$ref" : "#/components/schemas/LegacyPlugMetaRequest" - }, - "currentInterface" : { - "$ref" : "#/components/schemas/PlugInterface" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "NamedParameters_typeof_fromLegacy_": _named_parameters_typeof_from_legacy__model_schema -}) - -_named_parameters_typeof_from_legacy_documentation__model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "legacyDocumentation" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_documentation" - }, - "currentInterface" : { - "$ref" : "#/components/schemas/PlugInterface" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "NamedParameters_typeof_fromLegacyDocumentation_": _named_parameters_typeof_from_legacy_documentation__model_schema -}) - -_named_parameters_typeof_is_not_legacy__model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "documentation" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_documentation" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "NamedParameters_typeof_isNotLegacy_": _named_parameters_typeof_is_not_legacy__model_schema -}) - -_named_plug_versions_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "tags" : { - "$ref" : "#/components/schemas/TagsFilter" - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Named plug version listing query" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "NamedPlugVersionsQueryV2": _named_plug_versions_query_v2_model_schema -}) - -_named_versions_filter_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "nameVersion" : { - "type" : "array", - "description" : "Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - "items" : { - "$ref" : "#/components/schemas/NamedVersion" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"NamedVersionsFilter": _named_versions_filter_model_schema}) - -_named_webscript_versions_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Webscript named versions listing query." -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "NamedWebscriptVersionsQueryV2": _named_webscript_versions_query_v2_model_schema -}) - -_openfaas_deploy_args_model_schema = json.loads( - r"""{ - "required" : [ "endpoint", "imageName", "namespace" ], - "type" : "object", - "properties" : { - "namespace" : { - "type" : "string", - "description" : "The (openfaas) namespace for the target function." - }, - "endpoint" : { - "type" : "string", - "description" : "The (openfaas) endpoint service name" - }, - "imageName" : { - "type" : "string", - "description" : "The image name to use for deploying this function" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"OpenfaasDeployArgs": _openfaas_deploy_args_model_schema}) - -_openfaas_function_ref_model_schema = json.loads( - r"""{ - "required" : [ "endpoint", "namespace" ], - "type" : "object", - "properties" : { - "namespace" : { - "type" : "string", - "description" : "The (openfaas) namespace for the target function." - }, - "endpoint" : { - "type" : "string", - "description" : "The (openfaas) endpoint service name" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"OpenfaasFunctionRef": _openfaas_function_ref_model_schema}) - -_operation_model_schema = json.loads( - r"""{ - "required" : [ "description", "id", "name", "type" ], - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "name" : { - "type" : "string", - "deprecated" : true - }, - "type" : { - "$ref" : "#/components/schemas/JobType" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"Operation": _operation_model_schema}) - -_operation_status_model_schema = json.loads( - r"""{ - "required" : [ "description", "done", "id", "name", "type" ], - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "name" : { - "type" : "string", - "deprecated" : true - }, - "type" : { - "$ref" : "#/components/schemas/JobType" - }, - "done" : { - "type" : "boolean" - }, - "error" : { - "$ref" : "#/components/schemas/OperationStatus_error" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"OperationStatus": _operation_status_model_schema}) - -_operation_status_error_model_schema = json.loads( - r"""{ - "title" : "OperationStatus_error", - "required" : [ "code", "message", "name" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string" - }, - "message" : { - "title" : "message", - "type" : "string" - }, - "stack" : { - "title" : "stack", - "type" : "string" - }, - "code" : { - "title" : "code", - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "OperationStatus_error": _operation_status_error_model_schema -}) - -_paging_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PagingQuery": _paging_query_model_schema}) - -_paging_response_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PagingResponse": _paging_response_model_schema}) - -_parent_keys_model_schema = json.loads( - r"""{ - "title" : "ParentKeys", - "required" : [ "id" ], - "type" : "object", - "properties" : { - "id" : { - "title" : "id", - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"ParentKeys": _parent_keys_model_schema}) - -_patch_interface_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PatchInterfaceQuery": _patch_interface_query_model_schema}) - -_patch_metadata_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PatchMetadataQuery": _patch_metadata_query_model_schema}) - -_patch_plug_request_v1_model_schema = json.loads( - r"""{ - "required" : [ "metadata" ], - "type" : "object", - "properties" : { - "metadata" : { - "$ref" : "#/components/schemas/UserPlugMeta" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PatchPlugRequestV1": _patch_plug_request_v1_model_schema}) - -_plug_model_schema = json.loads( - r"""{ - "title" : "Plug", - "required" : [ "plug" ], - "type" : "object", - "properties" : { - "event" : { - "$ref" : "#/components/schemas/HALLink" - }, - "plug" : { - "$ref" : "#/components/schemas/HALLink" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"Plug": _plug_model_schema}) - -_plug_1_model_schema = json.loads( - r"""{ - "title" : "Plug", - "required" : [ "plug" ], - "type" : "object", - "properties" : { - "event" : { - "$ref" : "#/components/schemas/HALLink" - }, - "job" : { - "$ref" : "#/components/schemas/HALLink" - }, - "plug" : { - "$ref" : "#/components/schemas/HALLink" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"Plug_1": _plug_1_model_schema}) - -_plug_2_model_schema = json.loads( - r"""{ - "title" : "Plug", - "required" : [ "plug" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/HALLink" - }, - "plug" : { - "$ref" : "#/components/schemas/HALLink" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"Plug_2": _plug_2_model_schema}) - -_plug_delete_force_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "force" : { - "type" : "boolean", - "description" : "If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "PlugDeleteForceQuery": _plug_delete_force_query_model_schema -}) - -_plug_delete_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "force" : { - "type" : "boolean", - "description" : "If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings." - }, - "undeploy" : { - "type" : "boolean", - "description" : "If `true`, the `DELETE` operation\n* undeploys the (openfaas) function for the plug: it becomes no longer available for invocation.\n* does NOT remove the plug from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the plug can be restored later with a _rebuild_ action.\n\nIf `false`, the `DELETE` operation\n* _only_ marks the plug version(s) as _deprecated_: the plug remains active but is removed from the default listings. This also applies to _draft_ versions.\n\nThis parameter is incompatible with `force=true`.\n\nIf not set the default behaviour applies:\n* _draft_ versions are _undeployed_ and _removed_ from registry.\n* non-_draft_ versions are marked _deprecated_ only." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PlugDeleteQuery": _plug_delete_query_model_schema}) - -_plug_interface_model_schema = json.loads( - r"""{ - "title" : "PlugInterface", - "type" : "object", - "properties" : { - "states" : { - "title" : "states", - "type" : "array", - "description" : "The states of a plug as implemented in the plug code.", - "items" : { - "type" : "string" - } - }, - "input" : { - "title" : "input", - "type" : "array", - "description" : "The named input parameters of a plug", - "items" : { - "$ref" : "#/components/schemas/PlugProperty" - } - }, - "output" : { - "title" : "output", - "type" : "array", - "description" : "The named output parameters of a plug", - "items" : { - "$ref" : "#/components/schemas/PlugProperty" - } - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PlugInterface": _plug_interface_model_schema}) - -_plug_listing_and_query_response_model_schema = json.loads( - r"""{ - "required" : [ "plugs" ], - "type" : "object", - "properties" : { - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." - }, - "plugs" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PlugResponse" - } - } - }, - "description" : "Successful Response" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "PlugListingAndQueryResponse": _plug_listing_and_query_response_model_schema -}) - -_plug_listing_response_model_schema = json.loads( - r"""{ - "required" : [ "plugs" ], - "type" : "object", - "properties" : { - "plugs" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PlugResponse" - } - } - }, - "description" : "Successful Response" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PlugListingResponse": _plug_listing_response_model_schema}) - -_plug_manifest_model_schema = json.loads( - r"""{ - "title" : "PlugManifest", - "required" : [ "interface", "metadata", "name", "runtime", "type", "version" ], - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "title" : "name", - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/PlugMeta" - }, - "type" : { - "$ref" : "#/components/schemas/PlugType" - }, - "interface" : { - "$ref" : "#/components/schemas/PlugInterface" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PlugManifest": _plug_manifest_model_schema}) - -_plug_meta_model_schema = json.loads( - r"""{ - "title" : "PlugMeta", - "type" : "object", - "properties" : { - "author" : { - "title" : "author", - "type" : "string", - "description" : "The author of the function." - }, - "description" : { - "title" : "description", - "type" : "string", - "description" : "A description of the function" - }, - "iconURL" : { - "title" : "iconURL", - "type" : "string", - "description" : "An url to an icon that represents this function." - }, - "category" : { - "title" : "category", - "type" : "string", - "description" : "A category for this function (Deprecated: use tags to categorise your functions)", - "deprecated" : true - }, - "documentationURL" : { - "title" : "documentationURL", - "type" : "string", - "description" : "External url that document this function." - }, - "tags" : { - "title" : "tags", - "type" : "array", - "description" : "Tags associated with this function.", - "example" : [ { - "name" : "awaiting-review", - "color" : "#4153ea" - }, { - "name" : "demo", - "color" : "#e639a4" - } ], - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "friendlyName" : { - "title" : "friendlyName", - "type" : "string", - "description" : "Display title for this function." - }, - "documentation" : { - "$ref" : "#/components/schemas/Documentation" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PlugMeta": _plug_meta_model_schema}) - -_plug_property_model_schema = json.loads( - r"""{ - "title" : "PlugProperty", - "required" : [ "name" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string", - "description" : "The name of a plug input or output property." - }, - "dataType" : { - "$ref" : "#/components/schemas/PlugPropertyDataType" - }, - "mandatory" : { - "title" : "mandatory", - "type" : "boolean", - "description" : "If true this property is required.", - "example" : true - }, - "format" : { - "$ref" : "#/components/schemas/PlugPropertyFormat" - }, - "defaultValue" : { - "$ref" : "#/components/schemas/DefaultValue" - } - }, - "description" : "Interface specification of a plug property." -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PlugProperty": _plug_property_model_schema}) - -_plug_property_data_type_model_schema = json.loads( - r"""{ - "title" : "PlugPropertyDataType", - "type" : "string", - "description" : "Datatype supported in plug input or output properties.", - "enum" : [ "string", "integer", "long", "float", "double", "boolean", "object" ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "PlugPropertyDataType": _plug_property_data_type_model_schema -}) - -_plug_property_format_model_schema = json.loads( - r"""{ - "title" : "PlugPropertyFormat", - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/PlugPropertyFormatType" - }, - "values" : { - "title" : "values", - "type" : "array", - "description" : "The enumerated value domain when type=\"enum\"", - "example" : [ "low", "high" ], - "items" : { - "$ref" : "#/components/schemas/EnumValue" - } - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PlugPropertyFormat": _plug_property_format_model_schema}) - -_plug_property_format_type_model_schema = json.loads( - r"""{ - "title" : "PlugPropertyFormatType", - "type" : "string", - "description" : "Value domain for a plug input or output property.", - "enum" : [ "enum", "resource", "vault", "duration", "code", "url", "date", "template" ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "PlugPropertyFormatType": _plug_property_format_type_model_schema -}) - -_plug_response_model_schema = json.loads( - r"""{ - "required" : [ "createdAt", "createdBy", "isDeprecated", "metadata", "name", "runtime", "status", "updatedAt", "updatedBy", "version" ], - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - }, - "createdBy" : { - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "_links" : { - "type" : "array", - "description" : "Links to related entities.", - "items" : { - "$ref" : "#/components/schemas/JobHALLinks" - } - }, - "isDeprecated" : { - "type" : "boolean" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PlugResponse": _plug_response_model_schema}) - -_plug_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "createdAt", "createdBy", "deprecated", "draft", "plug", "runtime", "status", "updatedAt", "updatedBy", "updates" ], - "type" : "object", - "properties" : { - "createdBy" : { - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "updates" : { - "type" : "array", - "description" : "The audit logs corresponding to the latest modifying operations on this entity.", - "items" : { - "$ref" : "#/components/schemas/UpdateRecord" - } - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "runtime" : { - "$ref" : "#/components/schemas/RuntimeAttributes" - }, - "deprecated" : { - "type" : "boolean", - "description" : "If true this plug is removed from regular listings, as a result of a DELETE with force=false." - }, - "draft" : { - "type" : "boolean", - "description" : "If true this function is a draft function and it's assets are still mutable." - }, - "plug" : { - "$ref" : "#/components/schemas/PlugManifest" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PlugResponseV2": _plug_response_v2_model_schema}) - -_plug_type_model_schema = json.loads( - r"""{ - "title" : "PlugType", - "type" : "string", - "enum" : [ "sensor", "actuator", "transformer" ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PlugType": _plug_type_model_schema}) - -_plug_type_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/PlugType" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PlugTypeQuery": _plug_type_query_model_schema}) - -_plug_versions_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "count", "entities" ], - "type" : "object", - "properties" : { - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." - }, - "entities" : { - "type" : "array", - "description" : "The specification and deployment status of the queried functions", - "items" : { - "$ref" : "#/components/schemas/PlugResponseV2" - } - } - }, - "description" : "Plugs Versions Found" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "PlugVersionsResponseV2": _plug_versions_response_v2_model_schema -}) - -_post_model_job_async_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "_links", "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "entity" : { - "$ref" : "#/components/schemas/KfservingResponseV2" - } - }, - "description" : "Model Deployment Initiated" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "PostModelJobAsyncResponseV2": _post_model_job_async_response_v2_model_schema -}) - -_post_model_job_sync_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "entity" : { - "$ref" : "#/components/schemas/KfservingResponseV2" - } - }, - "description" : "Model Deployed" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "PostModelJobSyncResponseV2": _post_model_job_sync_response_v2_model_schema -}) - -_post_plug_job_async_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "_links", "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "entity" : { - "$ref" : "#/components/schemas/PlugResponseV2" - } - }, - "description" : "Plug Deployment Initiated" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "PostPlugJobAsyncResponseV2": _post_plug_job_async_response_v2_model_schema -}) - -_post_plug_job_sync_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "entity" : { - "$ref" : "#/components/schemas/PlugResponseV2" - } - }, - "description" : "Plug Deployed" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "PostPlugJobSyncResponseV2": _post_plug_job_sync_response_v2_model_schema -}) - -_post_webscript_job_async_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "_links", "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "entity" : { - "$ref" : "#/components/schemas/WebscriptResponseV2" - } - }, - "description" : "Webscript Deployment Initiated" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "PostWebscriptJobAsyncResponseV2": _post_webscript_job_async_response_v2_model_schema -}) - -_post_webscript_job_sync_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "entity" : { - "$ref" : "#/components/schemas/WebscriptResponseV2" - } - }, - "description" : "Webscript Deployed" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "PostWebscriptJobSyncResponseV2": _post_webscript_job_sync_response_v2_model_schema -}) - -_provided_dependency_model_schema = json.loads( - r"""{ - "title" : "ProvidedDependency", - "required" : [ "name" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string", - "description" : "Name of a provided dependency." - }, - "title" : { - "title" : "title", - "type" : "string", - "description" : "Optional display title." - }, - "description" : { - "title" : "description", - "type" : "string", - "description" : "Optional description." - }, - "version" : { - "title" : "version", - "type" : "string", - "description" : "Versions specification of a provided dependency" - }, - "deprecated" : { - "title" : "deprecated", - "type" : "boolean", - "description" : "If true, this provided dependency is scheduled for removal (or incompatible upgrade) in a next runtime version.", - "default" : false - }, - "removed" : { - "title" : "removed", - "type" : "boolean", - "description" : "If true, this dependency has been removed from the runtime (version)", - "default" : false - }, - "globals" : { - "title" : "globals", - "type" : "array", - "description" : "Global variables that expose this library to the user code. As the usage of these globals is deprecated, any usage of such global will pose issues in an next runtime version.", - "items" : { - "type" : "string" - } - }, - "native" : { - "title" : "native", - "type" : "boolean", - "description" : "If true, the library is provided natively by the runtime: e.g. node for javascript." - } - }, - "description" : "Library dependency that is provided by this runtime." -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"ProvidedDependency": _provided_dependency_model_schema}) - -_publish_function_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { + "friendlyName" : { + "title" : "friendlyName", "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "deprecatePrevious" : { - "$ref" : "#/components/schemas/DeprecatePreviousPolicy" - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"PublishFunctionQuery": _publish_function_query_model_schema}) - -_queue_events_model_schema = json.loads( - r"""{ - "title" : "QueueEvents", - "type" : "string", - "enum" : [ "completed", "failed", "active", "delayed", "waiting", "waiting-children", "added", "cleaned", "drained", "error", "paused", "progress", "removed", "resumed", "retries-exhausted", "stalled" ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"QueueEvents": _queue_events_model_schema}) - -_rebuild_computed_response_model_schema = json.loads( - r"""{ - "required" : [ "causes", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "causes" : { - "$ref" : "#/components/schemas/JobCauses" - } - }, - "description" : "Rebuild Ignored" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "RebuildComputedResponse": _rebuild_computed_response_model_schema -}) - -_rebuild_model_async_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "_links", "causes", "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "causes" : { - "$ref" : "#/components/schemas/JobCauses" - }, - "entity" : { - "$ref" : "#/components/schemas/KfservingResponseV2" - } - }, - "description" : "Model Rebuild Initiated" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "RebuildModelAsyncResponseV2": _rebuild_model_async_response_v2_model_schema -}) - -_rebuild_model_sync_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "causes", "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "causes" : { - "$ref" : "#/components/schemas/JobCauses" + "description" : "Display title for this function." }, - "entity" : { - "$ref" : "#/components/schemas/KfservingResponseV2" + "documentation" : { + "$ref" : "#/components/schemas/Documentation" } - }, - "description" : "Model Rebuild Ignored" + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "RebuildModelSyncResponseV2": _rebuild_model_sync_response_v2_model_schema -}) +MODEL_DEFINITIONS.update({"PlugMeta": _plug_meta_model_schema}) -_rebuild_plug_async_response_v2_model_schema = json.loads( +_plug_property_model_schema = json.loads( r"""{ - "required" : [ "_links", "causes", "entity", "message" ], + "title" : "PlugProperty", + "required" : [ "name" ], "type" : "object", "properties" : { - "message" : { - "type" : "string" + "name" : { + "title" : "name", + "type" : "string", + "description" : "The name of a plug input or output property." }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" + "dataType" : { + "$ref" : "#/components/schemas/PlugPropertyDataType" }, - "causes" : { - "$ref" : "#/components/schemas/JobCauses" + "mandatory" : { + "title" : "mandatory", + "type" : "boolean", + "description" : "If true this property is required.", + "example" : true }, - "entity" : { - "$ref" : "#/components/schemas/PlugResponseV2" + "format" : { + "$ref" : "#/components/schemas/PlugPropertyFormat" + }, + "defaultValue" : { + "$ref" : "#/components/schemas/DefaultValue" } }, - "description" : "Plug Rebuild Initiated" + "description" : "Interface specification of a plug property." +} +""", + object_hook=with_example_provider, +) +MODEL_DEFINITIONS.update({"PlugProperty": _plug_property_model_schema}) + +_plug_property_data_type_model_schema = json.loads( + r"""{ + "type" : "string", + "description" : "Datatype supported in plug input or output properties.", + "enum" : [ "string", "integer", "long", "float", "double", "boolean", "object" ] } """, object_hook=with_example_provider, ) MODEL_DEFINITIONS.update({ - "RebuildPlugAsyncResponseV2": _rebuild_plug_async_response_v2_model_schema + "PlugPropertyDataType": _plug_property_data_type_model_schema }) -_rebuild_plug_sync_response_v2_model_schema = json.loads( +_plug_property_format_model_schema = json.loads( r"""{ - "required" : [ "causes", "entity", "message" ], + "title" : "PlugPropertyFormat", "type" : "object", "properties" : { - "message" : { - "type" : "string" - }, - "causes" : { - "$ref" : "#/components/schemas/JobCauses" + "type" : { + "$ref" : "#/components/schemas/PlugPropertyFormatType" }, - "entity" : { - "$ref" : "#/components/schemas/PlugResponseV2" + "values" : { + "title" : "values", + "type" : "array", + "description" : "The enumerated value domain when type=\"enum\"", + "example" : [ "low", "high" ], + "items" : { + "$ref" : "#/components/schemas/EnumValue" + } } - }, - "description" : "Plug Rebuild Ignored" + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "RebuildPlugSyncResponseV2": _rebuild_plug_sync_response_v2_model_schema -}) +MODEL_DEFINITIONS.update({"PlugPropertyFormat": _plug_property_format_model_schema}) -_rebuild_policy_model_schema = json.loads( +_plug_property_format_type_model_schema = json.loads( r"""{ "type" : "string", - "description" : "The policy to select a new runtime version when a rebuild is issued.", - "enum" : [ "patch", "minor", "major", "same" ] + "description" : "Value domain for a plug input or output property.", + "enum" : [ "enum", "resource", "vault", "duration", "code", "url", "date", "template" ] } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RebuildPolicy": _rebuild_policy_model_schema}) +MODEL_DEFINITIONS.update({ + "PlugPropertyFormatType": _plug_property_format_type_model_schema +}) -_rebuild_query_params_model_schema = json.loads( +_plug_response_v2_model_schema = json.loads( r"""{ + "required" : [ "createdAt", "createdBy", "deprecated", "draft", "plug", "runtime", "status", "updatedAt", "updatedBy", "updates" ], "type" : "object", "properties" : { - "upgrade" : { - "$ref" : "#/components/schemas/RebuildPolicy" - }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, checks whether rebuild jobs are needed, but do not start any jobs." - }, - "forceVersion" : { - "$ref" : "#/components/schemas/SemanticVersion" + "createdBy" : { + "type" : "string", + "description" : "The user that created this entity." }, - "ignoreChecks" : { - "type" : "boolean", - "description" : "If set to true, checks that normally prevent a rebuild are overriden. These checks include:\n* function state in `pending`, `running`, `failed` or `undeployed`\n* backoff period due to recent failures\n* usage of deprecated dependencies\n* running jobs on entity\n* the `dryRun` option" + "createdAt" : { + "type" : "string", + "description" : "The timestamp at which this entity was created.", + "format" : "date-time" }, - "scaleToZero" : { - "type" : "boolean", - "description" : "Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command." + "updatedBy" : { + "type" : "string", + "description" : "The user that last updated this entity." }, - "skipRebuild" : { - "type" : "boolean", - "description" : "If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"RebuildQueryParams": _rebuild_query_params_model_schema}) - -_rebuild_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { + "updatedAt" : { "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." + "description" : "The timestamp at which this entity was last updated.", + "format" : "date-time" }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, checks whether rebuild jobs are needed, but do not start any jobs." + "updates" : { + "type" : "array", + "description" : "The audit logs corresponding to the latest modifying operations on this entity.", + "items" : { + "$ref" : "#/components/schemas/UpdateRecord" + } }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true + "status" : { + "$ref" : "#/components/schemas/Status" }, - "upgrade" : { - "$ref" : "#/components/schemas/RebuildPolicy" + "failureReason" : { + "$ref" : "#/components/schemas/FailureReason" }, - "forceVersion" : { - "$ref" : "#/components/schemas/SemanticVersion" + "runtime" : { + "$ref" : "#/components/schemas/RuntimeAttributes" }, - "ignoreChecks" : { + "deprecated" : { "type" : "boolean", - "description" : "If set to true, checks that normally prevent a rebuild are overriden. These checks include:\n* function state in `pending`, `running`, `failed` or `undeployed`\n* backoff period due to recent failures\n* usage of deprecated dependencies\n* running jobs on entity\n* the `dryRun` option" + "description" : "If true this plug is removed from regular listings, as a result of a DELETE with force=false." }, - "scaleToZero" : { + "draft" : { "type" : "boolean", - "description" : "Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command." + "description" : "If true this function is a draft function and it's assets are still mutable." }, - "skipRebuild" : { - "type" : "boolean", - "description" : "If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function." + "plug" : { + "$ref" : "#/components/schemas/PlugManifest" } - }, - "additionalProperties" : false + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RebuildQueryV2": _rebuild_query_v2_model_schema}) +MODEL_DEFINITIONS.update({"PlugResponseV2": _plug_response_v2_model_schema}) -_rebuild_submitted_response_model_schema = json.loads( +_plug_type_model_schema = json.loads( r"""{ - "required" : [ "_links", "causes", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "causes" : { - "$ref" : "#/components/schemas/JobCauses" - } - }, - "description" : "Rebuild Initiated" + "type" : "string", + "enum" : [ "sensor", "actuator", "transformer" ] } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "RebuildSubmittedResponse": _rebuild_submitted_response_model_schema -}) +MODEL_DEFINITIONS.update({"PlugType": _plug_type_model_schema}) -_rebuild_webscript_async_response_v2_model_schema = json.loads( +_plug_versions_response_v2_model_schema = json.loads( r"""{ - "required" : [ "_links", "causes", "entity", "message" ], + "required" : [ "count", "entities" ], "type" : "object", "properties" : { - "message" : { - "type" : "string" + "limit" : { + "type" : "number", + "description" : "The page size used for this query result." }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" + "count" : { + "type" : "number", + "description" : "The total count of matching items, from which this result is one page." }, - "causes" : { - "$ref" : "#/components/schemas/JobCauses" + "page" : { + "type" : "number", + "description" : "The page number of a paged query result." }, - "entity" : { - "$ref" : "#/components/schemas/WebscriptResponseV2" + "entities" : { + "type" : "array", + "description" : "The specification and deployment status of the queried functions", + "items" : { + "$ref" : "#/components/schemas/PlugResponseV2" + } } }, - "description" : "Webscript Rebuild Initiated" + "description" : "Plugs Versions Found" } """, object_hook=with_example_provider, ) MODEL_DEFINITIONS.update({ - "RebuildWebscriptAsyncResponseV2": _rebuild_webscript_async_response_v2_model_schema + "PlugVersionsResponseV2": _plug_versions_response_v2_model_schema }) -_rebuild_webscript_sync_response_v2_model_schema = json.loads( +_post_model_job_async_response_v2_model_schema = json.loads( r"""{ - "required" : [ "causes", "entity", "message" ], + "required" : [ "_links", "entity", "message" ], "type" : "object", "properties" : { "message" : { "type" : "string" }, - "causes" : { - "$ref" : "#/components/schemas/JobCauses" + "_links" : { + "$ref" : "#/components/schemas/JobHALLinks" }, "entity" : { - "$ref" : "#/components/schemas/WebscriptResponseV2" - } - }, - "description" : "Webscript Rebuild Ignored" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "RebuildWebscriptSyncResponseV2": _rebuild_webscript_sync_response_v2_model_schema -}) - -_remove_function_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "force" : { - "type" : "boolean", - "description" : "If true, the function version will be immediately undeployed and removed.\n\nOtherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_." - }, - "undeploy" : { - "type" : "boolean", - "description" : "If `true`, the `DELETE` operation\n* undeploys the (openfaas) function: it becomes no longer available for invocation.\n* does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action.\n\nIf `false`, the `DELETE` operation\n* _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions.\n\nThis parameter is incompatible with `force=true`.\n\nIf not set the default behaviour applies:\n* _draft_ versions are _undeployed_ and _removed_ from registry.\n* non-_draft_ versions are marked _deprecated_ only." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "RemoveFunctionQueryV2": _remove_function_query_v2_model_schema -}) - -_remove_plug_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "force" : { - "type" : "boolean", - "description" : "If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings." - }, - "undeploy" : { - "type" : "boolean", - "description" : "If `true`, the `DELETE` operation\n* undeploys the (openfaas) function for the plug: it becomes no longer available for invocation.\n* does NOT remove the plug from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the plug can be restored later with a _rebuild_ action.\n\nIf `false`, the `DELETE` operation\n* _only_ marks the plug version(s) as _deprecated_: the plug remains active but is removed from the default listings. This also applies to _draft_ versions.\n\nThis parameter is incompatible with `force=true`.\n\nIf not set the default behaviour applies:\n* _draft_ versions are _undeployed_ and _removed_ from registry.\n* non-_draft_ versions are marked _deprecated_ only." + "$ref" : "#/components/schemas/KfservingResponseV2" } }, - "additionalProperties" : false + "description" : "Model Deployment Initiated" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RemovePlugQueryV2": _remove_plug_query_v2_model_schema}) +MODEL_DEFINITIONS.update({ + "PostModelJobAsyncResponseV2": _post_model_job_async_response_v2_model_schema +}) -_request_operation_model_schema = json.loads( +_post_model_job_sync_response_v2_model_schema = json.loads( r"""{ - "title" : "RequestOperation", - "type" : "string", - "description" : "A modifying operation on the function.", - "enum" : [ "create", "metadata-update", "assets-update", "rebuild", "verify", "publish", "deprecate", "undeploy" ] + "required" : [ "entity", "message" ], + "type" : "object", + "properties" : { + "message" : { + "type" : "string" + }, + "entity" : { + "$ref" : "#/components/schemas/KfservingResponseV2" + } + }, + "description" : "Model Deployed" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RequestOperation": _request_operation_model_schema}) +MODEL_DEFINITIONS.update({ + "PostModelJobSyncResponseV2": _post_model_job_sync_response_v2_model_schema +}) -_resource_limits_model_schema = json.loads( +_post_plug_job_async_response_v2_model_schema = json.loads( r"""{ - "title" : "ResourceLimits", - "required" : [ "cpu", "memory" ], + "required" : [ "_links", "entity", "message" ], "type" : "object", "properties" : { - "memory" : { - "title" : "memory", + "message" : { "type" : "string" }, - "cpu" : { - "title" : "cpu", - "type" : "string" + "_links" : { + "$ref" : "#/components/schemas/JobHALLinks" + }, + "entity" : { + "$ref" : "#/components/schemas/PlugResponseV2" } - } + }, + "description" : "Plug Deployment Initiated" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"ResourceLimits": _resource_limits_model_schema}) +MODEL_DEFINITIONS.update({ + "PostPlugJobAsyncResponseV2": _post_plug_job_async_response_v2_model_schema +}) -_root_page_response_model_schema = json.loads( +_post_plug_job_sync_response_v2_model_schema = json.loads( r"""{ - "required" : [ "enabled", "name", "revision", "version" ], + "required" : [ "entity", "message" ], "type" : "object", "properties" : { - "name" : { - "type" : "string", - "description" : "Name of the service." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "enabled" : { - "type" : "object", - "description" : "Description of the features enabled on this service deployment." + "message" : { + "type" : "string" }, - "revision" : { - "type" : "string", - "description" : "Revision of the service source code." + "entity" : { + "$ref" : "#/components/schemas/PlugResponseV2" } }, - "description" : "Status Page" + "description" : "Plug Deployed" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RootPageResponse": _root_page_response_model_schema}) +MODEL_DEFINITIONS.update({ + "PostPlugJobSyncResponseV2": _post_plug_job_sync_response_v2_model_schema +}) -_runtime_attributes_model_schema = json.loads( +_post_webscript_job_async_response_v2_model_schema = json.loads( r"""{ - "title" : "RuntimeAttributes", - "required" : [ "deprecated", "name", "upgradable", "version" ], + "required" : [ "_links", "entity", "message" ], "type" : "object", "properties" : { - "deprecated" : { - "title" : "deprecated", - "type" : "boolean", - "description" : "If true, the function uses a deprecated runtime." - }, - "upgradable" : { - "title" : "upgradable", - "type" : "boolean", - "description" : "If true, a newer runtime for this function is available using the `rebuild` API." + "message" : { + "type" : "string" }, - "name" : { - "$ref" : "#/components/schemas/Runtime" + "_links" : { + "$ref" : "#/components/schemas/JobHALLinks" }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" + "entity" : { + "$ref" : "#/components/schemas/WebscriptResponseV2" } - } + }, + "description" : "Webscript Deployment Initiated" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeAttributes": _runtime_attributes_model_schema}) +MODEL_DEFINITIONS.update({ + "PostWebscriptJobAsyncResponseV2": _post_webscript_job_async_response_v2_model_schema +}) -_runtime_info_model_schema = json.loads( +_post_webscript_job_sync_response_v2_model_schema = json.loads( r"""{ - "required" : [ "archiveFormat", "functionType", "name" ], + "required" : [ "entity", "message" ], "type" : "object", "properties" : { - "name" : { + "message" : { "type" : "string" }, - "functionType" : { - "$ref" : "#/components/schemas/FunctionType" - }, - "archiveFormat" : { - "$ref" : "#/components/schemas/ArchiveFormat" + "entity" : { + "$ref" : "#/components/schemas/WebscriptResponseV2" } }, - "description" : "Runtime attributes that are the same for all versions of a runtime." + "description" : "Webscript Deployed" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeInfo": _runtime_info_model_schema}) +MODEL_DEFINITIONS.update({ + "PostWebscriptJobSyncResponseV2": _post_webscript_job_sync_response_v2_model_schema +}) -_runtime_name_query_model_schema = json.loads( +_provided_dependency_model_schema = json.loads( r"""{ + "title" : "ProvidedDependency", + "required" : [ "name" ], "type" : "object", "properties" : { "name" : { + "title" : "name", "type" : "string", - "description" : "If set, filters on the name of a runtime. Supports * and ? wildcards and is case-insensitive.", - "example" : "node*" + "description" : "Name of a provided dependency." }, - "functionType" : { - "type" : "array", - "description" : "If set, filters on the functionType of a runtime. Uses an exact match.", - "example" : "plugs", - "items" : { - "$ref" : "#/components/schemas/FunctionType" - } + "title" : { + "title" : "title", + "type" : "string", + "description" : "Optional display title." }, - "archiveFormat" : { + "description" : { + "title" : "description", + "type" : "string", + "description" : "Optional description." + }, + "version" : { + "title" : "version", + "type" : "string", + "description" : "Versions specification of a provided dependency" + }, + "deprecated" : { + "title" : "deprecated", + "type" : "boolean", + "description" : "If true, this provided dependency is scheduled for removal (or incompatible upgrade) in a next runtime version.", + "default" : false + }, + "removed" : { + "title" : "removed", + "type" : "boolean", + "description" : "If true, this dependency has been removed from the runtime (version)", + "default" : false + }, + "globals" : { + "title" : "globals", "type" : "array", - "description" : "If set, filters on the archiveFormat of a runtime. Uses an exact match.", - "example" : "node", + "description" : "Global variables that expose this library to the user code. As the usage of these globals is deprecated, any usage of such global will pose issues in an next runtime version.", "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" + "type" : "string" } + }, + "native" : { + "title" : "native", + "type" : "boolean", + "description" : "If true, the library is provided natively by the runtime: e.g. node for javascript." } }, - "additionalProperties" : false + "description" : "Library dependency that is provided by this runtime." } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeNameQuery": _runtime_name_query_model_schema}) +MODEL_DEFINITIONS.update({"ProvidedDependency": _provided_dependency_model_schema}) -_runtime_params_model_schema = json.loads( +_queue_events_model_schema = json.loads( r"""{ - "required" : [ "name" ], - "type" : "object", - "properties" : { - "name" : { - "$ref" : "#/components/schemas/Runtime" - } - }, - "additionalProperties" : false + "title" : "QueueEvents", + "type" : "string", + "enum" : [ "completed", "failed", "active", "delayed", "waiting", "waiting-children", "added", "cleaned", "drained", "error", "paused", "progress", "removed", "resumed", "retries-exhausted", "stalled" ] } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeParams": _runtime_params_model_schema}) +MODEL_DEFINITIONS.update({"QueueEvents": _queue_events_model_schema}) -_runtime_query_model_schema = json.loads( +_rebuild_model_async_response_v2_model_schema = json.loads( r"""{ + "required" : [ "_links", "causes", "entity", "message" ], "type" : "object", "properties" : { - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "latest" : { - "$ref" : "#/components/schemas/LatestVersionLevel" - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : false + "message" : { + "type" : "string" }, - "name" : { - "type" : "string", - "description" : "If set, filters on the name of a runtime. Supports * and ? wildcards and is case-insensitive.", - "example" : "node*" + "_links" : { + "$ref" : "#/components/schemas/JobHALLinks" }, - "functionType" : { - "type" : "array", - "description" : "If set, filters on the functionType of a runtime. Uses an exact match.", - "example" : "plugs", - "items" : { - "$ref" : "#/components/schemas/FunctionType" - } + "causes" : { + "$ref" : "#/components/schemas/JobCauses" }, - "archiveFormat" : { - "type" : "array", - "description" : "If set, filters on the archiveFormat of a runtime. Uses an exact match.", - "example" : "node", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } + "entity" : { + "$ref" : "#/components/schemas/KfservingResponseV2" } }, - "additionalProperties" : false + "description" : "Model Rebuild Initiated" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeQuery": _runtime_query_model_schema}) +MODEL_DEFINITIONS.update({ + "RebuildModelAsyncResponseV2": _rebuild_model_async_response_v2_model_schema +}) -_runtime_reference_model_schema = json.loads( +_rebuild_model_sync_response_v2_model_schema = json.loads( r"""{ - "required" : [ "name", "version" ], + "required" : [ "causes", "entity", "message" ], "type" : "object", "properties" : { - "name" : { - "$ref" : "#/components/schemas/Runtime" + "message" : { + "type" : "string" }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" + "causes" : { + "$ref" : "#/components/schemas/JobCauses" + }, + "entity" : { + "$ref" : "#/components/schemas/KfservingResponseV2" } }, - "description" : "Reference to a runtime version." + "description" : "Model Rebuild Ignored" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeReference": _runtime_reference_model_schema}) +MODEL_DEFINITIONS.update({ + "RebuildModelSyncResponseV2": _rebuild_model_sync_response_v2_model_schema +}) -_runtime_specification_model_schema = json.loads( +_rebuild_plug_async_response_v2_model_schema = json.loads( r"""{ + "required" : [ "_links", "causes", "entity", "message" ], "type" : "object", "properties" : { - "build" : { - "$ref" : "#/components/schemas/BuildSpec" - }, - "deploy" : { - "$ref" : "#/components/schemas/DeploySpec" - }, - "language" : { - "$ref" : "#/components/schemas/LanguageRelease" - }, - "providedDependencies" : { - "type" : "array", - "description" : "Description of dependencies provided by this runtime version.", - "items" : { - "$ref" : "#/components/schemas/ProvidedDependency" - } + "message" : { + "type" : "string" }, - "assets" : { - "$ref" : "#/components/schemas/AssetsConditions" + "_links" : { + "$ref" : "#/components/schemas/JobHALLinks" }, - "deprecated" : { - "type" : "boolean", - "description" : "If true, this runtime should no longer be used for new functions." + "causes" : { + "$ref" : "#/components/schemas/JobCauses" + }, + "entity" : { + "$ref" : "#/components/schemas/PlugResponseV2" } }, - "description" : "Runtime (version) specification that says\n* what assets are required/allowed to build the function\n* what build parameters are used\n* what deployment parameters are used\n* which dependencies are provided by the runtime" + "description" : "Plug Rebuild Initiated" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeSpecification": _runtime_specification_model_schema}) +MODEL_DEFINITIONS.update({ + "RebuildPlugAsyncResponseV2": _rebuild_plug_async_response_v2_model_schema +}) -_runtime_summary_model_schema = json.loads( +_rebuild_plug_sync_response_v2_model_schema = json.loads( r"""{ - "required" : [ "archiveFormat", "functionType", "name", "title", "versions" ], + "required" : [ "causes", "entity", "message" ], "type" : "object", "properties" : { - "name" : { - "$ref" : "#/components/schemas/Runtime" - }, - "title" : { - "type" : "string" - }, - "description" : { + "message" : { "type" : "string" }, - "functionType" : { - "$ref" : "#/components/schemas/FunctionType" - }, - "archiveFormat" : { - "$ref" : "#/components/schemas/ArchiveFormat" + "causes" : { + "$ref" : "#/components/schemas/JobCauses" }, - "versions" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RuntimeVersionInfo" - } + "entity" : { + "$ref" : "#/components/schemas/PlugResponseV2" } }, - "description" : "A summary representation of the runtime, and (selected) versions of it." + "description" : "Plug Rebuild Ignored" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeSummary": _runtime_summary_model_schema}) +MODEL_DEFINITIONS.update({ + "RebuildPlugSyncResponseV2": _rebuild_plug_sync_response_v2_model_schema +}) -_runtime_summary_attrs_model_schema = json.loads( +_rebuild_policy_model_schema = json.loads( r"""{ - "required" : [ "archiveFormat", "functionType", "name", "title" ], - "type" : "object", - "properties" : { - "name" : { - "$ref" : "#/components/schemas/Runtime" - }, - "title" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "functionType" : { - "$ref" : "#/components/schemas/FunctionType" - }, - "archiveFormat" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - } + "type" : "string", + "description" : "The policy to select a new runtime version when a rebuild is issued.", + "enum" : [ "patch", "minor", "major", "same" ] } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeSummaryAttrs": _runtime_summary_attrs_model_schema}) +MODEL_DEFINITIONS.update({"RebuildPolicy": _rebuild_policy_model_schema}) -_runtime_summary_response_model_schema = json.loads( +_rebuild_webscript_async_response_v2_model_schema = json.loads( r"""{ - "required" : [ "runtimes" ], + "required" : [ "_links", "causes", "entity", "message" ], "type" : "object", "properties" : { - "runtimes" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/RuntimeSummary" - } + "message" : { + "type" : "string" + }, + "_links" : { + "$ref" : "#/components/schemas/JobHALLinks" + }, + "causes" : { + "$ref" : "#/components/schemas/JobCauses" + }, + "entity" : { + "$ref" : "#/components/schemas/WebscriptResponseV2" } }, - "description" : "Runtimes Found" + "description" : "Webscript Rebuild Initiated" } """, object_hook=with_example_provider, ) MODEL_DEFINITIONS.update({ - "RuntimeSummaryResponse": _runtime_summary_response_model_schema + "RebuildWebscriptAsyncResponseV2": _rebuild_webscript_async_response_v2_model_schema }) -_runtime_version_and_path_params_model_schema = json.loads( +_rebuild_webscript_sync_response_v2_model_schema = json.loads( r"""{ - "required" : [ "*", "name", "version" ], + "required" : [ "causes", "entity", "message" ], "type" : "object", "properties" : { - "*" : { - "type" : "string", - "description" : "Full path or path prefix of the asset within the archive" + "message" : { + "type" : "string" }, - "name" : { - "$ref" : "#/components/schemas/Runtime" + "causes" : { + "$ref" : "#/components/schemas/JobCauses" }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" + "entity" : { + "$ref" : "#/components/schemas/WebscriptResponseV2" } }, - "additionalProperties" : false + "description" : "Webscript Rebuild Ignored" } """, object_hook=with_example_provider, ) MODEL_DEFINITIONS.update({ - "RuntimeVersionAndPathParams": _runtime_version_and_path_params_model_schema + "RebuildWebscriptSyncResponseV2": _rebuild_webscript_sync_response_v2_model_schema }) -_runtime_version_info_model_schema = json.loads( +_registry_error_response_model_schema = json.loads( r"""{ - "title" : "RuntimeVersionInfo", - "required" : [ "deprecated", "title", "upgradable", "version" ], + "required" : [ "code", "error", "statusCode" ], "type" : "object", "properties" : { - "deprecated" : { - "title" : "deprecated", - "type" : "boolean", - "description" : "If true, the function uses a deprecated runtime." - }, - "upgradable" : { - "title" : "upgradable", - "type" : "boolean", - "description" : "If true, a newer runtime for this function is available using the `rebuild` API." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "title" : { - "title" : "title", + "error" : { "type" : "string" }, - "description" : { - "title" : "description", + "code" : { "type" : "string" + }, + "statusCode" : { + "type" : "number" + }, + "data" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } } - }, - "description" : "A summary of a selected version for a runtime" + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeVersionInfo": _runtime_version_info_model_schema}) +MODEL_DEFINITIONS.update({ + "RegistryErrorResponse": _registry_error_response_model_schema +}) + +_request_operation_model_schema = json.loads( + r"""{ + "title" : "RequestOperation", + "type" : "string", + "description" : "A modifying operation on the function.", + "enum" : [ "create", "metadata-update", "assets-update", "rebuild", "verify", "publish", "deprecate", "undeploy" ] +} +""", + object_hook=with_example_provider, +) +MODEL_DEFINITIONS.update({"RequestOperation": _request_operation_model_schema}) -_runtime_version_params_model_schema = json.loads( +_resource_limits_model_schema = json.loads( r"""{ - "required" : [ "name", "version" ], + "title" : "ResourceLimits", + "required" : [ "cpu", "memory" ], "type" : "object", "properties" : { - "name" : { - "$ref" : "#/components/schemas/Runtime" + "memory" : { + "title" : "memory", + "type" : "string" }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" + "cpu" : { + "title" : "cpu", + "type" : "string" } - }, - "additionalProperties" : false + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeVersionParams": _runtime_version_params_model_schema}) +MODEL_DEFINITIONS.update({"ResourceLimits": _resource_limits_model_schema}) -_runtime_version_query_model_schema = json.loads( +_root_page_response_model_schema = json.loads( r"""{ + "required" : [ "enabled", "name", "revision", "version" ], "type" : "object", "properties" : { + "name" : { + "type" : "string", + "description" : "Name of the service." + }, "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" + "$ref" : "#/components/schemas/SemanticVersion" }, - "latest" : { - "$ref" : "#/components/schemas/LatestVersionLevel" + "enabled" : { + "type" : "object", + "description" : "Description of the features enabled on this service deployment." }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : false + "revision" : { + "type" : "string", + "description" : "Revision of the service source code." } }, - "additionalProperties" : false + "description" : "Status Page" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeVersionQuery": _runtime_version_query_model_schema}) +MODEL_DEFINITIONS.update({"RootPageResponse": _root_page_response_model_schema}) -_runtime_version_response_model_schema = json.loads( +_runtime_attributes_model_schema = json.loads( r"""{ - "required" : [ "runtime" ], + "title" : "RuntimeAttributes", + "required" : [ "deprecated", "name", "upgradable", "version" ], "type" : "object", "properties" : { - "runtime" : { - "$ref" : "#/components/schemas/CompiledRuntimeVersion" + "deprecated" : { + "title" : "deprecated", + "type" : "boolean", + "description" : "If true, the function uses a deprecated runtime." + }, + "upgradable" : { + "title" : "upgradable", + "type" : "boolean", + "description" : "If true, a newer runtime for this function is available using the `rebuild` API." + }, + "name" : { + "$ref" : "#/components/schemas/Runtime" + }, + "version" : { + "$ref" : "#/components/schemas/SemanticVersion" } - }, - "description" : ": Runtime Version Found" + } } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "RuntimeVersionResponse": _runtime_version_response_model_schema -}) +MODEL_DEFINITIONS.update({"RuntimeAttributes": _runtime_attributes_model_schema}) -_runtime_version_specification_model_schema = json.loads( +_runtime_summary_model_schema = json.loads( r"""{ - "required" : [ "title", "version" ], + "required" : [ "archiveFormat", "functionType", "name", "title", "versions" ], "type" : "object", "properties" : { - "build" : { - "$ref" : "#/components/schemas/BuildSpec" - }, - "deploy" : { - "$ref" : "#/components/schemas/DeploySpec" - }, - "language" : { - "$ref" : "#/components/schemas/LanguageRelease" - }, - "providedDependencies" : { - "type" : "array", - "description" : "Description of dependencies provided by this runtime version.", - "items" : { - "$ref" : "#/components/schemas/ProvidedDependency" - } - }, - "assets" : { - "$ref" : "#/components/schemas/AssetsConditions" - }, - "deprecated" : { - "type" : "boolean", - "description" : "If true, this runtime should no longer be used for new functions." + "name" : { + "$ref" : "#/components/schemas/Runtime" }, "title" : { "type" : "string" @@ -9106,48 +4451,60 @@ def with_example_provider(dct): "description" : { "type" : "string" }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" + "functionType" : { + "$ref" : "#/components/schemas/FunctionType" + }, + "archiveFormat" : { + "$ref" : "#/components/schemas/ArchiveFormat" + }, + "versions" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RuntimeVersionInfo" + } } - } + }, + "description" : "A summary representation of the runtime, and (selected) versions of it." } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "RuntimeVersionSpecification": _runtime_version_specification_model_schema -}) +MODEL_DEFINITIONS.update({"RuntimeSummary": _runtime_summary_model_schema}) -_runtime_version_status_model_schema = json.loads( +_runtime_summary_response_model_schema = json.loads( r"""{ - "required" : [ "deprecated", "upgradable" ], + "required" : [ "runtimes" ], "type" : "object", "properties" : { - "deprecated" : { - "type" : "boolean", - "description" : "If true, the function uses a deprecated runtime." - }, - "upgradable" : { - "type" : "boolean", - "description" : "If true, a newer runtime for this function is available using the `rebuild` API." + "runtimes" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/RuntimeSummary" + } } - } + }, + "description" : "Runtimes Found" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"RuntimeVersionStatus": _runtime_version_status_model_schema}) +MODEL_DEFINITIONS.update({ + "RuntimeSummaryResponse": _runtime_summary_response_model_schema +}) -_runtime_version_summary_model_schema = json.loads( +_runtime_version_info_model_schema = json.loads( r"""{ - "required" : [ "archiveFormat", "deprecated", "functionType", "name", "title", "upgradable", "version" ], + "title" : "RuntimeVersionInfo", + "required" : [ "deprecated", "title", "upgradable", "version" ], "type" : "object", "properties" : { "deprecated" : { + "title" : "deprecated", "type" : "boolean", "description" : "If true, the function uses a deprecated runtime." }, "upgradable" : { + "title" : "upgradable", "type" : "boolean", "description" : "If true, a newer runtime for this function is available using the `rebuild` API." }, @@ -9155,27 +4512,37 @@ def with_example_provider(dct): "$ref" : "#/components/schemas/SemanticVersion" }, "title" : { + "title" : "title", "type" : "string" }, "description" : { + "title" : "description", "type" : "string" - }, - "name" : { - "$ref" : "#/components/schemas/Runtime" - }, - "functionType" : { - "$ref" : "#/components/schemas/FunctionType" - }, - "archiveFormat" : { - "$ref" : "#/components/schemas/ArchiveFormat" } - } + }, + "description" : "A summary of a selected version for a runtime" +} +""", + object_hook=with_example_provider, +) +MODEL_DEFINITIONS.update({"RuntimeVersionInfo": _runtime_version_info_model_schema}) + +_runtime_version_response_model_schema = json.loads( + r"""{ + "required" : [ "runtime" ], + "type" : "object", + "properties" : { + "runtime" : { + "$ref" : "#/components/schemas/CompiledRuntimeVersion" + } + }, + "description" : ": Runtime Version Found" } """, object_hook=with_example_provider, ) MODEL_DEFINITIONS.update({ - "RuntimeVersionSummary": _runtime_version_summary_model_schema + "RuntimeVersionResponse": _runtime_version_response_model_schema }) _scale_model_schema = json.loads( @@ -9280,7 +4647,7 @@ def with_example_provider(dct): _scale_args_model_schema = json.loads( r"""{ "title" : "ScaleArgs", - "required" : [ "endpoint", "namespace", "replicas", "runtimeName", "runtimeVersion" ], + "required" : [ "endpoint", "namespace", "replicas", "revision", "runtimeName", "runtimeVersion" ], "type" : "object", "properties" : { "namespace" : { @@ -9372,45 +4739,8 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"Scale_type": _scale_type_model_schema}) -_schema_by_id_params_model_schema = json.loads( - r"""{ - "required" : [ "schemaId" ], - "type" : "object", - "properties" : { - "schemaId" : { - "type" : "string", - "description" : "Schema id" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"SchemaByIdParams": _schema_by_id_params_model_schema}) - -_schema_params_model_schema = json.loads( - r"""{ - "required" : [ "functionType", "role" ], - "type" : "object", - "properties" : { - "functionType" : { - "$ref" : "#/components/schemas/FunctionType" - }, - "role" : { - "$ref" : "#/components/schemas/AssetRole" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"SchemaParams": _schema_params_model_schema}) - _semantic_version_range_model_schema = json.loads( r"""{ - "title" : "SemanticVersionRange", "description" : "A range of semantic versions. See https://devhints.io/semver", "anyOf" : [ { "type" : "string" @@ -9423,6 +4753,16 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"SemanticVersionRange": _semantic_version_range_model_schema}) +_show_related_type_model_schema = json.loads( + r"""{ + "type" : "string", + "enum" : [ "embed", "link", "none" ] +} +""", + object_hook=with_example_provider, +) +MODEL_DEFINITIONS.update({"ShowRelatedType": _show_related_type_model_schema}) + _status_model_schema = json.loads( r"""{ "title" : "Status", @@ -9446,6 +4786,19 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"StatusAny": _status_any_model_schema}) +_status_exclude_model_schema = json.loads( + r"""{ + "pattern" : "^(registered|pending|deployed|unhealthy|failed|running|undeploying|undeployed)-$", + "type" : "string", + "description" : "Any status value with a `-` postfix appended, excludes that status as a filter.", + "example" : "running-", + "enum" : [ "registered-", "running-", "pending-", "deployed-", "unhealthy-", "failed-", "undeploying-", "undeployed-" ] +} +""", + object_hook=with_example_provider, +) +MODEL_DEFINITIONS.update({"StatusExclude": _status_exclude_model_schema}) + _status_filter_model_schema = json.loads( r"""{ "description" : "Inclusion or exclusion filter on the `status` property.", @@ -9474,21 +4827,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"StatusInclude": _status_include_model_schema}) -_status_response_model_schema = json.loads( - r"""{ - "required" : [ "statusCode" ], - "type" : "object", - "properties" : { - "statusCode" : { - "type" : "number" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"StatusResponse": _status_response_model_schema}) - _stream_closing_model_schema = json.loads( r"""{ "title" : "Stream Closing", @@ -9533,17 +4871,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"Stream_Ready": _stream_ready_model_schema}) -_supported_events_model_schema = json.loads( - r"""{ - "title" : "SupportedEvents", - "type" : "string", - "enum" : [ "completed", "failed", "active", "delayed", "waiting", "waiting-children" ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"SupportedEvents": _supported_events_model_schema}) - _tag_model_schema = json.loads( r"""{ "title" : "Tag", @@ -9568,31 +4895,8 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"Tag": _tag_model_schema}) -_tag_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "If set, filters on the name of a tag. Supports * and ? wildcards and is case-insensitive.", - "example" : "*-demo-??" - }, - "color" : { - "type" : "string", - "description" : "If set, filters on the color of a tag. Uses an exact match.", - "example" : "#4153ea" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"TagQuery": _tag_query_model_schema}) - _tags_filter_model_schema = json.loads( r"""{ - "title" : "TagsFilter", "anyOf" : [ { "type" : "array", "items" : { @@ -9607,21 +4911,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"TagsFilter": _tags_filter_model_schema}) -_tags_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "tags" : { - "$ref" : "#/components/schemas/TagsFilter" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"TagsQuery": _tags_query_model_schema}) - _timestamp_absolute_model_schema = json.loads( r"""{ "title" : "TimestampAbsolute", @@ -9654,7 +4943,6 @@ def with_example_provider(dct): _timestamp_spec_model_schema = json.loads( r"""{ - "title" : "TimestampSpec", "description" : "A timestamp specification.", "anyOf" : [ { "$ref" : "#/components/schemas/TimestampAge" @@ -9769,7 +5057,7 @@ def with_example_provider(dct): _undeploy_args_model_schema = json.loads( r"""{ "title" : "UndeployArgs", - "required" : [ "deleteEntity", "endpoint", "isNativePlug", "namespace", "runtimeName", "runtimeVersion" ], + "required" : [ "deleteEntity", "endpoint", "isNativePlug", "namespace", "revision", "runtimeName", "runtimeVersion" ], "type" : "object", "properties" : { "namespace" : { @@ -9925,144 +5213,22 @@ def with_example_provider(dct): "type" : "object", "properties" : { "message" : { - "type" : "string" - }, - "versions" : { - "type" : "array", - "description" : "The versions that where deprecated, undeployed and/or removed.", - "items" : { - "$ref" : "#/components/schemas/SemanticVersion" - } - } - }, - "description" : "Undeployed" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"UndeployedResponseV2": _undeployed_response_v2_model_schema}) - -_unhealthy_invokable_webscript_error_model_schema = json.loads( - r"""{ - "required" : [ "_links", "code", "entity", "error" ], - "type" : "object", - "properties" : { - "entity" : { - "$ref" : "#/components/schemas/InvokableWebscriptResponse_entity" - }, - "_links" : { - "$ref" : "#/components/schemas/InvokeInternalHALLink" - }, - "error" : { - "type" : "string" - }, - "code" : { - "type" : "string" - } - }, - "description" : "Webscript Not Healthy" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "UnhealthyInvokableWebscriptError": _unhealthy_invokable_webscript_error_model_schema -}) - -_update_comment_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"UpdateComment": _update_comment_model_schema}) - -_update_draft_query_model_schema = json.loads( - r"""{ - "required" : [ "chown" ], - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "chown" : { - "type" : "boolean", - "description" : "If set, ownership of the draft function is transferred to the current user.", - "default" : false - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"UpdateDraftQuery": _update_draft_query_model_schema}) - -_update_metadata_request_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "author" : { - "type" : "string", - "description" : "The author of the function." - }, - "description" : { - "type" : "string", - "description" : "A description of the function" - }, - "iconURL" : { - "type" : "string", - "description" : "An url to an icon that represents this function." - }, - "category" : { - "type" : "string", - "description" : "A category for this function (Deprecated: use tags to categorise your functions)", - "deprecated" : true - }, - "documentationURL" : { - "type" : "string", - "description" : "External url that document this function." - }, - "tags" : { - "type" : "array", - "description" : "Tags associated with this function.", - "example" : [ { - "name" : "awaiting-review", - "color" : "#4153ea" - }, { - "name" : "demo", - "color" : "#e639a4" - } ], + "type" : "string" + }, + "versions" : { + "type" : "array", + "description" : "The versions that where deprecated, undeployed and/or removed.", "items" : { - "$ref" : "#/components/schemas/Tag" + "$ref" : "#/components/schemas/SemanticVersion" } - }, - "friendlyName" : { - "type" : "string", - "description" : "Display title for this function." } }, - "additionalProperties" : false + "description" : "Undeployed" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({ - "UpdateMetadataRequestV1": _update_metadata_request_v1_model_schema -}) +MODEL_DEFINITIONS.update({"UndeployedResponseV2": _undeployed_response_v2_model_schema}) _update_metadata_request_v2_model_schema = json.loads( r"""{ @@ -10157,57 +5323,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"UpdateRecord": _update_record_model_schema}) -_user_plug_meta_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "author" : { - "type" : "string", - "description" : "The author of the function." - }, - "description" : { - "type" : "string", - "description" : "A description of the function" - }, - "iconURL" : { - "type" : "string", - "description" : "An url to an icon that represents this function." - }, - "category" : { - "type" : "string", - "description" : "A category for this function (Deprecated: use tags to categorise your functions)", - "deprecated" : true - }, - "documentationURL" : { - "type" : "string", - "description" : "External url that document this function." - }, - "tags" : { - "type" : "array", - "description" : "Tags associated with this function.", - "example" : [ { - "name" : "awaiting-review", - "color" : "#4153ea" - }, { - "name" : "demo", - "color" : "#e639a4" - } ], - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "friendlyName" : { - "type" : "string", - "description" : "Display title for this function." - } - }, - "description" : "Plug metadata that the user can update as `metadata`" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"UserPlugMeta": _user_plug_meta_model_schema}) - _verify_model_schema = json.loads( r"""{ "title" : "Verify", @@ -10310,7 +5425,7 @@ def with_example_provider(dct): _verify_args_model_schema = json.loads( r"""{ "title" : "VerifyArgs", - "required" : [ "endpoint", "namespace", "runtimeName", "runtimeVersion" ], + "required" : [ "endpoint", "namespace", "revision", "runtimeName", "runtimeVersion" ], "type" : "object", "properties" : { "namespace" : { @@ -10433,22 +5548,6 @@ def with_example_provider(dct): "VerifyPlugSyncResponseV2": _verify_plug_sync_response_v2_model_schema }) -_verify_query_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "scaleToZero" : { - "type" : "boolean", - "description" : "Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"VerifyQueryV1": _verify_query_v1_model_schema}) - _verify_result_model_schema = json.loads( r"""{ "title" : "VerifyResult", @@ -10493,281 +5592,21 @@ def with_example_provider(dct): "message" : { "type" : "string" }, - "entity" : { - "$ref" : "#/components/schemas/WebscriptResponseV2" - }, - "result" : { - "$ref" : "#/components/schemas/VerifyResult" - } - }, - "description" : "Webscript Health Verified" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "VerifyWebscriptSyncResponseV2": _verify_webscript_sync_response_v2_model_schema -}) - -_version_includes_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"VersionIncludes": _version_includes_model_schema}) - -_versions_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "endpoint" : { - "type" : "string", - "description" : "Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "imageName" : { - "type" : "string", - "description" : "Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "storageLocation" : { - "type" : "string", - "description" : "Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "nameVersion" : { - "type" : "array", - "description" : "Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - "items" : { - "$ref" : "#/components/schemas/NamedVersion" - } - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Function versions paged query" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"VersionsQuery": _versions_query_model_schema}) - -_versions_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "endpoint" : { - "type" : "string", - "description" : "Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "imageName" : { - "type" : "string", - "description" : "Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "storageLocation" : { - "type" : "string", - "description" : "Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "nameVersion" : { - "type" : "array", - "description" : "Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - "items" : { - "$ref" : "#/components/schemas/NamedVersion" - } - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Function versions paged query" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"VersionsQueryV2": _versions_query_v2_model_schema}) - -_versions_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "count", "entities" ], - "type" : "object", - "properties" : { - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." + "entity" : { + "$ref" : "#/components/schemas/WebscriptResponseV2" }, - "entities" : { - "type" : "array", - "description" : "The specification and deployment status of the queried functions", - "items" : { - "$ref" : "#/components/schemas/AnyFunctionResponse" - } + "result" : { + "$ref" : "#/components/schemas/VerifyResult" } }, - "description" : "Version Listing Response" + "description" : "Webscript Health Verified" } """, object_hook=with_example_provider, ) -MODEL_DEFINITIONS.update({"VersionsResponseV2": _versions_response_v2_model_schema}) +MODEL_DEFINITIONS.update({ + "VerifyWebscriptSyncResponseV2": _verify_webscript_sync_response_v2_model_schema +}) _waiting_children_event_sse_model_schema = json.loads( r"""{ @@ -10912,132 +5751,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"Webscript_2": _webscript_2_model_schema}) -_webscript_latest_version_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - } - }, - "additionalProperties" : false, - "description" : "Webscript latest named version query." -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "WebscriptLatestVersionQueryV2": _webscript_latest_version_query_v2_model_schema -}) - -_webscript_latest_versions_query_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Webscript lastest versions listing query" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "WebscriptLatestVersionsQueryV1": _webscript_latest_versions_query_v1_model_schema -}) - -_webscript_latest_versions_query_v2_model_schema = json.loads( - r"""{ - "description" : "Webscript lastest versions listing query.", - "anyOf" : [ { - "$ref" : "#/components/schemas/LatestFunctionVersionsQuery" - }, { - "$ref" : "#/components/schemas/LatestFunctionsQuery" - } ] -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({ - "WebscriptLatestVersionsQueryV2": _webscript_latest_versions_query_v2_model_schema -}) - _webscript_manifest_model_schema = json.loads( r"""{ "title" : "WebscriptManifest", @@ -11081,73 +5794,6 @@ def with_example_provider(dct): ) MODEL_DEFINITIONS.update({"WebscriptManifest": _webscript_manifest_model_schema}) -_webscript_response_model_schema = json.loads( - r"""{ - "required" : [ "createdAt", "createdBy", "metadata", "name", "runtime", "secret", "status", "updatedAt", "updatedBy", "version" ], - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - }, - "createdBy" : { - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "_links" : { - "type" : "array", - "description" : "Links to related entities.", - "items" : { - "$ref" : "#/components/schemas/JobHALLinks" - } - }, - "secret" : { - "type" : "string", - "nullable" : true - } - }, - "description" : "Successful Response" -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"WebscriptResponse": _webscript_response_model_schema}) - _webscript_response_v2_model_schema = json.loads( r"""{ "required" : [ "createdAt", "createdBy", "deprecated", "draft", "runtime", "status", "updatedAt", "updatedBy", "updates", "webscript" ], @@ -11308,111 +5954,3 @@ def with_example_provider(dct): MODEL_DEFINITIONS.update({ "WebscriptVersionsResponseV2": _webscript_versions_response_v2_model_schema }) - -_with_asset_hal_link_model_schema = json.loads( - r"""{ - "required" : [ "_links" ], - "type" : "object", - "properties" : { - "_links" : { - "$ref" : "#/components/schemas/AssetSummaryWithHALLink__links" - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"WithAssetHALLink": _with_asset_hal_link_model_schema}) - -_with_entity_attributes_model_schema = json.loads( - r"""{ - "required" : [ "createdAt", "createdBy", "deprecated", "draft", "runtime", "status", "updatedAt", "updatedBy", "updates" ], - "type" : "object", - "properties" : { - "createdBy" : { - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "updates" : { - "type" : "array", - "description" : "The audit logs corresponding to the latest modifying operations on this entity.", - "items" : { - "$ref" : "#/components/schemas/UpdateRecord" - } - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "runtime" : { - "$ref" : "#/components/schemas/RuntimeAttributes" - }, - "deprecated" : { - "type" : "boolean", - "description" : "If true this function is deprecated and removed from regular listings." - }, - "draft" : { - "type" : "boolean", - "description" : "If true this function is a draft function and it's assets are still mutable." - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"WithEntityAttributes": _with_entity_attributes_model_schema}) - -_with_limit_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"WithLimit": _with_limit_model_schema}) - -_with_paging_model_schema = json.loads( - r"""{ - "required" : [ "count" ], - "type" : "object", - "properties" : { - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." - } - } -} -""", - object_hook=with_example_provider, -) -MODEL_DEFINITIONS.update({"WithPaging": _with_paging_model_schema}) diff --git a/test/types/alt_embedded_version_i_kfserving_response_v2_stub.py b/test/types/alt_embedded_version_i_kfserving_response_v2_stub.py new file mode 100644 index 00000000..c2c3ec1b --- /dev/null +++ b/test/types/alt_embedded_version_i_kfserving_response_v2_stub.py @@ -0,0 +1,81 @@ +# coding: utf-8 +"""Waylay Function Registry model tests. + +This code was generated from the OpenAPI documentation of 'Waylay Function Registry' + +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" + +import json + +from jsf import JSF +from pydantic import TypeAdapter + +from ..openapi import MODEL_DEFINITIONS, with_example_provider + +try: + from waylay.services.registry.models.alt_embedded_version_i_kfserving_response_v2 import ( + AltEmbeddedVersionIKfservingResponseV2, + ) + + AltEmbeddedVersionIKfservingResponseV2Adapter = TypeAdapter( + AltEmbeddedVersionIKfservingResponseV2 + ) + MODELS_AVAILABLE = True +except ImportError as exc: + MODELS_AVAILABLE = False + +alt_embedded_version_i_kfserving_response_v2__model_schema = json.loads( + r"""{ + "title" : "AltEmbeddedVersion_IKfservingResponseV2_", + "type" : "object", + "properties" : { + "draft" : { + "$ref" : "#/components/schemas/KfservingResponseV2" + }, + "published" : { + "$ref" : "#/components/schemas/KfservingResponseV2" + } + }, + "description" : "Embedded representations of the _latest_ draft/published versions." +} +""", + object_hook=with_example_provider, +) +alt_embedded_version_i_kfserving_response_v2__model_schema.update({ + "definitions": MODEL_DEFINITIONS +}) + +alt_embedded_version_i_kfserving_response_v2__faker = JSF( + alt_embedded_version_i_kfserving_response_v2__model_schema, allow_none_optionals=1 +) + + +class AltEmbeddedVersionIKfservingResponseV2Stub: + """AltEmbeddedVersionIKfservingResponseV2 unit test stubs.""" + + @classmethod + def create_json(cls): + """Create a dict stub instance.""" + return alt_embedded_version_i_kfserving_response_v2__faker.generate( + use_defaults=True, use_examples=True + ) + + @classmethod + def create_instance(cls) -> "AltEmbeddedVersionIKfservingResponseV2": + """Create AltEmbeddedVersionIKfservingResponseV2 stub instance.""" + if not MODELS_AVAILABLE: + raise ImportError("Models must be installed to create class stubs") + json = cls.create_json() + if not json: + # use backup example based on the pydantic model schema + backup_faker = JSF( + AltEmbeddedVersionIKfservingResponseV2Adapter.json_schema(), + allow_none_optionals=1, + ) + json = backup_faker.generate(use_defaults=True, use_examples=True) + return AltEmbeddedVersionIKfservingResponseV2Adapter.validate_python( + json, context={"skip_validation": True} + ) diff --git a/test/types/job_event_payload_completed_event_data_stub.py b/test/types/alt_embedded_version_i_plug_response_v2_stub.py similarity index 50% rename from test/types/job_event_payload_completed_event_data_stub.py rename to test/types/alt_embedded_version_i_plug_response_v2_stub.py index 84fab82d..3d2adaa8 100644 --- a/test/types/job_event_payload_completed_event_data_stub.py +++ b/test/types/alt_embedded_version_i_plug_response_v2_stub.py @@ -16,70 +16,66 @@ from ..openapi import MODEL_DEFINITIONS, with_example_provider try: - from waylay.services.registry.models.job_event_payload_completed_event_data import ( - JobEventPayloadCompletedEventData, + from waylay.services.registry.models.alt_embedded_version_i_plug_response_v2 import ( + AltEmbeddedVersionIPlugResponseV2, ) - JobEventPayloadCompletedEventDataAdapter = TypeAdapter( - JobEventPayloadCompletedEventData + AltEmbeddedVersionIPlugResponseV2Adapter = TypeAdapter( + AltEmbeddedVersionIPlugResponseV2 ) MODELS_AVAILABLE = True except ImportError as exc: MODELS_AVAILABLE = False -job_event_payload_completed_event_data__model_schema = json.loads( +alt_embedded_version_i_plug_response_v2__model_schema = json.loads( r"""{ - "required" : [ "data", "job", "timestamp" ], + "title" : "AltEmbeddedVersion_IPlugResponseV2_", "type" : "object", "properties" : { - "job" : { - "$ref" : "#/components/schemas/JobReference" + "draft" : { + "$ref" : "#/components/schemas/PlugResponseV2" }, - "data" : { - "$ref" : "#/components/schemas/CompletedEventData" - }, - "timestamp" : { - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" + "published" : { + "$ref" : "#/components/schemas/PlugResponseV2" } - } + }, + "description" : "Embedded representations of the _latest_ draft/published versions." } """, object_hook=with_example_provider, ) -job_event_payload_completed_event_data__model_schema.update({ +alt_embedded_version_i_plug_response_v2__model_schema.update({ "definitions": MODEL_DEFINITIONS }) -job_event_payload_completed_event_data__faker = JSF( - job_event_payload_completed_event_data__model_schema, allow_none_optionals=1 +alt_embedded_version_i_plug_response_v2__faker = JSF( + alt_embedded_version_i_plug_response_v2__model_schema, allow_none_optionals=1 ) -class JobEventPayloadCompletedEventDataStub: - """JobEventPayloadCompletedEventData unit test stubs.""" +class AltEmbeddedVersionIPlugResponseV2Stub: + """AltEmbeddedVersionIPlugResponseV2 unit test stubs.""" @classmethod def create_json(cls): """Create a dict stub instance.""" - return job_event_payload_completed_event_data__faker.generate( + return alt_embedded_version_i_plug_response_v2__faker.generate( use_defaults=True, use_examples=True ) @classmethod - def create_instance(cls) -> "JobEventPayloadCompletedEventData": - """Create JobEventPayloadCompletedEventData stub instance.""" + def create_instance(cls) -> "AltEmbeddedVersionIPlugResponseV2": + """Create AltEmbeddedVersionIPlugResponseV2 stub instance.""" if not MODELS_AVAILABLE: raise ImportError("Models must be installed to create class stubs") json = cls.create_json() if not json: # use backup example based on the pydantic model schema backup_faker = JSF( - JobEventPayloadCompletedEventDataAdapter.json_schema(), + AltEmbeddedVersionIPlugResponseV2Adapter.json_schema(), allow_none_optionals=1, ) json = backup_faker.generate(use_defaults=True, use_examples=True) - return JobEventPayloadCompletedEventDataAdapter.validate_python( + return AltEmbeddedVersionIPlugResponseV2Adapter.validate_python( json, context={"skip_validation": True} ) diff --git a/test/types/alt_embedded_version_i_webscript_response_with_invoke_link_v2_stub.py b/test/types/alt_embedded_version_i_webscript_response_with_invoke_link_v2_stub.py new file mode 100644 index 00000000..cf7dbd1e --- /dev/null +++ b/test/types/alt_embedded_version_i_webscript_response_with_invoke_link_v2_stub.py @@ -0,0 +1,86 @@ +# coding: utf-8 +"""Waylay Function Registry model tests. + +This code was generated from the OpenAPI documentation of 'Waylay Function Registry' + +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. +""" + +import json + +from jsf import JSF +from pydantic import TypeAdapter + +from ..openapi import MODEL_DEFINITIONS, with_example_provider + +try: + from waylay.services.registry.models.alt_embedded_version_i_webscript_response_with_invoke_link_v2 import ( + AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2, + ) + + AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2Adapter = TypeAdapter( + AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2 + ) + MODELS_AVAILABLE = True +except ImportError as exc: + MODELS_AVAILABLE = False + +alt_embedded_version_i_webscript_response_with_invoke_link_v2__model_schema = ( + json.loads( + r"""{ + "title" : "AltEmbeddedVersion_IWebscriptResponseWithInvokeLinkV2_", + "type" : "object", + "properties" : { + "draft" : { + "$ref" : "#/components/schemas/WebscriptResponseWithInvokeLinkV2" + }, + "published" : { + "$ref" : "#/components/schemas/WebscriptResponseWithInvokeLinkV2" + } + }, + "description" : "Embedded representations of the _latest_ draft/published versions." +} +""", + object_hook=with_example_provider, + ) +) +alt_embedded_version_i_webscript_response_with_invoke_link_v2__model_schema.update({ + "definitions": MODEL_DEFINITIONS +}) + +alt_embedded_version_i_webscript_response_with_invoke_link_v2__faker = JSF( + alt_embedded_version_i_webscript_response_with_invoke_link_v2__model_schema, + allow_none_optionals=1, +) + + +class AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2Stub: + """AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2 unit test stubs.""" + + @classmethod + def create_json(cls): + """Create a dict stub instance.""" + return alt_embedded_version_i_webscript_response_with_invoke_link_v2__faker.generate( + use_defaults=True, use_examples=True + ) + + @classmethod + def create_instance(cls) -> "AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2": + """Create AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2 stub instance.""" + if not MODELS_AVAILABLE: + raise ImportError("Models must be installed to create class stubs") + json = cls.create_json() + if not json: + # use backup example based on the pydantic model schema + backup_faker = JSF( + AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2Adapter.json_schema(), + allow_none_optionals=1, + ) + json = backup_faker.generate(use_defaults=True, use_examples=True) + return ( + AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2Adapter.validate_python( + json, context={"skip_validation": True} + ) + ) diff --git a/test/types/any_function_response_stub.py b/test/types/any_function_response_stub.py deleted file mode 100644 index ea64aca5..00000000 --- a/test/types/any_function_response_stub.py +++ /dev/null @@ -1,72 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.any_function_response import ( - AnyFunctionResponse, - ) - - AnyFunctionResponseAdapter = TypeAdapter(AnyFunctionResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -any_function_response_model_schema = json.loads( - r"""{ - "anyOf" : [ { - "$ref" : "#/components/schemas/PlugResponseV2" - }, { - "$ref" : "#/components/schemas/KfservingResponseV2" - }, { - "$ref" : "#/components/schemas/WebscriptResponseV2" - } ] -} -""", - object_hook=with_example_provider, -) -any_function_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -any_function_response_faker = JSF( - any_function_response_model_schema, allow_none_optionals=1 -) - - -class AnyFunctionResponseStub: - """AnyFunctionResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return any_function_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "AnyFunctionResponse": - """Create AnyFunctionResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - AnyFunctionResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return AnyFunctionResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/any_job_result_stub.py b/test/types/any_job_result_stub.py index a3dc22b6..8911a367 100644 --- a/test/types/any_job_result_stub.py +++ b/test/types/any_job_result_stub.py @@ -40,6 +40,8 @@ "$ref" : "#/components/schemas/BatchResult" }, { "$ref" : "#/components/schemas/CleanupResult" + }, { + "$ref" : "#/components/schemas/NotifyResult" } ] } """, diff --git a/test/types/archive_format_stub.py b/test/types/archive_format_stub.py index 3d57c770..d3ed9646 100644 --- a/test/types/archive_format_stub.py +++ b/test/types/archive_format_stub.py @@ -25,7 +25,6 @@ archive_format_model_schema = json.loads( r"""{ - "title" : "ArchiveFormat", "type" : "string", "enum" : [ "node", "python", "golang", "byoml", "native" ] } diff --git a/test/types/asset_path_params_v2_stub.py b/test/types/asset_path_params_v2_stub.py deleted file mode 100644 index cd8393c1..00000000 --- a/test/types/asset_path_params_v2_stub.py +++ /dev/null @@ -1,70 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.asset_path_params_v2 import AssetPathParamsV2 - - AssetPathParamsV2Adapter = TypeAdapter(AssetPathParamsV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -asset_path_params_v2_model_schema = json.loads( - r"""{ - "required" : [ "*" ], - "type" : "object", - "properties" : { - "*" : { - "type" : "string", - "description" : "Full path or path prefix of the asset within the archive" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -asset_path_params_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -asset_path_params_v2_faker = JSF( - asset_path_params_v2_model_schema, allow_none_optionals=1 -) - - -class AssetPathParamsV2Stub: - """AssetPathParamsV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return asset_path_params_v2_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "AssetPathParamsV2": - """Create AssetPathParamsV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - AssetPathParamsV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return AssetPathParamsV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/asset_role_stub.py b/test/types/asset_role_stub.py index 9bd78207..40cb220e 100644 --- a/test/types/asset_role_stub.py +++ b/test/types/asset_role_stub.py @@ -25,7 +25,6 @@ asset_role_model_schema = json.loads( r"""{ - "title" : "AssetRole", "type" : "string", "description" : "Classification of assets with regard to their role.", "enum" : [ "manifest", "project", "main", "lib", "script", "other" ] diff --git a/test/types/asset_summary_stub.py b/test/types/asset_summary_stub.py deleted file mode 100644 index 8f804cff..00000000 --- a/test/types/asset_summary_stub.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.asset_summary import AssetSummary - - AssetSummaryAdapter = TypeAdapter(AssetSummary) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -asset_summary_model_schema = json.loads( - r"""{ - "required" : [ "name" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "File name" - }, - "title" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "role" : { - "$ref" : "#/components/schemas/AssetRole" - } - } -} -""", - object_hook=with_example_provider, -) -asset_summary_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -asset_summary_faker = JSF(asset_summary_model_schema, allow_none_optionals=1) - - -class AssetSummaryStub: - """AssetSummary unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return asset_summary_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "AssetSummary": - """Create AssetSummary stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - AssetSummaryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return AssetSummaryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/async_deploy_query_stub.py b/test/types/async_deploy_query_stub.py deleted file mode 100644 index a8de0ba8..00000000 --- a/test/types/async_deploy_query_stub.py +++ /dev/null @@ -1,80 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.async_deploy_query import AsyncDeployQuery - - AsyncDeployQueryAdapter = TypeAdapter(AsyncDeployQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -async_deploy_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "deprecatePrevious" : { - "$ref" : "#/components/schemas/DeprecatePreviousPolicy" - }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, validates the deployment conditions, but does not change anything." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "scaleToZero" : { - "type" : "boolean", - "description" : "If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately.", - "default" : false - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -async_deploy_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -async_deploy_query_faker = JSF(async_deploy_query_model_schema, allow_none_optionals=1) - - -class AsyncDeployQueryStub: - """AsyncDeployQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return async_deploy_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "AsyncDeployQuery": - """Create AsyncDeployQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - AsyncDeployQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return AsyncDeployQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/async_deploy_query_v1_stub.py b/test/types/async_deploy_query_v1_stub.py deleted file mode 100644 index 41aade22..00000000 --- a/test/types/async_deploy_query_v1_stub.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.async_deploy_query_v1 import AsyncDeployQueryV1 - - AsyncDeployQueryV1Adapter = TypeAdapter(AsyncDeployQueryV1) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -async_deploy_query_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "scaleToZero" : { - "type" : "boolean", - "description" : "If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately.", - "default" : false - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, validates the deployment conditions, but does not change anything." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -async_deploy_query_v1_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -async_deploy_query_v1_faker = JSF( - async_deploy_query_v1_model_schema, allow_none_optionals=1 -) - - -class AsyncDeployQueryV1Stub: - """AsyncDeployQueryV1 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return async_deploy_query_v1_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "AsyncDeployQueryV1": - """Create AsyncDeployQueryV1 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - AsyncDeployQueryV1Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return AsyncDeployQueryV1Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/async_query_default_false_stub.py b/test/types/async_query_default_false_stub.py deleted file mode 100644 index 10a41804..00000000 --- a/test/types/async_query_default_false_stub.py +++ /dev/null @@ -1,74 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.async_query_default_false import ( - AsyncQueryDefaultFalse, - ) - - AsyncQueryDefaultFalseAdapter = TypeAdapter(AsyncQueryDefaultFalse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -async_query_default_false_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "async" : { - "type" : "boolean", - "description" : "If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - "default" : false - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -async_query_default_false_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -async_query_default_false_faker = JSF( - async_query_default_false_model_schema, allow_none_optionals=1 -) - - -class AsyncQueryDefaultFalseStub: - """AsyncQueryDefaultFalse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return async_query_default_false_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "AsyncQueryDefaultFalse": - """Create AsyncQueryDefaultFalse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - AsyncQueryDefaultFalseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return AsyncQueryDefaultFalseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/async_query_default_true_stub.py b/test/types/async_query_default_true_stub.py deleted file mode 100644 index e81c246c..00000000 --- a/test/types/async_query_default_true_stub.py +++ /dev/null @@ -1,74 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.async_query_default_true import ( - AsyncQueryDefaultTrue, - ) - - AsyncQueryDefaultTrueAdapter = TypeAdapter(AsyncQueryDefaultTrue) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -async_query_default_true_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -async_query_default_true_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -async_query_default_true_faker = JSF( - async_query_default_true_model_schema, allow_none_optionals=1 -) - - -class AsyncQueryDefaultTrueStub: - """AsyncQueryDefaultTrue unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return async_query_default_true_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "AsyncQueryDefaultTrue": - """Create AsyncQueryDefaultTrue stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - AsyncQueryDefaultTrueAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return AsyncQueryDefaultTrueAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/async_verify_query_stub.py b/test/types/async_verify_query_stub.py deleted file mode 100644 index 058111bf..00000000 --- a/test/types/async_verify_query_stub.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.async_verify_query import AsyncVerifyQuery - - AsyncVerifyQueryAdapter = TypeAdapter(AsyncVerifyQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -async_verify_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "scaleToZero" : { - "type" : "boolean", - "description" : "Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -async_verify_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -async_verify_query_faker = JSF(async_verify_query_model_schema, allow_none_optionals=1) - - -class AsyncVerifyQueryStub: - """AsyncVerifyQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return async_verify_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "AsyncVerifyQuery": - """Create AsyncVerifyQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - AsyncVerifyQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return AsyncVerifyQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/build_args_stub.py b/test/types/build_args_stub.py index 03e22ea0..35d45f41 100644 --- a/test/types/build_args_stub.py +++ b/test/types/build_args_stub.py @@ -26,7 +26,7 @@ build_args_model_schema = json.loads( r"""{ "title" : "BuildArgs", - "required" : [ "args", "imageName", "runtimeName", "runtimeVersion", "storageLocation" ], + "required" : [ "args", "imageName", "revision", "runtimeName", "runtimeVersion", "storageLocation" ], "type" : "object", "properties" : { "runtimeName" : { diff --git a/test/types/completed_event_data_stub.py b/test/types/completed_event_data_stub.py index 3ba6a77c..868eab84 100644 --- a/test/types/completed_event_data_stub.py +++ b/test/types/completed_event_data_stub.py @@ -26,13 +26,13 @@ completed_event_data_model_schema = json.loads( r"""{ "title" : "CompletedEventData", - "required" : [ "returnValue" ], + "required" : [ "returnvalue" ], "type" : "object", "properties" : { "prev" : { "$ref" : "#/components/schemas/QueueEvents" }, - "returnValue" : { + "returnvalue" : { "$ref" : "#/components/schemas/AnyJobResult" } } diff --git a/test/types/content_query_v2_stub.py b/test/types/content_query_v2_stub.py deleted file mode 100644 index 058a68d7..00000000 --- a/test/types/content_query_v2_stub.py +++ /dev/null @@ -1,68 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.content_query_v2 import ContentQueryV2 - - ContentQueryV2Adapter = TypeAdapter(ContentQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -content_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "ls" : { - "type" : "boolean", - "description" : "If set to `true`, the result will be a listing of the files in the asset, annotated with metadata and validation report from the asset conditions of the functions runtime.", - "default" : false - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -content_query_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -content_query_v2_faker = JSF(content_query_v2_model_schema, allow_none_optionals=1) - - -class ContentQueryV2Stub: - """ContentQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return content_query_v2_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "ContentQueryV2": - """Create ContentQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - ContentQueryV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return ContentQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/create_function_query_v2_stub.py b/test/types/create_function_query_v2_stub.py deleted file mode 100644 index 65e46227..00000000 --- a/test/types/create_function_query_v2_stub.py +++ /dev/null @@ -1,98 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.create_function_query_v2 import ( - CreateFunctionQueryV2, - ) - - CreateFunctionQueryV2Adapter = TypeAdapter(CreateFunctionQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -create_function_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "deprecatePrevious" : { - "$ref" : "#/components/schemas/DeprecatePreviousPolicy" - }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, validates the deployment conditions, but does not change anything." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "scaleToZero" : { - "type" : "boolean", - "description" : "If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately.", - "default" : false - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "name" : { - "type" : "string", - "description" : "If set, the value will be used as the function name instead of the one specified in the manifest." - }, - "draft" : { - "type" : "boolean", - "description" : "If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid.", - "default" : false - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -create_function_query_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -create_function_query_v2_faker = JSF( - create_function_query_v2_model_schema, allow_none_optionals=1 -) - - -class CreateFunctionQueryV2Stub: - """CreateFunctionQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return create_function_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "CreateFunctionQueryV2": - """Create CreateFunctionQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - CreateFunctionQueryV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return CreateFunctionQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/create_kf_serving_async_response_stub.py b/test/types/create_kf_serving_async_response_stub.py deleted file mode 100644 index ad176256..00000000 --- a/test/types/create_kf_serving_async_response_stub.py +++ /dev/null @@ -1,80 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.create_kf_serving_async_response import ( - CreateKFServingAsyncResponse, - ) - - CreateKFServingAsyncResponseAdapter = TypeAdapter(CreateKFServingAsyncResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -create_kf_serving_async_response_model_schema = json.loads( - r"""{ - "required" : [ "_links", "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "entity" : { - "$ref" : "#/components/schemas/KFServingManifest" - } - }, - "description" : "Model Deployment Initiated" -} -""", - object_hook=with_example_provider, -) -create_kf_serving_async_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -create_kf_serving_async_response_faker = JSF( - create_kf_serving_async_response_model_schema, allow_none_optionals=1 -) - - -class CreateKFServingAsyncResponseStub: - """CreateKFServingAsyncResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return create_kf_serving_async_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "CreateKFServingAsyncResponse": - """Create CreateKFServingAsyncResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - CreateKFServingAsyncResponseAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return CreateKFServingAsyncResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/create_plug_async_response_stub.py b/test/types/create_plug_async_response_stub.py deleted file mode 100644 index 7fa00ede..00000000 --- a/test/types/create_plug_async_response_stub.py +++ /dev/null @@ -1,79 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.create_plug_async_response import ( - CreatePlugAsyncResponse, - ) - - CreatePlugAsyncResponseAdapter = TypeAdapter(CreatePlugAsyncResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -create_plug_async_response_model_schema = json.loads( - r"""{ - "required" : [ "_links", "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "entity" : { - "$ref" : "#/components/schemas/PlugManifest" - } - }, - "description" : "Successful Response" -} -""", - object_hook=with_example_provider, -) -create_plug_async_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -create_plug_async_response_faker = JSF( - create_plug_async_response_model_schema, allow_none_optionals=1 -) - - -class CreatePlugAsyncResponseStub: - """CreatePlugAsyncResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return create_plug_async_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "CreatePlugAsyncResponse": - """Create CreatePlugAsyncResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - CreatePlugAsyncResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return CreatePlugAsyncResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/create_webscript_async_response_stub.py b/test/types/create_webscript_async_response_stub.py deleted file mode 100644 index c6173d56..00000000 --- a/test/types/create_webscript_async_response_stub.py +++ /dev/null @@ -1,80 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.create_webscript_async_response import ( - CreateWebscriptAsyncResponse, - ) - - CreateWebscriptAsyncResponseAdapter = TypeAdapter(CreateWebscriptAsyncResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -create_webscript_async_response_model_schema = json.loads( - r"""{ - "required" : [ "_links", "entity", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "entity" : { - "$ref" : "#/components/schemas/WebscriptManifest" - } - }, - "description" : "Successful Response" -} -""", - object_hook=with_example_provider, -) -create_webscript_async_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -create_webscript_async_response_faker = JSF( - create_webscript_async_response_model_schema, allow_none_optionals=1 -) - - -class CreateWebscriptAsyncResponseStub: - """CreateWebscriptAsyncResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return create_webscript_async_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "CreateWebscriptAsyncResponse": - """Create CreateWebscriptAsyncResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - CreateWebscriptAsyncResponseAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return CreateWebscriptAsyncResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_required_properties_inner_stub.py b/test/types/create_webscripts_copy_parameter_stub.py similarity index 55% rename from test/types/legacy_required_properties_inner_stub.py rename to test/types/create_webscripts_copy_parameter_stub.py index 412cc344..28406ec5 100644 --- a/test/types/legacy_required_properties_inner_stub.py +++ b/test/types/create_webscripts_copy_parameter_stub.py @@ -16,57 +16,56 @@ from ..openapi import MODEL_DEFINITIONS, with_example_provider try: - from waylay.services.registry.models.legacy_required_properties_inner import ( - LegacyRequiredPropertiesInner, + from waylay.services.registry.models.create_webscripts_copy_parameter import ( + CreateWebscriptsCopyParameter, ) - LegacyRequiredPropertiesInnerAdapter = TypeAdapter(LegacyRequiredPropertiesInner) + CreateWebscriptsCopyParameterAdapter = TypeAdapter(CreateWebscriptsCopyParameter) MODELS_AVAILABLE = True except ImportError as exc: MODELS_AVAILABLE = False -legacy_required_properties_inner_model_schema = json.loads( +create_webscripts_copy_parameter_model_schema = json.loads( r"""{ - "title" : "LegacyRequiredProperties_inner", "anyOf" : [ { - "type" : "string" + "$ref" : "#/components/schemas/NamedVersionRange" }, { - "$ref" : "#/components/schemas/LegacyRequiredPropertyObject" + "$ref" : "#/components/schemas/ExampleReference" } ] } """, object_hook=with_example_provider, ) -legacy_required_properties_inner_model_schema.update({"definitions": MODEL_DEFINITIONS}) +create_webscripts_copy_parameter_model_schema.update({"definitions": MODEL_DEFINITIONS}) -legacy_required_properties_inner_faker = JSF( - legacy_required_properties_inner_model_schema, allow_none_optionals=1 +create_webscripts_copy_parameter_faker = JSF( + create_webscripts_copy_parameter_model_schema, allow_none_optionals=1 ) -class LegacyRequiredPropertiesInnerStub: - """LegacyRequiredPropertiesInner unit test stubs.""" +class CreateWebscriptsCopyParameterStub: + """CreateWebscriptsCopyParameter unit test stubs.""" @classmethod def create_json(cls): """Create a dict stub instance.""" - return legacy_required_properties_inner_faker.generate( + return create_webscripts_copy_parameter_faker.generate( use_defaults=True, use_examples=True ) @classmethod - def create_instance(cls) -> "LegacyRequiredPropertiesInner": - """Create LegacyRequiredPropertiesInner stub instance.""" + def create_instance(cls) -> "CreateWebscriptsCopyParameter": + """Create CreateWebscriptsCopyParameter stub instance.""" if not MODELS_AVAILABLE: raise ImportError("Models must be installed to create class stubs") json = cls.create_json() if not json: # use backup example based on the pydantic model schema backup_faker = JSF( - LegacyRequiredPropertiesInnerAdapter.json_schema(), + CreateWebscriptsCopyParameterAdapter.json_schema(), allow_none_optionals=1, ) json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyRequiredPropertiesInnerAdapter.validate_python( + return CreateWebscriptsCopyParameterAdapter.validate_python( json, context={"skip_validation": True} ) diff --git a/test/types/deploy_args_stub.py b/test/types/deploy_args_stub.py index 7609d2cb..ae5be32f 100644 --- a/test/types/deploy_args_stub.py +++ b/test/types/deploy_args_stub.py @@ -26,7 +26,7 @@ deploy_args_model_schema = json.loads( r"""{ "title" : "DeployArgs", - "required" : [ "deploySpecOverrides", "endpoint", "imageName", "namespace", "runtimeName", "runtimeVersion" ], + "required" : [ "deploySpecOverrides", "endpoint", "imageName", "namespace", "revision", "runtimeName", "runtimeVersion" ], "type" : "object", "properties" : { "namespace" : { diff --git a/test/types/deploy_attributes_filter_stub.py b/test/types/deploy_attributes_filter_stub.py deleted file mode 100644 index 380df86f..00000000 --- a/test/types/deploy_attributes_filter_stub.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.deploy_attributes_filter import ( - DeployAttributesFilter, - ) - - DeployAttributesFilterAdapter = TypeAdapter(DeployAttributesFilter) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -deploy_attributes_filter_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "endpoint" : { - "type" : "string", - "description" : "Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "imageName" : { - "type" : "string", - "description" : "Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "storageLocation" : { - "type" : "string", - "description" : "Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -deploy_attributes_filter_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -deploy_attributes_filter_faker = JSF( - deploy_attributes_filter_model_schema, allow_none_optionals=1 -) - - -class DeployAttributesFilterStub: - """DeployAttributesFilter unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return deploy_attributes_filter_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "DeployAttributesFilter": - """Create DeployAttributesFilter stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - DeployAttributesFilterAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return DeployAttributesFilterAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/deprecate_previous_policy_stub.py b/test/types/deprecate_previous_policy_stub.py index f57a05d8..9877e51a 100644 --- a/test/types/deprecate_previous_policy_stub.py +++ b/test/types/deprecate_previous_policy_stub.py @@ -27,7 +27,6 @@ deprecate_previous_policy_model_schema = json.loads( r"""{ - "title" : "DeprecatePreviousPolicy", "type" : "string", "enum" : [ "none", "all", "patch", "minor" ] } diff --git a/test/types/deprecate_previous_query_stub.py b/test/types/deprecate_previous_query_stub.py deleted file mode 100644 index 9dbc0afe..00000000 --- a/test/types/deprecate_previous_query_stub.py +++ /dev/null @@ -1,72 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.deprecate_previous_query import ( - DeprecatePreviousQuery, - ) - - DeprecatePreviousQueryAdapter = TypeAdapter(DeprecatePreviousQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -deprecate_previous_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "deprecatePrevious" : { - "$ref" : "#/components/schemas/DeprecatePreviousPolicy" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -deprecate_previous_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -deprecate_previous_query_faker = JSF( - deprecate_previous_query_model_schema, allow_none_optionals=1 -) - - -class DeprecatePreviousQueryStub: - """DeprecatePreviousQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return deprecate_previous_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "DeprecatePreviousQuery": - """Create DeprecatePreviousQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - DeprecatePreviousQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return DeprecatePreviousQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/deprecated_draft_filter_stub.py b/test/types/deprecated_draft_filter_stub.py deleted file mode 100644 index 2cb796de..00000000 --- a/test/types/deprecated_draft_filter_stub.py +++ /dev/null @@ -1,77 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.deprecated_draft_filter import ( - DeprecatedDraftFilter, - ) - - DeprecatedDraftFilterAdapter = TypeAdapter(DeprecatedDraftFilter) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -deprecated_draft_filter_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -deprecated_draft_filter_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -deprecated_draft_filter_faker = JSF( - deprecated_draft_filter_model_schema, allow_none_optionals=1 -) - - -class DeprecatedDraftFilterStub: - """DeprecatedDraftFilter unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return deprecated_draft_filter_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "DeprecatedDraftFilter": - """Create DeprecatedDraftFilter stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - DeprecatedDraftFilterAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return DeprecatedDraftFilterAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/dry_run_query_stub.py b/test/types/dry_run_query_stub.py deleted file mode 100644 index 20fe0f0b..00000000 --- a/test/types/dry_run_query_stub.py +++ /dev/null @@ -1,65 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.dry_run_query import DryRunQuery - - DryRunQueryAdapter = TypeAdapter(DryRunQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -dry_run_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, validates the deployment conditions, but does not change anything." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -dry_run_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -dry_run_query_faker = JSF(dry_run_query_model_schema, allow_none_optionals=1) - - -class DryRunQueryStub: - """DryRunQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return dry_run_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "DryRunQuery": - """Create DryRunQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(DryRunQueryAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return DryRunQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/entity_response_stub.py b/test/types/entity_response_stub.py deleted file mode 100644 index 227555b1..00000000 --- a/test/types/entity_response_stub.py +++ /dev/null @@ -1,113 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.entity_response import EntityResponse - - EntityResponseAdapter = TypeAdapter(EntityResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -entity_response_model_schema = json.loads( - r"""{ - "required" : [ "createdAt", "createdBy", "metadata", "name", "runtime", "status", "updatedAt", "updatedBy", "version" ], - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - }, - "createdBy" : { - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "_links" : { - "type" : "array", - "description" : "Links to related entities.", - "items" : { - "$ref" : "#/components/schemas/JobHALLinks" - } - } - } -} -""", - object_hook=with_example_provider, -) -entity_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -entity_response_faker = JSF(entity_response_model_schema, allow_none_optionals=1) - - -class EntityResponseStub: - """EntityResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return entity_response_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "EntityResponse": - """Create EntityResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - EntityResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return EntityResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/latest_models_response_v2_entities_inner_stub.py b/test/types/entity_with_links_i_kfserving_response_v2_stub.py similarity index 70% rename from test/types/latest_models_response_v2_entities_inner_stub.py rename to test/types/entity_with_links_i_kfserving_response_v2_stub.py index e696317a..8cef1a63 100644 --- a/test/types/latest_models_response_v2_entities_inner_stub.py +++ b/test/types/entity_with_links_i_kfserving_response_v2_stub.py @@ -16,23 +16,26 @@ from ..openapi import MODEL_DEFINITIONS, with_example_provider try: - from waylay.services.registry.models.latest_models_response_v2_entities_inner import ( - LatestModelsResponseV2EntitiesInner, + from waylay.services.registry.models.entity_with_links_i_kfserving_response_v2 import ( + EntityWithLinksIKfservingResponseV2, ) - LatestModelsResponseV2EntitiesInnerAdapter = TypeAdapter( - LatestModelsResponseV2EntitiesInner + EntityWithLinksIKfservingResponseV2Adapter = TypeAdapter( + EntityWithLinksIKfservingResponseV2 ) MODELS_AVAILABLE = True except ImportError as exc: MODELS_AVAILABLE = False -latest_models_response_v2_entities_inner_model_schema = json.loads( +entity_with_links_i_kfserving_response_v2__model_schema = json.loads( r"""{ - "title" : "LatestModelsResponseV2_entities_inner", - "required" : [ "_links", "createdAt", "createdBy", "deprecated", "draft", "model", "runtime", "status", "updatedAt", "updatedBy", "updates" ], + "title" : "EntityWithLinks_IKfservingResponseV2_", + "required" : [ "createdAt", "createdBy", "deprecated", "draft", "model", "runtime", "status", "updatedAt", "updatedBy", "updates" ], "type" : "object", "properties" : { + "_embedded" : { + "$ref" : "#/components/schemas/AltEmbeddedVersion_IKfservingResponseV2_" + }, "_links" : { "$ref" : "#/components/schemas/AltVersionHALLink" }, @@ -93,38 +96,38 @@ """, object_hook=with_example_provider, ) -latest_models_response_v2_entities_inner_model_schema.update({ +entity_with_links_i_kfserving_response_v2__model_schema.update({ "definitions": MODEL_DEFINITIONS }) -latest_models_response_v2_entities_inner_faker = JSF( - latest_models_response_v2_entities_inner_model_schema, allow_none_optionals=1 +entity_with_links_i_kfserving_response_v2__faker = JSF( + entity_with_links_i_kfserving_response_v2__model_schema, allow_none_optionals=1 ) -class LatestModelsResponseV2EntitiesInnerStub: - """LatestModelsResponseV2EntitiesInner unit test stubs.""" +class EntityWithLinksIKfservingResponseV2Stub: + """EntityWithLinksIKfservingResponseV2 unit test stubs.""" @classmethod def create_json(cls): """Create a dict stub instance.""" - return latest_models_response_v2_entities_inner_faker.generate( + return entity_with_links_i_kfserving_response_v2__faker.generate( use_defaults=True, use_examples=True ) @classmethod - def create_instance(cls) -> "LatestModelsResponseV2EntitiesInner": - """Create LatestModelsResponseV2EntitiesInner stub instance.""" + def create_instance(cls) -> "EntityWithLinksIKfservingResponseV2": + """Create EntityWithLinksIKfservingResponseV2 stub instance.""" if not MODELS_AVAILABLE: raise ImportError("Models must be installed to create class stubs") json = cls.create_json() if not json: # use backup example based on the pydantic model schema backup_faker = JSF( - LatestModelsResponseV2EntitiesInnerAdapter.json_schema(), + EntityWithLinksIKfservingResponseV2Adapter.json_schema(), allow_none_optionals=1, ) json = backup_faker.generate(use_defaults=True, use_examples=True) - return LatestModelsResponseV2EntitiesInnerAdapter.validate_python( + return EntityWithLinksIKfservingResponseV2Adapter.validate_python( json, context={"skip_validation": True} ) diff --git a/test/types/latest_plugs_response_v2_entities_inner_stub.py b/test/types/entity_with_links_i_plug_response_v2_stub.py similarity index 71% rename from test/types/latest_plugs_response_v2_entities_inner_stub.py rename to test/types/entity_with_links_i_plug_response_v2_stub.py index f7737c30..f743c757 100644 --- a/test/types/latest_plugs_response_v2_entities_inner_stub.py +++ b/test/types/entity_with_links_i_plug_response_v2_stub.py @@ -16,23 +16,24 @@ from ..openapi import MODEL_DEFINITIONS, with_example_provider try: - from waylay.services.registry.models.latest_plugs_response_v2_entities_inner import ( - LatestPlugsResponseV2EntitiesInner, + from waylay.services.registry.models.entity_with_links_i_plug_response_v2 import ( + EntityWithLinksIPlugResponseV2, ) - LatestPlugsResponseV2EntitiesInnerAdapter = TypeAdapter( - LatestPlugsResponseV2EntitiesInner - ) + EntityWithLinksIPlugResponseV2Adapter = TypeAdapter(EntityWithLinksIPlugResponseV2) MODELS_AVAILABLE = True except ImportError as exc: MODELS_AVAILABLE = False -latest_plugs_response_v2_entities_inner_model_schema = json.loads( +entity_with_links_i_plug_response_v2__model_schema = json.loads( r"""{ - "title" : "LatestPlugsResponseV2_entities_inner", - "required" : [ "_links", "createdAt", "createdBy", "deprecated", "draft", "plug", "runtime", "status", "updatedAt", "updatedBy", "updates" ], + "title" : "EntityWithLinks_IPlugResponseV2_", + "required" : [ "createdAt", "createdBy", "deprecated", "draft", "plug", "runtime", "status", "updatedAt", "updatedBy", "updates" ], "type" : "object", "properties" : { + "_embedded" : { + "$ref" : "#/components/schemas/AltEmbeddedVersion_IPlugResponseV2_" + }, "_links" : { "$ref" : "#/components/schemas/AltVersionHALLink" }, @@ -93,38 +94,38 @@ """, object_hook=with_example_provider, ) -latest_plugs_response_v2_entities_inner_model_schema.update({ +entity_with_links_i_plug_response_v2__model_schema.update({ "definitions": MODEL_DEFINITIONS }) -latest_plugs_response_v2_entities_inner_faker = JSF( - latest_plugs_response_v2_entities_inner_model_schema, allow_none_optionals=1 +entity_with_links_i_plug_response_v2__faker = JSF( + entity_with_links_i_plug_response_v2__model_schema, allow_none_optionals=1 ) -class LatestPlugsResponseV2EntitiesInnerStub: - """LatestPlugsResponseV2EntitiesInner unit test stubs.""" +class EntityWithLinksIPlugResponseV2Stub: + """EntityWithLinksIPlugResponseV2 unit test stubs.""" @classmethod def create_json(cls): """Create a dict stub instance.""" - return latest_plugs_response_v2_entities_inner_faker.generate( + return entity_with_links_i_plug_response_v2__faker.generate( use_defaults=True, use_examples=True ) @classmethod - def create_instance(cls) -> "LatestPlugsResponseV2EntitiesInner": - """Create LatestPlugsResponseV2EntitiesInner stub instance.""" + def create_instance(cls) -> "EntityWithLinksIPlugResponseV2": + """Create EntityWithLinksIPlugResponseV2 stub instance.""" if not MODELS_AVAILABLE: raise ImportError("Models must be installed to create class stubs") json = cls.create_json() if not json: # use backup example based on the pydantic model schema backup_faker = JSF( - LatestPlugsResponseV2EntitiesInnerAdapter.json_schema(), + EntityWithLinksIPlugResponseV2Adapter.json_schema(), allow_none_optionals=1, ) json = backup_faker.generate(use_defaults=True, use_examples=True) - return LatestPlugsResponseV2EntitiesInnerAdapter.validate_python( + return EntityWithLinksIPlugResponseV2Adapter.validate_python( json, context={"skip_validation": True} ) diff --git a/test/types/latest_webscripts_response_v2_entities_inner_stub.py b/test/types/entity_with_links_i_webscript_response_with_invoke_link_v2_stub.py similarity index 65% rename from test/types/latest_webscripts_response_v2_entities_inner_stub.py rename to test/types/entity_with_links_i_webscript_response_with_invoke_link_v2_stub.py index b6ab5f31..36663835 100644 --- a/test/types/latest_webscripts_response_v2_entities_inner_stub.py +++ b/test/types/entity_with_links_i_webscript_response_with_invoke_link_v2_stub.py @@ -16,23 +16,26 @@ from ..openapi import MODEL_DEFINITIONS, with_example_provider try: - from waylay.services.registry.models.latest_webscripts_response_v2_entities_inner import ( - LatestWebscriptsResponseV2EntitiesInner, + from waylay.services.registry.models.entity_with_links_i_webscript_response_with_invoke_link_v2 import ( + EntityWithLinksIWebscriptResponseWithInvokeLinkV2, ) - LatestWebscriptsResponseV2EntitiesInnerAdapter = TypeAdapter( - LatestWebscriptsResponseV2EntitiesInner + EntityWithLinksIWebscriptResponseWithInvokeLinkV2Adapter = TypeAdapter( + EntityWithLinksIWebscriptResponseWithInvokeLinkV2 ) MODELS_AVAILABLE = True except ImportError as exc: MODELS_AVAILABLE = False -latest_webscripts_response_v2_entities_inner_model_schema = json.loads( +entity_with_links_i_webscript_response_with_invoke_link_v2__model_schema = json.loads( r"""{ - "title" : "LatestWebscriptsResponseV2_entities_inner", - "required" : [ "_links", "createdAt", "createdBy", "deprecated", "draft", "runtime", "status", "updatedAt", "updatedBy", "updates", "webscript" ], + "title" : "EntityWithLinks_IWebscriptResponseWithInvokeLinkV2_", + "required" : [ "createdAt", "createdBy", "deprecated", "draft", "runtime", "status", "updatedAt", "updatedBy", "updates", "webscript" ], "type" : "object", "properties" : { + "_embedded" : { + "$ref" : "#/components/schemas/AltEmbeddedVersion_IWebscriptResponseWithInvokeLinkV2_" + }, "_links" : { "$ref" : "#/components/schemas/InvokeHALLink" }, @@ -98,38 +101,41 @@ """, object_hook=with_example_provider, ) -latest_webscripts_response_v2_entities_inner_model_schema.update({ +entity_with_links_i_webscript_response_with_invoke_link_v2__model_schema.update({ "definitions": MODEL_DEFINITIONS }) -latest_webscripts_response_v2_entities_inner_faker = JSF( - latest_webscripts_response_v2_entities_inner_model_schema, allow_none_optionals=1 +entity_with_links_i_webscript_response_with_invoke_link_v2__faker = JSF( + entity_with_links_i_webscript_response_with_invoke_link_v2__model_schema, + allow_none_optionals=1, ) -class LatestWebscriptsResponseV2EntitiesInnerStub: - """LatestWebscriptsResponseV2EntitiesInner unit test stubs.""" +class EntityWithLinksIWebscriptResponseWithInvokeLinkV2Stub: + """EntityWithLinksIWebscriptResponseWithInvokeLinkV2 unit test stubs.""" @classmethod def create_json(cls): """Create a dict stub instance.""" - return latest_webscripts_response_v2_entities_inner_faker.generate( - use_defaults=True, use_examples=True + return ( + entity_with_links_i_webscript_response_with_invoke_link_v2__faker.generate( + use_defaults=True, use_examples=True + ) ) @classmethod - def create_instance(cls) -> "LatestWebscriptsResponseV2EntitiesInner": - """Create LatestWebscriptsResponseV2EntitiesInner stub instance.""" + def create_instance(cls) -> "EntityWithLinksIWebscriptResponseWithInvokeLinkV2": + """Create EntityWithLinksIWebscriptResponseWithInvokeLinkV2 stub instance.""" if not MODELS_AVAILABLE: raise ImportError("Models must be installed to create class stubs") json = cls.create_json() if not json: # use backup example based on the pydantic model schema backup_faker = JSF( - LatestWebscriptsResponseV2EntitiesInnerAdapter.json_schema(), + EntityWithLinksIWebscriptResponseWithInvokeLinkV2Adapter.json_schema(), allow_none_optionals=1, ) json = backup_faker.generate(use_defaults=True, use_examples=True) - return LatestWebscriptsResponseV2EntitiesInnerAdapter.validate_python( + return EntityWithLinksIWebscriptResponseWithInvokeLinkV2Adapter.validate_python( json, context={"skip_validation": True} ) diff --git a/test/types/event_sse_stub.py b/test/types/event_sse_stub.py deleted file mode 100644 index 09f9a051..00000000 --- a/test/types/event_sse_stub.py +++ /dev/null @@ -1,63 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.event_sse import EventSSE - - EventSSEAdapter = TypeAdapter(EventSSE) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -event_sse_model_schema = json.loads( - r"""{ - "description" : "SSE stream events without closing protocol", - "anyOf" : [ { - "$ref" : "#/components/schemas/Stream_Ready" - }, { - "$ref" : "#/components/schemas/JobEventSSE" - }, { - "$ref" : "#/components/schemas/KeepAliveEventSSE" - } ] -} -""", - object_hook=with_example_provider, -) -event_sse_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -event_sse_faker = JSF(event_sse_model_schema, allow_none_optionals=1) - - -class EventSSEStub: - """EventSSE unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return event_sse_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "EventSSE": - """Create EventSSE stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(EventSSEAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return EventSSEAdapter.validate_python(json, context={"skip_validation": True}) diff --git a/test/types/event_type_sse_stub.py b/test/types/event_type_sse_stub.py deleted file mode 100644 index 2b37c207..00000000 --- a/test/types/event_type_sse_stub.py +++ /dev/null @@ -1,68 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.event_type_sse import EventTypeSSE - - EventTypeSSEAdapter = TypeAdapter(EventTypeSSE) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -event_type_sse_model_schema = json.loads( - r"""{ - "anyOf" : [ { - "$ref" : "#/components/schemas/SupportedEvents" - }, { - "$ref" : "#/components/schemas/EventAck" - }, { - "$ref" : "#/components/schemas/EventClose" - }, { - "$ref" : "#/components/schemas/EventKeepAlive" - } ] -} -""", - object_hook=with_example_provider, -) -event_type_sse_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -event_type_sse_faker = JSF(event_type_sse_model_schema, allow_none_optionals=1) - - -class EventTypeSSEStub: - """EventTypeSSE unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return event_type_sse_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "EventTypeSSE": - """Create EventTypeSSE stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - EventTypeSSEAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return EventTypeSSEAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/message_response_stub.py b/test/types/example_reference_stub.py similarity index 54% rename from test/types/message_response_stub.py rename to test/types/example_reference_stub.py index 65669357..23f94c05 100644 --- a/test/types/message_response_stub.py +++ b/test/types/example_reference_stub.py @@ -16,51 +16,47 @@ from ..openapi import MODEL_DEFINITIONS, with_example_provider try: - from waylay.services.registry.models.message_response import MessageResponse + from waylay.services.registry.models.example_reference import ExampleReference - MessageResponseAdapter = TypeAdapter(MessageResponse) + ExampleReferenceAdapter = TypeAdapter(ExampleReference) MODELS_AVAILABLE = True except ImportError as exc: MODELS_AVAILABLE = False -message_response_model_schema = json.loads( +example_reference_model_schema = json.loads( r"""{ - "required" : [ "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - } - } + "type" : "string", + "description" : "Example reference.\n\nReferences the example assets from the selected runtime.", + "enum" : [ "!example" ] } """, object_hook=with_example_provider, ) -message_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) +example_reference_model_schema.update({"definitions": MODEL_DEFINITIONS}) -message_response_faker = JSF(message_response_model_schema, allow_none_optionals=1) +example_reference_faker = JSF(example_reference_model_schema, allow_none_optionals=1) -class MessageResponseStub: - """MessageResponse unit test stubs.""" +class ExampleReferenceStub: + """ExampleReference unit test stubs.""" @classmethod def create_json(cls): """Create a dict stub instance.""" - return message_response_faker.generate(use_defaults=True, use_examples=True) + return example_reference_faker.generate(use_defaults=True, use_examples=True) @classmethod - def create_instance(cls) -> "MessageResponse": - """Create MessageResponse stub instance.""" + def create_instance(cls) -> "ExampleReference": + """Create ExampleReference stub instance.""" if not MODELS_AVAILABLE: raise ImportError("Models must be installed to create class stubs") json = cls.create_json() if not json: # use backup example based on the pydantic model schema backup_faker = JSF( - MessageResponseAdapter.json_schema(), allow_none_optionals=1 + ExampleReferenceAdapter.json_schema(), allow_none_optionals=1 ) json = backup_faker.generate(use_defaults=True, use_examples=True) - return MessageResponseAdapter.validate_python( + return ExampleReferenceAdapter.validate_python( json, context={"skip_validation": True} ) diff --git a/test/types/force_delete_query_v1_stub.py b/test/types/force_delete_query_v1_stub.py deleted file mode 100644 index 4b34c772..00000000 --- a/test/types/force_delete_query_v1_stub.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.force_delete_query_v1 import ForceDeleteQueryV1 - - ForceDeleteQueryV1Adapter = TypeAdapter(ForceDeleteQueryV1) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -force_delete_query_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "async" : { - "type" : "boolean", - "description" : "If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - "default" : false - }, - "force" : { - "type" : "boolean", - "description" : "If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -force_delete_query_v1_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -force_delete_query_v1_faker = JSF( - force_delete_query_v1_model_schema, allow_none_optionals=1 -) - - -class ForceDeleteQueryV1Stub: - """ForceDeleteQueryV1 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return force_delete_query_v1_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "ForceDeleteQueryV1": - """Create ForceDeleteQueryV1 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - ForceDeleteQueryV1Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return ForceDeleteQueryV1Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/function_delete_query_stub.py b/test/types/function_delete_query_stub.py deleted file mode 100644 index 84429eae..00000000 --- a/test/types/function_delete_query_stub.py +++ /dev/null @@ -1,77 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.function_delete_query import ( - FunctionDeleteQuery, - ) - - FunctionDeleteQueryAdapter = TypeAdapter(FunctionDeleteQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -function_delete_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "force" : { - "type" : "boolean", - "description" : "If true, the function version will be immediately undeployed and removed.\n\nOtherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_." - }, - "undeploy" : { - "type" : "boolean", - "description" : "If `true`, the `DELETE` operation\n* undeploys the (openfaas) function: it becomes no longer available for invocation.\n* does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action.\n\nIf `false`, the `DELETE` operation\n* _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions.\n\nThis parameter is incompatible with `force=true`.\n\nIf not set the default behaviour applies:\n* _draft_ versions are _undeployed_ and _removed_ from registry.\n* non-_draft_ versions are marked _deprecated_ only." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -function_delete_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -function_delete_query_faker = JSF( - function_delete_query_model_schema, allow_none_optionals=1 -) - - -class FunctionDeleteQueryStub: - """FunctionDeleteQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return function_delete_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "FunctionDeleteQuery": - """Create FunctionDeleteQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - FunctionDeleteQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return FunctionDeleteQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/function_deploy_overrides_stub.py b/test/types/function_deploy_overrides_stub.py deleted file mode 100644 index 7341bea1..00000000 --- a/test/types/function_deploy_overrides_stub.py +++ /dev/null @@ -1,71 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.function_deploy_overrides import ( - FunctionDeployOverrides, - ) - - FunctionDeployOverridesAdapter = TypeAdapter(FunctionDeployOverrides) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -function_deploy_overrides_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - } - } -} -""", - object_hook=with_example_provider, -) -function_deploy_overrides_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -function_deploy_overrides_faker = JSF( - function_deploy_overrides_model_schema, allow_none_optionals=1 -) - - -class FunctionDeployOverridesStub: - """FunctionDeployOverrides unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return function_deploy_overrides_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "FunctionDeployOverrides": - """Create FunctionDeployOverrides stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - FunctionDeployOverridesAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return FunctionDeployOverridesAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/function_deploy_overrides_type_stub.py b/test/types/function_deploy_overrides_type_stub.py index 891e57a6..eefd41b5 100644 --- a/test/types/function_deploy_overrides_type_stub.py +++ b/test/types/function_deploy_overrides_type_stub.py @@ -27,25 +27,21 @@ function_deploy_overrides_type_model_schema = json.loads( r"""{ - "title" : "FunctionDeployOverridesType", "type" : "object", "properties" : { "envVars" : { - "title" : "envVars", "type" : "object", "additionalProperties" : { "type" : "string" } }, "labels" : { - "title" : "labels", "type" : "object", "additionalProperties" : { "type" : "string" } }, "annotations" : { - "title" : "annotations", "type" : "object", "additionalProperties" : { "type" : "string" diff --git a/test/types/function_entity_query_stub.py b/test/types/function_entity_query_stub.py deleted file mode 100644 index 4441f7f9..00000000 --- a/test/types/function_entity_query_stub.py +++ /dev/null @@ -1,88 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.function_entity_query import ( - FunctionEntityQuery, - ) - - FunctionEntityQueryAdapter = TypeAdapter(FunctionEntityQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -function_entity_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Filter on function attributes that do not change across function versions." -} -""", - object_hook=with_example_provider, -) -function_entity_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -function_entity_query_faker = JSF( - function_entity_query_model_schema, allow_none_optionals=1 -) - - -class FunctionEntityQueryStub: - """FunctionEntityQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return function_entity_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "FunctionEntityQuery": - """Create FunctionEntityQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - FunctionEntityQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return FunctionEntityQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/function_job_args_stub.py b/test/types/function_job_args_stub.py deleted file mode 100644 index a5967fa6..00000000 --- a/test/types/function_job_args_stub.py +++ /dev/null @@ -1,74 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.function_job_args import FunctionJobArgs - - FunctionJobArgsAdapter = TypeAdapter(FunctionJobArgs) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -function_job_args_model_schema = json.loads( - r"""{ - "required" : [ "runtimeName", "runtimeVersion" ], - "type" : "object", - "properties" : { - "runtimeName" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "revision" : { - "type" : "string", - "description" : "The revision hash of the current (draft) function revision" - } - }, - "description" : "Job arguments shared by all function jobs" -} -""", - object_hook=with_example_provider, -) -function_job_args_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -function_job_args_faker = JSF(function_job_args_model_schema, allow_none_optionals=1) - - -class FunctionJobArgsStub: - """FunctionJobArgs unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return function_job_args_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "FunctionJobArgs": - """Create FunctionJobArgs stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - FunctionJobArgsAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return FunctionJobArgsAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/function_manifest_stub.py b/test/types/function_manifest_stub.py deleted file mode 100644 index b987c0c2..00000000 --- a/test/types/function_manifest_stub.py +++ /dev/null @@ -1,82 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.function_manifest import FunctionManifest - - FunctionManifestAdapter = TypeAdapter(FunctionManifest) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -function_manifest_model_schema = json.loads( - r"""{ - "required" : [ "metadata", "name", "runtime", "version" ], - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - } - } -} -""", - object_hook=with_example_provider, -) -function_manifest_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -function_manifest_faker = JSF(function_manifest_model_schema, allow_none_optionals=1) - - -class FunctionManifestStub: - """FunctionManifest unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return function_manifest_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "FunctionManifest": - """Create FunctionManifest stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - FunctionManifestAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return FunctionManifestAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/function_name_version_stub.py b/test/types/function_name_version_stub.py deleted file mode 100644 index 02f78df9..00000000 --- a/test/types/function_name_version_stub.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.function_name_version import ( - FunctionNameVersion, - ) - - FunctionNameVersionAdapter = TypeAdapter(FunctionNameVersion) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -function_name_version_model_schema = json.loads( - r"""{ - "required" : [ "name", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - } - } -} -""", - object_hook=with_example_provider, -) -function_name_version_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -function_name_version_faker = JSF( - function_name_version_model_schema, allow_none_optionals=1 -) - - -class FunctionNameVersionStub: - """FunctionNameVersion unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return function_name_version_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "FunctionNameVersion": - """Create FunctionNameVersion stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - FunctionNameVersionAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return FunctionNameVersionAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/function_spec_stub.py b/test/types/function_spec_stub.py deleted file mode 100644 index 6ab45e11..00000000 --- a/test/types/function_spec_stub.py +++ /dev/null @@ -1,73 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.function_spec import FunctionSpec - - FunctionSpecAdapter = TypeAdapter(FunctionSpec) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -function_spec_model_schema = json.loads( - r"""{ - "required" : [ "name", "runtime", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - } - } -} -""", - object_hook=with_example_provider, -) -function_spec_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -function_spec_faker = JSF(function_spec_model_schema, allow_none_optionals=1) - - -class FunctionSpecStub: - """FunctionSpec unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return function_spec_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "FunctionSpec": - """Create FunctionSpec stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - FunctionSpecAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return FunctionSpecAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/function_version_query_stub.py b/test/types/function_version_query_stub.py deleted file mode 100644 index bfbc9077..00000000 --- a/test/types/function_version_query_stub.py +++ /dev/null @@ -1,106 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.function_version_query import ( - FunctionVersionQuery, - ) - - FunctionVersionQueryAdapter = TypeAdapter(FunctionVersionQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -function_version_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - } - }, - "additionalProperties" : false, - "description" : "Filter on function attributes that can change across function versions. When these query parameters are used, the query is considered a _function version_ listing and no HAL links to latest (_draft_, _published_) versions are included." -} -""", - object_hook=with_example_provider, -) -function_version_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -function_version_query_faker = JSF( - function_version_query_model_schema, allow_none_optionals=1 -) - - -class FunctionVersionQueryStub: - """FunctionVersionQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return function_version_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "FunctionVersionQuery": - """Create FunctionVersionQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - FunctionVersionQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return FunctionVersionQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/get_content_params_v2_stub.py b/test/types/get_content_params_v2_stub.py deleted file mode 100644 index ab43780c..00000000 --- a/test/types/get_content_params_v2_stub.py +++ /dev/null @@ -1,79 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.get_content_params_v2 import GetContentParamsV2 - - GetContentParamsV2Adapter = TypeAdapter(GetContentParamsV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -get_content_params_v2_model_schema = json.loads( - r"""{ - "required" : [ "*", "name", "version" ], - "type" : "object", - "properties" : { - "*" : { - "type" : "string", - "description" : "Full path or path prefix of the asset within the archive" - }, - "name" : { - "type" : "string", - "description" : "The name of the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -get_content_params_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -get_content_params_v2_faker = JSF( - get_content_params_v2_model_schema, allow_none_optionals=1 -) - - -class GetContentParamsV2Stub: - """GetContentParamsV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return get_content_params_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "GetContentParamsV2": - """Create GetContentParamsV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - GetContentParamsV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return GetContentParamsV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/get_invokable_webscript_query_stub.py b/test/types/get_invokable_webscript_query_stub.py deleted file mode 100644 index 840d0504..00000000 --- a/test/types/get_invokable_webscript_query_stub.py +++ /dev/null @@ -1,88 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.get_invokable_webscript_query import ( - GetInvokableWebscriptQuery, - ) - - GetInvokableWebscriptQueryAdapter = TypeAdapter(GetInvokableWebscriptQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -get_invokable_webscript_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "status" : { - "type" : "array", - "description" : "If set, filters on the `status` of the webscript.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - }, - "default" : [ "running", "deployed", "unhealthy" ] - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -get_invokable_webscript_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -get_invokable_webscript_query_faker = JSF( - get_invokable_webscript_query_model_schema, allow_none_optionals=1 -) - - -class GetInvokableWebscriptQueryStub: - """GetInvokableWebscriptQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return get_invokable_webscript_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "GetInvokableWebscriptQuery": - """Create GetInvokableWebscriptQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - GetInvokableWebscriptQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return GetInvokableWebscriptQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/get_runtime_by_name_and_version_query_stub.py b/test/types/get_runtime_by_name_and_version_query_stub.py deleted file mode 100644 index c3b11956..00000000 --- a/test/types/get_runtime_by_name_and_version_query_stub.py +++ /dev/null @@ -1,79 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.get_runtime_by_name_and_version_query import ( - GetRuntimeByNameAndVersionQuery, - ) - - GetRuntimeByNameAndVersionQueryAdapter = TypeAdapter( - GetRuntimeByNameAndVersionQuery - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -get_runtime_by_name_and_version_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : true - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -get_runtime_by_name_and_version_query_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -get_runtime_by_name_and_version_query_faker = JSF( - get_runtime_by_name_and_version_query_model_schema, allow_none_optionals=1 -) - - -class GetRuntimeByNameAndVersionQueryStub: - """GetRuntimeByNameAndVersionQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return get_runtime_by_name_and_version_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "GetRuntimeByNameAndVersionQuery": - """Create GetRuntimeByNameAndVersionQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - GetRuntimeByNameAndVersionQueryAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return GetRuntimeByNameAndVersionQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/get_runtime_by_name_query_stub.py b/test/types/get_runtime_by_name_query_stub.py deleted file mode 100644 index ca70b5c8..00000000 --- a/test/types/get_runtime_by_name_query_stub.py +++ /dev/null @@ -1,93 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.get_runtime_by_name_query import ( - GetRuntimeByNameQuery, - ) - - GetRuntimeByNameQueryAdapter = TypeAdapter(GetRuntimeByNameQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -get_runtime_by_name_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : false - }, - "functionType" : { - "type" : "array", - "description" : "If set, filters on the functionType of a runtime. Uses an exact match.", - "example" : "plugs", - "items" : { - "$ref" : "#/components/schemas/FunctionType" - } - }, - "archiveFormat" : { - "type" : "array", - "description" : "If set, filters on the archiveFormat of a runtime. Uses an exact match.", - "example" : "node", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -get_runtime_by_name_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -get_runtime_by_name_query_faker = JSF( - get_runtime_by_name_query_model_schema, allow_none_optionals=1 -) - - -class GetRuntimeByNameQueryStub: - """GetRuntimeByNameQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return get_runtime_by_name_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "GetRuntimeByNameQuery": - """Create GetRuntimeByNameQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - GetRuntimeByNameQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return GetRuntimeByNameQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/get_runtime_example_query_stub.py b/test/types/get_runtime_example_query_stub.py deleted file mode 100644 index aefc2fa3..00000000 --- a/test/types/get_runtime_example_query_stub.py +++ /dev/null @@ -1,79 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.get_runtime_example_query import ( - GetRuntimeExampleQuery, - ) - - GetRuntimeExampleQueryAdapter = TypeAdapter(GetRuntimeExampleQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -get_runtime_example_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "ls" : { - "type" : "boolean", - "description" : "If set to `true`, the result will be a listing of the files in the asset, annotated with metadata and validation report from the asset conditions of the functions runtime.", - "default" : false - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : true - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -get_runtime_example_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -get_runtime_example_query_faker = JSF( - get_runtime_example_query_model_schema, allow_none_optionals=1 -) - - -class GetRuntimeExampleQueryStub: - """GetRuntimeExampleQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return get_runtime_example_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "GetRuntimeExampleQuery": - """Create GetRuntimeExampleQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - GetRuntimeExampleQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return GetRuntimeExampleQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/get_runtime_versions_query_stub.py b/test/types/get_runtime_versions_query_stub.py deleted file mode 100644 index 27606a9d..00000000 --- a/test/types/get_runtime_versions_query_stub.py +++ /dev/null @@ -1,96 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.get_runtime_versions_query import ( - GetRuntimeVersionsQuery, - ) - - GetRuntimeVersionsQueryAdapter = TypeAdapter(GetRuntimeVersionsQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -get_runtime_versions_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "latest" : { - "$ref" : "#/components/schemas/LatestVersionLevel" - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : false - }, - "functionType" : { - "type" : "array", - "description" : "If set, filters on the functionType of a runtime. Uses an exact match.", - "example" : "plugs", - "items" : { - "$ref" : "#/components/schemas/FunctionType" - } - }, - "archiveFormat" : { - "type" : "array", - "description" : "If set, filters on the archiveFormat of a runtime. Uses an exact match.", - "example" : "node", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -get_runtime_versions_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -get_runtime_versions_query_faker = JSF( - get_runtime_versions_query_model_schema, allow_none_optionals=1 -) - - -class GetRuntimeVersionsQueryStub: - """GetRuntimeVersionsQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return get_runtime_versions_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "GetRuntimeVersionsQuery": - """Create GetRuntimeVersionsQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - GetRuntimeVersionsQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return GetRuntimeVersionsQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/invokable_webscript_response_entity_stub.py b/test/types/invokable_webscript_response_entity_stub.py deleted file mode 100644 index 520bc349..00000000 --- a/test/types/invokable_webscript_response_entity_stub.py +++ /dev/null @@ -1,89 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.invokable_webscript_response_entity import ( - InvokableWebscriptResponseEntity, - ) - - InvokableWebscriptResponseEntityAdapter = TypeAdapter( - InvokableWebscriptResponseEntity - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -invokable_webscript_response_entity_model_schema = json.loads( - r"""{ - "title" : "InvokableWebscriptResponse_entity", - "required" : [ "draft", "status", "webscript" ], - "type" : "object", - "properties" : { - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "draft" : { - "title" : "draft", - "type" : "boolean" - }, - "webscript" : { - "$ref" : "#/components/schemas/InvokableWebscriptResponse_entity_webscript" - }, - "secret" : { - "title" : "secret", - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -invokable_webscript_response_entity_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -invokable_webscript_response_entity_faker = JSF( - invokable_webscript_response_entity_model_schema, allow_none_optionals=1 -) - - -class InvokableWebscriptResponseEntityStub: - """InvokableWebscriptResponseEntity unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return invokable_webscript_response_entity_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "InvokableWebscriptResponseEntity": - """Create InvokableWebscriptResponseEntity stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - InvokableWebscriptResponseEntityAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return InvokableWebscriptResponseEntityAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/invokable_webscript_response_entity_webscript_stub.py b/test/types/invokable_webscript_response_entity_webscript_stub.py deleted file mode 100644 index f5f36d15..00000000 --- a/test/types/invokable_webscript_response_entity_webscript_stub.py +++ /dev/null @@ -1,90 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.invokable_webscript_response_entity_webscript import ( - InvokableWebscriptResponseEntityWebscript, - ) - - InvokableWebscriptResponseEntityWebscriptAdapter = TypeAdapter( - InvokableWebscriptResponseEntityWebscript - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -invokable_webscript_response_entity_webscript_model_schema = json.loads( - r"""{ - "title" : "InvokableWebscriptResponse_entity_webscript", - "required" : [ "allowHmac", "name", "private", "version" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "private" : { - "title" : "private", - "type" : "boolean" - }, - "allowHmac" : { - "title" : "allowHmac", - "type" : "boolean" - } - } -} -""", - object_hook=with_example_provider, -) -invokable_webscript_response_entity_webscript_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -invokable_webscript_response_entity_webscript_faker = JSF( - invokable_webscript_response_entity_webscript_model_schema, allow_none_optionals=1 -) - - -class InvokableWebscriptResponseEntityWebscriptStub: - """InvokableWebscriptResponseEntityWebscript unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return invokable_webscript_response_entity_webscript_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "InvokableWebscriptResponseEntityWebscript": - """Create InvokableWebscriptResponseEntityWebscript stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - InvokableWebscriptResponseEntityWebscriptAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return InvokableWebscriptResponseEntityWebscriptAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/invokable_webscript_response_stub.py b/test/types/invokable_webscript_response_stub.py deleted file mode 100644 index e7ad5b84..00000000 --- a/test/types/invokable_webscript_response_stub.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.invokable_webscript_response import ( - InvokableWebscriptResponse, - ) - - InvokableWebscriptResponseAdapter = TypeAdapter(InvokableWebscriptResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -invokable_webscript_response_model_schema = json.loads( - r"""{ - "required" : [ "_links", "entity" ], - "type" : "object", - "properties" : { - "entity" : { - "$ref" : "#/components/schemas/InvokableWebscriptResponse_entity" - }, - "_links" : { - "$ref" : "#/components/schemas/InvokeInternalHALLink" - } - }, - "description" : "Webscript Found" -} -""", - object_hook=with_example_provider, -) -invokable_webscript_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -invokable_webscript_response_faker = JSF( - invokable_webscript_response_model_schema, allow_none_optionals=1 -) - - -class InvokableWebscriptResponseStub: - """InvokableWebscriptResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return invokable_webscript_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "InvokableWebscriptResponse": - """Create InvokableWebscriptResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - InvokableWebscriptResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return InvokableWebscriptResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/invoke_internal_hal_link_stub.py b/test/types/invoke_internal_hal_link_stub.py deleted file mode 100644 index 82197db3..00000000 --- a/test/types/invoke_internal_hal_link_stub.py +++ /dev/null @@ -1,72 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.invoke_internal_hal_link import ( - InvokeInternalHALLink, - ) - - InvokeInternalHALLinkAdapter = TypeAdapter(InvokeInternalHALLink) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -invoke_internal_hal_link_model_schema = json.loads( - r"""{ - "title" : "InvokeInternalHALLink", - "type" : "object", - "properties" : { - "invoke-internal" : { - "$ref" : "#/components/schemas/HALLink" - } - } -} -""", - object_hook=with_example_provider, -) -invoke_internal_hal_link_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -invoke_internal_hal_link_faker = JSF( - invoke_internal_hal_link_model_schema, allow_none_optionals=1 -) - - -class InvokeInternalHALLinkStub: - """InvokeInternalHALLink unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return invoke_internal_hal_link_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "InvokeInternalHALLink": - """Create InvokeInternalHALLink stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - InvokeInternalHALLinkAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return InvokeInternalHALLinkAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/job_causes_stub.py b/test/types/job_causes_stub.py index 03e3a278..8f718db5 100644 --- a/test/types/job_causes_stub.py +++ b/test/types/job_causes_stub.py @@ -25,7 +25,6 @@ job_causes_model_schema = json.loads( r"""{ - "title" : "JobCauses", "type" : "object", "properties" : { "build" : { diff --git a/test/types/job_event_payload_active_event_data_stub.py b/test/types/job_event_payload_active_event_data_stub.py deleted file mode 100644 index cbd7608a..00000000 --- a/test/types/job_event_payload_active_event_data_stub.py +++ /dev/null @@ -1,83 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.job_event_payload_active_event_data import ( - JobEventPayloadActiveEventData, - ) - - JobEventPayloadActiveEventDataAdapter = TypeAdapter(JobEventPayloadActiveEventData) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -job_event_payload_active_event_data__model_schema = json.loads( - r"""{ - "required" : [ "data", "job", "timestamp" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/JobReference" - }, - "data" : { - "$ref" : "#/components/schemas/ActiveEventData" - }, - "timestamp" : { - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" - } - } -} -""", - object_hook=with_example_provider, -) -job_event_payload_active_event_data__model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -job_event_payload_active_event_data__faker = JSF( - job_event_payload_active_event_data__model_schema, allow_none_optionals=1 -) - - -class JobEventPayloadActiveEventDataStub: - """JobEventPayloadActiveEventData unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return job_event_payload_active_event_data__faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "JobEventPayloadActiveEventData": - """Create JobEventPayloadActiveEventData stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - JobEventPayloadActiveEventDataAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return JobEventPayloadActiveEventDataAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/job_event_payload_delayed_event_data_stub.py b/test/types/job_event_payload_delayed_event_data_stub.py deleted file mode 100644 index adf621ee..00000000 --- a/test/types/job_event_payload_delayed_event_data_stub.py +++ /dev/null @@ -1,85 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.job_event_payload_delayed_event_data import ( - JobEventPayloadDelayedEventData, - ) - - JobEventPayloadDelayedEventDataAdapter = TypeAdapter( - JobEventPayloadDelayedEventData - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -job_event_payload_delayed_event_data__model_schema = json.loads( - r"""{ - "required" : [ "data", "job", "timestamp" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/JobReference" - }, - "data" : { - "$ref" : "#/components/schemas/DelayedEventData" - }, - "timestamp" : { - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" - } - } -} -""", - object_hook=with_example_provider, -) -job_event_payload_delayed_event_data__model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -job_event_payload_delayed_event_data__faker = JSF( - job_event_payload_delayed_event_data__model_schema, allow_none_optionals=1 -) - - -class JobEventPayloadDelayedEventDataStub: - """JobEventPayloadDelayedEventData unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return job_event_payload_delayed_event_data__faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "JobEventPayloadDelayedEventData": - """Create JobEventPayloadDelayedEventData stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - JobEventPayloadDelayedEventDataAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return JobEventPayloadDelayedEventDataAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/job_event_payload_failed_event_data_stub.py b/test/types/job_event_payload_failed_event_data_stub.py deleted file mode 100644 index 106b0799..00000000 --- a/test/types/job_event_payload_failed_event_data_stub.py +++ /dev/null @@ -1,83 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.job_event_payload_failed_event_data import ( - JobEventPayloadFailedEventData, - ) - - JobEventPayloadFailedEventDataAdapter = TypeAdapter(JobEventPayloadFailedEventData) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -job_event_payload_failed_event_data__model_schema = json.loads( - r"""{ - "required" : [ "data", "job", "timestamp" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/JobReference" - }, - "data" : { - "$ref" : "#/components/schemas/FailedEventData" - }, - "timestamp" : { - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" - } - } -} -""", - object_hook=with_example_provider, -) -job_event_payload_failed_event_data__model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -job_event_payload_failed_event_data__faker = JSF( - job_event_payload_failed_event_data__model_schema, allow_none_optionals=1 -) - - -class JobEventPayloadFailedEventDataStub: - """JobEventPayloadFailedEventData unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return job_event_payload_failed_event_data__faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "JobEventPayloadFailedEventData": - """Create JobEventPayloadFailedEventData stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - JobEventPayloadFailedEventDataAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return JobEventPayloadFailedEventDataAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/job_event_payload_waiting_children_event_data_stub.py b/test/types/job_event_payload_waiting_children_event_data_stub.py deleted file mode 100644 index 27de3d33..00000000 --- a/test/types/job_event_payload_waiting_children_event_data_stub.py +++ /dev/null @@ -1,85 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.job_event_payload_waiting_children_event_data import ( - JobEventPayloadWaitingChildrenEventData, - ) - - JobEventPayloadWaitingChildrenEventDataAdapter = TypeAdapter( - JobEventPayloadWaitingChildrenEventData - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -job_event_payload_waiting_children_event_data__model_schema = json.loads( - r"""{ - "required" : [ "data", "job", "timestamp" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/JobReference" - }, - "data" : { - "$ref" : "#/components/schemas/WaitingChildrenEventData" - }, - "timestamp" : { - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" - } - } -} -""", - object_hook=with_example_provider, -) -job_event_payload_waiting_children_event_data__model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -job_event_payload_waiting_children_event_data__faker = JSF( - job_event_payload_waiting_children_event_data__model_schema, allow_none_optionals=1 -) - - -class JobEventPayloadWaitingChildrenEventDataStub: - """JobEventPayloadWaitingChildrenEventData unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return job_event_payload_waiting_children_event_data__faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "JobEventPayloadWaitingChildrenEventData": - """Create JobEventPayloadWaitingChildrenEventData stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - JobEventPayloadWaitingChildrenEventDataAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return JobEventPayloadWaitingChildrenEventDataAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/job_event_payload_waiting_event_data_stub.py b/test/types/job_event_payload_waiting_event_data_stub.py deleted file mode 100644 index 35afe731..00000000 --- a/test/types/job_event_payload_waiting_event_data_stub.py +++ /dev/null @@ -1,85 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.job_event_payload_waiting_event_data import ( - JobEventPayloadWaitingEventData, - ) - - JobEventPayloadWaitingEventDataAdapter = TypeAdapter( - JobEventPayloadWaitingEventData - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -job_event_payload_waiting_event_data__model_schema = json.loads( - r"""{ - "required" : [ "data", "job", "timestamp" ], - "type" : "object", - "properties" : { - "job" : { - "$ref" : "#/components/schemas/JobReference" - }, - "data" : { - "$ref" : "#/components/schemas/WaitingEventData" - }, - "timestamp" : { - "type" : "string", - "description" : "Timestamp of the event", - "format" : "date-time" - } - } -} -""", - object_hook=with_example_provider, -) -job_event_payload_waiting_event_data__model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -job_event_payload_waiting_event_data__faker = JSF( - job_event_payload_waiting_event_data__model_schema, allow_none_optionals=1 -) - - -class JobEventPayloadWaitingEventDataStub: - """JobEventPayloadWaitingEventData unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return job_event_payload_waiting_event_data__faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "JobEventPayloadWaitingEventData": - """Create JobEventPayloadWaitingEventData stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - JobEventPayloadWaitingEventDataAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return JobEventPayloadWaitingEventDataAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/job_events_filter_query_stub.py b/test/types/job_events_filter_query_stub.py deleted file mode 100644 index 00069dcd..00000000 --- a/test/types/job_events_filter_query_stub.py +++ /dev/null @@ -1,80 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.job_events_filter_query import ( - JobEventsFilterQuery, - ) - - JobEventsFilterQueryAdapter = TypeAdapter(JobEventsFilterQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -job_events_filter_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/JobType" - }, - "id" : { - "type" : "string", - "description" : "The id of the job." - }, - "children" : { - "type" : "boolean", - "description" : "If set to true, the event stream will include events of the job's dependants. E.g., when subscribing to a verify job with `children=true`, you will also receive the events of the underlying build and deploy jobs. Defaults to false." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -job_events_filter_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -job_events_filter_query_faker = JSF( - job_events_filter_query_model_schema, allow_none_optionals=1 -) - - -class JobEventsFilterQueryStub: - """JobEventsFilterQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return job_events_filter_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "JobEventsFilterQuery": - """Create JobEventsFilterQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - JobEventsFilterQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return JobEventsFilterQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/job_hal_links_stub.py b/test/types/job_hal_links_stub.py index 48173218..aa327b8a 100644 --- a/test/types/job_hal_links_stub.py +++ b/test/types/job_hal_links_stub.py @@ -25,7 +25,6 @@ job_hal_links_model_schema = json.loads( r"""{ - "title" : "JobHALLinks", "type" : "object", "properties" : { "event" : { diff --git a/test/types/job_query_stub.py b/test/types/job_query_stub.py deleted file mode 100644 index b997afbe..00000000 --- a/test/types/job_query_stub.py +++ /dev/null @@ -1,91 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.job_query import JobQuery - - JobQueryAdapter = TypeAdapter(JobQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -job_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "type" : { - "type" : "array", - "description" : "Filter on job type", - "items" : { - "$ref" : "#/components/schemas/JobTypeSchema" - } - }, - "state" : { - "type" : "array", - "description" : "Filter on job state", - "items" : { - "$ref" : "#/components/schemas/JobStateResult" - } - }, - "functionType" : { - "type" : "array", - "description" : "Filter on function type", - "items" : { - "$ref" : "#/components/schemas/FunctionType" - } - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -job_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -job_query_faker = JSF(job_query_model_schema, allow_none_optionals=1) - - -class JobQueryStub: - """JobQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return job_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "JobQuery": - """Create JobQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(JobQueryAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return JobQueryAdapter.validate_python(json, context={"skip_validation": True}) diff --git a/test/types/job_reference_params_stub.py b/test/types/job_reference_params_stub.py deleted file mode 100644 index de0fbdf9..00000000 --- a/test/types/job_reference_params_stub.py +++ /dev/null @@ -1,72 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.job_reference_params import JobReferenceParams - - JobReferenceParamsAdapter = TypeAdapter(JobReferenceParams) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -job_reference_params_model_schema = json.loads( - r"""{ - "required" : [ "id", "type" ], - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/JobType" - }, - "id" : { - "type" : "string" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -job_reference_params_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -job_reference_params_faker = JSF( - job_reference_params_model_schema, allow_none_optionals=1 -) - - -class JobReferenceParamsStub: - """JobReferenceParams unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return job_reference_params_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "JobReferenceParams": - """Create JobReferenceParams stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - JobReferenceParamsAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return JobReferenceParamsAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/job_state_result_stub.py b/test/types/job_state_result_stub.py index f84a86bc..b2f10a2c 100644 --- a/test/types/job_state_result_stub.py +++ b/test/types/job_state_result_stub.py @@ -25,7 +25,6 @@ job_state_result_model_schema = json.loads( r"""{ - "title" : "JobStateResult", "description" : "All reported job states", "anyOf" : [ { "$ref" : "#/components/schemas/JobState" diff --git a/test/types/job_submitted_response_stub.py b/test/types/job_submitted_response_stub.py deleted file mode 100644 index fdb27ff5..00000000 --- a/test/types/job_submitted_response_stub.py +++ /dev/null @@ -1,75 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.job_submitted_response import ( - JobSubmittedResponse, - ) - - JobSubmittedResponseAdapter = TypeAdapter(JobSubmittedResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -job_submitted_response_model_schema = json.loads( - r"""{ - "required" : [ "_links", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - } - } -} -""", - object_hook=with_example_provider, -) -job_submitted_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -job_submitted_response_faker = JSF( - job_submitted_response_model_schema, allow_none_optionals=1 -) - - -class JobSubmittedResponseStub: - """JobSubmittedResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return job_submitted_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "JobSubmittedResponse": - """Create JobSubmittedResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - JobSubmittedResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return JobSubmittedResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/plug_type_query_stub.py b/test/types/job_type_notify_stub.py similarity index 58% rename from test/types/plug_type_query_stub.py rename to test/types/job_type_notify_stub.py index 5149855c..a1d88792 100644 --- a/test/types/plug_type_query_stub.py +++ b/test/types/job_type_notify_stub.py @@ -16,51 +16,48 @@ from ..openapi import MODEL_DEFINITIONS, with_example_provider try: - from waylay.services.registry.models.plug_type_query import PlugTypeQuery + from waylay.services.registry.models.job_type_notify import JobTypeNotify - PlugTypeQueryAdapter = TypeAdapter(PlugTypeQuery) + JobTypeNotifyAdapter = TypeAdapter(JobTypeNotify) MODELS_AVAILABLE = True except ImportError as exc: MODELS_AVAILABLE = False -plug_type_query_model_schema = json.loads( +job_type_notify_model_schema = json.loads( r"""{ - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/PlugType" - } - }, - "additionalProperties" : false + "title" : "JobTypeNotify", + "type" : "string", + "description" : "A job to notify that an function version has changed.", + "enum" : [ "notify" ] } """, object_hook=with_example_provider, ) -plug_type_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) +job_type_notify_model_schema.update({"definitions": MODEL_DEFINITIONS}) -plug_type_query_faker = JSF(plug_type_query_model_schema, allow_none_optionals=1) +job_type_notify_faker = JSF(job_type_notify_model_schema, allow_none_optionals=1) -class PlugTypeQueryStub: - """PlugTypeQuery unit test stubs.""" +class JobTypeNotifyStub: + """JobTypeNotify unit test stubs.""" @classmethod def create_json(cls): """Create a dict stub instance.""" - return plug_type_query_faker.generate(use_defaults=True, use_examples=True) + return job_type_notify_faker.generate(use_defaults=True, use_examples=True) @classmethod - def create_instance(cls) -> "PlugTypeQuery": - """Create PlugTypeQuery stub instance.""" + def create_instance(cls) -> "JobTypeNotify": + """Create JobTypeNotify stub instance.""" if not MODELS_AVAILABLE: raise ImportError("Models must be installed to create class stubs") json = cls.create_json() if not json: # use backup example based on the pydantic model schema backup_faker = JSF( - PlugTypeQueryAdapter.json_schema(), allow_none_optionals=1 + JobTypeNotifyAdapter.json_schema(), allow_none_optionals=1 ) json = backup_faker.generate(use_defaults=True, use_examples=True) - return PlugTypeQueryAdapter.validate_python( + return JobTypeNotifyAdapter.validate_python( json, context={"skip_validation": True} ) diff --git a/test/types/job_type_schema_stub.py b/test/types/job_type_schema_stub.py index 9695a50a..63f61c83 100644 --- a/test/types/job_type_schema_stub.py +++ b/test/types/job_type_schema_stub.py @@ -25,7 +25,6 @@ job_type_schema_model_schema = json.loads( r"""{ - "title" : "JobTypeSchema", "anyOf" : [ { "$ref" : "#/components/schemas/JobTypeBuild" }, { @@ -38,6 +37,8 @@ "$ref" : "#/components/schemas/JobTypeScale" }, { "$ref" : "#/components/schemas/JobTypeBatch" + }, { + "$ref" : "#/components/schemas/JobTypeNotify" } ] } """, diff --git a/test/types/job_type_stub.py b/test/types/job_type_stub.py index e79f0725..91f2a7af 100644 --- a/test/types/job_type_stub.py +++ b/test/types/job_type_stub.py @@ -25,9 +25,8 @@ job_type_model_schema = json.loads( r"""{ - "title" : "JobType", "type" : "string", - "enum" : [ "build", "deploy", "verify", "undeploy", "batch", "scale", "cleanup", "other" ] + "enum" : [ "build", "deploy", "verify", "undeploy", "batch", "scale", "cleanup", "notify" ] } """, object_hook=with_example_provider, diff --git a/test/types/jobs_hal_link_stub.py b/test/types/jobs_hal_link_stub.py deleted file mode 100644 index 7c0fba1f..00000000 --- a/test/types/jobs_hal_link_stub.py +++ /dev/null @@ -1,63 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.jobs_hal_link import JobsHALLink - - JobsHALLinkAdapter = TypeAdapter(JobsHALLink) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -jobs_hal_link_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "jobs" : { - "$ref" : "#/components/schemas/HALLink" - } - } -} -""", - object_hook=with_example_provider, -) -jobs_hal_link_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -jobs_hal_link_faker = JSF(jobs_hal_link_model_schema, allow_none_optionals=1) - - -class JobsHALLinkStub: - """JobsHALLink unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return jobs_hal_link_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "JobsHALLink": - """Create JobsHALLink stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(JobsHALLinkAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return JobsHALLinkAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_delete_multiple_response_stub.py b/test/types/kf_serving_delete_multiple_response_stub.py deleted file mode 100644 index a711aeb9..00000000 --- a/test/types/kf_serving_delete_multiple_response_stub.py +++ /dev/null @@ -1,84 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_delete_multiple_response import ( - KFServingDeleteMultipleResponse, - ) - - KFServingDeleteMultipleResponseAdapter = TypeAdapter( - KFServingDeleteMultipleResponse - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_delete_multiple_response_model_schema = json.loads( - r"""{ - "required" : [ "name", "versions" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "versions" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - }, - "description" : "Models Deleted" -} -""", - object_hook=with_example_provider, -) -kf_serving_delete_multiple_response_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -kf_serving_delete_multiple_response_faker = JSF( - kf_serving_delete_multiple_response_model_schema, allow_none_optionals=1 -) - - -class KFServingDeleteMultipleResponseStub: - """KFServingDeleteMultipleResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_delete_multiple_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "KFServingDeleteMultipleResponse": - """Create KFServingDeleteMultipleResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingDeleteMultipleResponseAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingDeleteMultipleResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_delete_multiple_with_job_response_stub.py b/test/types/kf_serving_delete_multiple_with_job_response_stub.py deleted file mode 100644 index 716dab98..00000000 --- a/test/types/kf_serving_delete_multiple_with_job_response_stub.py +++ /dev/null @@ -1,90 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_delete_multiple_with_job_response import ( - KFServingDeleteMultipleWithJobResponse, - ) - - KFServingDeleteMultipleWithJobResponseAdapter = TypeAdapter( - KFServingDeleteMultipleWithJobResponse - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_delete_multiple_with_job_response_model_schema = json.loads( - r"""{ - "required" : [ "_links", "message", "name", "versions" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "versions" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - } - }, - "description" : "Model Deletions Initiated" -} -""", - object_hook=with_example_provider, -) -kf_serving_delete_multiple_with_job_response_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -kf_serving_delete_multiple_with_job_response_faker = JSF( - kf_serving_delete_multiple_with_job_response_model_schema, allow_none_optionals=1 -) - - -class KFServingDeleteMultipleWithJobResponseStub: - """KFServingDeleteMultipleWithJobResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_delete_multiple_with_job_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "KFServingDeleteMultipleWithJobResponse": - """Create KFServingDeleteMultipleWithJobResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingDeleteMultipleWithJobResponseAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingDeleteMultipleWithJobResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_delete_query_v1_stub.py b/test/types/kf_serving_delete_query_v1_stub.py deleted file mode 100644 index b48f5b34..00000000 --- a/test/types/kf_serving_delete_query_v1_stub.py +++ /dev/null @@ -1,146 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_delete_query_v1 import ( - KFServingDeleteQueryV1, - ) - - KFServingDeleteQueryV1Adapter = TypeAdapter(KFServingDeleteQueryV1) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_delete_query_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "async" : { - "type" : "boolean", - "description" : "If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - "default" : false - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -kf_serving_delete_query_v1_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -kf_serving_delete_query_v1_faker = JSF( - kf_serving_delete_query_v1_model_schema, allow_none_optionals=1 -) - - -class KFServingDeleteQueryV1Stub: - """KFServingDeleteQueryV1 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_delete_query_v1_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "KFServingDeleteQueryV1": - """Create KFServingDeleteQueryV1 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingDeleteQueryV1Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingDeleteQueryV1Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_delete_query_v2_stub.py b/test/types/kf_serving_delete_query_v2_stub.py deleted file mode 100644 index 8f341e29..00000000 --- a/test/types/kf_serving_delete_query_v2_stub.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_delete_query_v2 import ( - KFServingDeleteQueryV2, - ) - - KFServingDeleteQueryV2Adapter = TypeAdapter(KFServingDeleteQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_delete_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "force" : { - "type" : "boolean", - "description" : "If true, the function version will be immediately undeployed and removed.\n\nOtherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_." - }, - "undeploy" : { - "type" : "boolean", - "description" : "If `true`, the `DELETE` operation\n* undeploys the (openfaas) function: it becomes no longer available for invocation.\n* does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action.\n\nIf `false`, the `DELETE` operation\n* _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions.\n\nThis parameter is incompatible with `force=true`.\n\nIf not set the default behaviour applies:\n* _draft_ versions are _undeployed_ and _removed_ from registry.\n* non-_draft_ versions are marked _deprecated_ only." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -kf_serving_delete_query_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -kf_serving_delete_query_v2_faker = JSF( - kf_serving_delete_query_v2_model_schema, allow_none_optionals=1 -) - - -class KFServingDeleteQueryV2Stub: - """KFServingDeleteQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_delete_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "KFServingDeleteQueryV2": - """Create KFServingDeleteQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingDeleteQueryV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingDeleteQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_delete_response_stub.py b/test/types/kf_serving_delete_response_stub.py deleted file mode 100644 index dc120975..00000000 --- a/test/types/kf_serving_delete_response_stub.py +++ /dev/null @@ -1,77 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_delete_response import ( - KFServingDeleteResponse, - ) - - KFServingDeleteResponseAdapter = TypeAdapter(KFServingDeleteResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_delete_response_model_schema = json.loads( - r"""{ - "required" : [ "name", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - } - }, - "description" : "Model Deleted" -} -""", - object_hook=with_example_provider, -) -kf_serving_delete_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -kf_serving_delete_response_faker = JSF( - kf_serving_delete_response_model_schema, allow_none_optionals=1 -) - - -class KFServingDeleteResponseStub: - """KFServingDeleteResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_delete_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "KFServingDeleteResponse": - """Create KFServingDeleteResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingDeleteResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingDeleteResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_delete_with_job_response_stub.py b/test/types/kf_serving_delete_with_job_response_stub.py deleted file mode 100644 index 06de8e14..00000000 --- a/test/types/kf_serving_delete_with_job_response_stub.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_delete_with_job_response import ( - KFServingDeleteWithJobResponse, - ) - - KFServingDeleteWithJobResponseAdapter = TypeAdapter(KFServingDeleteWithJobResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_delete_with_job_response_model_schema = json.loads( - r"""{ - "required" : [ "_links", "message", "name", "version" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "name" : { - "type" : "string", - "description" : "The name of the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - } - }, - "description" : "Model Delete Initiated" -} -""", - object_hook=with_example_provider, -) -kf_serving_delete_with_job_response_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -kf_serving_delete_with_job_response_faker = JSF( - kf_serving_delete_with_job_response_model_schema, allow_none_optionals=1 -) - - -class KFServingDeleteWithJobResponseStub: - """KFServingDeleteWithJobResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_delete_with_job_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "KFServingDeleteWithJobResponse": - """Create KFServingDeleteWithJobResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingDeleteWithJobResponseAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingDeleteWithJobResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_latest_version_query_v2_stub.py b/test/types/kf_serving_latest_version_query_v2_stub.py deleted file mode 100644 index cfabc1ad..00000000 --- a/test/types/kf_serving_latest_version_query_v2_stub.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_latest_version_query_v2 import ( - KFServingLatestVersionQueryV2, - ) - - KFServingLatestVersionQueryV2Adapter = TypeAdapter(KFServingLatestVersionQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_latest_version_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - } - }, - "additionalProperties" : false, - "description" : "Named Model latest version query." -} -""", - object_hook=with_example_provider, -) -kf_serving_latest_version_query_v2_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -kf_serving_latest_version_query_v2_faker = JSF( - kf_serving_latest_version_query_v2_model_schema, allow_none_optionals=1 -) - - -class KFServingLatestVersionQueryV2Stub: - """KFServingLatestVersionQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_latest_version_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "KFServingLatestVersionQueryV2": - """Create KFServingLatestVersionQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingLatestVersionQueryV2Adapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingLatestVersionQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_latest_versions_query_v1_stub.py b/test/types/kf_serving_latest_versions_query_v1_stub.py deleted file mode 100644 index 5756764b..00000000 --- a/test/types/kf_serving_latest_versions_query_v1_stub.py +++ /dev/null @@ -1,145 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_latest_versions_query_v1 import ( - KFServingLatestVersionsQueryV1, - ) - - KFServingLatestVersionsQueryV1Adapter = TypeAdapter(KFServingLatestVersionsQueryV1) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_latest_versions_query_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Model listing query" -} -""", - object_hook=with_example_provider, -) -kf_serving_latest_versions_query_v1_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -kf_serving_latest_versions_query_v1_faker = JSF( - kf_serving_latest_versions_query_v1_model_schema, allow_none_optionals=1 -) - - -class KFServingLatestVersionsQueryV1Stub: - """KFServingLatestVersionsQueryV1 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_latest_versions_query_v1_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "KFServingLatestVersionsQueryV1": - """Create KFServingLatestVersionsQueryV1 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingLatestVersionsQueryV1Adapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingLatestVersionsQueryV1Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_latest_versions_query_v2_stub.py b/test/types/kf_serving_latest_versions_query_v2_stub.py deleted file mode 100644 index 006a880a..00000000 --- a/test/types/kf_serving_latest_versions_query_v2_stub.py +++ /dev/null @@ -1,74 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_latest_versions_query_v2 import ( - KFServingLatestVersionsQueryV2, - ) - - KFServingLatestVersionsQueryV2Adapter = TypeAdapter(KFServingLatestVersionsQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_latest_versions_query_v2_model_schema = json.loads( - r"""{ - "description" : "Latest model versions listing query.", - "anyOf" : [ { - "$ref" : "#/components/schemas/LatestFunctionVersionsQuery" - }, { - "$ref" : "#/components/schemas/LatestFunctionsQuery" - } ] -} -""", - object_hook=with_example_provider, -) -kf_serving_latest_versions_query_v2_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -kf_serving_latest_versions_query_v2_faker = JSF( - kf_serving_latest_versions_query_v2_model_schema, allow_none_optionals=1 -) - - -class KFServingLatestVersionsQueryV2Stub: - """KFServingLatestVersionsQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_latest_versions_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "KFServingLatestVersionsQueryV2": - """Create KFServingLatestVersionsQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingLatestVersionsQueryV2Adapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingLatestVersionsQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_models_response_stub.py b/test/types/kf_serving_models_response_stub.py deleted file mode 100644 index 9e338b03..00000000 --- a/test/types/kf_serving_models_response_stub.py +++ /dev/null @@ -1,79 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_models_response import ( - KFServingModelsResponse, - ) - - KFServingModelsResponseAdapter = TypeAdapter(KFServingModelsResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_models_response_model_schema = json.loads( - r"""{ - "required" : [ "models" ], - "type" : "object", - "properties" : { - "models" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/KFServingResponse" - } - }, - "paging" : { - "$ref" : "#/components/schemas/PagingResponse" - } - }, - "description" : "Successful Response" -} -""", - object_hook=with_example_provider, -) -kf_serving_models_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -kf_serving_models_response_faker = JSF( - kf_serving_models_response_model_schema, allow_none_optionals=1 -) - - -class KFServingModelsResponseStub: - """KFServingModelsResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_models_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "KFServingModelsResponse": - """Create KFServingModelsResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingModelsResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingModelsResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_response_stub.py b/test/types/kf_serving_response_stub.py deleted file mode 100644 index 5198c99e..00000000 --- a/test/types/kf_serving_response_stub.py +++ /dev/null @@ -1,116 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_response import KFServingResponse - - KFServingResponseAdapter = TypeAdapter(KFServingResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_response_model_schema = json.loads( - r"""{ - "required" : [ "createdAt", "createdBy", "metadata", "name", "runtime", "status", "updatedAt", "updatedBy", "version" ], - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - }, - "createdBy" : { - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "_links" : { - "type" : "array", - "description" : "Links to related entities.", - "items" : { - "$ref" : "#/components/schemas/JobHALLinks" - } - } - }, - "description" : "Successful Response" -} -""", - object_hook=with_example_provider, -) -kf_serving_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -kf_serving_response_faker = JSF( - kf_serving_response_model_schema, allow_none_optionals=1 -) - - -class KFServingResponseStub: - """KFServingResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_response_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "KFServingResponse": - """Create KFServingResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/kf_serving_versions_query_v1_stub.py b/test/types/kf_serving_versions_query_v1_stub.py deleted file mode 100644 index d37e2bc5..00000000 --- a/test/types/kf_serving_versions_query_v1_stub.py +++ /dev/null @@ -1,134 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.kf_serving_versions_query_v1 import ( - KFServingVersionsQueryV1, - ) - - KFServingVersionsQueryV1Adapter = TypeAdapter(KFServingVersionsQueryV1) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -kf_serving_versions_query_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Named model versions query" -} -""", - object_hook=with_example_provider, -) -kf_serving_versions_query_v1_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -kf_serving_versions_query_v1_faker = JSF( - kf_serving_versions_query_v1_model_schema, allow_none_optionals=1 -) - - -class KFServingVersionsQueryV1Stub: - """KFServingVersionsQueryV1 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return kf_serving_versions_query_v1_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "KFServingVersionsQueryV1": - """Create KFServingVersionsQueryV1 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - KFServingVersionsQueryV1Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return KFServingVersionsQueryV1Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/latest_function_versions_query_stub.py b/test/types/latest_function_versions_query_stub.py deleted file mode 100644 index 037d0d15..00000000 --- a/test/types/latest_function_versions_query_stub.py +++ /dev/null @@ -1,161 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.latest_function_versions_query import ( - LatestFunctionVersionsQuery, - ) - - LatestFunctionVersionsQueryAdapter = TypeAdapter(LatestFunctionVersionsQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -latest_function_versions_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "nameVersion" : { - "type" : "array", - "description" : "Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - "items" : { - "$ref" : "#/components/schemas/NamedVersion" - } - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - }, - "latest" : { - "type" : "boolean", - "description" : "When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter." - } - }, - "additionalProperties" : false, - "description" : "Latest function versions listing query." -} -""", - object_hook=with_example_provider, -) -latest_function_versions_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -latest_function_versions_query_faker = JSF( - latest_function_versions_query_model_schema, allow_none_optionals=1 -) - - -class LatestFunctionVersionsQueryStub: - """LatestFunctionVersionsQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return latest_function_versions_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LatestFunctionVersionsQuery": - """Create LatestFunctionVersionsQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LatestFunctionVersionsQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LatestFunctionVersionsQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/latest_functions_query_stub.py b/test/types/latest_functions_query_stub.py deleted file mode 100644 index da51990e..00000000 --- a/test/types/latest_functions_query_stub.py +++ /dev/null @@ -1,106 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.latest_functions_query import ( - LatestFunctionsQuery, - ) - - LatestFunctionsQueryAdapter = TypeAdapter(LatestFunctionsQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -latest_functions_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Request to list latest function versions per named function. A request that only uses these query parameters will include links to the _latest_ draft/published versions." -} -""", - object_hook=with_example_provider, -) -latest_functions_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -latest_functions_query_faker = JSF( - latest_functions_query_model_schema, allow_none_optionals=1 -) - - -class LatestFunctionsQueryStub: - """LatestFunctionsQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return latest_functions_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LatestFunctionsQuery": - """Create LatestFunctionsQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LatestFunctionsQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LatestFunctionsQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/latest_models_response_v2_stub.py b/test/types/latest_models_response_v2_stub.py index 88f91c82..53b6515e 100644 --- a/test/types/latest_models_response_v2_stub.py +++ b/test/types/latest_models_response_v2_stub.py @@ -46,7 +46,7 @@ "type" : "array", "description" : "The specification and deployment status of the queried functions", "items" : { - "$ref" : "#/components/schemas/LatestModelsResponseV2_entities_inner" + "$ref" : "#/components/schemas/EntityWithLinks_IKfservingResponseV2_" } } }, diff --git a/test/types/latest_plug_query_stub.py b/test/types/latest_plug_query_stub.py deleted file mode 100644 index d74a01e7..00000000 --- a/test/types/latest_plug_query_stub.py +++ /dev/null @@ -1,142 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.latest_plug_query import LatestPlugQuery - - LatestPlugQueryAdapter = TypeAdapter(LatestPlugQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -latest_plug_query_model_schema = json.loads( - r"""{ - "required" : [ "type" ], - "type" : "object", - "properties" : { - "tags" : { - "$ref" : "#/components/schemas/TagsFilter" - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - }, - "type" : { - "$ref" : "#/components/schemas/PlugType" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -latest_plug_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -latest_plug_query_faker = JSF(latest_plug_query_model_schema, allow_none_optionals=1) - - -class LatestPlugQueryStub: - """LatestPlugQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return latest_plug_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "LatestPlugQuery": - """Create LatestPlugQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LatestPlugQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LatestPlugQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/latest_plug_version_query_v2_stub.py b/test/types/latest_plug_version_query_v2_stub.py deleted file mode 100644 index 481f9be9..00000000 --- a/test/types/latest_plug_version_query_v2_stub.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.latest_plug_version_query_v2 import ( - LatestPlugVersionQueryV2, - ) - - LatestPlugVersionQueryV2Adapter = TypeAdapter(LatestPlugVersionQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -latest_plug_version_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/PlugType" - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - } - }, - "additionalProperties" : false, - "description" : "Latest named plug version listing query" -} -""", - object_hook=with_example_provider, -) -latest_plug_version_query_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -latest_plug_version_query_v2_faker = JSF( - latest_plug_version_query_v2_model_schema, allow_none_optionals=1 -) - - -class LatestPlugVersionQueryV2Stub: - """LatestPlugVersionQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return latest_plug_version_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LatestPlugVersionQueryV2": - """Create LatestPlugVersionQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LatestPlugVersionQueryV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LatestPlugVersionQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/latest_plug_versions_query_stub.py b/test/types/latest_plug_versions_query_stub.py deleted file mode 100644 index b5f1f445..00000000 --- a/test/types/latest_plug_versions_query_stub.py +++ /dev/null @@ -1,167 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.latest_plug_versions_query import ( - LatestPlugVersionsQuery, - ) - - LatestPlugVersionsQueryAdapter = TypeAdapter(LatestPlugVersionsQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -latest_plug_versions_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "tags" : { - "$ref" : "#/components/schemas/TagsFilter" - }, - "type" : { - "$ref" : "#/components/schemas/PlugType" - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "nameVersion" : { - "type" : "array", - "description" : "Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - "items" : { - "$ref" : "#/components/schemas/NamedVersion" - } - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - }, - "latest" : { - "type" : "boolean", - "description" : "When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter." - } - }, - "additionalProperties" : false, - "description" : "Plug versions listing query." -} -""", - object_hook=with_example_provider, -) -latest_plug_versions_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -latest_plug_versions_query_faker = JSF( - latest_plug_versions_query_model_schema, allow_none_optionals=1 -) - - -class LatestPlugVersionsQueryStub: - """LatestPlugVersionsQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return latest_plug_versions_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LatestPlugVersionsQuery": - """Create LatestPlugVersionsQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LatestPlugVersionsQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LatestPlugVersionsQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/latest_plug_versions_query_v2_stub.py b/test/types/latest_plug_versions_query_v2_stub.py deleted file mode 100644 index 0816bf8c..00000000 --- a/test/types/latest_plug_versions_query_v2_stub.py +++ /dev/null @@ -1,71 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.latest_plug_versions_query_v2 import ( - LatestPlugVersionsQueryV2, - ) - - LatestPlugVersionsQueryV2Adapter = TypeAdapter(LatestPlugVersionsQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -latest_plug_versions_query_v2_model_schema = json.loads( - r"""{ - "description" : "Latest plug versions listing query.", - "anyOf" : [ { - "$ref" : "#/components/schemas/LatestPlugVersionsQuery" - }, { - "$ref" : "#/components/schemas/LatestPlugsQuery" - } ] -} -""", - object_hook=with_example_provider, -) -latest_plug_versions_query_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -latest_plug_versions_query_v2_faker = JSF( - latest_plug_versions_query_v2_model_schema, allow_none_optionals=1 -) - - -class LatestPlugVersionsQueryV2Stub: - """LatestPlugVersionsQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return latest_plug_versions_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LatestPlugVersionsQueryV2": - """Create LatestPlugVersionsQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LatestPlugVersionsQueryV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LatestPlugVersionsQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/latest_plugs_query_stub.py b/test/types/latest_plugs_query_stub.py deleted file mode 100644 index 24ca499a..00000000 --- a/test/types/latest_plugs_query_stub.py +++ /dev/null @@ -1,103 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.latest_plugs_query import LatestPlugsQuery - - LatestPlugsQueryAdapter = TypeAdapter(LatestPlugsQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -latest_plugs_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/PlugType" - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Latest plug versions listing query with latest links. A request that only uses these query parameters will include links to the _latest_ draft/published versions of the plug." -} -""", - object_hook=with_example_provider, -) -latest_plugs_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -latest_plugs_query_faker = JSF(latest_plugs_query_model_schema, allow_none_optionals=1) - - -class LatestPlugsQueryStub: - """LatestPlugsQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return latest_plugs_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "LatestPlugsQuery": - """Create LatestPlugsQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LatestPlugsQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LatestPlugsQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/latest_plugs_response_v2_stub.py b/test/types/latest_plugs_response_v2_stub.py index d7b8474c..6515c827 100644 --- a/test/types/latest_plugs_response_v2_stub.py +++ b/test/types/latest_plugs_response_v2_stub.py @@ -46,7 +46,7 @@ "type" : "array", "description" : "The specification and deployment status of the queried functions", "items" : { - "$ref" : "#/components/schemas/LatestPlugsResponseV2_entities_inner" + "$ref" : "#/components/schemas/EntityWithLinks_IPlugResponseV2_" } } }, diff --git a/test/types/latest_version_level_stub.py b/test/types/latest_version_level_stub.py index 37a0d8df..1366166b 100644 --- a/test/types/latest_version_level_stub.py +++ b/test/types/latest_version_level_stub.py @@ -25,7 +25,6 @@ latest_version_level_model_schema = json.loads( r"""{ - "title" : "LatestVersionLevel", "type" : "string", "description" : "Level of latest versions that should be included.", "enum" : [ "major", "minor", "patch", "true", "false" ] diff --git a/test/types/latest_webscripts_response_v2_stub.py b/test/types/latest_webscripts_response_v2_stub.py index 52e0be0d..2e851579 100644 --- a/test/types/latest_webscripts_response_v2_stub.py +++ b/test/types/latest_webscripts_response_v2_stub.py @@ -46,7 +46,7 @@ "type" : "array", "description" : "The specification and deployment status of the queried functions", "items" : { - "$ref" : "#/components/schemas/LatestWebscriptsResponseV2_entities_inner" + "$ref" : "#/components/schemas/EntityWithLinks_IWebscriptResponseWithInvokeLinkV2_" } } }, diff --git a/test/types/legacy_configuration_object_format_stub.py b/test/types/legacy_configuration_object_format_stub.py deleted file mode 100644 index ab6029b0..00000000 --- a/test/types/legacy_configuration_object_format_stub.py +++ /dev/null @@ -1,84 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_configuration_object_format import ( - LegacyConfigurationObjectFormat, - ) - - LegacyConfigurationObjectFormatAdapter = TypeAdapter( - LegacyConfigurationObjectFormat - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_configuration_object_format_model_schema = json.loads( - r"""{ - "title" : "LegacyConfigurationObject_format", - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/PlugPropertyFormatType" - }, - "values" : { - "title" : "values", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/EnumValue" - } - } - } -} -""", - object_hook=with_example_provider, -) -legacy_configuration_object_format_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -legacy_configuration_object_format_faker = JSF( - legacy_configuration_object_format_model_schema, allow_none_optionals=1 -) - - -class LegacyConfigurationObjectFormatStub: - """LegacyConfigurationObjectFormat unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_configuration_object_format_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyConfigurationObjectFormat": - """Create LegacyConfigurationObjectFormat stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyConfigurationObjectFormatAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyConfigurationObjectFormatAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_configuration_object_stub.py b/test/types/legacy_configuration_object_stub.py deleted file mode 100644 index 19ec3b2f..00000000 --- a/test/types/legacy_configuration_object_stub.py +++ /dev/null @@ -1,87 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_configuration_object import ( - LegacyConfigurationObject, - ) - - LegacyConfigurationObjectAdapter = TypeAdapter(LegacyConfigurationObject) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_configuration_object_model_schema = json.loads( - r"""{ - "title" : "LegacyConfigurationObject", - "required" : [ "name", "type" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string" - }, - "type" : { - "$ref" : "#/components/schemas/PlugPropertyDataType" - }, - "mandatory" : { - "title" : "mandatory", - "type" : "boolean" - }, - "format" : { - "$ref" : "#/components/schemas/LegacyConfigurationObject_format" - }, - "defaultValue" : { - "$ref" : "#/components/schemas/DefaultValue" - } - } -} -""", - object_hook=with_example_provider, -) -legacy_configuration_object_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_configuration_object_faker = JSF( - legacy_configuration_object_model_schema, allow_none_optionals=1 -) - - -class LegacyConfigurationObjectStub: - """LegacyConfigurationObject unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_configuration_object_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyConfigurationObject": - """Create LegacyConfigurationObject stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyConfigurationObjectAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyConfigurationObjectAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_configuration_response_object_stub.py b/test/types/legacy_configuration_response_object_stub.py deleted file mode 100644 index f19d6470..00000000 --- a/test/types/legacy_configuration_response_object_stub.py +++ /dev/null @@ -1,96 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_configuration_response_object import ( - LegacyConfigurationResponseObject, - ) - - LegacyConfigurationResponseObjectAdapter = TypeAdapter( - LegacyConfigurationResponseObject - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_configuration_response_object_model_schema = json.loads( - r"""{ - "title" : "LegacyConfigurationResponseObject", - "required" : [ "name", "type" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string" - }, - "type" : { - "$ref" : "#/components/schemas/PlugPropertyDataType" - }, - "mandatory" : { - "title" : "mandatory", - "type" : "boolean" - }, - "format" : { - "$ref" : "#/components/schemas/LegacyConfigurationObject_format" - }, - "defaultValue" : { - "$ref" : "#/components/schemas/DefaultValue" - }, - "sensitive" : { - "title" : "sensitive", - "type" : "boolean" - } - } -} -""", - object_hook=with_example_provider, -) -legacy_configuration_response_object_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -legacy_configuration_response_object_faker = JSF( - legacy_configuration_response_object_model_schema, allow_none_optionals=1 -) - - -class LegacyConfigurationResponseObjectStub: - """LegacyConfigurationResponseObject unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_configuration_response_object_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyConfigurationResponseObject": - """Create LegacyConfigurationResponseObject stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyConfigurationResponseObjectAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyConfigurationResponseObjectAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_create_debug_response_stub.py b/test/types/legacy_create_debug_response_stub.py deleted file mode 100644 index 28db6d1c..00000000 --- a/test/types/legacy_create_debug_response_stub.py +++ /dev/null @@ -1,72 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_create_debug_response import ( - LegacyCreateDebugResponse, - ) - - LegacyCreateDebugResponseAdapter = TypeAdapter(LegacyCreateDebugResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_create_debug_response_model_schema = json.loads( - r"""{ - "required" : [ "functionName" ], - "type" : "object", - "properties" : { - "functionName" : { - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -legacy_create_debug_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_create_debug_response_faker = JSF( - legacy_create_debug_response_model_schema, allow_none_optionals=1 -) - - -class LegacyCreateDebugResponseStub: - """LegacyCreateDebugResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_create_debug_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyCreateDebugResponse": - """Create LegacyCreateDebugResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyCreateDebugResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyCreateDebugResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_debug_plug_manifest_stub.py b/test/types/legacy_debug_plug_manifest_stub.py deleted file mode 100644 index 8d5396e4..00000000 --- a/test/types/legacy_debug_plug_manifest_stub.py +++ /dev/null @@ -1,98 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_debug_plug_manifest import ( - LegacyDebugPlugManifest, - ) - - LegacyDebugPlugManifestAdapter = TypeAdapter(LegacyDebugPlugManifest) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_debug_plug_manifest_model_schema = json.loads( - r"""{ - "required" : [ "metadata", "name", "runtime", "script", "tenant", "version" ], - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - }, - "tenant" : { - "$ref" : "#/components/schemas/TenantId" - }, - "dependencies" : { - "$ref" : "#/components/schemas/LegacyPlugDependencies" - }, - "script" : { - "type" : "string" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -legacy_debug_plug_manifest_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_debug_plug_manifest_faker = JSF( - legacy_debug_plug_manifest_model_schema, allow_none_optionals=1 -) - - -class LegacyDebugPlugManifestStub: - """LegacyDebugPlugManifest unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_debug_plug_manifest_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyDebugPlugManifest": - """Create LegacyDebugPlugManifest stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyDebugPlugManifestAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyDebugPlugManifestAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_debug_plug_request_stub.py b/test/types/legacy_debug_plug_request_stub.py deleted file mode 100644 index 7a1063ad..00000000 --- a/test/types/legacy_debug_plug_request_stub.py +++ /dev/null @@ -1,82 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_debug_plug_request import ( - LegacyDebugPlugRequest, - ) - - LegacyDebugPlugRequestAdapter = TypeAdapter(LegacyDebugPlugRequest) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_debug_plug_request_model_schema = json.loads( - r"""{ - "required" : [ "script" ], - "type" : "object", - "properties" : { - "type" : { - "$ref" : "#/components/schemas/PlugType" - }, - "script" : { - "type" : "string" - }, - "dependencies" : { - "$ref" : "#/components/schemas/LegacyPlugDependencies" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -legacy_debug_plug_request_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_debug_plug_request_faker = JSF( - legacy_debug_plug_request_model_schema, allow_none_optionals=1 -) - - -class LegacyDebugPlugRequestStub: - """LegacyDebugPlugRequest unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_debug_plug_request_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyDebugPlugRequest": - """Create LegacyDebugPlugRequest stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyDebugPlugRequestAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyDebugPlugRequestAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_documentation_request_stub.py b/test/types/legacy_documentation_request_stub.py deleted file mode 100644 index 2c8d6725..00000000 --- a/test/types/legacy_documentation_request_stub.py +++ /dev/null @@ -1,91 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_documentation_request import ( - LegacyDocumentationRequest, - ) - - LegacyDocumentationRequestAdapter = TypeAdapter(LegacyDocumentationRequest) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_documentation_request_model_schema = json.loads( - r"""{ - "required" : [ "configuration", "rawData", "supportedStates" ], - "type" : "object", - "properties" : { - "description" : { - "type" : "string" - }, - "supportedStates" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "configuration" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "rawData" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -legacy_documentation_request_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_documentation_request_faker = JSF( - legacy_documentation_request_model_schema, allow_none_optionals=1 -) - - -class LegacyDocumentationRequestStub: - """LegacyDocumentationRequest unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_documentation_request_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyDocumentationRequest": - """Create LegacyDocumentationRequest stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyDocumentationRequestAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyDocumentationRequestAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_documentation_stub.py b/test/types/legacy_documentation_stub.py deleted file mode 100644 index 5d10769d..00000000 --- a/test/types/legacy_documentation_stub.py +++ /dev/null @@ -1,83 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_documentation import LegacyDocumentation - - LegacyDocumentationAdapter = TypeAdapter(LegacyDocumentation) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_documentation_model_schema = json.loads( - r"""{ - "required" : [ "configuration", "rawData", "supportedStates" ], - "type" : "object", - "properties" : { - "supportedStates" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "configuration" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "rawData" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - } - } -} -""", - object_hook=with_example_provider, -) -legacy_documentation_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_documentation_faker = JSF( - legacy_documentation_model_schema, allow_none_optionals=1 -) - - -class LegacyDocumentationStub: - """LegacyDocumentation unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_documentation_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "LegacyDocumentation": - """Create LegacyDocumentation stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyDocumentationAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyDocumentationAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_function_meta_stub.py b/test/types/legacy_function_meta_stub.py deleted file mode 100644 index 3057cd1c..00000000 --- a/test/types/legacy_function_meta_stub.py +++ /dev/null @@ -1,85 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_function_meta import LegacyFunctionMeta - - LegacyFunctionMetaAdapter = TypeAdapter(LegacyFunctionMeta) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_function_meta_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "author" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "category" : { - "type" : "string" - }, - "tags" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "iconURL" : { - "type" : "string" - }, - "friendlyName" : { - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -legacy_function_meta_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_function_meta_faker = JSF( - legacy_function_meta_model_schema, allow_none_optionals=1 -) - - -class LegacyFunctionMetaStub: - """LegacyFunctionMeta unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_function_meta_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "LegacyFunctionMeta": - """Create LegacyFunctionMeta stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyFunctionMetaAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyFunctionMetaAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_create_query_stub.py b/test/types/legacy_plug_create_query_stub.py deleted file mode 100644 index 1e701971..00000000 --- a/test/types/legacy_plug_create_query_stub.py +++ /dev/null @@ -1,82 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_create_query import ( - LegacyPlugCreateQuery, - ) - - LegacyPlugCreateQueryAdapter = TypeAdapter(LegacyPlugCreateQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_create_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "async" : { - "type" : "boolean", - "description" : "If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - "default" : false - }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, only validates the incoming request." - }, - "scaleToZero" : { - "type" : "boolean", - "description" : "If set to true, scales the function to zero after successful deployment." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -legacy_plug_create_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_plug_create_query_faker = JSF( - legacy_plug_create_query_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugCreateQueryStub: - """LegacyPlugCreateQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_create_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugCreateQuery": - """Create LegacyPlugCreateQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugCreateQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugCreateQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_create_request_stub.py b/test/types/legacy_plug_create_request_stub.py deleted file mode 100644 index 41d1a891..00000000 --- a/test/types/legacy_plug_create_request_stub.py +++ /dev/null @@ -1,88 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_create_request import ( - LegacyPlugCreateRequest, - ) - - LegacyPlugCreateRequestAdapter = TypeAdapter(LegacyPlugCreateRequest) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_create_request_model_schema = json.loads( - r"""{ - "required" : [ "metadata", "name", "script", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "script" : { - "type" : "string" - }, - "dependencies" : { - "$ref" : "#/components/schemas/LegacyPlugDependencies" - }, - "metadata" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata" - }, - "type" : { - "$ref" : "#/components/schemas/PlugType" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -legacy_plug_create_request_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_plug_create_request_faker = JSF( - legacy_plug_create_request_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugCreateRequestStub: - """LegacyPlugCreateRequest unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_create_request_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugCreateRequest": - """Create LegacyPlugCreateRequest stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugCreateRequestAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugCreateRequestAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_create_response_stub.py b/test/types/legacy_plug_create_response_stub.py deleted file mode 100644 index c5e0feb0..00000000 --- a/test/types/legacy_plug_create_response_stub.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_create_response import ( - LegacyPlugCreateResponse, - ) - - LegacyPlugCreateResponseAdapter = TypeAdapter(LegacyPlugCreateResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_create_response_model_schema = json.loads( - r"""{ - "required" : [ "entity", "statusCode", "uri" ], - "type" : "object", - "properties" : { - "statusCode" : { - "type" : "number" - }, - "uri" : { - "type" : "string" - }, - "entity" : { - "$ref" : "#/components/schemas/LegacyPlugScriptResponse" - } - } -} -""", - object_hook=with_example_provider, -) -legacy_plug_create_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_plug_create_response_faker = JSF( - legacy_plug_create_response_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugCreateResponseStub: - """LegacyPlugCreateResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_create_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugCreateResponse": - """Create LegacyPlugCreateResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugCreateResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugCreateResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_meta_request_stub.py b/test/types/legacy_plug_meta_request_stub.py deleted file mode 100644 index 0fe06a8c..00000000 --- a/test/types/legacy_plug_meta_request_stub.py +++ /dev/null @@ -1,96 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_meta_request import ( - LegacyPlugMetaRequest, - ) - - LegacyPlugMetaRequestAdapter = TypeAdapter(LegacyPlugMetaRequest) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_meta_request_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "author" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "category" : { - "type" : "string" - }, - "tags" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "iconURL" : { - "type" : "string" - }, - "friendlyName" : { - "type" : "string" - }, - "documentation" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_documentation" - }, - "documentationURL" : { - "type" : "string" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -legacy_plug_meta_request_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_plug_meta_request_faker = JSF( - legacy_plug_meta_request_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugMetaRequestStub: - """LegacyPlugMetaRequest unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_meta_request_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugMetaRequest": - """Create LegacyPlugMetaRequest stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugMetaRequestAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugMetaRequestAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_query_stub.py b/test/types/legacy_plug_query_stub.py deleted file mode 100644 index 42101903..00000000 --- a/test/types/legacy_plug_query_stub.py +++ /dev/null @@ -1,138 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_query import LegacyPlugQuery - - LegacyPlugQueryAdapter = TypeAdapter(LegacyPlugQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "tags" : { - "$ref" : "#/components/schemas/TagsFilter" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -legacy_plug_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_plug_query_faker = JSF(legacy_plug_query_model_schema, allow_none_optionals=1) - - -class LegacyPlugQueryStub: - """LegacyPlugQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "LegacyPlugQuery": - """Create LegacyPlugQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_request_metadata_documentation_any_of_stub.py b/test/types/legacy_plug_request_metadata_documentation_any_of_stub.py deleted file mode 100644 index 26128ad3..00000000 --- a/test/types/legacy_plug_request_metadata_documentation_any_of_stub.py +++ /dev/null @@ -1,93 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_request_metadata_documentation_any_of import ( - LegacyPlugRequestMetadataDocumentationAnyOf, - ) - - LegacyPlugRequestMetadataDocumentationAnyOfAdapter = TypeAdapter( - LegacyPlugRequestMetadataDocumentationAnyOf - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_request_metadata_documentation_any_of_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "supportedStates" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "configuration" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - }, - "rawData" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/DocumentationProperty" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -legacy_plug_request_metadata_documentation_any_of_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -legacy_plug_request_metadata_documentation_any_of_faker = JSF( - legacy_plug_request_metadata_documentation_any_of_model_schema, - allow_none_optionals=1, -) - - -class LegacyPlugRequestMetadataDocumentationAnyOfStub: - """LegacyPlugRequestMetadataDocumentationAnyOf unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_request_metadata_documentation_any_of_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugRequestMetadataDocumentationAnyOf": - """Create LegacyPlugRequestMetadataDocumentationAnyOf stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugRequestMetadataDocumentationAnyOfAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugRequestMetadataDocumentationAnyOfAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_request_metadata_documentation_stub.py b/test/types/legacy_plug_request_metadata_documentation_stub.py deleted file mode 100644 index fcb845bf..00000000 --- a/test/types/legacy_plug_request_metadata_documentation_stub.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_request_metadata_documentation import ( - LegacyPlugRequestMetadataDocumentation, - ) - - LegacyPlugRequestMetadataDocumentationAdapter = TypeAdapter( - LegacyPlugRequestMetadataDocumentation - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_request_metadata_documentation_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugRequest_metadata_documentation", - "anyOf" : [ { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_documentation_anyOf" - }, { - "$ref" : "#/components/schemas/Documentation" - } ] -} -""", - object_hook=with_example_provider, -) -legacy_plug_request_metadata_documentation_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -legacy_plug_request_metadata_documentation_faker = JSF( - legacy_plug_request_metadata_documentation_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugRequestMetadataDocumentationStub: - """LegacyPlugRequestMetadataDocumentation unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_request_metadata_documentation_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugRequestMetadataDocumentation": - """Create LegacyPlugRequestMetadataDocumentation stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugRequestMetadataDocumentationAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugRequestMetadataDocumentationAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_request_metadata_raw_data_inner_stub.py b/test/types/legacy_plug_request_metadata_raw_data_inner_stub.py deleted file mode 100644 index daac7093..00000000 --- a/test/types/legacy_plug_request_metadata_raw_data_inner_stub.py +++ /dev/null @@ -1,83 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_request_metadata_raw_data_inner import ( - LegacyPlugRequestMetadataRawDataInner, - ) - - LegacyPlugRequestMetadataRawDataInnerAdapter = TypeAdapter( - LegacyPlugRequestMetadataRawDataInner - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_request_metadata_raw_data_inner_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugRequest_metadata_rawData_inner", - "required" : [ "parameter" ], - "type" : "object", - "properties" : { - "parameter" : { - "title" : "parameter", - "type" : "string" - }, - "dataType" : { - "$ref" : "#/components/schemas/PlugPropertyDataType" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -legacy_plug_request_metadata_raw_data_inner_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -legacy_plug_request_metadata_raw_data_inner_faker = JSF( - legacy_plug_request_metadata_raw_data_inner_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugRequestMetadataRawDataInnerStub: - """LegacyPlugRequestMetadataRawDataInner unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_request_metadata_raw_data_inner_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugRequestMetadataRawDataInner": - """Create LegacyPlugRequestMetadataRawDataInner stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugRequestMetadataRawDataInnerAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugRequestMetadataRawDataInnerAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_request_metadata_stub.py b/test/types/legacy_plug_request_metadata_stub.py deleted file mode 100644 index 3e78792e..00000000 --- a/test/types/legacy_plug_request_metadata_stub.py +++ /dev/null @@ -1,124 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_request_metadata import ( - LegacyPlugRequestMetadata, - ) - - LegacyPlugRequestMetadataAdapter = TypeAdapter(LegacyPlugRequestMetadata) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_request_metadata_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugRequest_metadata", - "type" : "object", - "properties" : { - "requiredProperties" : { - "$ref" : "#/components/schemas/LegacyRequiredProperties" - }, - "supportedStates" : { - "title" : "supportedStates", - "type" : "array", - "items" : { - "type" : "string" - } - }, - "rawData" : { - "title" : "rawData", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_rawData_inner" - } - }, - "configuration" : { - "$ref" : "#/components/schemas/LegacyConfiguration" - }, - "author" : { - "title" : "author", - "type" : "string" - }, - "description" : { - "title" : "description", - "type" : "string" - }, - "category" : { - "title" : "category", - "type" : "string" - }, - "tags" : { - "title" : "tags", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "iconURL" : { - "title" : "iconURL", - "type" : "string" - }, - "friendlyName" : { - "title" : "friendlyName", - "type" : "string" - }, - "documentation" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_documentation" - }, - "documentationURL" : { - "title" : "documentationURL", - "type" : "string" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -legacy_plug_request_metadata_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_plug_request_metadata_faker = JSF( - legacy_plug_request_metadata_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugRequestMetadataStub: - """LegacyPlugRequestMetadata unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_request_metadata_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugRequestMetadata": - """Create LegacyPlugRequestMetadata stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugRequestMetadataAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugRequestMetadataAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_request_stub.py b/test/types/legacy_plug_request_stub.py deleted file mode 100644 index 0192b0a9..00000000 --- a/test/types/legacy_plug_request_stub.py +++ /dev/null @@ -1,84 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_request import LegacyPlugRequest - - LegacyPlugRequestAdapter = TypeAdapter(LegacyPlugRequest) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_request_model_schema = json.loads( - r"""{ - "required" : [ "metadata", "name", "script", "type", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "script" : { - "type" : "string" - }, - "dependencies" : { - "$ref" : "#/components/schemas/LegacyPlugDependencies" - }, - "metadata" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata" - }, - "type" : { - "$ref" : "#/components/schemas/PlugType" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -legacy_plug_request_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_plug_request_faker = JSF( - legacy_plug_request_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugRequestStub: - """LegacyPlugRequest unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_request_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "LegacyPlugRequest": - """Create LegacyPlugRequest stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugRequestAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugRequestAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_response_metadata_stub.py b/test/types/legacy_plug_response_metadata_stub.py deleted file mode 100644 index 59f23834..00000000 --- a/test/types/legacy_plug_response_metadata_stub.py +++ /dev/null @@ -1,99 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_response_metadata import ( - LegacyPlugResponseMetadata, - ) - - LegacyPlugResponseMetadataAdapter = TypeAdapter(LegacyPlugResponseMetadata) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_response_metadata_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugResponse_metadata", - "type" : "object", - "properties" : { - "documentation" : { - "$ref" : "#/components/schemas/LegacyDocumentation" - }, - "author" : { - "title" : "author", - "type" : "string" - }, - "description" : { - "title" : "description", - "type" : "string" - }, - "category" : { - "title" : "category", - "type" : "string" - }, - "tags" : { - "title" : "tags", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "iconURL" : { - "title" : "iconURL", - "type" : "string" - }, - "friendlyName" : { - "title" : "friendlyName", - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -legacy_plug_response_metadata_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_plug_response_metadata_faker = JSF( - legacy_plug_response_metadata_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugResponseMetadataStub: - """LegacyPlugResponseMetadata unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_response_metadata_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugResponseMetadata": - """Create LegacyPlugResponseMetadata stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugResponseMetadataAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugResponseMetadataAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_response_stub.py b/test/types/legacy_plug_response_stub.py deleted file mode 100644 index 7bd26a16..00000000 --- a/test/types/legacy_plug_response_stub.py +++ /dev/null @@ -1,125 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_response import LegacyPlugResponse - - LegacyPlugResponseAdapter = TypeAdapter(LegacyPlugResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_response_model_schema = json.loads( - r"""{ - "required" : [ "commands", "isDeprecated", "mediaType", "metadata", "name", "status", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "author" : { - "type" : "string" - }, - "category" : { - "type" : "string" - }, - "iconURL" : { - "type" : "string" - }, - "documentationURL" : { - "type" : "string" - }, - "isDeprecated" : { - "type" : "boolean" - }, - "description" : { - "type" : "string" - }, - "states" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "rawData" : { - "type" : "array", - "items" : { - "type" : "object" - } - }, - "mediaType" : { - "$ref" : "#/components/schemas/MediaType" - }, - "configuration" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LegacyConfigurationResponseObject" - } - }, - "commands" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "metadata" : { - "$ref" : "#/components/schemas/LegacyPlugResponse_metadata" - } - } -} -""", - object_hook=with_example_provider, -) -legacy_plug_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_plug_response_faker = JSF( - legacy_plug_response_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugResponseStub: - """LegacyPlugResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_response_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "LegacyPlugResponse": - """Create LegacyPlugResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_script_meta_raw_data_inner_stub.py b/test/types/legacy_plug_script_meta_raw_data_inner_stub.py deleted file mode 100644 index 3269faed..00000000 --- a/test/types/legacy_plug_script_meta_raw_data_inner_stub.py +++ /dev/null @@ -1,83 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_script_meta_raw_data_inner import ( - LegacyPlugScriptMetaRawDataInner, - ) - - LegacyPlugScriptMetaRawDataInnerAdapter = TypeAdapter( - LegacyPlugScriptMetaRawDataInner - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_script_meta_raw_data_inner_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugScriptMeta_rawData_inner", - "required" : [ "parameter" ], - "type" : "object", - "properties" : { - "parameter" : { - "title" : "parameter", - "type" : "string" - }, - "dataType" : { - "title" : "dataType", - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -legacy_plug_script_meta_raw_data_inner_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -legacy_plug_script_meta_raw_data_inner_faker = JSF( - legacy_plug_script_meta_raw_data_inner_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugScriptMetaRawDataInnerStub: - """LegacyPlugScriptMetaRawDataInner unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_script_meta_raw_data_inner_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugScriptMetaRawDataInner": - """Create LegacyPlugScriptMetaRawDataInner stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugScriptMetaRawDataInnerAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugScriptMetaRawDataInnerAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_script_meta_stub.py b/test/types/legacy_plug_script_meta_stub.py deleted file mode 100644 index 739845ac..00000000 --- a/test/types/legacy_plug_script_meta_stub.py +++ /dev/null @@ -1,114 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_script_meta import ( - LegacyPlugScriptMeta, - ) - - LegacyPlugScriptMetaAdapter = TypeAdapter(LegacyPlugScriptMeta) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_script_meta_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugScriptMeta", - "required" : [ "rawData", "supportedStates" ], - "type" : "object", - "properties" : { - "author" : { - "title" : "author", - "type" : "string" - }, - "description" : { - "title" : "description", - "type" : "string" - }, - "category" : { - "title" : "category", - "type" : "string" - }, - "tags" : { - "title" : "tags", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "iconURL" : { - "title" : "iconURL", - "type" : "string" - }, - "friendlyName" : { - "title" : "friendlyName", - "type" : "string" - }, - "supportedStates" : { - "title" : "supportedStates", - "type" : "array", - "items" : { - "type" : "string" - } - }, - "rawData" : { - "title" : "rawData", - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/LegacyPlugScriptMeta_rawData_inner" - } - }, - "requiredProperties" : { - "$ref" : "#/components/schemas/LegacyRequiredProperties" - } - } -} -""", - object_hook=with_example_provider, -) -legacy_plug_script_meta_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_plug_script_meta_faker = JSF( - legacy_plug_script_meta_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugScriptMetaStub: - """LegacyPlugScriptMeta unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_script_meta_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugScriptMeta": - """Create LegacyPlugScriptMeta stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugScriptMetaAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugScriptMetaAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_plug_script_response_stub.py b/test/types/legacy_plug_script_response_stub.py deleted file mode 100644 index 412a3d72..00000000 --- a/test/types/legacy_plug_script_response_stub.py +++ /dev/null @@ -1,91 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_plug_script_response import ( - LegacyPlugScriptResponse, - ) - - LegacyPlugScriptResponseAdapter = TypeAdapter(LegacyPlugScriptResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_plug_script_response_model_schema = json.loads( - r"""{ - "title" : "LegacyPlugScriptResponse", - "required" : [ "dependencies", "metadata", "name", "script", "type", "version" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "type" : { - "$ref" : "#/components/schemas/PlugType" - }, - "script" : { - "title" : "script", - "type" : "string" - }, - "metadata" : { - "$ref" : "#/components/schemas/LegacyPlugScriptMeta" - }, - "dependencies" : { - "title" : "dependencies", - "type" : "object" - } - } -} -""", - object_hook=with_example_provider, -) -legacy_plug_script_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_plug_script_response_faker = JSF( - legacy_plug_script_response_model_schema, allow_none_optionals=1 -) - - -class LegacyPlugScriptResponseStub: - """LegacyPlugScriptResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_plug_script_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyPlugScriptResponse": - """Create LegacyPlugScriptResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyPlugScriptResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyPlugScriptResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/legacy_required_property_object_stub.py b/test/types/legacy_required_property_object_stub.py deleted file mode 100644 index c9f83df6..00000000 --- a/test/types/legacy_required_property_object_stub.py +++ /dev/null @@ -1,82 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.legacy_required_property_object import ( - LegacyRequiredPropertyObject, - ) - - LegacyRequiredPropertyObjectAdapter = TypeAdapter(LegacyRequiredPropertyObject) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -legacy_required_property_object_model_schema = json.loads( - r"""{ - "required" : [ "mandatory", "name", "sensitive", "type" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "type" : { - "$ref" : "#/components/schemas/PlugPropertyDataType" - }, - "mandatory" : { - "type" : "boolean" - }, - "sensitive" : { - "type" : "boolean" - } - } -} -""", - object_hook=with_example_provider, -) -legacy_required_property_object_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -legacy_required_property_object_faker = JSF( - legacy_required_property_object_model_schema, allow_none_optionals=1 -) - - -class LegacyRequiredPropertyObjectStub: - """LegacyRequiredPropertyObject unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return legacy_required_property_object_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "LegacyRequiredPropertyObject": - """Create LegacyRequiredPropertyObject stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - LegacyRequiredPropertyObjectAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LegacyRequiredPropertyObjectAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/limit_query_stub.py b/test/types/limit_query_stub.py deleted file mode 100644 index fd0b36ed..00000000 --- a/test/types/limit_query_stub.py +++ /dev/null @@ -1,66 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.limit_query import LimitQuery - - LimitQueryAdapter = TypeAdapter(LimitQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -limit_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -limit_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -limit_query_faker = JSF(limit_query_model_schema, allow_none_optionals=1) - - -class LimitQueryStub: - """LimitQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return limit_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "LimitQuery": - """Create LimitQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(LimitQueryAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return LimitQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/media_type_stub.py b/test/types/media_type_stub.py deleted file mode 100644 index b1646461..00000000 --- a/test/types/media_type_stub.py +++ /dev/null @@ -1,58 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.media_type import MediaType - - MediaTypeAdapter = TypeAdapter(MediaType) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -media_type_model_schema = json.loads( - r"""{ - "title" : "MediaType", - "type" : "string", - "enum" : [ "application/javascript", "application/java-vm", "text/x-python", "text/x-golang" ] -} -""", - object_hook=with_example_provider, -) -media_type_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -media_type_faker = JSF(media_type_model_schema, allow_none_optionals=1) - - -class MediaTypeStub: - """MediaType unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return media_type_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "MediaType": - """Create MediaType stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(MediaTypeAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return MediaTypeAdapter.validate_python(json, context={"skip_validation": True}) diff --git a/test/types/message_and_status_response_stub.py b/test/types/message_and_status_response_stub.py deleted file mode 100644 index d18091a3..00000000 --- a/test/types/message_and_status_response_stub.py +++ /dev/null @@ -1,75 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.message_and_status_response import ( - MessageAndStatusResponse, - ) - - MessageAndStatusResponseAdapter = TypeAdapter(MessageAndStatusResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -message_and_status_response_model_schema = json.loads( - r"""{ - "required" : [ "message", "statusCode" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "statusCode" : { - "type" : "number" - } - } -} -""", - object_hook=with_example_provider, -) -message_and_status_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -message_and_status_response_faker = JSF( - message_and_status_response_model_schema, allow_none_optionals=1 -) - - -class MessageAndStatusResponseStub: - """MessageAndStatusResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return message_and_status_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "MessageAndStatusResponse": - """Create MessageAndStatusResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - MessageAndStatusResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return MessageAndStatusResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/multipart_file_upload_stub.py b/test/types/multipart_file_upload_stub.py deleted file mode 100644 index 8e7f9062..00000000 --- a/test/types/multipart_file_upload_stub.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.multipart_file_upload import ( - MultipartFileUpload, - ) - - MultipartFileUploadAdapter = TypeAdapter(MultipartFileUpload) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -multipart_file_upload__model_schema = json.loads( - r"""{ - "title" : "Multipart file upload.", - "type" : "object", - "properties" : { - "filename" : { - "type" : "array", - "items" : { - "type" : "string", - "format" : "binary" - } - } - }, - "description" : "A multi-part upload containing one or more file assets.", - "nullable" : true -} -""", - object_hook=with_example_provider, -) -multipart_file_upload__model_schema.update({"definitions": MODEL_DEFINITIONS}) - -multipart_file_upload__faker = JSF( - multipart_file_upload__model_schema, allow_none_optionals=1 -) - - -class MultipartFileUploadStub: - """MultipartFileUpload unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return multipart_file_upload__faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "MultipartFileUpload": - """Create MultipartFileUpload stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - MultipartFileUploadAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return MultipartFileUploadAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/name_and_version_stub.py b/test/types/name_and_version_stub.py deleted file mode 100644 index 009a1727..00000000 --- a/test/types/name_and_version_stub.py +++ /dev/null @@ -1,70 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.name_and_version import NameAndVersion - - NameAndVersionAdapter = TypeAdapter(NameAndVersion) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -name_and_version_model_schema = json.loads( - r"""{ - "required" : [ "name", "version" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - } - } -} -""", - object_hook=with_example_provider, -) -name_and_version_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -name_and_version_faker = JSF(name_and_version_model_schema, allow_none_optionals=1) - - -class NameAndVersionStub: - """NameAndVersion unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return name_and_version_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "NameAndVersion": - """Create NameAndVersion stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - NameAndVersionAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NameAndVersionAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/name_stub.py b/test/types/name_stub.py deleted file mode 100644 index dcee17b4..00000000 --- a/test/types/name_stub.py +++ /dev/null @@ -1,63 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.name import Name - - NameAdapter = TypeAdapter(Name) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -name_model_schema = json.loads( - r"""{ - "required" : [ "name" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "The name of the function." - } - } -} -""", - object_hook=with_example_provider, -) -name_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -name_faker = JSF(name_model_schema, allow_none_optionals=1) - - -class NameStub: - """Name unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return name_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "Name": - """Create Name stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(NameAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NameAdapter.validate_python(json, context={"skip_validation": True}) diff --git a/test/types/named_function_versions_query_stub.py b/test/types/named_function_versions_query_stub.py deleted file mode 100644 index 29011cd6..00000000 --- a/test/types/named_function_versions_query_stub.py +++ /dev/null @@ -1,138 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.named_function_versions_query import ( - NamedFunctionVersionsQuery, - ) - - NamedFunctionVersionsQueryAdapter = TypeAdapter(NamedFunctionVersionsQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -named_function_versions_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Named function versions listing query." -} -""", - object_hook=with_example_provider, -) -named_function_versions_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -named_function_versions_query_faker = JSF( - named_function_versions_query_model_schema, allow_none_optionals=1 -) - - -class NamedFunctionVersionsQueryStub: - """NamedFunctionVersionsQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return named_function_versions_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "NamedFunctionVersionsQuery": - """Create NamedFunctionVersionsQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - NamedFunctionVersionsQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NamedFunctionVersionsQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/named_kf_serving_versions_query_v2_stub.py b/test/types/named_kf_serving_versions_query_v2_stub.py deleted file mode 100644 index c8ea08af..00000000 --- a/test/types/named_kf_serving_versions_query_v2_stub.py +++ /dev/null @@ -1,141 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.named_kf_serving_versions_query_v2 import ( - NamedKFServingVersionsQueryV2, - ) - - NamedKFServingVersionsQueryV2Adapter = TypeAdapter(NamedKFServingVersionsQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -named_kf_serving_versions_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Named Model versions query." -} -""", - object_hook=with_example_provider, -) -named_kf_serving_versions_query_v2_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -named_kf_serving_versions_query_v2_faker = JSF( - named_kf_serving_versions_query_v2_model_schema, allow_none_optionals=1 -) - - -class NamedKFServingVersionsQueryV2Stub: - """NamedKFServingVersionsQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return named_kf_serving_versions_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "NamedKFServingVersionsQueryV2": - """Create NamedKFServingVersionsQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - NamedKFServingVersionsQueryV2Adapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NamedKFServingVersionsQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/named_parameters_typeof_as_job_reference_job_status_stub.py b/test/types/named_parameters_typeof_as_job_reference_job_status_stub.py deleted file mode 100644 index 9a34a281..00000000 --- a/test/types/named_parameters_typeof_as_job_reference_job_status_stub.py +++ /dev/null @@ -1,119 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.named_parameters_typeof_as_job_reference_job_status import ( - NamedParametersTypeofAsJobReferenceJobStatus, - ) - - NamedParametersTypeofAsJobReferenceJobStatusAdapter = TypeAdapter( - NamedParametersTypeofAsJobReferenceJobStatus - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -named_parameters_typeof_as_job_reference__job_status_model_schema = json.loads( - r"""{ - "title" : "NamedParameters_typeof_asJobReference__jobStatus", - "required" : [ "createdAt", "createdBy", "operation", "state", "type" ], - "type" : "object", - "properties" : { - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "type" : { - "title" : "type", - "description" : "The type of the background task." - }, - "state" : { - "$ref" : "#/components/schemas/JobStateResult" - }, - "request" : { - "title" : "request", - "description" : "The request that initiated this job." - }, - "result" : { - "title" : "result", - "description" : "The result of the job if completed." - }, - "createdAt" : { - "title" : "createdAt", - "type" : "string", - "description" : "The timestamp of creation of this job", - "format" : "date-time" - }, - "createdBy" : { - "title" : "createdBy", - "type" : "string", - "description" : "The user that created this job" - }, - "operation" : { - "title" : "operation", - "type" : "string", - "description" : "Request operation" - }, - "function" : { - "$ref" : "#/components/schemas/FunctionRef" - }, - "job" : { - "$ref" : "#/components/schemas/JobStatus" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - } - } -} -""", - object_hook=with_example_provider, -) -named_parameters_typeof_as_job_reference__job_status_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -named_parameters_typeof_as_job_reference__job_status_faker = JSF( - named_parameters_typeof_as_job_reference__job_status_model_schema, - allow_none_optionals=1, -) - - -class NamedParametersTypeofAsJobReferenceJobStatusStub: - """NamedParametersTypeofAsJobReferenceJobStatus unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return named_parameters_typeof_as_job_reference__job_status_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "NamedParametersTypeofAsJobReferenceJobStatus": - """Create NamedParametersTypeofAsJobReferenceJobStatus stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - NamedParametersTypeofAsJobReferenceJobStatusAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NamedParametersTypeofAsJobReferenceJobStatusAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/named_parameters_typeof_as_job_reference_stub.py b/test/types/named_parameters_typeof_as_job_reference_stub.py deleted file mode 100644 index ac4be911..00000000 --- a/test/types/named_parameters_typeof_as_job_reference_stub.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.named_parameters_typeof_as_job_reference import ( - NamedParametersTypeofAsJobReference, - ) - - NamedParametersTypeofAsJobReferenceAdapter = TypeAdapter( - NamedParametersTypeofAsJobReference - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -named_parameters_typeof_as_job_reference__model_schema = json.loads( - r"""{ - "required" : [ "jobStatus" ], - "type" : "object", - "properties" : { - "jobStatus" : { - "$ref" : "#/components/schemas/NamedParameters_typeof_asJobReference__jobStatus" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -named_parameters_typeof_as_job_reference__model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -named_parameters_typeof_as_job_reference__faker = JSF( - named_parameters_typeof_as_job_reference__model_schema, allow_none_optionals=1 -) - - -class NamedParametersTypeofAsJobReferenceStub: - """NamedParametersTypeofAsJobReference unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return named_parameters_typeof_as_job_reference__faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "NamedParametersTypeofAsJobReference": - """Create NamedParametersTypeofAsJobReference stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - NamedParametersTypeofAsJobReferenceAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NamedParametersTypeofAsJobReferenceAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/named_parameters_typeof_from_legacy_documentation_stub.py b/test/types/named_parameters_typeof_from_legacy_documentation_stub.py deleted file mode 100644 index 1328e8d3..00000000 --- a/test/types/named_parameters_typeof_from_legacy_documentation_stub.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.named_parameters_typeof_from_legacy_documentation import ( - NamedParametersTypeofFromLegacyDocumentation, - ) - - NamedParametersTypeofFromLegacyDocumentationAdapter = TypeAdapter( - NamedParametersTypeofFromLegacyDocumentation - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -named_parameters_typeof_from_legacy_documentation__model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "legacyDocumentation" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_documentation" - }, - "currentInterface" : { - "$ref" : "#/components/schemas/PlugInterface" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -named_parameters_typeof_from_legacy_documentation__model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -named_parameters_typeof_from_legacy_documentation__faker = JSF( - named_parameters_typeof_from_legacy_documentation__model_schema, - allow_none_optionals=1, -) - - -class NamedParametersTypeofFromLegacyDocumentationStub: - """NamedParametersTypeofFromLegacyDocumentation unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return named_parameters_typeof_from_legacy_documentation__faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "NamedParametersTypeofFromLegacyDocumentation": - """Create NamedParametersTypeofFromLegacyDocumentation stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - NamedParametersTypeofFromLegacyDocumentationAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NamedParametersTypeofFromLegacyDocumentationAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/named_parameters_typeof_from_legacy_stub.py b/test/types/named_parameters_typeof_from_legacy_stub.py deleted file mode 100644 index a83bac90..00000000 --- a/test/types/named_parameters_typeof_from_legacy_stub.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.named_parameters_typeof_from_legacy import ( - NamedParametersTypeofFromLegacy, - ) - - NamedParametersTypeofFromLegacyAdapter = TypeAdapter( - NamedParametersTypeofFromLegacy - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -named_parameters_typeof_from_legacy__model_schema = json.loads( - r"""{ - "required" : [ "metadata" ], - "type" : "object", - "properties" : { - "metadata" : { - "$ref" : "#/components/schemas/LegacyPlugMetaRequest" - }, - "currentInterface" : { - "$ref" : "#/components/schemas/PlugInterface" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -named_parameters_typeof_from_legacy__model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -named_parameters_typeof_from_legacy__faker = JSF( - named_parameters_typeof_from_legacy__model_schema, allow_none_optionals=1 -) - - -class NamedParametersTypeofFromLegacyStub: - """NamedParametersTypeofFromLegacy unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return named_parameters_typeof_from_legacy__faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "NamedParametersTypeofFromLegacy": - """Create NamedParametersTypeofFromLegacy stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - NamedParametersTypeofFromLegacyAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NamedParametersTypeofFromLegacyAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/named_parameters_typeof_is_not_legacy_stub.py b/test/types/named_parameters_typeof_is_not_legacy_stub.py deleted file mode 100644 index d7b98364..00000000 --- a/test/types/named_parameters_typeof_is_not_legacy_stub.py +++ /dev/null @@ -1,77 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.named_parameters_typeof_is_not_legacy import ( - NamedParametersTypeofIsNotLegacy, - ) - - NamedParametersTypeofIsNotLegacyAdapter = TypeAdapter( - NamedParametersTypeofIsNotLegacy - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -named_parameters_typeof_is_not_legacy__model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "documentation" : { - "$ref" : "#/components/schemas/LegacyPlugRequest_metadata_documentation" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -named_parameters_typeof_is_not_legacy__model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -named_parameters_typeof_is_not_legacy__faker = JSF( - named_parameters_typeof_is_not_legacy__model_schema, allow_none_optionals=1 -) - - -class NamedParametersTypeofIsNotLegacyStub: - """NamedParametersTypeofIsNotLegacy unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return named_parameters_typeof_is_not_legacy__faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "NamedParametersTypeofIsNotLegacy": - """Create NamedParametersTypeofIsNotLegacy stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - NamedParametersTypeofIsNotLegacyAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NamedParametersTypeofIsNotLegacyAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/named_plug_versions_query_v2_stub.py b/test/types/named_plug_versions_query_v2_stub.py deleted file mode 100644 index 77ecb131..00000000 --- a/test/types/named_plug_versions_query_v2_stub.py +++ /dev/null @@ -1,141 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.named_plug_versions_query_v2 import ( - NamedPlugVersionsQueryV2, - ) - - NamedPlugVersionsQueryV2Adapter = TypeAdapter(NamedPlugVersionsQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -named_plug_versions_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "tags" : { - "$ref" : "#/components/schemas/TagsFilter" - }, - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Named plug version listing query" -} -""", - object_hook=with_example_provider, -) -named_plug_versions_query_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -named_plug_versions_query_v2_faker = JSF( - named_plug_versions_query_v2_model_schema, allow_none_optionals=1 -) - - -class NamedPlugVersionsQueryV2Stub: - """NamedPlugVersionsQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return named_plug_versions_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "NamedPlugVersionsQueryV2": - """Create NamedPlugVersionsQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - NamedPlugVersionsQueryV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NamedPlugVersionsQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/named_versions_filter_stub.py b/test/types/named_versions_filter_stub.py deleted file mode 100644 index 002db09d..00000000 --- a/test/types/named_versions_filter_stub.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.named_versions_filter import ( - NamedVersionsFilter, - ) - - NamedVersionsFilterAdapter = TypeAdapter(NamedVersionsFilter) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -named_versions_filter_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "nameVersion" : { - "type" : "array", - "description" : "Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - "items" : { - "$ref" : "#/components/schemas/NamedVersion" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -named_versions_filter_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -named_versions_filter_faker = JSF( - named_versions_filter_model_schema, allow_none_optionals=1 -) - - -class NamedVersionsFilterStub: - """NamedVersionsFilter unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return named_versions_filter_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "NamedVersionsFilter": - """Create NamedVersionsFilter stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - NamedVersionsFilterAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NamedVersionsFilterAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/named_webscript_versions_query_v2_stub.py b/test/types/named_webscript_versions_query_v2_stub.py deleted file mode 100644 index b88f635a..00000000 --- a/test/types/named_webscript_versions_query_v2_stub.py +++ /dev/null @@ -1,141 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.named_webscript_versions_query_v2 import ( - NamedWebscriptVersionsQueryV2, - ) - - NamedWebscriptVersionsQueryV2Adapter = TypeAdapter(NamedWebscriptVersionsQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -named_webscript_versions_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Webscript named versions listing query." -} -""", - object_hook=with_example_provider, -) -named_webscript_versions_query_v2_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -named_webscript_versions_query_v2_faker = JSF( - named_webscript_versions_query_v2_model_schema, allow_none_optionals=1 -) - - -class NamedWebscriptVersionsQueryV2Stub: - """NamedWebscriptVersionsQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return named_webscript_versions_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "NamedWebscriptVersionsQueryV2": - """Create NamedWebscriptVersionsQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - NamedWebscriptVersionsQueryV2Adapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return NamedWebscriptVersionsQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/schema_params_stub.py b/test/types/notify_result_stub.py similarity index 57% rename from test/types/schema_params_stub.py rename to test/types/notify_result_stub.py index 10c0726f..a4fd66dd 100644 --- a/test/types/schema_params_stub.py +++ b/test/types/notify_result_stub.py @@ -16,55 +16,53 @@ from ..openapi import MODEL_DEFINITIONS, with_example_provider try: - from waylay.services.registry.models.schema_params import SchemaParams + from waylay.services.registry.models.notify_result import NotifyResult - SchemaParamsAdapter = TypeAdapter(SchemaParams) + NotifyResultAdapter = TypeAdapter(NotifyResult) MODELS_AVAILABLE = True except ImportError as exc: MODELS_AVAILABLE = False -schema_params_model_schema = json.loads( +notify_result_model_schema = json.loads( r"""{ - "required" : [ "functionType", "role" ], + "title" : "NotifyResult", + "required" : [ "operation" ], "type" : "object", "properties" : { - "functionType" : { - "$ref" : "#/components/schemas/FunctionType" - }, - "role" : { - "$ref" : "#/components/schemas/AssetRole" + "operation" : { + "$ref" : "#/components/schemas/RequestOperation" } }, - "additionalProperties" : false + "description" : "The result data for a change notification." } """, object_hook=with_example_provider, ) -schema_params_model_schema.update({"definitions": MODEL_DEFINITIONS}) +notify_result_model_schema.update({"definitions": MODEL_DEFINITIONS}) -schema_params_faker = JSF(schema_params_model_schema, allow_none_optionals=1) +notify_result_faker = JSF(notify_result_model_schema, allow_none_optionals=1) -class SchemaParamsStub: - """SchemaParams unit test stubs.""" +class NotifyResultStub: + """NotifyResult unit test stubs.""" @classmethod def create_json(cls): """Create a dict stub instance.""" - return schema_params_faker.generate(use_defaults=True, use_examples=True) + return notify_result_faker.generate(use_defaults=True, use_examples=True) @classmethod - def create_instance(cls) -> "SchemaParams": - """Create SchemaParams stub instance.""" + def create_instance(cls) -> "NotifyResult": + """Create NotifyResult stub instance.""" if not MODELS_AVAILABLE: raise ImportError("Models must be installed to create class stubs") json = cls.create_json() if not json: # use backup example based on the pydantic model schema backup_faker = JSF( - SchemaParamsAdapter.json_schema(), allow_none_optionals=1 + NotifyResultAdapter.json_schema(), allow_none_optionals=1 ) json = backup_faker.generate(use_defaults=True, use_examples=True) - return SchemaParamsAdapter.validate_python( + return NotifyResultAdapter.validate_python( json, context={"skip_validation": True} ) diff --git a/test/types/openfaas_deploy_args_stub.py b/test/types/openfaas_deploy_args_stub.py deleted file mode 100644 index 0e82e774..00000000 --- a/test/types/openfaas_deploy_args_stub.py +++ /dev/null @@ -1,77 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.openfaas_deploy_args import OpenfaasDeployArgs - - OpenfaasDeployArgsAdapter = TypeAdapter(OpenfaasDeployArgs) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -openfaas_deploy_args_model_schema = json.loads( - r"""{ - "required" : [ "endpoint", "imageName", "namespace" ], - "type" : "object", - "properties" : { - "namespace" : { - "type" : "string", - "description" : "The (openfaas) namespace for the target function." - }, - "endpoint" : { - "type" : "string", - "description" : "The (openfaas) endpoint service name" - }, - "imageName" : { - "type" : "string", - "description" : "The image name to use for deploying this function" - } - } -} -""", - object_hook=with_example_provider, -) -openfaas_deploy_args_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -openfaas_deploy_args_faker = JSF( - openfaas_deploy_args_model_schema, allow_none_optionals=1 -) - - -class OpenfaasDeployArgsStub: - """OpenfaasDeployArgs unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return openfaas_deploy_args_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "OpenfaasDeployArgs": - """Create OpenfaasDeployArgs stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - OpenfaasDeployArgsAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return OpenfaasDeployArgsAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/openfaas_function_ref_stub.py b/test/types/openfaas_function_ref_stub.py deleted file mode 100644 index d94232b8..00000000 --- a/test/types/openfaas_function_ref_stub.py +++ /dev/null @@ -1,77 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.openfaas_function_ref import ( - OpenfaasFunctionRef, - ) - - OpenfaasFunctionRefAdapter = TypeAdapter(OpenfaasFunctionRef) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -openfaas_function_ref_model_schema = json.loads( - r"""{ - "required" : [ "endpoint", "namespace" ], - "type" : "object", - "properties" : { - "namespace" : { - "type" : "string", - "description" : "The (openfaas) namespace for the target function." - }, - "endpoint" : { - "type" : "string", - "description" : "The (openfaas) endpoint service name" - } - } -} -""", - object_hook=with_example_provider, -) -openfaas_function_ref_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -openfaas_function_ref_faker = JSF( - openfaas_function_ref_model_schema, allow_none_optionals=1 -) - - -class OpenfaasFunctionRefStub: - """OpenfaasFunctionRef unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return openfaas_function_ref_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "OpenfaasFunctionRef": - """Create OpenfaasFunctionRef stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - OpenfaasFunctionRefAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return OpenfaasFunctionRefAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/operation_status_error_stub.py b/test/types/operation_status_error_stub.py deleted file mode 100644 index 0380e11b..00000000 --- a/test/types/operation_status_error_stub.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.operation_status_error import ( - OperationStatusError, - ) - - OperationStatusErrorAdapter = TypeAdapter(OperationStatusError) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -operation_status_error_model_schema = json.loads( - r"""{ - "title" : "OperationStatus_error", - "required" : [ "code", "message", "name" ], - "type" : "object", - "properties" : { - "name" : { - "title" : "name", - "type" : "string" - }, - "message" : { - "title" : "message", - "type" : "string" - }, - "stack" : { - "title" : "stack", - "type" : "string" - }, - "code" : { - "title" : "code", - "type" : "string" - } - } -} -""", - object_hook=with_example_provider, -) -operation_status_error_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -operation_status_error_faker = JSF( - operation_status_error_model_schema, allow_none_optionals=1 -) - - -class OperationStatusErrorStub: - """OperationStatusError unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return operation_status_error_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "OperationStatusError": - """Create OperationStatusError stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - OperationStatusErrorAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return OperationStatusErrorAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/operation_status_stub.py b/test/types/operation_status_stub.py deleted file mode 100644 index 0c4d284e..00000000 --- a/test/types/operation_status_stub.py +++ /dev/null @@ -1,82 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.operation_status import OperationStatus - - OperationStatusAdapter = TypeAdapter(OperationStatus) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -operation_status_model_schema = json.loads( - r"""{ - "required" : [ "description", "done", "id", "name", "type" ], - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "name" : { - "type" : "string", - "deprecated" : true - }, - "type" : { - "$ref" : "#/components/schemas/JobType" - }, - "done" : { - "type" : "boolean" - }, - "error" : { - "$ref" : "#/components/schemas/OperationStatus_error" - } - } -} -""", - object_hook=with_example_provider, -) -operation_status_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -operation_status_faker = JSF(operation_status_model_schema, allow_none_optionals=1) - - -class OperationStatusStub: - """OperationStatus unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return operation_status_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "OperationStatus": - """Create OperationStatus stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - OperationStatusAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return OperationStatusAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/operation_stub.py b/test/types/operation_stub.py deleted file mode 100644 index f137afd9..00000000 --- a/test/types/operation_stub.py +++ /dev/null @@ -1,72 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.operation import Operation - - OperationAdapter = TypeAdapter(Operation) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -operation_model_schema = json.loads( - r"""{ - "required" : [ "description", "id", "name", "type" ], - "type" : "object", - "properties" : { - "id" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "name" : { - "type" : "string", - "deprecated" : true - }, - "type" : { - "$ref" : "#/components/schemas/JobType" - } - } -} -""", - object_hook=with_example_provider, -) -operation_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -operation_faker = JSF(operation_model_schema, allow_none_optionals=1) - - -class OperationStub: - """Operation unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return operation_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "Operation": - """Create Operation stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(OperationAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return OperationAdapter.validate_python(json, context={"skip_validation": True}) diff --git a/test/types/paging_query_stub.py b/test/types/paging_query_stub.py deleted file mode 100644 index ab171bcf..00000000 --- a/test/types/paging_query_stub.py +++ /dev/null @@ -1,71 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.paging_query import PagingQuery - - PagingQueryAdapter = TypeAdapter(PagingQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -paging_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -paging_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -paging_query_faker = JSF(paging_query_model_schema, allow_none_optionals=1) - - -class PagingQueryStub: - """PagingQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return paging_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "PagingQuery": - """Create PagingQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(PagingQueryAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return PagingQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/paging_response_stub.py b/test/types/paging_response_stub.py deleted file mode 100644 index 449d0ac5..00000000 --- a/test/types/paging_response_stub.py +++ /dev/null @@ -1,74 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.paging_response import PagingResponse - - PagingResponseAdapter = TypeAdapter(PagingResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -paging_response_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." - } - } -} -""", - object_hook=with_example_provider, -) -paging_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -paging_response_faker = JSF(paging_response_model_schema, allow_none_optionals=1) - - -class PagingResponseStub: - """PagingResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return paging_response_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "PagingResponse": - """Create PagingResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - PagingResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return PagingResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/patch_interface_query_stub.py b/test/types/patch_interface_query_stub.py deleted file mode 100644 index 25e3ccdc..00000000 --- a/test/types/patch_interface_query_stub.py +++ /dev/null @@ -1,73 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.patch_interface_query import ( - PatchInterfaceQuery, - ) - - PatchInterfaceQueryAdapter = TypeAdapter(PatchInterfaceQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -patch_interface_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -patch_interface_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -patch_interface_query_faker = JSF( - patch_interface_query_model_schema, allow_none_optionals=1 -) - - -class PatchInterfaceQueryStub: - """PatchInterfaceQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return patch_interface_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "PatchInterfaceQuery": - """Create PatchInterfaceQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - PatchInterfaceQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return PatchInterfaceQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/patch_metadata_query_stub.py b/test/types/patch_metadata_query_stub.py deleted file mode 100644 index c4b008dd..00000000 --- a/test/types/patch_metadata_query_stub.py +++ /dev/null @@ -1,69 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.patch_metadata_query import PatchMetadataQuery - - PatchMetadataQueryAdapter = TypeAdapter(PatchMetadataQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -patch_metadata_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -patch_metadata_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -patch_metadata_query_faker = JSF( - patch_metadata_query_model_schema, allow_none_optionals=1 -) - - -class PatchMetadataQueryStub: - """PatchMetadataQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return patch_metadata_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "PatchMetadataQuery": - """Create PatchMetadataQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - PatchMetadataQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return PatchMetadataQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/patch_plug_request_v1_stub.py b/test/types/patch_plug_request_v1_stub.py deleted file mode 100644 index c88fbe8c..00000000 --- a/test/types/patch_plug_request_v1_stub.py +++ /dev/null @@ -1,71 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.patch_plug_request_v1 import PatchPlugRequestV1 - - PatchPlugRequestV1Adapter = TypeAdapter(PatchPlugRequestV1) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -patch_plug_request_v1_model_schema = json.loads( - r"""{ - "required" : [ "metadata" ], - "type" : "object", - "properties" : { - "metadata" : { - "$ref" : "#/components/schemas/UserPlugMeta" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -patch_plug_request_v1_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -patch_plug_request_v1_faker = JSF( - patch_plug_request_v1_model_schema, allow_none_optionals=1 -) - - -class PatchPlugRequestV1Stub: - """PatchPlugRequestV1 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return patch_plug_request_v1_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "PatchPlugRequestV1": - """Create PatchPlugRequestV1 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - PatchPlugRequestV1Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return PatchPlugRequestV1Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/plug_delete_force_query_stub.py b/test/types/plug_delete_force_query_stub.py deleted file mode 100644 index cabbc3d7..00000000 --- a/test/types/plug_delete_force_query_stub.py +++ /dev/null @@ -1,73 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.plug_delete_force_query import ( - PlugDeleteForceQuery, - ) - - PlugDeleteForceQueryAdapter = TypeAdapter(PlugDeleteForceQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -plug_delete_force_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "force" : { - "type" : "boolean", - "description" : "If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -plug_delete_force_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -plug_delete_force_query_faker = JSF( - plug_delete_force_query_model_schema, allow_none_optionals=1 -) - - -class PlugDeleteForceQueryStub: - """PlugDeleteForceQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return plug_delete_force_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "PlugDeleteForceQuery": - """Create PlugDeleteForceQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - PlugDeleteForceQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return PlugDeleteForceQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/plug_delete_query_stub.py b/test/types/plug_delete_query_stub.py deleted file mode 100644 index 64f4d436..00000000 --- a/test/types/plug_delete_query_stub.py +++ /dev/null @@ -1,71 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.plug_delete_query import PlugDeleteQuery - - PlugDeleteQueryAdapter = TypeAdapter(PlugDeleteQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -plug_delete_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "force" : { - "type" : "boolean", - "description" : "If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings." - }, - "undeploy" : { - "type" : "boolean", - "description" : "If `true`, the `DELETE` operation\n* undeploys the (openfaas) function for the plug: it becomes no longer available for invocation.\n* does NOT remove the plug from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the plug can be restored later with a _rebuild_ action.\n\nIf `false`, the `DELETE` operation\n* _only_ marks the plug version(s) as _deprecated_: the plug remains active but is removed from the default listings. This also applies to _draft_ versions.\n\nThis parameter is incompatible with `force=true`.\n\nIf not set the default behaviour applies:\n* _draft_ versions are _undeployed_ and _removed_ from registry.\n* non-_draft_ versions are marked _deprecated_ only." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -plug_delete_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -plug_delete_query_faker = JSF(plug_delete_query_model_schema, allow_none_optionals=1) - - -class PlugDeleteQueryStub: - """PlugDeleteQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return plug_delete_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "PlugDeleteQuery": - """Create PlugDeleteQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - PlugDeleteQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return PlugDeleteQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/plug_listing_and_query_response_stub.py b/test/types/plug_listing_and_query_response_stub.py deleted file mode 100644 index 8940f622..00000000 --- a/test/types/plug_listing_and_query_response_stub.py +++ /dev/null @@ -1,88 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.plug_listing_and_query_response import ( - PlugListingAndQueryResponse, - ) - - PlugListingAndQueryResponseAdapter = TypeAdapter(PlugListingAndQueryResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -plug_listing_and_query_response_model_schema = json.loads( - r"""{ - "required" : [ "plugs" ], - "type" : "object", - "properties" : { - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." - }, - "plugs" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PlugResponse" - } - } - }, - "description" : "Successful Response" -} -""", - object_hook=with_example_provider, -) -plug_listing_and_query_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -plug_listing_and_query_response_faker = JSF( - plug_listing_and_query_response_model_schema, allow_none_optionals=1 -) - - -class PlugListingAndQueryResponseStub: - """PlugListingAndQueryResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return plug_listing_and_query_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "PlugListingAndQueryResponse": - """Create PlugListingAndQueryResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - PlugListingAndQueryResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return PlugListingAndQueryResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/plug_listing_response_stub.py b/test/types/plug_listing_response_stub.py deleted file mode 100644 index f554bdcc..00000000 --- a/test/types/plug_listing_response_stub.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.plug_listing_response import ( - PlugListingResponse, - ) - - PlugListingResponseAdapter = TypeAdapter(PlugListingResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -plug_listing_response_model_schema = json.loads( - r"""{ - "required" : [ "plugs" ], - "type" : "object", - "properties" : { - "plugs" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/PlugResponse" - } - } - }, - "description" : "Successful Response" -} -""", - object_hook=with_example_provider, -) -plug_listing_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -plug_listing_response_faker = JSF( - plug_listing_response_model_schema, allow_none_optionals=1 -) - - -class PlugListingResponseStub: - """PlugListingResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return plug_listing_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "PlugListingResponse": - """Create PlugListingResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - PlugListingResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return PlugListingResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/plug_property_data_type_stub.py b/test/types/plug_property_data_type_stub.py index 0b8f0354..0560858c 100644 --- a/test/types/plug_property_data_type_stub.py +++ b/test/types/plug_property_data_type_stub.py @@ -27,7 +27,6 @@ plug_property_data_type_model_schema = json.loads( r"""{ - "title" : "PlugPropertyDataType", "type" : "string", "description" : "Datatype supported in plug input or output properties.", "enum" : [ "string", "integer", "long", "float", "double", "boolean", "object" ] diff --git a/test/types/plug_property_format_type_stub.py b/test/types/plug_property_format_type_stub.py index b389f472..7d11c3e9 100644 --- a/test/types/plug_property_format_type_stub.py +++ b/test/types/plug_property_format_type_stub.py @@ -27,7 +27,6 @@ plug_property_format_type_model_schema = json.loads( r"""{ - "title" : "PlugPropertyFormatType", "type" : "string", "description" : "Value domain for a plug input or output property.", "enum" : [ "enum", "resource", "vault", "duration", "code", "url", "date", "template" ] diff --git a/test/types/plug_response_stub.py b/test/types/plug_response_stub.py deleted file mode 100644 index 533028a1..00000000 --- a/test/types/plug_response_stub.py +++ /dev/null @@ -1,116 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.plug_response import PlugResponse - - PlugResponseAdapter = TypeAdapter(PlugResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -plug_response_model_schema = json.loads( - r"""{ - "required" : [ "createdAt", "createdBy", "isDeprecated", "metadata", "name", "runtime", "status", "updatedAt", "updatedBy", "version" ], - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - }, - "createdBy" : { - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "_links" : { - "type" : "array", - "description" : "Links to related entities.", - "items" : { - "$ref" : "#/components/schemas/JobHALLinks" - } - }, - "isDeprecated" : { - "type" : "boolean" - } - } -} -""", - object_hook=with_example_provider, -) -plug_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -plug_response_faker = JSF(plug_response_model_schema, allow_none_optionals=1) - - -class PlugResponseStub: - """PlugResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return plug_response_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "PlugResponse": - """Create PlugResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - PlugResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return PlugResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/plug_type_stub.py b/test/types/plug_type_stub.py index 9a3f33a4..86b3b362 100644 --- a/test/types/plug_type_stub.py +++ b/test/types/plug_type_stub.py @@ -25,7 +25,6 @@ plug_type_model_schema = json.loads( r"""{ - "title" : "PlugType", "type" : "string", "enum" : [ "sensor", "actuator", "transformer" ] } diff --git a/test/types/publish_function_query_stub.py b/test/types/publish_function_query_stub.py deleted file mode 100644 index 5006219f..00000000 --- a/test/types/publish_function_query_stub.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.publish_function_query import ( - PublishFunctionQuery, - ) - - PublishFunctionQueryAdapter = TypeAdapter(PublishFunctionQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -publish_function_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "deprecatePrevious" : { - "$ref" : "#/components/schemas/DeprecatePreviousPolicy" - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -publish_function_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -publish_function_query_faker = JSF( - publish_function_query_model_schema, allow_none_optionals=1 -) - - -class PublishFunctionQueryStub: - """PublishFunctionQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return publish_function_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "PublishFunctionQuery": - """Create PublishFunctionQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - PublishFunctionQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return PublishFunctionQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/rebuild_computed_response_stub.py b/test/types/rebuild_computed_response_stub.py deleted file mode 100644 index ef2cd4b8..00000000 --- a/test/types/rebuild_computed_response_stub.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.rebuild_computed_response import ( - RebuildComputedResponse, - ) - - RebuildComputedResponseAdapter = TypeAdapter(RebuildComputedResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -rebuild_computed_response_model_schema = json.loads( - r"""{ - "required" : [ "causes", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "causes" : { - "$ref" : "#/components/schemas/JobCauses" - } - }, - "description" : "Rebuild Ignored" -} -""", - object_hook=with_example_provider, -) -rebuild_computed_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -rebuild_computed_response_faker = JSF( - rebuild_computed_response_model_schema, allow_none_optionals=1 -) - - -class RebuildComputedResponseStub: - """RebuildComputedResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return rebuild_computed_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "RebuildComputedResponse": - """Create RebuildComputedResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RebuildComputedResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RebuildComputedResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/rebuild_query_params_stub.py b/test/types/rebuild_query_params_stub.py deleted file mode 100644 index 131de147..00000000 --- a/test/types/rebuild_query_params_stub.py +++ /dev/null @@ -1,87 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.rebuild_query_params import RebuildQueryParams - - RebuildQueryParamsAdapter = TypeAdapter(RebuildQueryParams) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -rebuild_query_params_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "upgrade" : { - "$ref" : "#/components/schemas/RebuildPolicy" - }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, checks whether rebuild jobs are needed, but do not start any jobs." - }, - "forceVersion" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "ignoreChecks" : { - "type" : "boolean", - "description" : "If set to true, checks that normally prevent a rebuild are overriden. These checks include:\n* function state in `pending`, `running`, `failed` or `undeployed`\n* backoff period due to recent failures\n* usage of deprecated dependencies\n* running jobs on entity\n* the `dryRun` option" - }, - "scaleToZero" : { - "type" : "boolean", - "description" : "Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command." - }, - "skipRebuild" : { - "type" : "boolean", - "description" : "If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -rebuild_query_params_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -rebuild_query_params_faker = JSF( - rebuild_query_params_model_schema, allow_none_optionals=1 -) - - -class RebuildQueryParamsStub: - """RebuildQueryParams unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return rebuild_query_params_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "RebuildQueryParams": - """Create RebuildQueryParams stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RebuildQueryParamsAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RebuildQueryParamsAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/rebuild_query_v2_stub.py b/test/types/rebuild_query_v2_stub.py deleted file mode 100644 index 64060483..00000000 --- a/test/types/rebuild_query_v2_stub.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.rebuild_query_v2 import RebuildQueryV2 - - RebuildQueryV2Adapter = TypeAdapter(RebuildQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -rebuild_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "dryRun" : { - "type" : "boolean", - "description" : "If set to true, checks whether rebuild jobs are needed, but do not start any jobs." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "upgrade" : { - "$ref" : "#/components/schemas/RebuildPolicy" - }, - "forceVersion" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "ignoreChecks" : { - "type" : "boolean", - "description" : "If set to true, checks that normally prevent a rebuild are overriden. These checks include:\n* function state in `pending`, `running`, `failed` or `undeployed`\n* backoff period due to recent failures\n* usage of deprecated dependencies\n* running jobs on entity\n* the `dryRun` option" - }, - "scaleToZero" : { - "type" : "boolean", - "description" : "Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command." - }, - "skipRebuild" : { - "type" : "boolean", - "description" : "If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -rebuild_query_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -rebuild_query_v2_faker = JSF(rebuild_query_v2_model_schema, allow_none_optionals=1) - - -class RebuildQueryV2Stub: - """RebuildQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return rebuild_query_v2_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "RebuildQueryV2": - """Create RebuildQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RebuildQueryV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RebuildQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/rebuild_submitted_response_stub.py b/test/types/rebuild_submitted_response_stub.py deleted file mode 100644 index 2f531531..00000000 --- a/test/types/rebuild_submitted_response_stub.py +++ /dev/null @@ -1,79 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.rebuild_submitted_response import ( - RebuildSubmittedResponse, - ) - - RebuildSubmittedResponseAdapter = TypeAdapter(RebuildSubmittedResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -rebuild_submitted_response_model_schema = json.loads( - r"""{ - "required" : [ "_links", "causes", "message" ], - "type" : "object", - "properties" : { - "message" : { - "type" : "string" - }, - "_links" : { - "$ref" : "#/components/schemas/JobHALLinks" - }, - "causes" : { - "$ref" : "#/components/schemas/JobCauses" - } - }, - "description" : "Rebuild Initiated" -} -""", - object_hook=with_example_provider, -) -rebuild_submitted_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -rebuild_submitted_response_faker = JSF( - rebuild_submitted_response_model_schema, allow_none_optionals=1 -) - - -class RebuildSubmittedResponseStub: - """RebuildSubmittedResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return rebuild_submitted_response_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "RebuildSubmittedResponse": - """Create RebuildSubmittedResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RebuildSubmittedResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RebuildSubmittedResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/error_and_status_response_stub.py b/test/types/registry_error_response_stub.py similarity index 55% rename from test/types/error_and_status_response_stub.py rename to test/types/registry_error_response_stub.py index f765fd0c..578c9e7a 100644 --- a/test/types/error_and_status_response_stub.py +++ b/test/types/registry_error_response_stub.py @@ -16,60 +16,69 @@ from ..openapi import MODEL_DEFINITIONS, with_example_provider try: - from waylay.services.registry.models.error_and_status_response import ( - ErrorAndStatusResponse, + from waylay.services.registry.models.registry_error_response import ( + RegistryErrorResponse, ) - ErrorAndStatusResponseAdapter = TypeAdapter(ErrorAndStatusResponse) + RegistryErrorResponseAdapter = TypeAdapter(RegistryErrorResponse) MODELS_AVAILABLE = True except ImportError as exc: MODELS_AVAILABLE = False -error_and_status_response_model_schema = json.loads( +registry_error_response_model_schema = json.loads( r"""{ - "required" : [ "error", "statusCode" ], + "required" : [ "code", "error", "statusCode" ], "type" : "object", "properties" : { "error" : { "type" : "string" }, + "code" : { + "type" : "string" + }, "statusCode" : { "type" : "number" + }, + "data" : { + "type" : "object", + "additionalProperties" : { + "type" : "string" + } } } } """, object_hook=with_example_provider, ) -error_and_status_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) +registry_error_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) -error_and_status_response_faker = JSF( - error_and_status_response_model_schema, allow_none_optionals=1 +registry_error_response_faker = JSF( + registry_error_response_model_schema, allow_none_optionals=1 ) -class ErrorAndStatusResponseStub: - """ErrorAndStatusResponse unit test stubs.""" +class RegistryErrorResponseStub: + """RegistryErrorResponse unit test stubs.""" @classmethod def create_json(cls): """Create a dict stub instance.""" - return error_and_status_response_faker.generate( + return registry_error_response_faker.generate( use_defaults=True, use_examples=True ) @classmethod - def create_instance(cls) -> "ErrorAndStatusResponse": - """Create ErrorAndStatusResponse stub instance.""" + def create_instance(cls) -> "RegistryErrorResponse": + """Create RegistryErrorResponse stub instance.""" if not MODELS_AVAILABLE: raise ImportError("Models must be installed to create class stubs") json = cls.create_json() if not json: # use backup example based on the pydantic model schema backup_faker = JSF( - ErrorAndStatusResponseAdapter.json_schema(), allow_none_optionals=1 + RegistryErrorResponseAdapter.json_schema(), allow_none_optionals=1 ) json = backup_faker.generate(use_defaults=True, use_examples=True) - return ErrorAndStatusResponseAdapter.validate_python( + return RegistryErrorResponseAdapter.validate_python( json, context={"skip_validation": True} ) diff --git a/test/types/remove_function_query_v2_stub.py b/test/types/remove_function_query_v2_stub.py deleted file mode 100644 index 72fca493..00000000 --- a/test/types/remove_function_query_v2_stub.py +++ /dev/null @@ -1,86 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.remove_function_query_v2 import ( - RemoveFunctionQueryV2, - ) - - RemoveFunctionQueryV2Adapter = TypeAdapter(RemoveFunctionQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -remove_function_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "force" : { - "type" : "boolean", - "description" : "If true, the function version will be immediately undeployed and removed.\n\nOtherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_." - }, - "undeploy" : { - "type" : "boolean", - "description" : "If `true`, the `DELETE` operation\n* undeploys the (openfaas) function: it becomes no longer available for invocation.\n* does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action.\n\nIf `false`, the `DELETE` operation\n* _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions.\n\nThis parameter is incompatible with `force=true`.\n\nIf not set the default behaviour applies:\n* _draft_ versions are _undeployed_ and _removed_ from registry.\n* non-_draft_ versions are marked _deprecated_ only." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -remove_function_query_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -remove_function_query_v2_faker = JSF( - remove_function_query_v2_model_schema, allow_none_optionals=1 -) - - -class RemoveFunctionQueryV2Stub: - """RemoveFunctionQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return remove_function_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "RemoveFunctionQueryV2": - """Create RemoveFunctionQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RemoveFunctionQueryV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RemoveFunctionQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/remove_plug_query_v2_stub.py b/test/types/remove_plug_query_v2_stub.py deleted file mode 100644 index 61750b2b..00000000 --- a/test/types/remove_plug_query_v2_stub.py +++ /dev/null @@ -1,82 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.remove_plug_query_v2 import RemovePlugQueryV2 - - RemovePlugQueryV2Adapter = TypeAdapter(RemovePlugQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -remove_plug_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "force" : { - "type" : "boolean", - "description" : "If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings." - }, - "undeploy" : { - "type" : "boolean", - "description" : "If `true`, the `DELETE` operation\n* undeploys the (openfaas) function for the plug: it becomes no longer available for invocation.\n* does NOT remove the plug from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the plug can be restored later with a _rebuild_ action.\n\nIf `false`, the `DELETE` operation\n* _only_ marks the plug version(s) as _deprecated_: the plug remains active but is removed from the default listings. This also applies to _draft_ versions.\n\nThis parameter is incompatible with `force=true`.\n\nIf not set the default behaviour applies:\n* _draft_ versions are _undeployed_ and _removed_ from registry.\n* non-_draft_ versions are marked _deprecated_ only." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -remove_plug_query_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -remove_plug_query_v2_faker = JSF( - remove_plug_query_v2_model_schema, allow_none_optionals=1 -) - - -class RemovePlugQueryV2Stub: - """RemovePlugQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return remove_plug_query_v2_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "RemovePlugQueryV2": - """Create RemovePlugQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RemovePlugQueryV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RemovePlugQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_info_stub.py b/test/types/runtime_info_stub.py deleted file mode 100644 index 15b7d0aa..00000000 --- a/test/types/runtime_info_stub.py +++ /dev/null @@ -1,71 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_info import RuntimeInfo - - RuntimeInfoAdapter = TypeAdapter(RuntimeInfo) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_info_model_schema = json.loads( - r"""{ - "required" : [ "archiveFormat", "functionType", "name" ], - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "functionType" : { - "$ref" : "#/components/schemas/FunctionType" - }, - "archiveFormat" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "description" : "Runtime attributes that are the same for all versions of a runtime." -} -""", - object_hook=with_example_provider, -) -runtime_info_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_info_faker = JSF(runtime_info_model_schema, allow_none_optionals=1) - - -class RuntimeInfoStub: - """RuntimeInfo unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_info_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "RuntimeInfo": - """Create RuntimeInfo stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(RuntimeInfoAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeInfoAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_name_query_stub.py b/test/types/runtime_name_query_stub.py deleted file mode 100644 index 7ca95bb8..00000000 --- a/test/types/runtime_name_query_stub.py +++ /dev/null @@ -1,84 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_name_query import RuntimeNameQuery - - RuntimeNameQueryAdapter = TypeAdapter(RuntimeNameQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_name_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "If set, filters on the name of a runtime. Supports * and ? wildcards and is case-insensitive.", - "example" : "node*" - }, - "functionType" : { - "type" : "array", - "description" : "If set, filters on the functionType of a runtime. Uses an exact match.", - "example" : "plugs", - "items" : { - "$ref" : "#/components/schemas/FunctionType" - } - }, - "archiveFormat" : { - "type" : "array", - "description" : "If set, filters on the archiveFormat of a runtime. Uses an exact match.", - "example" : "node", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -runtime_name_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_name_query_faker = JSF(runtime_name_query_model_schema, allow_none_optionals=1) - - -class RuntimeNameQueryStub: - """RuntimeNameQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_name_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "RuntimeNameQuery": - """Create RuntimeNameQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeNameQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeNameQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_params_stub.py b/test/types/runtime_params_stub.py deleted file mode 100644 index f74a4dab..00000000 --- a/test/types/runtime_params_stub.py +++ /dev/null @@ -1,67 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_params import RuntimeParams - - RuntimeParamsAdapter = TypeAdapter(RuntimeParams) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_params_model_schema = json.loads( - r"""{ - "required" : [ "name" ], - "type" : "object", - "properties" : { - "name" : { - "$ref" : "#/components/schemas/Runtime" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -runtime_params_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_params_faker = JSF(runtime_params_model_schema, allow_none_optionals=1) - - -class RuntimeParamsStub: - """RuntimeParams unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_params_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "RuntimeParams": - """Create RuntimeParams stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeParamsAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeParamsAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_query_stub.py b/test/types/runtime_query_stub.py deleted file mode 100644 index 36b8f90b..00000000 --- a/test/types/runtime_query_stub.py +++ /dev/null @@ -1,95 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_query import RuntimeQuery - - RuntimeQueryAdapter = TypeAdapter(RuntimeQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "latest" : { - "$ref" : "#/components/schemas/LatestVersionLevel" - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : false - }, - "name" : { - "type" : "string", - "description" : "If set, filters on the name of a runtime. Supports * and ? wildcards and is case-insensitive.", - "example" : "node*" - }, - "functionType" : { - "type" : "array", - "description" : "If set, filters on the functionType of a runtime. Uses an exact match.", - "example" : "plugs", - "items" : { - "$ref" : "#/components/schemas/FunctionType" - } - }, - "archiveFormat" : { - "type" : "array", - "description" : "If set, filters on the archiveFormat of a runtime. Uses an exact match.", - "example" : "node", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -runtime_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_query_faker = JSF(runtime_query_model_schema, allow_none_optionals=1) - - -class RuntimeQueryStub: - """RuntimeQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "RuntimeQuery": - """Create RuntimeQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_reference_stub.py b/test/types/runtime_reference_stub.py deleted file mode 100644 index 36d6b681..00000000 --- a/test/types/runtime_reference_stub.py +++ /dev/null @@ -1,70 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_reference import RuntimeReference - - RuntimeReferenceAdapter = TypeAdapter(RuntimeReference) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_reference_model_schema = json.loads( - r"""{ - "required" : [ "name", "version" ], - "type" : "object", - "properties" : { - "name" : { - "$ref" : "#/components/schemas/Runtime" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - } - }, - "description" : "Reference to a runtime version." -} -""", - object_hook=with_example_provider, -) -runtime_reference_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_reference_faker = JSF(runtime_reference_model_schema, allow_none_optionals=1) - - -class RuntimeReferenceStub: - """RuntimeReference unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_reference_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "RuntimeReference": - """Create RuntimeReference stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeReferenceAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeReferenceAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_specification_stub.py b/test/types/runtime_specification_stub.py deleted file mode 100644 index a6126b9f..00000000 --- a/test/types/runtime_specification_stub.py +++ /dev/null @@ -1,92 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_specification import ( - RuntimeSpecification, - ) - - RuntimeSpecificationAdapter = TypeAdapter(RuntimeSpecification) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_specification_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "build" : { - "$ref" : "#/components/schemas/BuildSpec" - }, - "deploy" : { - "$ref" : "#/components/schemas/DeploySpec" - }, - "language" : { - "$ref" : "#/components/schemas/LanguageRelease" - }, - "providedDependencies" : { - "type" : "array", - "description" : "Description of dependencies provided by this runtime version.", - "items" : { - "$ref" : "#/components/schemas/ProvidedDependency" - } - }, - "assets" : { - "$ref" : "#/components/schemas/AssetsConditions" - }, - "deprecated" : { - "type" : "boolean", - "description" : "If true, this runtime should no longer be used for new functions." - } - }, - "description" : "Runtime (version) specification that says\n* what assets are required/allowed to build the function\n* what build parameters are used\n* what deployment parameters are used\n* which dependencies are provided by the runtime" -} -""", - object_hook=with_example_provider, -) -runtime_specification_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_specification_faker = JSF( - runtime_specification_model_schema, allow_none_optionals=1 -) - - -class RuntimeSpecificationStub: - """RuntimeSpecification unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_specification_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "RuntimeSpecification": - """Create RuntimeSpecification stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeSpecificationAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeSpecificationAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_summary_attrs_stub.py b/test/types/runtime_summary_attrs_stub.py deleted file mode 100644 index d61a797a..00000000 --- a/test/types/runtime_summary_attrs_stub.py +++ /dev/null @@ -1,84 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_summary_attrs import ( - RuntimeSummaryAttrs, - ) - - RuntimeSummaryAttrsAdapter = TypeAdapter(RuntimeSummaryAttrs) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_summary_attrs_model_schema = json.loads( - r"""{ - "required" : [ "archiveFormat", "functionType", "name", "title" ], - "type" : "object", - "properties" : { - "name" : { - "$ref" : "#/components/schemas/Runtime" - }, - "title" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "functionType" : { - "$ref" : "#/components/schemas/FunctionType" - }, - "archiveFormat" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - } -} -""", - object_hook=with_example_provider, -) -runtime_summary_attrs_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_summary_attrs_faker = JSF( - runtime_summary_attrs_model_schema, allow_none_optionals=1 -) - - -class RuntimeSummaryAttrsStub: - """RuntimeSummaryAttrs unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_summary_attrs_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "RuntimeSummaryAttrs": - """Create RuntimeSummaryAttrs stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeSummaryAttrsAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeSummaryAttrsAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_version_and_path_params_stub.py b/test/types/runtime_version_and_path_params_stub.py deleted file mode 100644 index bad686d6..00000000 --- a/test/types/runtime_version_and_path_params_stub.py +++ /dev/null @@ -1,80 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_version_and_path_params import ( - RuntimeVersionAndPathParams, - ) - - RuntimeVersionAndPathParamsAdapter = TypeAdapter(RuntimeVersionAndPathParams) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_version_and_path_params_model_schema = json.loads( - r"""{ - "required" : [ "*", "name", "version" ], - "type" : "object", - "properties" : { - "*" : { - "type" : "string", - "description" : "Full path or path prefix of the asset within the archive" - }, - "name" : { - "$ref" : "#/components/schemas/Runtime" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -runtime_version_and_path_params_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_version_and_path_params_faker = JSF( - runtime_version_and_path_params_model_schema, allow_none_optionals=1 -) - - -class RuntimeVersionAndPathParamsStub: - """RuntimeVersionAndPathParams unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_version_and_path_params_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "RuntimeVersionAndPathParams": - """Create RuntimeVersionAndPathParams stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeVersionAndPathParamsAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeVersionAndPathParamsAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_version_params_stub.py b/test/types/runtime_version_params_stub.py deleted file mode 100644 index bdaaa24b..00000000 --- a/test/types/runtime_version_params_stub.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_version_params import ( - RuntimeVersionParams, - ) - - RuntimeVersionParamsAdapter = TypeAdapter(RuntimeVersionParams) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_version_params_model_schema = json.loads( - r"""{ - "required" : [ "name", "version" ], - "type" : "object", - "properties" : { - "name" : { - "$ref" : "#/components/schemas/Runtime" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -runtime_version_params_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_version_params_faker = JSF( - runtime_version_params_model_schema, allow_none_optionals=1 -) - - -class RuntimeVersionParamsStub: - """RuntimeVersionParams unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_version_params_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "RuntimeVersionParams": - """Create RuntimeVersionParams stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeVersionParamsAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeVersionParamsAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_version_query_stub.py b/test/types/runtime_version_query_stub.py deleted file mode 100644 index 03ac38ff..00000000 --- a/test/types/runtime_version_query_stub.py +++ /dev/null @@ -1,80 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_version_query import ( - RuntimeVersionQuery, - ) - - RuntimeVersionQueryAdapter = TypeAdapter(RuntimeVersionQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_version_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "version" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "latest" : { - "$ref" : "#/components/schemas/LatestVersionLevel" - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "If set to `true`, deprecated runtimes will be included in the query.", - "default" : false - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -runtime_version_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_version_query_faker = JSF( - runtime_version_query_model_schema, allow_none_optionals=1 -) - - -class RuntimeVersionQueryStub: - """RuntimeVersionQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_version_query_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "RuntimeVersionQuery": - """Create RuntimeVersionQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeVersionQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeVersionQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_version_specification_stub.py b/test/types/runtime_version_specification_stub.py deleted file mode 100644 index 91758b97..00000000 --- a/test/types/runtime_version_specification_stub.py +++ /dev/null @@ -1,101 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_version_specification import ( - RuntimeVersionSpecification, - ) - - RuntimeVersionSpecificationAdapter = TypeAdapter(RuntimeVersionSpecification) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_version_specification_model_schema = json.loads( - r"""{ - "required" : [ "title", "version" ], - "type" : "object", - "properties" : { - "build" : { - "$ref" : "#/components/schemas/BuildSpec" - }, - "deploy" : { - "$ref" : "#/components/schemas/DeploySpec" - }, - "language" : { - "$ref" : "#/components/schemas/LanguageRelease" - }, - "providedDependencies" : { - "type" : "array", - "description" : "Description of dependencies provided by this runtime version.", - "items" : { - "$ref" : "#/components/schemas/ProvidedDependency" - } - }, - "assets" : { - "$ref" : "#/components/schemas/AssetsConditions" - }, - "deprecated" : { - "type" : "boolean", - "description" : "If true, this runtime should no longer be used for new functions." - }, - "title" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - } - } -} -""", - object_hook=with_example_provider, -) -runtime_version_specification_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_version_specification_faker = JSF( - runtime_version_specification_model_schema, allow_none_optionals=1 -) - - -class RuntimeVersionSpecificationStub: - """RuntimeVersionSpecification unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_version_specification_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "RuntimeVersionSpecification": - """Create RuntimeVersionSpecification stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeVersionSpecificationAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeVersionSpecificationAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_version_status_stub.py b/test/types/runtime_version_status_stub.py deleted file mode 100644 index d6cb3631..00000000 --- a/test/types/runtime_version_status_stub.py +++ /dev/null @@ -1,77 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_version_status import ( - RuntimeVersionStatus, - ) - - RuntimeVersionStatusAdapter = TypeAdapter(RuntimeVersionStatus) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_version_status_model_schema = json.loads( - r"""{ - "required" : [ "deprecated", "upgradable" ], - "type" : "object", - "properties" : { - "deprecated" : { - "type" : "boolean", - "description" : "If true, the function uses a deprecated runtime." - }, - "upgradable" : { - "type" : "boolean", - "description" : "If true, a newer runtime for this function is available using the `rebuild` API." - } - } -} -""", - object_hook=with_example_provider, -) -runtime_version_status_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_version_status_faker = JSF( - runtime_version_status_model_schema, allow_none_optionals=1 -) - - -class RuntimeVersionStatusStub: - """RuntimeVersionStatus unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_version_status_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "RuntimeVersionStatus": - """Create RuntimeVersionStatus stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeVersionStatusAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeVersionStatusAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/runtime_version_summary_stub.py b/test/types/runtime_version_summary_stub.py deleted file mode 100644 index d3d85764..00000000 --- a/test/types/runtime_version_summary_stub.py +++ /dev/null @@ -1,95 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.runtime_version_summary import ( - RuntimeVersionSummary, - ) - - RuntimeVersionSummaryAdapter = TypeAdapter(RuntimeVersionSummary) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -runtime_version_summary_model_schema = json.loads( - r"""{ - "required" : [ "archiveFormat", "deprecated", "functionType", "name", "title", "upgradable", "version" ], - "type" : "object", - "properties" : { - "deprecated" : { - "type" : "boolean", - "description" : "If true, the function uses a deprecated runtime." - }, - "upgradable" : { - "type" : "boolean", - "description" : "If true, a newer runtime for this function is available using the `rebuild` API." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "title" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "name" : { - "$ref" : "#/components/schemas/Runtime" - }, - "functionType" : { - "$ref" : "#/components/schemas/FunctionType" - }, - "archiveFormat" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - } -} -""", - object_hook=with_example_provider, -) -runtime_version_summary_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -runtime_version_summary_faker = JSF( - runtime_version_summary_model_schema, allow_none_optionals=1 -) - - -class RuntimeVersionSummaryStub: - """RuntimeVersionSummary unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return runtime_version_summary_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "RuntimeVersionSummary": - """Create RuntimeVersionSummary stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - RuntimeVersionSummaryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return RuntimeVersionSummaryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/scale_args_stub.py b/test/types/scale_args_stub.py index 7d25981b..8aa6db60 100644 --- a/test/types/scale_args_stub.py +++ b/test/types/scale_args_stub.py @@ -26,7 +26,7 @@ scale_args_model_schema = json.loads( r"""{ "title" : "ScaleArgs", - "required" : [ "endpoint", "namespace", "replicas", "runtimeName", "runtimeVersion" ], + "required" : [ "endpoint", "namespace", "replicas", "revision", "runtimeName", "runtimeVersion" ], "type" : "object", "properties" : { "namespace" : { diff --git a/test/types/schema_by_id_params_stub.py b/test/types/schema_by_id_params_stub.py deleted file mode 100644 index 2e0d4d43..00000000 --- a/test/types/schema_by_id_params_stub.py +++ /dev/null @@ -1,70 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.schema_by_id_params import SchemaByIdParams - - SchemaByIdParamsAdapter = TypeAdapter(SchemaByIdParams) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -schema_by_id_params_model_schema = json.loads( - r"""{ - "required" : [ "schemaId" ], - "type" : "object", - "properties" : { - "schemaId" : { - "type" : "string", - "description" : "Schema id" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -schema_by_id_params_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -schema_by_id_params_faker = JSF( - schema_by_id_params_model_schema, allow_none_optionals=1 -) - - -class SchemaByIdParamsStub: - """SchemaByIdParams unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return schema_by_id_params_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "SchemaByIdParams": - """Create SchemaByIdParams stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - SchemaByIdParamsAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return SchemaByIdParamsAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/semantic_version_range_stub.py b/test/types/semantic_version_range_stub.py index 38f76b94..dfee8ede 100644 --- a/test/types/semantic_version_range_stub.py +++ b/test/types/semantic_version_range_stub.py @@ -27,7 +27,6 @@ semantic_version_range_model_schema = json.loads( r"""{ - "title" : "SemanticVersionRange", "description" : "A range of semantic versions. See https://devhints.io/semver", "anyOf" : [ { "type" : "string" diff --git a/test/types/supported_events_stub.py b/test/types/show_related_type_stub.py similarity index 56% rename from test/types/supported_events_stub.py rename to test/types/show_related_type_stub.py index bc53ed2b..a45b9c04 100644 --- a/test/types/supported_events_stub.py +++ b/test/types/show_related_type_stub.py @@ -16,47 +16,46 @@ from ..openapi import MODEL_DEFINITIONS, with_example_provider try: - from waylay.services.registry.models.supported_events import SupportedEvents + from waylay.services.registry.models.show_related_type import ShowRelatedType - SupportedEventsAdapter = TypeAdapter(SupportedEvents) + ShowRelatedTypeAdapter = TypeAdapter(ShowRelatedType) MODELS_AVAILABLE = True except ImportError as exc: MODELS_AVAILABLE = False -supported_events_model_schema = json.loads( +show_related_type_model_schema = json.loads( r"""{ - "title" : "SupportedEvents", "type" : "string", - "enum" : [ "completed", "failed", "active", "delayed", "waiting", "waiting-children" ] + "enum" : [ "embed", "link", "none" ] } """, object_hook=with_example_provider, ) -supported_events_model_schema.update({"definitions": MODEL_DEFINITIONS}) +show_related_type_model_schema.update({"definitions": MODEL_DEFINITIONS}) -supported_events_faker = JSF(supported_events_model_schema, allow_none_optionals=1) +show_related_type_faker = JSF(show_related_type_model_schema, allow_none_optionals=1) -class SupportedEventsStub: - """SupportedEvents unit test stubs.""" +class ShowRelatedTypeStub: + """ShowRelatedType unit test stubs.""" @classmethod def create_json(cls): """Create a dict stub instance.""" - return supported_events_faker.generate(use_defaults=True, use_examples=True) + return show_related_type_faker.generate(use_defaults=True, use_examples=True) @classmethod - def create_instance(cls) -> "SupportedEvents": - """Create SupportedEvents stub instance.""" + def create_instance(cls) -> "ShowRelatedType": + """Create ShowRelatedType stub instance.""" if not MODELS_AVAILABLE: raise ImportError("Models must be installed to create class stubs") json = cls.create_json() if not json: # use backup example based on the pydantic model schema backup_faker = JSF( - SupportedEventsAdapter.json_schema(), allow_none_optionals=1 + ShowRelatedTypeAdapter.json_schema(), allow_none_optionals=1 ) json = backup_faker.generate(use_defaults=True, use_examples=True) - return SupportedEventsAdapter.validate_python( + return ShowRelatedTypeAdapter.validate_python( json, context={"skip_validation": True} ) diff --git a/test/types/error_response_stub.py b/test/types/status_exclude_stub.py similarity index 52% rename from test/types/error_response_stub.py rename to test/types/status_exclude_stub.py index f5326107..7c7f5b02 100644 --- a/test/types/error_response_stub.py +++ b/test/types/status_exclude_stub.py @@ -16,51 +16,49 @@ from ..openapi import MODEL_DEFINITIONS, with_example_provider try: - from waylay.services.registry.models.error_response import ErrorResponse + from waylay.services.registry.models.status_exclude import StatusExclude - ErrorResponseAdapter = TypeAdapter(ErrorResponse) + StatusExcludeAdapter = TypeAdapter(StatusExclude) MODELS_AVAILABLE = True except ImportError as exc: MODELS_AVAILABLE = False -error_response_model_schema = json.loads( +status_exclude_model_schema = json.loads( r"""{ - "required" : [ "error" ], - "type" : "object", - "properties" : { - "error" : { - "type" : "string" - } - } + "pattern" : "^(registered|pending|deployed|unhealthy|failed|running|undeploying|undeployed)-$", + "type" : "string", + "description" : "Any status value with a `-` postfix appended, excludes that status as a filter.", + "example" : "running-", + "enum" : [ "registered-", "running-", "pending-", "deployed-", "unhealthy-", "failed-", "undeploying-", "undeployed-" ] } """, object_hook=with_example_provider, ) -error_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) +status_exclude_model_schema.update({"definitions": MODEL_DEFINITIONS}) -error_response_faker = JSF(error_response_model_schema, allow_none_optionals=1) +status_exclude_faker = JSF(status_exclude_model_schema, allow_none_optionals=1) -class ErrorResponseStub: - """ErrorResponse unit test stubs.""" +class StatusExcludeStub: + """StatusExclude unit test stubs.""" @classmethod def create_json(cls): """Create a dict stub instance.""" - return error_response_faker.generate(use_defaults=True, use_examples=True) + return status_exclude_faker.generate(use_defaults=True, use_examples=True) @classmethod - def create_instance(cls) -> "ErrorResponse": - """Create ErrorResponse stub instance.""" + def create_instance(cls) -> "StatusExclude": + """Create StatusExclude stub instance.""" if not MODELS_AVAILABLE: raise ImportError("Models must be installed to create class stubs") json = cls.create_json() if not json: # use backup example based on the pydantic model schema backup_faker = JSF( - ErrorResponseAdapter.json_schema(), allow_none_optionals=1 + StatusExcludeAdapter.json_schema(), allow_none_optionals=1 ) json = backup_faker.generate(use_defaults=True, use_examples=True) - return ErrorResponseAdapter.validate_python( + return StatusExcludeAdapter.validate_python( json, context={"skip_validation": True} ) diff --git a/test/types/status_response_stub.py b/test/types/status_response_stub.py deleted file mode 100644 index e4945031..00000000 --- a/test/types/status_response_stub.py +++ /dev/null @@ -1,66 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.status_response import StatusResponse - - StatusResponseAdapter = TypeAdapter(StatusResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -status_response_model_schema = json.loads( - r"""{ - "required" : [ "statusCode" ], - "type" : "object", - "properties" : { - "statusCode" : { - "type" : "number" - } - } -} -""", - object_hook=with_example_provider, -) -status_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -status_response_faker = JSF(status_response_model_schema, allow_none_optionals=1) - - -class StatusResponseStub: - """StatusResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return status_response_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "StatusResponse": - """Create StatusResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - StatusResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return StatusResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/tag_query_stub.py b/test/types/tag_query_stub.py deleted file mode 100644 index f61b7979..00000000 --- a/test/types/tag_query_stub.py +++ /dev/null @@ -1,69 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.tag_query import TagQuery - - TagQueryAdapter = TypeAdapter(TagQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -tag_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "name" : { - "type" : "string", - "description" : "If set, filters on the name of a tag. Supports * and ? wildcards and is case-insensitive.", - "example" : "*-demo-??" - }, - "color" : { - "type" : "string", - "description" : "If set, filters on the color of a tag. Uses an exact match.", - "example" : "#4153ea" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -tag_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -tag_query_faker = JSF(tag_query_model_schema, allow_none_optionals=1) - - -class TagQueryStub: - """TagQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return tag_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "TagQuery": - """Create TagQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(TagQueryAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return TagQueryAdapter.validate_python(json, context={"skip_validation": True}) diff --git a/test/types/tags_filter_stub.py b/test/types/tags_filter_stub.py index d8890251..d92eb6cf 100644 --- a/test/types/tags_filter_stub.py +++ b/test/types/tags_filter_stub.py @@ -25,7 +25,6 @@ tags_filter_model_schema = json.loads( r"""{ - "title" : "TagsFilter", "anyOf" : [ { "type" : "array", "items" : { diff --git a/test/types/tags_query_stub.py b/test/types/tags_query_stub.py deleted file mode 100644 index aa508e87..00000000 --- a/test/types/tags_query_stub.py +++ /dev/null @@ -1,62 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.tags_query import TagsQuery - - TagsQueryAdapter = TypeAdapter(TagsQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -tags_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "tags" : { - "$ref" : "#/components/schemas/TagsFilter" - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -tags_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -tags_query_faker = JSF(tags_query_model_schema, allow_none_optionals=1) - - -class TagsQueryStub: - """TagsQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return tags_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "TagsQuery": - """Create TagsQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(TagsQueryAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return TagsQueryAdapter.validate_python(json, context={"skip_validation": True}) diff --git a/test/types/timestamp_spec_stub.py b/test/types/timestamp_spec_stub.py index a7769663..8369893b 100644 --- a/test/types/timestamp_spec_stub.py +++ b/test/types/timestamp_spec_stub.py @@ -25,7 +25,6 @@ timestamp_spec_model_schema = json.loads( r"""{ - "title" : "TimestampSpec", "description" : "A timestamp specification.", "anyOf" : [ { "$ref" : "#/components/schemas/TimestampAge" diff --git a/test/types/undeploy_args_stub.py b/test/types/undeploy_args_stub.py index 3eb3ed59..8b056040 100644 --- a/test/types/undeploy_args_stub.py +++ b/test/types/undeploy_args_stub.py @@ -26,7 +26,7 @@ undeploy_args_model_schema = json.loads( r"""{ "title" : "UndeployArgs", - "required" : [ "deleteEntity", "endpoint", "isNativePlug", "namespace", "runtimeName", "runtimeVersion" ], + "required" : [ "deleteEntity", "endpoint", "isNativePlug", "namespace", "revision", "runtimeName", "runtimeVersion" ], "type" : "object", "properties" : { "namespace" : { diff --git a/test/types/unhealthy_invokable_webscript_error_stub.py b/test/types/unhealthy_invokable_webscript_error_stub.py deleted file mode 100644 index cd9f2472..00000000 --- a/test/types/unhealthy_invokable_webscript_error_stub.py +++ /dev/null @@ -1,87 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.unhealthy_invokable_webscript_error import ( - UnhealthyInvokableWebscriptError, - ) - - UnhealthyInvokableWebscriptErrorAdapter = TypeAdapter( - UnhealthyInvokableWebscriptError - ) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -unhealthy_invokable_webscript_error_model_schema = json.loads( - r"""{ - "required" : [ "_links", "code", "entity", "error" ], - "type" : "object", - "properties" : { - "entity" : { - "$ref" : "#/components/schemas/InvokableWebscriptResponse_entity" - }, - "_links" : { - "$ref" : "#/components/schemas/InvokeInternalHALLink" - }, - "error" : { - "type" : "string" - }, - "code" : { - "type" : "string" - } - }, - "description" : "Webscript Not Healthy" -} -""", - object_hook=with_example_provider, -) -unhealthy_invokable_webscript_error_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -unhealthy_invokable_webscript_error_faker = JSF( - unhealthy_invokable_webscript_error_model_schema, allow_none_optionals=1 -) - - -class UnhealthyInvokableWebscriptErrorStub: - """UnhealthyInvokableWebscriptError unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return unhealthy_invokable_webscript_error_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "UnhealthyInvokableWebscriptError": - """Create UnhealthyInvokableWebscriptError stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - UnhealthyInvokableWebscriptErrorAdapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return UnhealthyInvokableWebscriptErrorAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/update_comment_stub.py b/test/types/update_comment_stub.py deleted file mode 100644 index c7732368..00000000 --- a/test/types/update_comment_stub.py +++ /dev/null @@ -1,66 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.update_comment import UpdateComment - - UpdateCommentAdapter = TypeAdapter(UpdateComment) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -update_comment_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - } - } -} -""", - object_hook=with_example_provider, -) -update_comment_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -update_comment_faker = JSF(update_comment_model_schema, allow_none_optionals=1) - - -class UpdateCommentStub: - """UpdateComment unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return update_comment_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "UpdateComment": - """Create UpdateComment stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - UpdateCommentAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return UpdateCommentAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/update_draft_query_stub.py b/test/types/update_draft_query_stub.py deleted file mode 100644 index 809a43ed..00000000 --- a/test/types/update_draft_query_stub.py +++ /dev/null @@ -1,78 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.update_draft_query import UpdateDraftQuery - - UpdateDraftQueryAdapter = TypeAdapter(UpdateDraftQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -update_draft_query_model_schema = json.loads( - r"""{ - "required" : [ "chown" ], - "type" : "object", - "properties" : { - "comment" : { - "type" : "string", - "description" : "An optional user-specified comment corresponding to the operation." - }, - "async" : { - "type" : "boolean", - "description" : "Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - "default" : true - }, - "chown" : { - "type" : "boolean", - "description" : "If set, ownership of the draft function is transferred to the current user.", - "default" : false - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -update_draft_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -update_draft_query_faker = JSF(update_draft_query_model_schema, allow_none_optionals=1) - - -class UpdateDraftQueryStub: - """UpdateDraftQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return update_draft_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "UpdateDraftQuery": - """Create UpdateDraftQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - UpdateDraftQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return UpdateDraftQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/update_metadata_request_v1_stub.py b/test/types/update_metadata_request_v1_stub.py deleted file mode 100644 index a5a3a38a..00000000 --- a/test/types/update_metadata_request_v1_stub.py +++ /dev/null @@ -1,108 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.update_metadata_request_v1 import ( - UpdateMetadataRequestV1, - ) - - UpdateMetadataRequestV1Adapter = TypeAdapter(UpdateMetadataRequestV1) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -update_metadata_request_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "author" : { - "type" : "string", - "description" : "The author of the function." - }, - "description" : { - "type" : "string", - "description" : "A description of the function" - }, - "iconURL" : { - "type" : "string", - "description" : "An url to an icon that represents this function." - }, - "category" : { - "type" : "string", - "description" : "A category for this function (Deprecated: use tags to categorise your functions)", - "deprecated" : true - }, - "documentationURL" : { - "type" : "string", - "description" : "External url that document this function." - }, - "tags" : { - "type" : "array", - "description" : "Tags associated with this function.", - "example" : [ { - "name" : "awaiting-review", - "color" : "#4153ea" - }, { - "name" : "demo", - "color" : "#e639a4" - } ], - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "friendlyName" : { - "type" : "string", - "description" : "Display title for this function." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -update_metadata_request_v1_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -update_metadata_request_v1_faker = JSF( - update_metadata_request_v1_model_schema, allow_none_optionals=1 -) - - -class UpdateMetadataRequestV1Stub: - """UpdateMetadataRequestV1 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return update_metadata_request_v1_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "UpdateMetadataRequestV1": - """Create UpdateMetadataRequestV1 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - UpdateMetadataRequestV1Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return UpdateMetadataRequestV1Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/user_plug_meta_stub.py b/test/types/user_plug_meta_stub.py deleted file mode 100644 index c64b2a24..00000000 --- a/test/types/user_plug_meta_stub.py +++ /dev/null @@ -1,102 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.user_plug_meta import UserPlugMeta - - UserPlugMetaAdapter = TypeAdapter(UserPlugMeta) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -user_plug_meta_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "author" : { - "type" : "string", - "description" : "The author of the function." - }, - "description" : { - "type" : "string", - "description" : "A description of the function" - }, - "iconURL" : { - "type" : "string", - "description" : "An url to an icon that represents this function." - }, - "category" : { - "type" : "string", - "description" : "A category for this function (Deprecated: use tags to categorise your functions)", - "deprecated" : true - }, - "documentationURL" : { - "type" : "string", - "description" : "External url that document this function." - }, - "tags" : { - "type" : "array", - "description" : "Tags associated with this function.", - "example" : [ { - "name" : "awaiting-review", - "color" : "#4153ea" - }, { - "name" : "demo", - "color" : "#e639a4" - } ], - "items" : { - "$ref" : "#/components/schemas/Tag" - } - }, - "friendlyName" : { - "type" : "string", - "description" : "Display title for this function." - } - }, - "description" : "Plug metadata that the user can update as `metadata`" -} -""", - object_hook=with_example_provider, -) -user_plug_meta_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -user_plug_meta_faker = JSF(user_plug_meta_model_schema, allow_none_optionals=1) - - -class UserPlugMetaStub: - """UserPlugMeta unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return user_plug_meta_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "UserPlugMeta": - """Create UserPlugMeta stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - UserPlugMetaAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return UserPlugMetaAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/verify_args_stub.py b/test/types/verify_args_stub.py index 99768e3a..f26c9af0 100644 --- a/test/types/verify_args_stub.py +++ b/test/types/verify_args_stub.py @@ -26,7 +26,7 @@ verify_args_model_schema = json.loads( r"""{ "title" : "VerifyArgs", - "required" : [ "endpoint", "namespace", "runtimeName", "runtimeVersion" ], + "required" : [ "endpoint", "namespace", "revision", "runtimeName", "runtimeVersion" ], "type" : "object", "properties" : { "namespace" : { diff --git a/test/types/verify_query_v1_stub.py b/test/types/verify_query_v1_stub.py deleted file mode 100644 index dea046a0..00000000 --- a/test/types/verify_query_v1_stub.py +++ /dev/null @@ -1,67 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.verify_query_v1 import VerifyQueryV1 - - VerifyQueryV1Adapter = TypeAdapter(VerifyQueryV1) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -verify_query_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "scaleToZero" : { - "type" : "boolean", - "description" : "Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -verify_query_v1_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -verify_query_v1_faker = JSF(verify_query_v1_model_schema, allow_none_optionals=1) - - -class VerifyQueryV1Stub: - """VerifyQueryV1 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return verify_query_v1_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "VerifyQueryV1": - """Create VerifyQueryV1 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - VerifyQueryV1Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return VerifyQueryV1Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/version_includes_stub.py b/test/types/version_includes_stub.py deleted file mode 100644 index 9e860d46..00000000 --- a/test/types/version_includes_stub.py +++ /dev/null @@ -1,71 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.version_includes import VersionIncludes - - VersionIncludesAdapter = TypeAdapter(VersionIncludes) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -version_includes_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - } - }, - "additionalProperties" : false -} -""", - object_hook=with_example_provider, -) -version_includes_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -version_includes_faker = JSF(version_includes_model_schema, allow_none_optionals=1) - - -class VersionIncludesStub: - """VersionIncludes unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return version_includes_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "VersionIncludes": - """Create VersionIncludes stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - VersionIncludesAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return VersionIncludesAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/versions_query_stub.py b/test/types/versions_query_stub.py deleted file mode 100644 index c70372c2..00000000 --- a/test/types/versions_query_stub.py +++ /dev/null @@ -1,155 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.versions_query import VersionsQuery - - VersionsQueryAdapter = TypeAdapter(VersionsQuery) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -versions_query_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "endpoint" : { - "type" : "string", - "description" : "Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "imageName" : { - "type" : "string", - "description" : "Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "storageLocation" : { - "type" : "string", - "description" : "Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "nameVersion" : { - "type" : "array", - "description" : "Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - "items" : { - "$ref" : "#/components/schemas/NamedVersion" - } - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Function versions paged query" -} -""", - object_hook=with_example_provider, -) -versions_query_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -versions_query_faker = JSF(versions_query_model_schema, allow_none_optionals=1) - - -class VersionsQueryStub: - """VersionsQuery unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return versions_query_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "VersionsQuery": - """Create VersionsQuery stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - VersionsQueryAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return VersionsQueryAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/versions_query_v2_stub.py b/test/types/versions_query_v2_stub.py deleted file mode 100644 index 47ffcf6a..00000000 --- a/test/types/versions_query_v2_stub.py +++ /dev/null @@ -1,155 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.versions_query_v2 import VersionsQueryV2 - - VersionsQueryV2Adapter = TypeAdapter(VersionsQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -versions_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "endpoint" : { - "type" : "string", - "description" : "Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "imageName" : { - "type" : "string", - "description" : "Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "storageLocation" : { - "type" : "string", - "description" : "Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "deprecated" : { - "type" : "boolean", - "description" : "Filter on the deprecation status of the function." - }, - "draft" : { - "type" : "boolean", - "description" : "Filter on the draft status of the function." - }, - "nameVersion" : { - "type" : "array", - "description" : "Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - "items" : { - "$ref" : "#/components/schemas/NamedVersion" - } - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Function versions paged query" -} -""", - object_hook=with_example_provider, -) -versions_query_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -versions_query_v2_faker = JSF(versions_query_v2_model_schema, allow_none_optionals=1) - - -class VersionsQueryV2Stub: - """VersionsQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return versions_query_v2_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "VersionsQueryV2": - """Create VersionsQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - VersionsQueryV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return VersionsQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/versions_response_v2_stub.py b/test/types/versions_response_v2_stub.py deleted file mode 100644 index 1a37c0ac..00000000 --- a/test/types/versions_response_v2_stub.py +++ /dev/null @@ -1,85 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.versions_response_v2 import VersionsResponseV2 - - VersionsResponseV2Adapter = TypeAdapter(VersionsResponseV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -versions_response_v2_model_schema = json.loads( - r"""{ - "required" : [ "count", "entities" ], - "type" : "object", - "properties" : { - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." - }, - "entities" : { - "type" : "array", - "description" : "The specification and deployment status of the queried functions", - "items" : { - "$ref" : "#/components/schemas/AnyFunctionResponse" - } - } - }, - "description" : "Version Listing Response" -} -""", - object_hook=with_example_provider, -) -versions_response_v2_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -versions_response_v2_faker = JSF( - versions_response_v2_model_schema, allow_none_optionals=1 -) - - -class VersionsResponseV2Stub: - """VersionsResponseV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return versions_response_v2_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "VersionsResponseV2": - """Create VersionsResponseV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - VersionsResponseV2Adapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return VersionsResponseV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/webscript_latest_version_query_v2_stub.py b/test/types/webscript_latest_version_query_v2_stub.py deleted file mode 100644 index 408809c3..00000000 --- a/test/types/webscript_latest_version_query_v2_stub.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.webscript_latest_version_query_v2 import ( - WebscriptLatestVersionQueryV2, - ) - - WebscriptLatestVersionQueryV2Adapter = TypeAdapter(WebscriptLatestVersionQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -webscript_latest_version_query_v2_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - } - }, - "additionalProperties" : false, - "description" : "Webscript latest named version query." -} -""", - object_hook=with_example_provider, -) -webscript_latest_version_query_v2_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -webscript_latest_version_query_v2_faker = JSF( - webscript_latest_version_query_v2_model_schema, allow_none_optionals=1 -) - - -class WebscriptLatestVersionQueryV2Stub: - """WebscriptLatestVersionQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return webscript_latest_version_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "WebscriptLatestVersionQueryV2": - """Create WebscriptLatestVersionQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - WebscriptLatestVersionQueryV2Adapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return WebscriptLatestVersionQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/webscript_latest_versions_query_v1_stub.py b/test/types/webscript_latest_versions_query_v1_stub.py deleted file mode 100644 index 2ca5c874..00000000 --- a/test/types/webscript_latest_versions_query_v1_stub.py +++ /dev/null @@ -1,145 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.webscript_latest_versions_query_v1 import ( - WebscriptLatestVersionsQueryV1, - ) - - WebscriptLatestVersionsQueryV1Adapter = TypeAdapter(WebscriptLatestVersionsQueryV1) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -webscript_latest_versions_query_v1_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "minimum" : 0, - "type" : "number", - "description" : "The maximum number of items to be return from this query. Has a deployment-defined default and maximum value." - }, - "page" : { - "minimum" : 0, - "type" : "number", - "description" : "The number of pages to skip when returning result to this query." - }, - "includeDraft" : { - "type" : "boolean", - "description" : "Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - }, - "includeDeprecated" : { - "type" : "boolean", - "description" : "Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - }, - "version" : { - "type" : "string", - "description" : "Filter on the version of the function (case-sensitive, supports wildcards)." - }, - "status" : { - "type" : "array", - "description" : "Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - "items" : { - "$ref" : "#/components/schemas/StatusFilter" - } - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "createdBy" : { - "type" : "string", - "description" : "Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "updatedBy" : { - "type" : "string", - "description" : "Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - "example" : "@me" - }, - "createdBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "createdAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedBefore" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "updatedAfter" : { - "$ref" : "#/components/schemas/TimestampSpec" - }, - "name" : { - "type" : "string", - "description" : "Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - }, - "archiveFormat" : { - "type" : "array", - "description" : "Filter on the archive format of the function.", - "items" : { - "$ref" : "#/components/schemas/ArchiveFormat" - } - }, - "runtime" : { - "type" : "array", - "description" : "Filter on the runtime of the function.", - "items" : { - "$ref" : "#/components/schemas/Runtime" - } - } - }, - "additionalProperties" : false, - "description" : "Webscript lastest versions listing query" -} -""", - object_hook=with_example_provider, -) -webscript_latest_versions_query_v1_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -webscript_latest_versions_query_v1_faker = JSF( - webscript_latest_versions_query_v1_model_schema, allow_none_optionals=1 -) - - -class WebscriptLatestVersionsQueryV1Stub: - """WebscriptLatestVersionsQueryV1 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return webscript_latest_versions_query_v1_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "WebscriptLatestVersionsQueryV1": - """Create WebscriptLatestVersionsQueryV1 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - WebscriptLatestVersionsQueryV1Adapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return WebscriptLatestVersionsQueryV1Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/webscript_latest_versions_query_v2_stub.py b/test/types/webscript_latest_versions_query_v2_stub.py deleted file mode 100644 index 7d62879b..00000000 --- a/test/types/webscript_latest_versions_query_v2_stub.py +++ /dev/null @@ -1,74 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.webscript_latest_versions_query_v2 import ( - WebscriptLatestVersionsQueryV2, - ) - - WebscriptLatestVersionsQueryV2Adapter = TypeAdapter(WebscriptLatestVersionsQueryV2) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -webscript_latest_versions_query_v2_model_schema = json.loads( - r"""{ - "description" : "Webscript lastest versions listing query.", - "anyOf" : [ { - "$ref" : "#/components/schemas/LatestFunctionVersionsQuery" - }, { - "$ref" : "#/components/schemas/LatestFunctionsQuery" - } ] -} -""", - object_hook=with_example_provider, -) -webscript_latest_versions_query_v2_model_schema.update({ - "definitions": MODEL_DEFINITIONS -}) - -webscript_latest_versions_query_v2_faker = JSF( - webscript_latest_versions_query_v2_model_schema, allow_none_optionals=1 -) - - -class WebscriptLatestVersionsQueryV2Stub: - """WebscriptLatestVersionsQueryV2 unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return webscript_latest_versions_query_v2_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "WebscriptLatestVersionsQueryV2": - """Create WebscriptLatestVersionsQueryV2 stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - WebscriptLatestVersionsQueryV2Adapter.json_schema(), - allow_none_optionals=1, - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return WebscriptLatestVersionsQueryV2Adapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/webscript_response_stub.py b/test/types/webscript_response_stub.py deleted file mode 100644 index 29c8048d..00000000 --- a/test/types/webscript_response_stub.py +++ /dev/null @@ -1,118 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.webscript_response import WebscriptResponse - - WebscriptResponseAdapter = TypeAdapter(WebscriptResponse) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -webscript_response_model_schema = json.loads( - r"""{ - "required" : [ "createdAt", "createdBy", "metadata", "name", "runtime", "secret", "status", "updatedAt", "updatedBy", "version" ], - "type" : "object", - "properties" : { - "deploy" : { - "$ref" : "#/components/schemas/FunctionDeployOverridesType" - }, - "name" : { - "type" : "string", - "description" : "The logical name for the function." - }, - "version" : { - "$ref" : "#/components/schemas/SemanticVersion" - }, - "runtime" : { - "$ref" : "#/components/schemas/Runtime" - }, - "runtimeVersion" : { - "$ref" : "#/components/schemas/SemanticVersionRange" - }, - "metadata" : { - "$ref" : "#/components/schemas/FunctionMeta" - }, - "createdBy" : { - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "_links" : { - "type" : "array", - "description" : "Links to related entities.", - "items" : { - "$ref" : "#/components/schemas/JobHALLinks" - } - }, - "secret" : { - "type" : "string", - "nullable" : true - } - }, - "description" : "Successful Response" -} -""", - object_hook=with_example_provider, -) -webscript_response_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -webscript_response_faker = JSF(webscript_response_model_schema, allow_none_optionals=1) - - -class WebscriptResponseStub: - """WebscriptResponse unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return webscript_response_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "WebscriptResponse": - """Create WebscriptResponse stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - WebscriptResponseAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return WebscriptResponseAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/with_asset_hal_link_stub.py b/test/types/with_asset_hal_link_stub.py deleted file mode 100644 index 5e183448..00000000 --- a/test/types/with_asset_hal_link_stub.py +++ /dev/null @@ -1,68 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.with_asset_hal_link import WithAssetHALLink - - WithAssetHALLinkAdapter = TypeAdapter(WithAssetHALLink) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -with_asset_hal_link_model_schema = json.loads( - r"""{ - "required" : [ "_links" ], - "type" : "object", - "properties" : { - "_links" : { - "$ref" : "#/components/schemas/AssetSummaryWithHALLink__links" - } - } -} -""", - object_hook=with_example_provider, -) -with_asset_hal_link_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -with_asset_hal_link_faker = JSF( - with_asset_hal_link_model_schema, allow_none_optionals=1 -) - - -class WithAssetHALLinkStub: - """WithAssetHALLink unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return with_asset_hal_link_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "WithAssetHALLink": - """Create WithAssetHALLink stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - WithAssetHALLinkAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return WithAssetHALLinkAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/with_entity_attributes_stub.py b/test/types/with_entity_attributes_stub.py deleted file mode 100644 index bb57cdbb..00000000 --- a/test/types/with_entity_attributes_stub.py +++ /dev/null @@ -1,111 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.with_entity_attributes import ( - WithEntityAttributes, - ) - - WithEntityAttributesAdapter = TypeAdapter(WithEntityAttributes) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -with_entity_attributes_model_schema = json.loads( - r"""{ - "required" : [ "createdAt", "createdBy", "deprecated", "draft", "runtime", "status", "updatedAt", "updatedBy", "updates" ], - "type" : "object", - "properties" : { - "createdBy" : { - "type" : "string", - "description" : "The user that created this entity." - }, - "createdAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was created.", - "format" : "date-time" - }, - "updatedBy" : { - "type" : "string", - "description" : "The user that last updated this entity." - }, - "updatedAt" : { - "type" : "string", - "description" : "The timestamp at which this entity was last updated.", - "format" : "date-time" - }, - "updates" : { - "type" : "array", - "description" : "The audit logs corresponding to the latest modifying operations on this entity.", - "items" : { - "$ref" : "#/components/schemas/UpdateRecord" - } - }, - "status" : { - "$ref" : "#/components/schemas/Status" - }, - "failureReason" : { - "$ref" : "#/components/schemas/FailureReason" - }, - "runtime" : { - "$ref" : "#/components/schemas/RuntimeAttributes" - }, - "deprecated" : { - "type" : "boolean", - "description" : "If true this function is deprecated and removed from regular listings." - }, - "draft" : { - "type" : "boolean", - "description" : "If true this function is a draft function and it's assets are still mutable." - } - } -} -""", - object_hook=with_example_provider, -) -with_entity_attributes_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -with_entity_attributes_faker = JSF( - with_entity_attributes_model_schema, allow_none_optionals=1 -) - - -class WithEntityAttributesStub: - """WithEntityAttributes unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return with_entity_attributes_faker.generate( - use_defaults=True, use_examples=True - ) - - @classmethod - def create_instance(cls) -> "WithEntityAttributes": - """Create WithEntityAttributes stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF( - WithEntityAttributesAdapter.json_schema(), allow_none_optionals=1 - ) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return WithEntityAttributesAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/test/types/with_limit_stub.py b/test/types/with_limit_stub.py deleted file mode 100644 index 01fcc5d6..00000000 --- a/test/types/with_limit_stub.py +++ /dev/null @@ -1,62 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.with_limit import WithLimit - - WithLimitAdapter = TypeAdapter(WithLimit) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -with_limit_model_schema = json.loads( - r"""{ - "type" : "object", - "properties" : { - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - } - } -} -""", - object_hook=with_example_provider, -) -with_limit_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -with_limit_faker = JSF(with_limit_model_schema, allow_none_optionals=1) - - -class WithLimitStub: - """WithLimit unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return with_limit_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "WithLimit": - """Create WithLimit stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(WithLimitAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return WithLimitAdapter.validate_python(json, context={"skip_validation": True}) diff --git a/test/types/with_paging_stub.py b/test/types/with_paging_stub.py deleted file mode 100644 index 221142df..00000000 --- a/test/types/with_paging_stub.py +++ /dev/null @@ -1,73 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry model tests. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. -""" - -import json - -from jsf import JSF -from pydantic import TypeAdapter - -from ..openapi import MODEL_DEFINITIONS, with_example_provider - -try: - from waylay.services.registry.models.with_paging import WithPaging - - WithPagingAdapter = TypeAdapter(WithPaging) - MODELS_AVAILABLE = True -except ImportError as exc: - MODELS_AVAILABLE = False - -with_paging_model_schema = json.loads( - r"""{ - "required" : [ "count" ], - "type" : "object", - "properties" : { - "limit" : { - "type" : "number", - "description" : "The page size used for this query result." - }, - "count" : { - "type" : "number", - "description" : "The total count of matching items, from which this result is one page." - }, - "page" : { - "type" : "number", - "description" : "The page number of a paged query result." - } - } -} -""", - object_hook=with_example_provider, -) -with_paging_model_schema.update({"definitions": MODEL_DEFINITIONS}) - -with_paging_faker = JSF(with_paging_model_schema, allow_none_optionals=1) - - -class WithPagingStub: - """WithPaging unit test stubs.""" - - @classmethod - def create_json(cls): - """Create a dict stub instance.""" - return with_paging_faker.generate(use_defaults=True, use_examples=True) - - @classmethod - def create_instance(cls) -> "WithPaging": - """Create WithPaging stub instance.""" - if not MODELS_AVAILABLE: - raise ImportError("Models must be installed to create class stubs") - json = cls.create_json() - if not json: - # use backup example based on the pydantic model schema - backup_faker = JSF(WithPagingAdapter.json_schema(), allow_none_optionals=1) - json = backup_faker.generate(use_defaults=True, use_examples=True) - return WithPagingAdapter.validate_python( - json, context={"skip_validation": True} - ) diff --git a/waylay-sdk-registry-types/.openapi-generator/FILES b/waylay-sdk-registry-types/.openapi-generator/FILES index 106337ab..9a52a7d5 100644 --- a/waylay-sdk-registry-types/.openapi-generator/FILES +++ b/waylay-sdk-registry-types/.openapi-generator/FILES @@ -4,8 +4,10 @@ src/waylay/services/registry/models/__init__.py src/waylay/services/registry/models/active_event_data.py src/waylay/services/registry/models/active_event_sse.py src/waylay/services/registry/models/active_event_sse_event.py +src/waylay/services/registry/models/alt_embedded_version_i_kfserving_response_v2.py +src/waylay/services/registry/models/alt_embedded_version_i_plug_response_v2.py +src/waylay/services/registry/models/alt_embedded_version_i_webscript_response_with_invoke_link_v2.py src/waylay/services/registry/models/alt_version_hal_link.py -src/waylay/services/registry/models/any_function_response.py src/waylay/services/registry/models/any_job_for_function.py src/waylay/services/registry/models/any_job_result.py src/waylay/services/registry/models/any_job_status.py @@ -14,17 +16,10 @@ src/waylay/services/registry/models/archive_format.py src/waylay/services/registry/models/asset_condition.py src/waylay/services/registry/models/asset_condition_content_type.py src/waylay/services/registry/models/asset_condition_pattern.py -src/waylay/services/registry/models/asset_path_params_v2.py src/waylay/services/registry/models/asset_role.py -src/waylay/services/registry/models/asset_summary.py src/waylay/services/registry/models/asset_summary_with_hal_link.py src/waylay/services/registry/models/asset_summary_with_hal_link_links.py src/waylay/services/registry/models/assets_conditions.py -src/waylay/services/registry/models/async_deploy_query.py -src/waylay/services/registry/models/async_deploy_query_v1.py -src/waylay/services/registry/models/async_query_default_false.py -src/waylay/services/registry/models/async_query_default_true.py -src/waylay/services/registry/models/async_verify_query.py src/waylay/services/registry/models/batch.py src/waylay/services/registry/models/batch_args.py src/waylay/services/registry/models/batch_job_status.py @@ -42,12 +37,8 @@ src/waylay/services/registry/models/compiled_runtime_version.py src/waylay/services/registry/models/completed_event_data.py src/waylay/services/registry/models/completed_event_sse.py src/waylay/services/registry/models/completed_event_sse_event.py -src/waylay/services/registry/models/content_query_v2.py src/waylay/services/registry/models/content_validation_listing.py -src/waylay/services/registry/models/create_function_query_v2.py -src/waylay/services/registry/models/create_kf_serving_async_response.py -src/waylay/services/registry/models/create_plug_async_response.py -src/waylay/services/registry/models/create_webscript_async_response.py +src/waylay/services/registry/models/create_webscripts_copy_parameter.py src/waylay/services/registry/models/delayed_event_data.py src/waylay/services/registry/models/delayed_event_sse.py src/waylay/services/registry/models/delayed_event_sse_event.py @@ -55,74 +46,44 @@ src/waylay/services/registry/models/deploy.py src/waylay/services/registry/models/deploy1.py src/waylay/services/registry/models/deploy_args.py src/waylay/services/registry/models/deploy_args_deploy_spec_overrides.py -src/waylay/services/registry/models/deploy_attributes_filter.py src/waylay/services/registry/models/deploy_job_status.py src/waylay/services/registry/models/deploy_result.py src/waylay/services/registry/models/deploy_spec.py src/waylay/services/registry/models/deploy_spec_openfaas_spec.py src/waylay/services/registry/models/deploy_type.py src/waylay/services/registry/models/deprecate_previous_policy.py -src/waylay/services/registry/models/deprecate_previous_query.py -src/waylay/services/registry/models/deprecated_draft_filter.py src/waylay/services/registry/models/documentation.py src/waylay/services/registry/models/documentation_property.py -src/waylay/services/registry/models/dry_run_query.py -src/waylay/services/registry/models/entity_response.py -src/waylay/services/registry/models/error_and_status_response.py -src/waylay/services/registry/models/error_response.py +src/waylay/services/registry/models/entity_with_links_i_kfserving_response_v2.py +src/waylay/services/registry/models/entity_with_links_i_plug_response_v2.py +src/waylay/services/registry/models/entity_with_links_i_webscript_response_with_invoke_link_v2.py src/waylay/services/registry/models/event_ack.py src/waylay/services/registry/models/event_close.py src/waylay/services/registry/models/event_keep_alive.py -src/waylay/services/registry/models/event_sse.py -src/waylay/services/registry/models/event_type_sse.py src/waylay/services/registry/models/event_with_close_sse.py +src/waylay/services/registry/models/example_reference.py src/waylay/services/registry/models/exposed_openfaas_deploy_spec.py src/waylay/services/registry/models/failed_event_data.py src/waylay/services/registry/models/failed_event_sse.py src/waylay/services/registry/models/failed_event_sse_event.py src/waylay/services/registry/models/failure_reason.py src/waylay/services/registry/models/file_upload.py -src/waylay/services/registry/models/force_delete_query_v1.py -src/waylay/services/registry/models/function_delete_query.py -src/waylay/services/registry/models/function_deploy_overrides.py src/waylay/services/registry/models/function_deploy_overrides_type.py -src/waylay/services/registry/models/function_entity_query.py -src/waylay/services/registry/models/function_job_args.py -src/waylay/services/registry/models/function_manifest.py src/waylay/services/registry/models/function_meta.py -src/waylay/services/registry/models/function_name_version.py src/waylay/services/registry/models/function_ref.py -src/waylay/services/registry/models/function_spec.py src/waylay/services/registry/models/function_type.py -src/waylay/services/registry/models/function_version_query.py -src/waylay/services/registry/models/get_content_params_v2.py -src/waylay/services/registry/models/get_invokable_webscript_query.py src/waylay/services/registry/models/get_model_response_v2.py src/waylay/services/registry/models/get_plug_response_v2.py src/waylay/services/registry/models/get_plug_response_v2_links.py src/waylay/services/registry/models/get_plug_response_v2_links_draft.py src/waylay/services/registry/models/get_plug_response_v2_links_published.py -src/waylay/services/registry/models/get_runtime_by_name_and_version_query.py -src/waylay/services/registry/models/get_runtime_by_name_query.py -src/waylay/services/registry/models/get_runtime_example_query.py -src/waylay/services/registry/models/get_runtime_versions_query.py src/waylay/services/registry/models/get_webscript_response_v2.py src/waylay/services/registry/models/get_webscript_response_v2_links.py src/waylay/services/registry/models/hal_link.py -src/waylay/services/registry/models/invokable_webscript_response.py -src/waylay/services/registry/models/invokable_webscript_response_entity.py -src/waylay/services/registry/models/invokable_webscript_response_entity_webscript.py src/waylay/services/registry/models/invoke_hal_link.py -src/waylay/services/registry/models/invoke_internal_hal_link.py src/waylay/services/registry/models/job_and_function_hal_link.py src/waylay/services/registry/models/job_cause.py src/waylay/services/registry/models/job_causes.py -src/waylay/services/registry/models/job_event_payload_active_event_data.py -src/waylay/services/registry/models/job_event_payload_completed_event_data.py -src/waylay/services/registry/models/job_event_payload_delayed_event_data.py -src/waylay/services/registry/models/job_event_payload_failed_event_data.py -src/waylay/services/registry/models/job_event_payload_waiting_children_event_data.py -src/waylay/services/registry/models/job_event_payload_waiting_event_data.py src/waylay/services/registry/models/job_event_response_active_event_data.py src/waylay/services/registry/models/job_event_response_completed_event_data.py src/waylay/services/registry/models/job_event_response_delayed_event_data.py @@ -131,12 +92,9 @@ src/waylay/services/registry/models/job_event_response_waiting_children_event_da src/waylay/services/registry/models/job_event_response_waiting_event_data.py src/waylay/services/registry/models/job_event_sse.py src/waylay/services/registry/models/job_events_and_function_hal_link.py -src/waylay/services/registry/models/job_events_filter_query.py src/waylay/services/registry/models/job_events_hal_link.py src/waylay/services/registry/models/job_hal_links.py -src/waylay/services/registry/models/job_query.py src/waylay/services/registry/models/job_reference.py -src/waylay/services/registry/models/job_reference_params.py src/waylay/services/registry/models/job_response.py src/waylay/services/registry/models/job_state.py src/waylay/services/registry/models/job_state_active.py @@ -152,11 +110,11 @@ src/waylay/services/registry/models/job_status.py src/waylay/services/registry/models/job_status_and_entity_hal_links.py src/waylay/services/registry/models/job_status_hal_link.py src/waylay/services/registry/models/job_status_progress.py -src/waylay/services/registry/models/job_submitted_response.py src/waylay/services/registry/models/job_type.py src/waylay/services/registry/models/job_type_batch.py src/waylay/services/registry/models/job_type_build.py src/waylay/services/registry/models/job_type_deploy.py +src/waylay/services/registry/models/job_type_notify.py src/waylay/services/registry/models/job_type_scale.py src/waylay/services/registry/models/job_type_schema.py src/waylay/services/registry/models/job_type_undeploy.py @@ -167,115 +125,34 @@ src/waylay/services/registry/models/jobs_for_plug_response_v2.py src/waylay/services/registry/models/jobs_for_plug_response_v2_links.py src/waylay/services/registry/models/jobs_for_webscript_response_v2.py src/waylay/services/registry/models/jobs_for_webscript_response_v2_links.py -src/waylay/services/registry/models/jobs_hal_link.py src/waylay/services/registry/models/jobs_response.py src/waylay/services/registry/models/keep_alive_event_sse.py -src/waylay/services/registry/models/kf_serving_delete_multiple_response.py -src/waylay/services/registry/models/kf_serving_delete_multiple_with_job_response.py -src/waylay/services/registry/models/kf_serving_delete_query_v1.py -src/waylay/services/registry/models/kf_serving_delete_query_v2.py -src/waylay/services/registry/models/kf_serving_delete_response.py -src/waylay/services/registry/models/kf_serving_delete_with_job_response.py -src/waylay/services/registry/models/kf_serving_latest_version_query_v2.py -src/waylay/services/registry/models/kf_serving_latest_versions_query_v1.py -src/waylay/services/registry/models/kf_serving_latest_versions_query_v2.py src/waylay/services/registry/models/kf_serving_manifest.py -src/waylay/services/registry/models/kf_serving_models_response.py -src/waylay/services/registry/models/kf_serving_response.py -src/waylay/services/registry/models/kf_serving_versions_query_v1.py src/waylay/services/registry/models/kfserving_response_v2.py src/waylay/services/registry/models/language_release.py -src/waylay/services/registry/models/latest_function_versions_query.py -src/waylay/services/registry/models/latest_functions_query.py src/waylay/services/registry/models/latest_models_response_v2.py -src/waylay/services/registry/models/latest_models_response_v2_entities_inner.py -src/waylay/services/registry/models/latest_plug_query.py -src/waylay/services/registry/models/latest_plug_version_query_v2.py -src/waylay/services/registry/models/latest_plug_versions_query.py -src/waylay/services/registry/models/latest_plug_versions_query_v2.py -src/waylay/services/registry/models/latest_plugs_query.py src/waylay/services/registry/models/latest_plugs_response_v2.py -src/waylay/services/registry/models/latest_plugs_response_v2_entities_inner.py src/waylay/services/registry/models/latest_version_level.py src/waylay/services/registry/models/latest_webscripts_response_v2.py -src/waylay/services/registry/models/latest_webscripts_response_v2_entities_inner.py -src/waylay/services/registry/models/legacy_configuration_object.py -src/waylay/services/registry/models/legacy_configuration_object_format.py -src/waylay/services/registry/models/legacy_configuration_response_object.py -src/waylay/services/registry/models/legacy_create_debug_response.py -src/waylay/services/registry/models/legacy_debug_plug_manifest.py -src/waylay/services/registry/models/legacy_debug_plug_request.py -src/waylay/services/registry/models/legacy_documentation.py -src/waylay/services/registry/models/legacy_documentation_request.py -src/waylay/services/registry/models/legacy_function_meta.py -src/waylay/services/registry/models/legacy_plug_create_query.py -src/waylay/services/registry/models/legacy_plug_create_request.py -src/waylay/services/registry/models/legacy_plug_create_response.py -src/waylay/services/registry/models/legacy_plug_meta_request.py -src/waylay/services/registry/models/legacy_plug_query.py -src/waylay/services/registry/models/legacy_plug_request.py -src/waylay/services/registry/models/legacy_plug_request_metadata.py -src/waylay/services/registry/models/legacy_plug_request_metadata_documentation.py -src/waylay/services/registry/models/legacy_plug_request_metadata_documentation_any_of.py -src/waylay/services/registry/models/legacy_plug_request_metadata_raw_data_inner.py -src/waylay/services/registry/models/legacy_plug_response.py -src/waylay/services/registry/models/legacy_plug_response_metadata.py -src/waylay/services/registry/models/legacy_plug_script_meta.py -src/waylay/services/registry/models/legacy_plug_script_meta_raw_data_inner.py -src/waylay/services/registry/models/legacy_plug_script_response.py -src/waylay/services/registry/models/legacy_required_properties_inner.py -src/waylay/services/registry/models/legacy_required_property_object.py -src/waylay/services/registry/models/limit_query.py -src/waylay/services/registry/models/media_type.py -src/waylay/services/registry/models/message_and_status_response.py -src/waylay/services/registry/models/message_response.py src/waylay/services/registry/models/model.py src/waylay/services/registry/models/model1.py src/waylay/services/registry/models/model2.py src/waylay/services/registry/models/model_versions_response_v2.py -src/waylay/services/registry/models/multipart_file_upload.py -src/waylay/services/registry/models/name.py -src/waylay/services/registry/models/name_and_version.py -src/waylay/services/registry/models/named_function_versions_query.py -src/waylay/services/registry/models/named_kf_serving_versions_query_v2.py -src/waylay/services/registry/models/named_parameters_typeof_as_job_reference.py -src/waylay/services/registry/models/named_parameters_typeof_as_job_reference_job_status.py -src/waylay/services/registry/models/named_parameters_typeof_from_legacy.py -src/waylay/services/registry/models/named_parameters_typeof_from_legacy_documentation.py -src/waylay/services/registry/models/named_parameters_typeof_is_not_legacy.py -src/waylay/services/registry/models/named_plug_versions_query_v2.py -src/waylay/services/registry/models/named_versions_filter.py -src/waylay/services/registry/models/named_webscript_versions_query_v2.py +src/waylay/services/registry/models/notify_result.py src/waylay/services/registry/models/object.py -src/waylay/services/registry/models/openfaas_deploy_args.py -src/waylay/services/registry/models/openfaas_function_ref.py -src/waylay/services/registry/models/operation.py -src/waylay/services/registry/models/operation_status.py -src/waylay/services/registry/models/operation_status_error.py -src/waylay/services/registry/models/paging_query.py -src/waylay/services/registry/models/paging_response.py src/waylay/services/registry/models/parent_keys.py -src/waylay/services/registry/models/patch_interface_query.py -src/waylay/services/registry/models/patch_metadata_query.py -src/waylay/services/registry/models/patch_plug_request_v1.py src/waylay/services/registry/models/plug.py src/waylay/services/registry/models/plug1.py src/waylay/services/registry/models/plug2.py -src/waylay/services/registry/models/plug_delete_force_query.py -src/waylay/services/registry/models/plug_delete_query.py src/waylay/services/registry/models/plug_interface.py -src/waylay/services/registry/models/plug_listing_and_query_response.py -src/waylay/services/registry/models/plug_listing_response.py src/waylay/services/registry/models/plug_manifest.py src/waylay/services/registry/models/plug_meta.py src/waylay/services/registry/models/plug_property.py src/waylay/services/registry/models/plug_property_data_type.py src/waylay/services/registry/models/plug_property_format.py src/waylay/services/registry/models/plug_property_format_type.py -src/waylay/services/registry/models/plug_response.py src/waylay/services/registry/models/plug_response_v2.py src/waylay/services/registry/models/plug_type.py -src/waylay/services/registry/models/plug_type_query.py src/waylay/services/registry/models/plug_versions_response_v2.py src/waylay/services/registry/models/post_model_job_async_response_v2.py src/waylay/services/registry/models/post_model_job_sync_response_v2.py @@ -284,63 +161,40 @@ src/waylay/services/registry/models/post_plug_job_sync_response_v2.py src/waylay/services/registry/models/post_webscript_job_async_response_v2.py src/waylay/services/registry/models/post_webscript_job_sync_response_v2.py src/waylay/services/registry/models/provided_dependency.py -src/waylay/services/registry/models/publish_function_query.py src/waylay/services/registry/models/py.typed src/waylay/services/registry/models/queue_events.py -src/waylay/services/registry/models/rebuild_computed_response.py src/waylay/services/registry/models/rebuild_model_async_response_v2.py src/waylay/services/registry/models/rebuild_model_sync_response_v2.py src/waylay/services/registry/models/rebuild_plug_async_response_v2.py src/waylay/services/registry/models/rebuild_plug_sync_response_v2.py src/waylay/services/registry/models/rebuild_policy.py -src/waylay/services/registry/models/rebuild_query_params.py -src/waylay/services/registry/models/rebuild_query_v2.py -src/waylay/services/registry/models/rebuild_submitted_response.py src/waylay/services/registry/models/rebuild_webscript_async_response_v2.py src/waylay/services/registry/models/rebuild_webscript_sync_response_v2.py -src/waylay/services/registry/models/remove_function_query_v2.py -src/waylay/services/registry/models/remove_plug_query_v2.py +src/waylay/services/registry/models/registry_error_response.py src/waylay/services/registry/models/request_operation.py src/waylay/services/registry/models/resource_limits.py src/waylay/services/registry/models/root_page_response.py src/waylay/services/registry/models/runtime_attributes.py -src/waylay/services/registry/models/runtime_info.py -src/waylay/services/registry/models/runtime_name_query.py -src/waylay/services/registry/models/runtime_params.py -src/waylay/services/registry/models/runtime_query.py -src/waylay/services/registry/models/runtime_reference.py -src/waylay/services/registry/models/runtime_specification.py src/waylay/services/registry/models/runtime_summary.py -src/waylay/services/registry/models/runtime_summary_attrs.py src/waylay/services/registry/models/runtime_summary_response.py -src/waylay/services/registry/models/runtime_version_and_path_params.py src/waylay/services/registry/models/runtime_version_info.py -src/waylay/services/registry/models/runtime_version_params.py -src/waylay/services/registry/models/runtime_version_query.py src/waylay/services/registry/models/runtime_version_response.py -src/waylay/services/registry/models/runtime_version_specification.py -src/waylay/services/registry/models/runtime_version_status.py -src/waylay/services/registry/models/runtime_version_summary.py src/waylay/services/registry/models/scale.py src/waylay/services/registry/models/scale1.py src/waylay/services/registry/models/scale_args.py src/waylay/services/registry/models/scale_job_status.py src/waylay/services/registry/models/scale_type.py -src/waylay/services/registry/models/schema_by_id_params.py -src/waylay/services/registry/models/schema_params.py src/waylay/services/registry/models/semantic_version_range.py +src/waylay/services/registry/models/show_related_type.py src/waylay/services/registry/models/status.py src/waylay/services/registry/models/status_any.py +src/waylay/services/registry/models/status_exclude.py src/waylay/services/registry/models/status_filter.py src/waylay/services/registry/models/status_include.py -src/waylay/services/registry/models/status_response.py src/waylay/services/registry/models/stream_closing.py src/waylay/services/registry/models/stream_ready.py -src/waylay/services/registry/models/supported_events.py src/waylay/services/registry/models/tag.py -src/waylay/services/registry/models/tag_query.py src/waylay/services/registry/models/tags_filter.py -src/waylay/services/registry/models/tags_query.py src/waylay/services/registry/models/timestamp_absolute.py src/waylay/services/registry/models/timestamp_age.py src/waylay/services/registry/models/timestamp_spec.py @@ -352,27 +206,17 @@ src/waylay/services/registry/models/undeploy_result.py src/waylay/services/registry/models/undeploy_submitted_response_v2.py src/waylay/services/registry/models/undeploy_type.py src/waylay/services/registry/models/undeployed_response_v2.py -src/waylay/services/registry/models/unhealthy_invokable_webscript_error.py -src/waylay/services/registry/models/update_comment.py -src/waylay/services/registry/models/update_draft_query.py -src/waylay/services/registry/models/update_metadata_request_v1.py src/waylay/services/registry/models/update_metadata_request_v2.py src/waylay/services/registry/models/update_record.py -src/waylay/services/registry/models/user_plug_meta.py src/waylay/services/registry/models/verify.py src/waylay/services/registry/models/verify1.py src/waylay/services/registry/models/verify_args.py src/waylay/services/registry/models/verify_job_status.py src/waylay/services/registry/models/verify_model_sync_response_v2.py src/waylay/services/registry/models/verify_plug_sync_response_v2.py -src/waylay/services/registry/models/verify_query_v1.py src/waylay/services/registry/models/verify_result.py src/waylay/services/registry/models/verify_type.py src/waylay/services/registry/models/verify_webscript_sync_response_v2.py -src/waylay/services/registry/models/version_includes.py -src/waylay/services/registry/models/versions_query.py -src/waylay/services/registry/models/versions_query_v2.py -src/waylay/services/registry/models/versions_response_v2.py src/waylay/services/registry/models/waiting_children_event_sse.py src/waylay/services/registry/models/waiting_children_event_sse_event.py src/waylay/services/registry/models/waiting_event_data.py @@ -381,24 +225,16 @@ src/waylay/services/registry/models/waiting_event_sse_event.py src/waylay/services/registry/models/webscript.py src/waylay/services/registry/models/webscript1.py src/waylay/services/registry/models/webscript2.py -src/waylay/services/registry/models/webscript_latest_version_query_v2.py -src/waylay/services/registry/models/webscript_latest_versions_query_v1.py -src/waylay/services/registry/models/webscript_latest_versions_query_v2.py src/waylay/services/registry/models/webscript_manifest.py -src/waylay/services/registry/models/webscript_response.py src/waylay/services/registry/models/webscript_response_v2.py src/waylay/services/registry/models/webscript_response_with_invoke_link_v2.py src/waylay/services/registry/models/webscript_versions_response_v2.py -src/waylay/services/registry/models/with_asset_hal_link.py -src/waylay/services/registry/models/with_entity_attributes.py -src/waylay/services/registry/models/with_limit.py -src/waylay/services/registry/models/with_paging.py src/waylay/services/registry/queries/__init__.py -src/waylay/services/registry/queries/default_api.py +src/waylay/services/registry/queries/about_api.py src/waylay/services/registry/queries/jobs_api.py -src/waylay/services/registry/queries/model_functions_api.py -src/waylay/services/registry/queries/plug_functions_api.py +src/waylay/services/registry/queries/models_api.py +src/waylay/services/registry/queries/plugs_api.py src/waylay/services/registry/queries/py.typed src/waylay/services/registry/queries/runtimes_api.py src/waylay/services/registry/queries/schemas_api.py -src/waylay/services/registry/queries/webscript_functions_api.py +src/waylay/services/registry/queries/webscripts_api.py diff --git a/waylay-sdk-registry-types/README.md b/waylay-sdk-registry-types/README.md index 64dfcdf9..23f543b6 100644 --- a/waylay-sdk-registry-types/README.md +++ b/waylay-sdk-registry-types/README.md @@ -2,7 +2,7 @@ V2 API to build and deploy Waylay functions (plugs, webscripts, BYOML models). This Python package is automatically generated based on the -Waylay Registry OpenAPI specification (API version: 2.12.4) +Waylay Registry OpenAPI specification (API version: 2.13.0) For more information, please visit [the openapi specification](https://docs.waylay.io/openapi/public/redocly/registry.html). It is considered an extension of the waylay-sdk-registry package, and it consists of the typed model classes for all path params, query params, body params and responses for each of the api methods in `waylay-sdk-registry`. @@ -32,22 +32,16 @@ from waylay.sdk.api.api_exceptions import ApiError waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed -from waylay.services.registry.models.function_type import FunctionType -from waylay.services.registry.models.job_state_result import JobStateResult -from waylay.services.registry.models.job_type_schema import JobTypeSchema -from waylay.services.registry.models.jobs_response import JobsResponse +from waylay.services.registry.models.root_page_response import RootPageResponse try: - # List Jobs - # calls `GET /registry/v2/jobs/` - api_response = await waylay_client.registry.jobs.list( - # query parameters: - query = { - }, + # Get Service Status + # calls `GET /registry/v2/` + api_response = await waylay_client.registry.about.get( ) - print("The response of registry.jobs.list:\n") + print("The response of registry.about.get:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.jobs.list: %s\n" % e) + print("Exception when calling registry.about.get: %s\n" % e) ``` diff --git a/waylay-sdk-registry-types/pyproject.toml b/waylay-sdk-registry-types/pyproject.toml index a2249172..23c3db6c 100644 --- a/waylay-sdk-registry-types/pyproject.toml +++ b/waylay-sdk-registry-types/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "waylay-sdk-registry-types" -version = "2.12.4.20240423" +version = "2.13.0.20240430" description = "Waylay Function Registry Types " authors = [ { name = "Waylay", email = "info@waylay.io"} @@ -13,7 +13,7 @@ keywords = ["Waylay Function Registry" , "Types"] requires-python = ">= 3.9" dependencies = [ "waylay-sdk-core ~= 0.2.1", - "waylay-sdk-registry == 2.12.4.20240423", + "waylay-sdk-registry == 2.13.0.20240430", "pydantic ~= 2.6", "typing-extensions ~= 4.10", "eval-type-backport ~= 0.1.3; python_version < '3.10'", diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/__init__.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/__init__.py index 52b6dad1..cbf291f2 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/__init__.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/__init__.py @@ -3,7 +3,7 @@ This code was generated from the OpenAPI documentation of 'Waylay Function Registry' -version: 2.12.4 +version: 2.13.0 V2 API to build and deploy Waylay functions (plugs, webscripts, BYOML models). @@ -12,14 +12,20 @@ Do not edit the class manually. """ -__version__ = "2.12.4.20240423" +__version__ = "2.13.0.20240430" # import models into model package from .active_event_data import ActiveEventData from .active_event_sse import ActiveEventSSE from .active_event_sse_event import ActiveEventSSEEvent +from .alt_embedded_version_i_kfserving_response_v2 import ( + AltEmbeddedVersionIKfservingResponseV2, +) +from .alt_embedded_version_i_plug_response_v2 import AltEmbeddedVersionIPlugResponseV2 +from .alt_embedded_version_i_webscript_response_with_invoke_link_v2 import ( + AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2, +) from .alt_version_hal_link import AltVersionHALLink -from .any_function_response import AnyFunctionResponse from .any_job_for_function import AnyJobForFunction from .any_job_result import AnyJobResult from .any_job_status import AnyJobStatus @@ -28,17 +34,10 @@ from .asset_condition import AssetCondition from .asset_condition_content_type import AssetConditionContentType from .asset_condition_pattern import AssetConditionPattern -from .asset_path_params_v2 import AssetPathParamsV2 from .asset_role import AssetRole -from .asset_summary import AssetSummary from .asset_summary_with_hal_link import AssetSummaryWithHALLink from .asset_summary_with_hal_link_links import AssetSummaryWithHALLinkLinks from .assets_conditions import AssetsConditions -from .async_deploy_query import AsyncDeployQuery -from .async_deploy_query_v1 import AsyncDeployQueryV1 -from .async_query_default_false import AsyncQueryDefaultFalse -from .async_query_default_true import AsyncQueryDefaultTrue -from .async_verify_query import AsyncVerifyQuery from .batch import Batch from .batch_args import BatchArgs from .batch_job_status import BatchJobStatus @@ -56,12 +55,8 @@ from .completed_event_data import CompletedEventData from .completed_event_sse import CompletedEventSSE from .completed_event_sse_event import CompletedEventSSEEvent -from .content_query_v2 import ContentQueryV2 from .content_validation_listing import ContentValidationListing -from .create_function_query_v2 import CreateFunctionQueryV2 -from .create_kf_serving_async_response import CreateKFServingAsyncResponse -from .create_plug_async_response import CreatePlugAsyncResponse -from .create_webscript_async_response import CreateWebscriptAsyncResponse +from .create_webscripts_copy_parameter import CreateWebscriptsCopyParameter from .delayed_event_data import DelayedEventData from .delayed_event_sse import DelayedEventSSE from .delayed_event_sse_event import DelayedEventSSEEvent @@ -69,78 +64,48 @@ from .deploy1 import Deploy1 from .deploy_args import DeployArgs from .deploy_args_deploy_spec_overrides import DeployArgsDeploySpecOverrides -from .deploy_attributes_filter import DeployAttributesFilter from .deploy_job_status import DeployJobStatus from .deploy_result import DeployResult from .deploy_spec import DeploySpec from .deploy_spec_openfaas_spec import DeploySpecOpenfaasSpec from .deploy_type import DeployType from .deprecate_previous_policy import DeprecatePreviousPolicy -from .deprecate_previous_query import DeprecatePreviousQuery -from .deprecated_draft_filter import DeprecatedDraftFilter from .documentation import Documentation from .documentation_property import DocumentationProperty -from .dry_run_query import DryRunQuery -from .entity_response import EntityResponse -from .error_and_status_response import ErrorAndStatusResponse -from .error_response import ErrorResponse +from .entity_with_links_i_kfserving_response_v2 import ( + EntityWithLinksIKfservingResponseV2, +) +from .entity_with_links_i_plug_response_v2 import EntityWithLinksIPlugResponseV2 +from .entity_with_links_i_webscript_response_with_invoke_link_v2 import ( + EntityWithLinksIWebscriptResponseWithInvokeLinkV2, +) from .event_ack import EventAck from .event_close import EventClose from .event_keep_alive import EventKeepAlive -from .event_sse import EventSSE -from .event_type_sse import EventTypeSSE from .event_with_close_sse import EventWithCloseSSE +from .example_reference import ExampleReference from .exposed_openfaas_deploy_spec import ExposedOpenfaasDeploySpec from .failed_event_data import FailedEventData from .failed_event_sse import FailedEventSSE from .failed_event_sse_event import FailedEventSSEEvent from .failure_reason import FailureReason from .file_upload import FileUpload -from .force_delete_query_v1 import ForceDeleteQueryV1 -from .function_delete_query import FunctionDeleteQuery -from .function_deploy_overrides import FunctionDeployOverrides from .function_deploy_overrides_type import FunctionDeployOverridesType -from .function_entity_query import FunctionEntityQuery -from .function_job_args import FunctionJobArgs -from .function_manifest import FunctionManifest from .function_meta import FunctionMeta -from .function_name_version import FunctionNameVersion from .function_ref import FunctionRef -from .function_spec import FunctionSpec from .function_type import FunctionType -from .function_version_query import FunctionVersionQuery -from .get_content_params_v2 import GetContentParamsV2 -from .get_invokable_webscript_query import GetInvokableWebscriptQuery from .get_model_response_v2 import GetModelResponseV2 from .get_plug_response_v2 import GetPlugResponseV2 from .get_plug_response_v2_links import GetPlugResponseV2Links from .get_plug_response_v2_links_draft import GetPlugResponseV2LinksDraft from .get_plug_response_v2_links_published import GetPlugResponseV2LinksPublished -from .get_runtime_by_name_and_version_query import GetRuntimeByNameAndVersionQuery -from .get_runtime_by_name_query import GetRuntimeByNameQuery -from .get_runtime_example_query import GetRuntimeExampleQuery -from .get_runtime_versions_query import GetRuntimeVersionsQuery from .get_webscript_response_v2 import GetWebscriptResponseV2 from .get_webscript_response_v2_links import GetWebscriptResponseV2Links from .hal_link import HALLink -from .invokable_webscript_response import InvokableWebscriptResponse -from .invokable_webscript_response_entity import InvokableWebscriptResponseEntity -from .invokable_webscript_response_entity_webscript import ( - InvokableWebscriptResponseEntityWebscript, -) from .invoke_hal_link import InvokeHALLink -from .invoke_internal_hal_link import InvokeInternalHALLink from .job_and_function_hal_link import JobAndFunctionHALLink from .job_cause import JobCause from .job_causes import JobCauses -from .job_event_payload_active_event_data import JobEventPayloadActiveEventData -from .job_event_payload_completed_event_data import JobEventPayloadCompletedEventData -from .job_event_payload_delayed_event_data import JobEventPayloadDelayedEventData -from .job_event_payload_failed_event_data import JobEventPayloadFailedEventData -from .job_event_payload_waiting_children_event_data import ( - JobEventPayloadWaitingChildrenEventData, -) -from .job_event_payload_waiting_event_data import JobEventPayloadWaitingEventData from .job_event_response_active_event_data import JobEventResponseActiveEventData from .job_event_response_completed_event_data import JobEventResponseCompletedEventData from .job_event_response_delayed_event_data import JobEventResponseDelayedEventData @@ -151,12 +116,9 @@ from .job_event_response_waiting_event_data import JobEventResponseWaitingEventData from .job_event_sse import JobEventSSE from .job_events_and_function_hal_link import JobEventsAndFunctionHALLink -from .job_events_filter_query import JobEventsFilterQuery from .job_events_hal_link import JobEventsHALLink from .job_hal_links import JobHALLinks -from .job_query import JobQuery from .job_reference import JobReference -from .job_reference_params import JobReferenceParams from .job_response import JobResponse from .job_state import JobState from .job_state_active import JobStateActive @@ -172,11 +134,11 @@ from .job_status_and_entity_hal_links import JobStatusAndEntityHALLinks from .job_status_hal_link import JobStatusHALLink from .job_status_progress import JobStatusProgress -from .job_submitted_response import JobSubmittedResponse from .job_type import JobType from .job_type_batch import JobTypeBatch from .job_type_build import JobTypeBuild from .job_type_deploy import JobTypeDeploy +from .job_type_notify import JobTypeNotify from .job_type_scale import JobTypeScale from .job_type_schema import JobTypeSchema from .job_type_undeploy import JobTypeUndeploy @@ -187,132 +149,33 @@ from .jobs_for_plug_response_v2_links import JobsForPlugResponseV2Links from .jobs_for_webscript_response_v2 import JobsForWebscriptResponseV2 from .jobs_for_webscript_response_v2_links import JobsForWebscriptResponseV2Links -from .jobs_hal_link import JobsHALLink from .jobs_response import JobsResponse from .keep_alive_event_sse import KeepAliveEventSSE -from .kf_serving_delete_multiple_response import KFServingDeleteMultipleResponse -from .kf_serving_delete_multiple_with_job_response import ( - KFServingDeleteMultipleWithJobResponse, -) -from .kf_serving_delete_query_v1 import KFServingDeleteQueryV1 -from .kf_serving_delete_query_v2 import KFServingDeleteQueryV2 -from .kf_serving_delete_response import KFServingDeleteResponse -from .kf_serving_delete_with_job_response import KFServingDeleteWithJobResponse -from .kf_serving_latest_version_query_v2 import KFServingLatestVersionQueryV2 -from .kf_serving_latest_versions_query_v1 import KFServingLatestVersionsQueryV1 -from .kf_serving_latest_versions_query_v2 import KFServingLatestVersionsQueryV2 from .kf_serving_manifest import KFServingManifest -from .kf_serving_models_response import KFServingModelsResponse -from .kf_serving_response import KFServingResponse -from .kf_serving_versions_query_v1 import KFServingVersionsQueryV1 from .kfserving_response_v2 import KfservingResponseV2 from .language_release import LanguageRelease -from .latest_function_versions_query import LatestFunctionVersionsQuery -from .latest_functions_query import LatestFunctionsQuery from .latest_models_response_v2 import LatestModelsResponseV2 -from .latest_models_response_v2_entities_inner import ( - LatestModelsResponseV2EntitiesInner, -) -from .latest_plug_query import LatestPlugQuery -from .latest_plug_version_query_v2 import LatestPlugVersionQueryV2 -from .latest_plug_versions_query import LatestPlugVersionsQuery -from .latest_plug_versions_query_v2 import LatestPlugVersionsQueryV2 -from .latest_plugs_query import LatestPlugsQuery from .latest_plugs_response_v2 import LatestPlugsResponseV2 -from .latest_plugs_response_v2_entities_inner import LatestPlugsResponseV2EntitiesInner from .latest_version_level import LatestVersionLevel from .latest_webscripts_response_v2 import LatestWebscriptsResponseV2 -from .latest_webscripts_response_v2_entities_inner import ( - LatestWebscriptsResponseV2EntitiesInner, -) -from .legacy_configuration_object import LegacyConfigurationObject -from .legacy_configuration_object_format import LegacyConfigurationObjectFormat -from .legacy_configuration_response_object import LegacyConfigurationResponseObject -from .legacy_create_debug_response import LegacyCreateDebugResponse -from .legacy_debug_plug_manifest import LegacyDebugPlugManifest -from .legacy_debug_plug_request import LegacyDebugPlugRequest -from .legacy_documentation import LegacyDocumentation -from .legacy_documentation_request import LegacyDocumentationRequest -from .legacy_function_meta import LegacyFunctionMeta -from .legacy_plug_create_query import LegacyPlugCreateQuery -from .legacy_plug_create_request import LegacyPlugCreateRequest -from .legacy_plug_create_response import LegacyPlugCreateResponse -from .legacy_plug_meta_request import LegacyPlugMetaRequest -from .legacy_plug_query import LegacyPlugQuery -from .legacy_plug_request import LegacyPlugRequest -from .legacy_plug_request_metadata import LegacyPlugRequestMetadata -from .legacy_plug_request_metadata_documentation import ( - LegacyPlugRequestMetadataDocumentation, -) -from .legacy_plug_request_metadata_documentation_any_of import ( - LegacyPlugRequestMetadataDocumentationAnyOf, -) -from .legacy_plug_request_metadata_raw_data_inner import ( - LegacyPlugRequestMetadataRawDataInner, -) -from .legacy_plug_response import LegacyPlugResponse -from .legacy_plug_response_metadata import LegacyPlugResponseMetadata -from .legacy_plug_script_meta import LegacyPlugScriptMeta -from .legacy_plug_script_meta_raw_data_inner import LegacyPlugScriptMetaRawDataInner -from .legacy_plug_script_response import LegacyPlugScriptResponse -from .legacy_required_properties_inner import LegacyRequiredPropertiesInner -from .legacy_required_property_object import LegacyRequiredPropertyObject -from .limit_query import LimitQuery -from .media_type import MediaType -from .message_and_status_response import MessageAndStatusResponse -from .message_response import MessageResponse from .model import Model from .model1 import Model1 from .model2 import Model2 from .model_versions_response_v2 import ModelVersionsResponseV2 -from .multipart_file_upload import MultipartFileUpload -from .name import Name -from .name_and_version import NameAndVersion -from .named_function_versions_query import NamedFunctionVersionsQuery -from .named_kf_serving_versions_query_v2 import NamedKFServingVersionsQueryV2 -from .named_parameters_typeof_as_job_reference import ( - NamedParametersTypeofAsJobReference, -) -from .named_parameters_typeof_as_job_reference_job_status import ( - NamedParametersTypeofAsJobReferenceJobStatus, -) -from .named_parameters_typeof_from_legacy import NamedParametersTypeofFromLegacy -from .named_parameters_typeof_from_legacy_documentation import ( - NamedParametersTypeofFromLegacyDocumentation, -) -from .named_parameters_typeof_is_not_legacy import NamedParametersTypeofIsNotLegacy -from .named_plug_versions_query_v2 import NamedPlugVersionsQueryV2 -from .named_versions_filter import NamedVersionsFilter -from .named_webscript_versions_query_v2 import NamedWebscriptVersionsQueryV2 -from .openfaas_deploy_args import OpenfaasDeployArgs -from .openfaas_function_ref import OpenfaasFunctionRef -from .operation import Operation -from .operation_status import OperationStatus -from .operation_status_error import OperationStatusError -from .paging_query import PagingQuery -from .paging_response import PagingResponse +from .notify_result import NotifyResult from .parent_keys import ParentKeys -from .patch_interface_query import PatchInterfaceQuery -from .patch_metadata_query import PatchMetadataQuery -from .patch_plug_request_v1 import PatchPlugRequestV1 from .plug import Plug from .plug1 import Plug1 from .plug2 import Plug2 -from .plug_delete_force_query import PlugDeleteForceQuery -from .plug_delete_query import PlugDeleteQuery from .plug_interface import PlugInterface -from .plug_listing_and_query_response import PlugListingAndQueryResponse -from .plug_listing_response import PlugListingResponse from .plug_manifest import PlugManifest from .plug_meta import PlugMeta from .plug_property import PlugProperty from .plug_property_data_type import PlugPropertyDataType from .plug_property_format import PlugPropertyFormat from .plug_property_format_type import PlugPropertyFormatType -from .plug_response import PlugResponse from .plug_response_v2 import PlugResponseV2 from .plug_type import PlugType -from .plug_type_query import PlugTypeQuery from .plug_versions_response_v2 import PlugVersionsResponseV2 from .post_model_job_async_response_v2 import PostModelJobAsyncResponseV2 from .post_model_job_sync_response_v2 import PostModelJobSyncResponseV2 @@ -321,62 +184,39 @@ from .post_webscript_job_async_response_v2 import PostWebscriptJobAsyncResponseV2 from .post_webscript_job_sync_response_v2 import PostWebscriptJobSyncResponseV2 from .provided_dependency import ProvidedDependency -from .publish_function_query import PublishFunctionQuery from .queue_events import QueueEvents -from .rebuild_computed_response import RebuildComputedResponse from .rebuild_model_async_response_v2 import RebuildModelAsyncResponseV2 from .rebuild_model_sync_response_v2 import RebuildModelSyncResponseV2 from .rebuild_plug_async_response_v2 import RebuildPlugAsyncResponseV2 from .rebuild_plug_sync_response_v2 import RebuildPlugSyncResponseV2 from .rebuild_policy import RebuildPolicy -from .rebuild_query_params import RebuildQueryParams -from .rebuild_query_v2 import RebuildQueryV2 -from .rebuild_submitted_response import RebuildSubmittedResponse from .rebuild_webscript_async_response_v2 import RebuildWebscriptAsyncResponseV2 from .rebuild_webscript_sync_response_v2 import RebuildWebscriptSyncResponseV2 -from .remove_function_query_v2 import RemoveFunctionQueryV2 -from .remove_plug_query_v2 import RemovePlugQueryV2 +from .registry_error_response import RegistryErrorResponse from .request_operation import RequestOperation from .resource_limits import ResourceLimits from .root_page_response import RootPageResponse from .runtime_attributes import RuntimeAttributes -from .runtime_info import RuntimeInfo -from .runtime_name_query import RuntimeNameQuery -from .runtime_params import RuntimeParams -from .runtime_query import RuntimeQuery -from .runtime_reference import RuntimeReference -from .runtime_specification import RuntimeSpecification from .runtime_summary import RuntimeSummary -from .runtime_summary_attrs import RuntimeSummaryAttrs from .runtime_summary_response import RuntimeSummaryResponse -from .runtime_version_and_path_params import RuntimeVersionAndPathParams from .runtime_version_info import RuntimeVersionInfo -from .runtime_version_params import RuntimeVersionParams -from .runtime_version_query import RuntimeVersionQuery from .runtime_version_response import RuntimeVersionResponse -from .runtime_version_specification import RuntimeVersionSpecification -from .runtime_version_status import RuntimeVersionStatus -from .runtime_version_summary import RuntimeVersionSummary from .scale import Scale from .scale1 import Scale1 from .scale_args import ScaleArgs from .scale_job_status import ScaleJobStatus from .scale_type import ScaleType -from .schema_by_id_params import SchemaByIdParams -from .schema_params import SchemaParams from .semantic_version_range import SemanticVersionRange +from .show_related_type import ShowRelatedType from .status import Status from .status_any import StatusAny +from .status_exclude import StatusExclude from .status_filter import StatusFilter from .status_include import StatusInclude -from .status_response import StatusResponse from .stream_closing import StreamClosing from .stream_ready import StreamReady -from .supported_events import SupportedEvents from .tag import Tag -from .tag_query import TagQuery from .tags_filter import TagsFilter -from .tags_query import TagsQuery from .timestamp_absolute import TimestampAbsolute from .timestamp_age import TimestampAge from .timestamp_spec import TimestampSpec @@ -388,27 +228,17 @@ from .undeploy_submitted_response_v2 import UndeploySubmittedResponseV2 from .undeploy_type import UndeployType from .undeployed_response_v2 import UndeployedResponseV2 -from .unhealthy_invokable_webscript_error import UnhealthyInvokableWebscriptError -from .update_comment import UpdateComment -from .update_draft_query import UpdateDraftQuery -from .update_metadata_request_v1 import UpdateMetadataRequestV1 from .update_metadata_request_v2 import UpdateMetadataRequestV2 from .update_record import UpdateRecord -from .user_plug_meta import UserPlugMeta from .verify import Verify from .verify1 import Verify1 from .verify_args import VerifyArgs from .verify_job_status import VerifyJobStatus from .verify_model_sync_response_v2 import VerifyModelSyncResponseV2 from .verify_plug_sync_response_v2 import VerifyPlugSyncResponseV2 -from .verify_query_v1 import VerifyQueryV1 from .verify_result import VerifyResult from .verify_type import VerifyType from .verify_webscript_sync_response_v2 import VerifyWebscriptSyncResponseV2 -from .version_includes import VersionIncludes -from .versions_query import VersionsQuery -from .versions_query_v2 import VersionsQueryV2 -from .versions_response_v2 import VersionsResponseV2 from .waiting_children_event_sse import WaitingChildrenEventSSE from .waiting_children_event_sse_event import WaitingChildrenEventSSEEvent from .waiting_event_data import WaitingEventData @@ -417,26 +247,20 @@ from .webscript import Webscript from .webscript1 import Webscript1 from .webscript2 import Webscript2 -from .webscript_latest_version_query_v2 import WebscriptLatestVersionQueryV2 -from .webscript_latest_versions_query_v1 import WebscriptLatestVersionsQueryV1 -from .webscript_latest_versions_query_v2 import WebscriptLatestVersionsQueryV2 from .webscript_manifest import WebscriptManifest -from .webscript_response import WebscriptResponse from .webscript_response_v2 import WebscriptResponseV2 from .webscript_response_with_invoke_link_v2 import WebscriptResponseWithInvokeLinkV2 from .webscript_versions_response_v2 import WebscriptVersionsResponseV2 -from .with_asset_hal_link import WithAssetHALLink -from .with_entity_attributes import WithEntityAttributes -from .with_limit import WithLimit -from .with_paging import WithPaging __all__ = [ "__version__", "ActiveEventData", "ActiveEventSSE", "ActiveEventSSEEvent", + "AltEmbeddedVersionIKfservingResponseV2", + "AltEmbeddedVersionIPlugResponseV2", + "AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2", "AltVersionHALLink", - "AnyFunctionResponse", "AnyJobForFunction", "AnyJobResult", "AnyJobStatus", @@ -445,17 +269,10 @@ "AssetCondition", "AssetConditionContentType", "AssetConditionPattern", - "AssetPathParamsV2", "AssetRole", - "AssetSummary", "AssetSummaryWithHALLink", "AssetSummaryWithHALLinkLinks", "AssetsConditions", - "AsyncDeployQuery", - "AsyncDeployQueryV1", - "AsyncQueryDefaultFalse", - "AsyncQueryDefaultTrue", - "AsyncVerifyQuery", "Batch", "BatchArgs", "BatchJobStatus", @@ -473,12 +290,8 @@ "CompletedEventData", "CompletedEventSSE", "CompletedEventSSEEvent", - "ContentQueryV2", "ContentValidationListing", - "CreateFunctionQueryV2", - "CreateKFServingAsyncResponse", - "CreatePlugAsyncResponse", - "CreateWebscriptAsyncResponse", + "CreateWebscriptsCopyParameter", "DelayedEventData", "DelayedEventSSE", "DelayedEventSSEEvent", @@ -486,74 +299,44 @@ "Deploy1", "DeployArgs", "DeployArgsDeploySpecOverrides", - "DeployAttributesFilter", "DeployJobStatus", "DeployResult", "DeploySpec", "DeploySpecOpenfaasSpec", "DeployType", "DeprecatePreviousPolicy", - "DeprecatePreviousQuery", - "DeprecatedDraftFilter", "Documentation", "DocumentationProperty", - "DryRunQuery", - "EntityResponse", - "ErrorAndStatusResponse", - "ErrorResponse", + "EntityWithLinksIKfservingResponseV2", + "EntityWithLinksIPlugResponseV2", + "EntityWithLinksIWebscriptResponseWithInvokeLinkV2", "EventAck", "EventClose", "EventKeepAlive", - "EventSSE", - "EventTypeSSE", "EventWithCloseSSE", + "ExampleReference", "ExposedOpenfaasDeploySpec", "FailedEventData", "FailedEventSSE", "FailedEventSSEEvent", "FailureReason", "FileUpload", - "ForceDeleteQueryV1", - "FunctionDeleteQuery", - "FunctionDeployOverrides", "FunctionDeployOverridesType", - "FunctionEntityQuery", - "FunctionJobArgs", - "FunctionManifest", "FunctionMeta", - "FunctionNameVersion", "FunctionRef", - "FunctionSpec", "FunctionType", - "FunctionVersionQuery", - "GetContentParamsV2", - "GetInvokableWebscriptQuery", "GetModelResponseV2", "GetPlugResponseV2", "GetPlugResponseV2Links", "GetPlugResponseV2LinksDraft", "GetPlugResponseV2LinksPublished", - "GetRuntimeByNameAndVersionQuery", - "GetRuntimeByNameQuery", - "GetRuntimeExampleQuery", - "GetRuntimeVersionsQuery", "GetWebscriptResponseV2", "GetWebscriptResponseV2Links", "HALLink", - "InvokableWebscriptResponse", - "InvokableWebscriptResponseEntity", - "InvokableWebscriptResponseEntityWebscript", "InvokeHALLink", - "InvokeInternalHALLink", "JobAndFunctionHALLink", "JobCause", "JobCauses", - "JobEventPayloadActiveEventData", - "JobEventPayloadCompletedEventData", - "JobEventPayloadDelayedEventData", - "JobEventPayloadFailedEventData", - "JobEventPayloadWaitingChildrenEventData", - "JobEventPayloadWaitingEventData", "JobEventResponseActiveEventData", "JobEventResponseCompletedEventData", "JobEventResponseDelayedEventData", @@ -562,12 +345,9 @@ "JobEventResponseWaitingEventData", "JobEventSSE", "JobEventsAndFunctionHALLink", - "JobEventsFilterQuery", "JobEventsHALLink", "JobHALLinks", - "JobQuery", "JobReference", - "JobReferenceParams", "JobResponse", "JobState", "JobStateActive", @@ -583,11 +363,11 @@ "JobStatusAndEntityHALLinks", "JobStatusHALLink", "JobStatusProgress", - "JobSubmittedResponse", "JobType", "JobTypeBatch", "JobTypeBuild", "JobTypeDeploy", + "JobTypeNotify", "JobTypeScale", "JobTypeSchema", "JobTypeUndeploy", @@ -598,114 +378,33 @@ "JobsForPlugResponseV2Links", "JobsForWebscriptResponseV2", "JobsForWebscriptResponseV2Links", - "JobsHALLink", "JobsResponse", - "KFServingDeleteMultipleResponse", - "KFServingDeleteMultipleWithJobResponse", - "KFServingDeleteQueryV1", - "KFServingDeleteQueryV2", - "KFServingDeleteResponse", - "KFServingDeleteWithJobResponse", - "KFServingLatestVersionQueryV2", - "KFServingLatestVersionsQueryV1", - "KFServingLatestVersionsQueryV2", "KFServingManifest", - "KFServingModelsResponse", - "KFServingResponse", - "KFServingVersionsQueryV1", "KeepAliveEventSSE", "KfservingResponseV2", "LanguageRelease", - "LatestFunctionVersionsQuery", - "LatestFunctionsQuery", "LatestModelsResponseV2", - "LatestModelsResponseV2EntitiesInner", - "LatestPlugQuery", - "LatestPlugVersionQueryV2", - "LatestPlugVersionsQuery", - "LatestPlugVersionsQueryV2", - "LatestPlugsQuery", "LatestPlugsResponseV2", - "LatestPlugsResponseV2EntitiesInner", "LatestVersionLevel", "LatestWebscriptsResponseV2", - "LatestWebscriptsResponseV2EntitiesInner", - "LegacyConfigurationObject", - "LegacyConfigurationObjectFormat", - "LegacyConfigurationResponseObject", - "LegacyCreateDebugResponse", - "LegacyDebugPlugManifest", - "LegacyDebugPlugRequest", - "LegacyDocumentation", - "LegacyDocumentationRequest", - "LegacyFunctionMeta", - "LegacyPlugCreateQuery", - "LegacyPlugCreateRequest", - "LegacyPlugCreateResponse", - "LegacyPlugMetaRequest", - "LegacyPlugQuery", - "LegacyPlugRequest", - "LegacyPlugRequestMetadata", - "LegacyPlugRequestMetadataDocumentation", - "LegacyPlugRequestMetadataDocumentationAnyOf", - "LegacyPlugRequestMetadataRawDataInner", - "LegacyPlugResponse", - "LegacyPlugResponseMetadata", - "LegacyPlugScriptMeta", - "LegacyPlugScriptMetaRawDataInner", - "LegacyPlugScriptResponse", - "LegacyRequiredPropertiesInner", - "LegacyRequiredPropertyObject", - "LimitQuery", - "MediaType", - "MessageAndStatusResponse", - "MessageResponse", "Model", "Model1", "Model2", "ModelVersionsResponseV2", - "MultipartFileUpload", - "Name", - "NameAndVersion", - "NamedFunctionVersionsQuery", - "NamedKFServingVersionsQueryV2", - "NamedParametersTypeofAsJobReference", - "NamedParametersTypeofAsJobReferenceJobStatus", - "NamedParametersTypeofFromLegacy", - "NamedParametersTypeofFromLegacyDocumentation", - "NamedParametersTypeofIsNotLegacy", - "NamedPlugVersionsQueryV2", - "NamedVersionsFilter", - "NamedWebscriptVersionsQueryV2", - "OpenfaasDeployArgs", - "OpenfaasFunctionRef", - "Operation", - "OperationStatus", - "OperationStatusError", - "PagingQuery", - "PagingResponse", + "NotifyResult", "ParentKeys", - "PatchInterfaceQuery", - "PatchMetadataQuery", - "PatchPlugRequestV1", "Plug", "Plug1", "Plug2", - "PlugDeleteForceQuery", - "PlugDeleteQuery", "PlugInterface", - "PlugListingAndQueryResponse", - "PlugListingResponse", "PlugManifest", "PlugMeta", "PlugProperty", "PlugPropertyDataType", "PlugPropertyFormat", "PlugPropertyFormatType", - "PlugResponse", "PlugResponseV2", "PlugType", - "PlugTypeQuery", "PlugVersionsResponseV2", "PostModelJobAsyncResponseV2", "PostModelJobSyncResponseV2", @@ -714,62 +413,39 @@ "PostWebscriptJobAsyncResponseV2", "PostWebscriptJobSyncResponseV2", "ProvidedDependency", - "PublishFunctionQuery", "QueueEvents", - "RebuildComputedResponse", "RebuildModelAsyncResponseV2", "RebuildModelSyncResponseV2", "RebuildPlugAsyncResponseV2", "RebuildPlugSyncResponseV2", "RebuildPolicy", - "RebuildQueryParams", - "RebuildQueryV2", - "RebuildSubmittedResponse", "RebuildWebscriptAsyncResponseV2", "RebuildWebscriptSyncResponseV2", - "RemoveFunctionQueryV2", - "RemovePlugQueryV2", + "RegistryErrorResponse", "RequestOperation", "ResourceLimits", "RootPageResponse", "RuntimeAttributes", - "RuntimeInfo", - "RuntimeNameQuery", - "RuntimeParams", - "RuntimeQuery", - "RuntimeReference", - "RuntimeSpecification", "RuntimeSummary", - "RuntimeSummaryAttrs", "RuntimeSummaryResponse", - "RuntimeVersionAndPathParams", "RuntimeVersionInfo", - "RuntimeVersionParams", - "RuntimeVersionQuery", "RuntimeVersionResponse", - "RuntimeVersionSpecification", - "RuntimeVersionStatus", - "RuntimeVersionSummary", "Scale", "Scale1", "ScaleArgs", "ScaleJobStatus", "ScaleType", - "SchemaByIdParams", - "SchemaParams", "SemanticVersionRange", + "ShowRelatedType", "Status", "StatusAny", + "StatusExclude", "StatusFilter", "StatusInclude", - "StatusResponse", "StreamClosing", "StreamReady", - "SupportedEvents", "Tag", - "TagQuery", "TagsFilter", - "TagsQuery", "TimestampAbsolute", "TimestampAge", "TimestampSpec", @@ -781,27 +457,17 @@ "UndeploySubmittedResponseV2", "UndeployType", "UndeployedResponseV2", - "UnhealthyInvokableWebscriptError", - "UpdateComment", - "UpdateDraftQuery", - "UpdateMetadataRequestV1", "UpdateMetadataRequestV2", "UpdateRecord", - "UserPlugMeta", "Verify", "Verify1", "VerifyArgs", "VerifyJobStatus", "VerifyModelSyncResponseV2", "VerifyPlugSyncResponseV2", - "VerifyQueryV1", "VerifyResult", "VerifyType", "VerifyWebscriptSyncResponseV2", - "VersionIncludes", - "VersionsQuery", - "VersionsQueryV2", - "VersionsResponseV2", "WaitingChildrenEventSSE", "WaitingChildrenEventSSEEvent", "WaitingEventData", @@ -810,16 +476,8 @@ "Webscript", "Webscript1", "Webscript2", - "WebscriptLatestVersionQueryV2", - "WebscriptLatestVersionsQueryV1", - "WebscriptLatestVersionsQueryV2", "WebscriptManifest", - "WebscriptResponse", "WebscriptResponseV2", "WebscriptResponseWithInvokeLinkV2", "WebscriptVersionsResponseV2", - "WithAssetHALLink", - "WithEntityAttributes", - "WithLimit", - "WithPaging", ] diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/deprecate_previous_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/alt_embedded_version_i_kfserving_response_v2.py similarity index 62% rename from waylay-sdk-registry-types/src/waylay/services/registry/models/deprecate_previous_query.py rename to waylay-sdk-registry-types/src/waylay/services/registry/models/alt_embedded_version_i_kfserving_response_v2.py index d25650ab..d158906c 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/deprecate_previous_query.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/alt_embedded_version_i_kfserving_response_v2.py @@ -13,19 +13,17 @@ from pydantic import ( ConfigDict, - Field, ) from waylay.sdk.api._models import BaseModel as WaylayBaseModel -from ..models.deprecate_previous_policy import DeprecatePreviousPolicy +from ..models.kfserving_response_v2 import KfservingResponseV2 -class DeprecatePreviousQuery(WaylayBaseModel): - """DeprecatePreviousQuery.""" +class AltEmbeddedVersionIKfservingResponseV2(WaylayBaseModel): + """Embedded representations of the _latest_ draft/published versions..""" - deprecate_previous: DeprecatePreviousPolicy | None = Field( - default=None, alias="deprecatePrevious" - ) + draft: KfservingResponseV2 | None = None + published: KfservingResponseV2 | None = None model_config = ConfigDict( populate_by_name=True, protected_namespaces=(), extra="ignore" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_deploy_overrides.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/alt_embedded_version_i_plug_response_v2.py similarity index 64% rename from waylay-sdk-registry-types/src/waylay/services/registry/models/function_deploy_overrides.py rename to waylay-sdk-registry-types/src/waylay/services/registry/models/alt_embedded_version_i_plug_response_v2.py index 30cff1c3..f0bae701 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_deploy_overrides.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/alt_embedded_version_i_plug_response_v2.py @@ -16,13 +16,14 @@ ) from waylay.sdk.api._models import BaseModel as WaylayBaseModel -from ..models.function_deploy_overrides_type import FunctionDeployOverridesType +from ..models.plug_response_v2 import PlugResponseV2 -class FunctionDeployOverrides(WaylayBaseModel): - """FunctionDeployOverrides.""" +class AltEmbeddedVersionIPlugResponseV2(WaylayBaseModel): + """Embedded representations of the _latest_ draft/published versions..""" - deploy: FunctionDeployOverridesType | None = None + draft: PlugResponseV2 | None = None + published: PlugResponseV2 | None = None model_config = ConfigDict( populate_by_name=True, protected_namespaces=(), extra="ignore" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/invokable_webscript_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/alt_embedded_version_i_webscript_response_with_invoke_link_v2.py similarity index 56% rename from waylay-sdk-registry-types/src/waylay/services/registry/models/invokable_webscript_response.py rename to waylay-sdk-registry-types/src/waylay/services/registry/models/alt_embedded_version_i_webscript_response_with_invoke_link_v2.py index 28826629..27686928 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/invokable_webscript_response.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/alt_embedded_version_i_webscript_response_with_invoke_link_v2.py @@ -13,21 +13,19 @@ from pydantic import ( ConfigDict, - Field, ) from waylay.sdk.api._models import BaseModel as WaylayBaseModel -from ..models.invokable_webscript_response_entity import ( - InvokableWebscriptResponseEntity, +from ..models.webscript_response_with_invoke_link_v2 import ( + WebscriptResponseWithInvokeLinkV2, ) -from ..models.invoke_internal_hal_link import InvokeInternalHALLink -class InvokableWebscriptResponse(WaylayBaseModel): - """Webscript Found.""" +class AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2(WaylayBaseModel): + """Embedded representations of the _latest_ draft/published versions..""" - entity: InvokableWebscriptResponseEntity - links: InvokeInternalHALLink = Field(alias="_links") + draft: WebscriptResponseWithInvokeLinkV2 | None = None + published: WebscriptResponseWithInvokeLinkV2 | None = None model_config = ConfigDict( populate_by_name=True, protected_namespaces=(), extra="ignore" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/any_function_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/any_function_response.py deleted file mode 100644 index a2d3d94d..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/any_function_response.py +++ /dev/null @@ -1,31 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import ( - Union, -) - -from typing_extensions import ( - Annotated, # >=3.9 -) - -from ..models.kfserving_response_v2 import KfservingResponseV2 -from ..models.plug_response_v2 import PlugResponseV2 -from ..models.webscript_response_v2 import WebscriptResponseV2 - -AnyFunctionResponse = Union[ - Annotated[PlugResponseV2, ""], - Annotated[KfservingResponseV2, ""], - Annotated[WebscriptResponseV2, ""], -] -"""AnyFunctionResponse.""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/any_job_result.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/any_job_result.py index b2f85d47..3877f953 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/any_job_result.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/any_job_result.py @@ -23,6 +23,7 @@ from ..models.build_result import BuildResult from ..models.cleanup_result import CleanupResult from ..models.deploy_result import DeployResult +from ..models.notify_result import NotifyResult from ..models.undeploy_result import UndeployResult from ..models.verify_result import VerifyResult @@ -34,5 +35,6 @@ Annotated[object, "The result data for a completed scale job."], Annotated[BatchResult, ""], Annotated[CleanupResult, ""], + Annotated[NotifyResult, ""], ] """AnyJobResult.""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/asset_path_params_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/asset_path_params_v2.py deleted file mode 100644 index 9caba53e..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/asset_path_params_v2.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class AssetPathParamsV2(WaylayBaseModel): - """AssetPathParamsV2.""" - - wildcard: StrictStr = Field( - description="Full path or path prefix of the asset within the archive", - alias="*", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/asset_summary.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/asset_summary.py deleted file mode 100644 index f9b4f640..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/asset_summary.py +++ /dev/null @@ -1,34 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.asset_role import AssetRole - - -class AssetSummary(WaylayBaseModel): - """AssetSummary.""" - - name: StrictStr = Field(description="File name") - title: StrictStr | None = None - description: StrictStr | None = None - role: AssetRole | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/async_deploy_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/async_deploy_query.py deleted file mode 100644 index c6d8f46d..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/async_deploy_query.py +++ /dev/null @@ -1,48 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.deprecate_previous_policy import DeprecatePreviousPolicy - - -class AsyncDeployQuery(WaylayBaseModel): - """AsyncDeployQuery.""" - - deprecate_previous: DeprecatePreviousPolicy | None = Field( - default=None, alias="deprecatePrevious" - ) - dry_run: StrictBool | None = Field( - default=None, - description="If set to true, validates the deployment conditions, but does not change anything.", - alias="dryRun", - ) - var_async: StrictBool | None = Field( - default=True, - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - scale_to_zero: StrictBool | None = Field( - default=False, - description="If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately.", - alias="scaleToZero", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/async_deploy_query_v1.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/async_deploy_query_v1.py deleted file mode 100644 index 6897e9a9..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/async_deploy_query_v1.py +++ /dev/null @@ -1,43 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class AsyncDeployQueryV1(WaylayBaseModel): - """AsyncDeployQueryV1.""" - - scale_to_zero: StrictBool | None = Field( - default=False, - description="If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately.", - alias="scaleToZero", - ) - var_async: StrictBool | None = Field( - default=True, - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - dry_run: StrictBool | None = Field( - default=None, - description="If set to true, validates the deployment conditions, but does not change anything.", - alias="dryRun", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/async_query_default_false.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/async_query_default_false.py deleted file mode 100644 index 9129e0fc..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/async_query_default_false.py +++ /dev/null @@ -1,33 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class AsyncQueryDefaultFalse(WaylayBaseModel): - """AsyncQueryDefaultFalse.""" - - var_async: StrictBool | None = Field( - default=False, - description="If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/async_query_default_true.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/async_query_default_true.py deleted file mode 100644 index db1c70b5..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/async_query_default_true.py +++ /dev/null @@ -1,33 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class AsyncQueryDefaultTrue(WaylayBaseModel): - """AsyncQueryDefaultTrue.""" - - var_async: StrictBool | None = Field( - default=True, - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/async_verify_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/async_verify_query.py deleted file mode 100644 index db16a2ca..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/async_verify_query.py +++ /dev/null @@ -1,43 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class AsyncVerifyQuery(WaylayBaseModel): - """AsyncVerifyQuery.""" - - comment: StrictStr | None = Field( - default=None, - description="An optional user-specified comment corresponding to the operation.", - ) - var_async: StrictBool | None = Field( - default=True, - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - scale_to_zero: StrictBool | None = Field( - default=None, - description="Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command.", - alias="scaleToZero", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/build_args.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/build_args.py index 1db0e409..8c856c0f 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/build_args.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/build_args.py @@ -34,9 +34,8 @@ class BuildArgs(WaylayBaseModel): description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org", alias="runtimeVersion", ) - revision: StrictStr | None = Field( - default=None, - description="The revision hash of the current (draft) function revision", + revision: StrictStr = Field( + description="The revision hash of the current (draft) function revision" ) storage_location: StrictStr = Field( description="Location of the function assets.", alias="storageLocation" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/completed_event_data.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/completed_event_data.py index 9a75dadb..5f494e73 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/completed_event_data.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/completed_event_data.py @@ -13,7 +13,6 @@ from pydantic import ( ConfigDict, - Field, ) from waylay.sdk.api._models import BaseModel as WaylayBaseModel @@ -25,7 +24,7 @@ class CompletedEventData(WaylayBaseModel): """CompletedEventData.""" prev: QueueEvents | None = None - return_value: AnyJobResult = Field(alias="returnValue") + returnvalue: AnyJobResult model_config = ConfigDict( populate_by_name=True, protected_namespaces=(), extra="ignore" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/content_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/content_query_v2.py deleted file mode 100644 index e77199d3..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/content_query_v2.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class ContentQueryV2(WaylayBaseModel): - """ContentQueryV2.""" - - ls: StrictBool | None = Field( - default=False, - description="If set to `true`, the result will be a listing of the files in the asset, annotated with metadata and validation report from the asset conditions of the functions runtime.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/create_function_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/create_function_query_v2.py deleted file mode 100644 index 1f9ec96c..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/create_function_query_v2.py +++ /dev/null @@ -1,59 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.deprecate_previous_policy import DeprecatePreviousPolicy -from ..models.semantic_version_range import SemanticVersionRange - - -class CreateFunctionQueryV2(WaylayBaseModel): - """CreateFunctionQueryV2.""" - - deprecate_previous: DeprecatePreviousPolicy | None = Field( - default=None, alias="deprecatePrevious" - ) - dry_run: StrictBool | None = Field( - default=None, - description="If set to true, validates the deployment conditions, but does not change anything.", - alias="dryRun", - ) - var_async: StrictBool | None = Field( - default=True, - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - scale_to_zero: StrictBool | None = Field( - default=False, - description="If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately.", - alias="scaleToZero", - ) - version: SemanticVersionRange | None = None - name: StrictStr | None = Field( - default=None, - description="If set, the value will be used as the function name instead of the one specified in the manifest.", - ) - draft: StrictBool | None = Field( - default=False, - description="If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/create_kf_serving_async_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/create_kf_serving_async_response.py deleted file mode 100644 index 67896306..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/create_kf_serving_async_response.py +++ /dev/null @@ -1,34 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_hal_links import JobHALLinks -from ..models.kf_serving_manifest import KFServingManifest - - -class CreateKFServingAsyncResponse(WaylayBaseModel): - """Model Deployment Initiated.""" - - message: StrictStr - links: JobHALLinks = Field(alias="_links") - entity: KFServingManifest - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/create_plug_async_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/create_plug_async_response.py deleted file mode 100644 index edf248a8..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/create_plug_async_response.py +++ /dev/null @@ -1,34 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_hal_links import JobHALLinks -from ..models.plug_manifest import PlugManifest - - -class CreatePlugAsyncResponse(WaylayBaseModel): - """Successful Response.""" - - message: StrictStr - links: JobHALLinks = Field(alias="_links") - entity: PlugManifest - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/create_webscript_async_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/create_webscript_async_response.py deleted file mode 100644 index 59937561..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/create_webscript_async_response.py +++ /dev/null @@ -1,34 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_hal_links import JobHALLinks -from ..models.webscript_manifest import WebscriptManifest - - -class CreateWebscriptAsyncResponse(WaylayBaseModel): - """Successful Response.""" - - message: StrictStr - links: JobHALLinks = Field(alias="_links") - entity: WebscriptManifest - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/create_webscripts_copy_parameter.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/create_webscripts_copy_parameter.py new file mode 100644 index 00000000..a6af3eec --- /dev/null +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/create_webscripts_copy_parameter.py @@ -0,0 +1,31 @@ +# coding: utf-8 +"""Waylay Function Registry models. + +This code was generated from the OpenAPI documentation of 'Waylay Function Registry' + +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. + +""" + +from __future__ import annotations + +from typing import ( + Union, +) + +from typing_extensions import ( + Annotated, # >=3.9 +) + +from ..models.example_reference import ExampleReference + +CreateWebscriptsCopyParameter = Union[ + Annotated[ + str, + "A name reference with optional version range: `[@]`. References (a version range of) a named and versioned entity like _function_ or _runtime_.", + ], + Annotated[ExampleReference, ""], +] +"""CreateWebscriptsCopyParameter.""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/deploy_args.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/deploy_args.py index 55f6ab3b..e99a84b8 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/deploy_args.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/deploy_args.py @@ -43,9 +43,8 @@ class DeployArgs(WaylayBaseModel): description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org", alias="runtimeVersion", ) - revision: StrictStr | None = Field( - default=None, - description="The revision hash of the current (draft) function revision", + revision: StrictStr = Field( + description="The revision hash of the current (draft) function revision" ) deploy_spec_overrides: DeployArgsDeploySpecOverrides = Field( alias="deploySpecOverrides" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/deploy_attributes_filter.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/deploy_attributes_filter.py deleted file mode 100644 index 545e1c48..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/deploy_attributes_filter.py +++ /dev/null @@ -1,42 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class DeployAttributesFilter(WaylayBaseModel): - """DeployAttributesFilter.""" - - endpoint: StrictStr | None = Field( - default=None, - description="Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - image_name: StrictStr | None = Field( - default=None, - description="Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - alias="imageName", - ) - storage_location: StrictStr | None = Field( - default=None, - description="Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - alias="storageLocation", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/deprecated_draft_filter.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/deprecated_draft_filter.py deleted file mode 100644 index d0fa1313..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/deprecated_draft_filter.py +++ /dev/null @@ -1,34 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class DeprecatedDraftFilter(WaylayBaseModel): - """DeprecatedDraftFilter.""" - - deprecated: StrictBool | None = Field( - default=None, description="Filter on the deprecation status of the function." - ) - draft: StrictBool | None = Field( - default=None, description="Filter on the draft status of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/dry_run_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/dry_run_query.py deleted file mode 100644 index 60e3fafa..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/dry_run_query.py +++ /dev/null @@ -1,33 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class DryRunQuery(WaylayBaseModel): - """DryRunQuery.""" - - dry_run: StrictBool | None = Field( - default=None, - description="If set to true, validates the deployment conditions, but does not change anything.", - alias="dryRun", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/entity_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/entity_response.py deleted file mode 100644 index 72c79040..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/entity_response.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re -from datetime import datetime -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.failure_reason import FailureReason -from ..models.function_deploy_overrides_type import FunctionDeployOverridesType -from ..models.function_meta import FunctionMeta -from ..models.job_hal_links import JobHALLinks -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status import Status - - -class EntityResponse(WaylayBaseModel): - """EntityResponse.""" - - deploy: FunctionDeployOverridesType | None = None - name: StrictStr = Field(description="The logical name for the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - runtime: StrictStr - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - metadata: FunctionMeta - created_by: StrictStr = Field( - description="The user that created this entity.", alias="createdBy" - ) - created_at: datetime = Field( - description="The timestamp at which this entity was created.", alias="createdAt" - ) - updated_by: StrictStr = Field( - description="The user that last updated this entity.", alias="updatedBy" - ) - updated_at: datetime = Field( - description="The timestamp at which this entity was last updated.", - alias="updatedAt", - ) - status: Status - failure_reason: FailureReason | None = Field(default=None, alias="failureReason") - links: List[JobHALLinks] | None = Field( - default=None, description="Links to related entities.", alias="_links" - ) - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_models_response_v2_entities_inner.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/entity_with_links_i_kfserving_response_v2.py similarity index 83% rename from waylay-sdk-registry-types/src/waylay/services/registry/models/latest_models_response_v2_entities_inner.py rename to waylay-sdk-registry-types/src/waylay/services/registry/models/entity_with_links_i_kfserving_response_v2.py index cc50617d..49022c44 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_models_response_v2_entities_inner.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/entity_with_links_i_kfserving_response_v2.py @@ -22,6 +22,9 @@ ) from waylay.sdk.api._models import BaseModel as WaylayBaseModel +from ..models.alt_embedded_version_i_kfserving_response_v2 import ( + AltEmbeddedVersionIKfservingResponseV2, +) from ..models.alt_version_hal_link import AltVersionHALLink from ..models.failure_reason import FailureReason from ..models.kf_serving_manifest import KFServingManifest @@ -30,10 +33,13 @@ from ..models.update_record import UpdateRecord -class LatestModelsResponseV2EntitiesInner(WaylayBaseModel): - """LatestModelsResponseV2EntitiesInner.""" +class EntityWithLinksIKfservingResponseV2(WaylayBaseModel): + """EntityWithLinksIKfservingResponseV2.""" - links: AltVersionHALLink = Field(alias="_links") + embedded: AltEmbeddedVersionIKfservingResponseV2 | None = Field( + default=None, alias="_embedded" + ) + links: AltVersionHALLink | None = Field(default=None, alias="_links") created_by: StrictStr = Field( description="The user that created this entity.", alias="createdBy" ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plugs_response_v2_entities_inner.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/entity_with_links_i_plug_response_v2.py similarity index 84% rename from waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plugs_response_v2_entities_inner.py rename to waylay-sdk-registry-types/src/waylay/services/registry/models/entity_with_links_i_plug_response_v2.py index e334cf0c..d0d25910 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plugs_response_v2_entities_inner.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/entity_with_links_i_plug_response_v2.py @@ -22,6 +22,9 @@ ) from waylay.sdk.api._models import BaseModel as WaylayBaseModel +from ..models.alt_embedded_version_i_plug_response_v2 import ( + AltEmbeddedVersionIPlugResponseV2, +) from ..models.alt_version_hal_link import AltVersionHALLink from ..models.failure_reason import FailureReason from ..models.plug_manifest import PlugManifest @@ -30,10 +33,13 @@ from ..models.update_record import UpdateRecord -class LatestPlugsResponseV2EntitiesInner(WaylayBaseModel): - """LatestPlugsResponseV2EntitiesInner.""" +class EntityWithLinksIPlugResponseV2(WaylayBaseModel): + """EntityWithLinksIPlugResponseV2.""" - links: AltVersionHALLink = Field(alias="_links") + embedded: AltEmbeddedVersionIPlugResponseV2 | None = Field( + default=None, alias="_embedded" + ) + links: AltVersionHALLink | None = Field(default=None, alias="_links") created_by: StrictStr = Field( description="The user that created this entity.", alias="createdBy" ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_webscripts_response_v2_entities_inner.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/entity_with_links_i_webscript_response_with_invoke_link_v2.py similarity index 82% rename from waylay-sdk-registry-types/src/waylay/services/registry/models/latest_webscripts_response_v2_entities_inner.py rename to waylay-sdk-registry-types/src/waylay/services/registry/models/entity_with_links_i_webscript_response_with_invoke_link_v2.py index bdbe0a3a..b1975510 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_webscripts_response_v2_entities_inner.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/entity_with_links_i_webscript_response_with_invoke_link_v2.py @@ -22,6 +22,9 @@ ) from waylay.sdk.api._models import BaseModel as WaylayBaseModel +from ..models.alt_embedded_version_i_webscript_response_with_invoke_link_v2 import ( + AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2, +) from ..models.failure_reason import FailureReason from ..models.invoke_hal_link import InvokeHALLink from ..models.runtime_attributes import RuntimeAttributes @@ -30,10 +33,13 @@ from ..models.webscript_manifest import WebscriptManifest -class LatestWebscriptsResponseV2EntitiesInner(WaylayBaseModel): - """LatestWebscriptsResponseV2EntitiesInner.""" +class EntityWithLinksIWebscriptResponseWithInvokeLinkV2(WaylayBaseModel): + """EntityWithLinksIWebscriptResponseWithInvokeLinkV2.""" - links: InvokeHALLink = Field(alias="_links") + embedded: AltEmbeddedVersionIWebscriptResponseWithInvokeLinkV2 | None = Field( + default=None, alias="_embedded" + ) + links: InvokeHALLink | None = Field(default=None, alias="_links") created_by: StrictStr = Field( description="The user that created this entity.", alias="createdBy" ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/error_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/error_response.py deleted file mode 100644 index c40e6ded..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/error_response.py +++ /dev/null @@ -1,28 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class ErrorResponse(WaylayBaseModel): - """ErrorResponse.""" - - error: StrictStr - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/event_sse.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/event_sse.py deleted file mode 100644 index 735f0683..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/event_sse.py +++ /dev/null @@ -1,31 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import ( - Union, -) - -from typing_extensions import ( - Annotated, # >=3.9 -) - -from ..models.job_event_sse import JobEventSSE -from ..models.keep_alive_event_sse import KeepAliveEventSSE -from ..models.stream_ready import StreamReady - -EventSSE = Union[ - Annotated[StreamReady, ""], - Annotated[JobEventSSE, ""], - Annotated[KeepAliveEventSSE, ""], -] -"""SSE stream events without closing protocol.""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/event_type_sse.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/event_type_sse.py deleted file mode 100644 index b146814e..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/event_type_sse.py +++ /dev/null @@ -1,33 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import ( - Union, -) - -from typing_extensions import ( - Annotated, # >=3.9 -) - -from ..models.event_ack import EventAck -from ..models.event_close import EventClose -from ..models.event_keep_alive import EventKeepAlive -from ..models.supported_events import SupportedEvents - -EventTypeSSE = Union[ - Annotated[SupportedEvents, ""], - Annotated[EventAck, ""], - Annotated[EventClose, ""], - Annotated[EventKeepAlive, ""], -] -"""EventTypeSSE.""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/supported_events.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/example_reference.py similarity index 61% rename from waylay-sdk-registry-types/src/waylay/services/registry/models/supported_events.py rename to waylay-sdk-registry-types/src/waylay/services/registry/models/example_reference.py index 33b30800..a64d8b02 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/supported_events.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/example_reference.py @@ -14,15 +14,10 @@ from enum import Enum -class SupportedEvents(str, Enum): - """SupportedEvents.""" - - COMPLETED = "completed" - FAILED = "failed" - ACTIVE = "active" - DELAYED = "delayed" - WAITING = "waiting" - WAITING_MINUS_CHILDREN = "waiting-children" +class ExampleReference(str, Enum): + """Example reference. References the example assets from the selected runtime..""" + + EXCLAMATION_EXAMPLE = "!example" def __str__(self) -> str: return str(self.value) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/force_delete_query_v1.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/force_delete_query_v1.py deleted file mode 100644 index 33d3bbad..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/force_delete_query_v1.py +++ /dev/null @@ -1,37 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class ForceDeleteQueryV1(WaylayBaseModel): - """ForceDeleteQueryV1.""" - - var_async: StrictBool | None = Field( - default=False, - description="If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - force: StrictBool | None = Field( - default=None, - description="If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_delete_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/function_delete_query.py deleted file mode 100644 index 7caf1227..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_delete_query.py +++ /dev/null @@ -1,36 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class FunctionDeleteQuery(WaylayBaseModel): - """FunctionDeleteQuery.""" - - force: StrictBool | None = Field( - default=None, - description="If true, the function version will be immediately undeployed and removed. Otherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_.", - ) - undeploy: StrictBool | None = Field( - default=None, - description="If `true`, the `DELETE` operation * undeploys the (openfaas) function: it becomes no longer available for invocation. * does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_entity_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/function_entity_query.py deleted file mode 100644 index cf9957ad..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_entity_query.py +++ /dev/null @@ -1,44 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat - - -class FunctionEntityQuery(WaylayBaseModel): - """Filter on function attributes that do not change across function versions..""" - - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_job_args.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/function_job_args.py deleted file mode 100644 index de72e3e1..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_job_args.py +++ /dev/null @@ -1,53 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class FunctionJobArgs(WaylayBaseModel): - """Job arguments shared by all function jobs.""" - - runtime_name: StrictStr = Field(alias="runtimeName") - runtime_version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org", - alias="runtimeVersion", - ) - revision: StrictStr | None = Field( - default=None, - description="The revision hash of the current (draft) function revision", - ) - - @field_validator("runtime_version") - @classmethod - def runtime_version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_manifest.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/function_manifest.py deleted file mode 100644 index 69d8004e..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_manifest.py +++ /dev/null @@ -1,58 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.function_deploy_overrides_type import FunctionDeployOverridesType -from ..models.function_meta import FunctionMeta -from ..models.semantic_version_range import SemanticVersionRange - - -class FunctionManifest(WaylayBaseModel): - """FunctionManifest.""" - - deploy: FunctionDeployOverridesType | None = None - name: StrictStr = Field(description="The logical name for the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - runtime: StrictStr - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - metadata: FunctionMeta - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_name_version.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/function_name_version.py deleted file mode 100644 index b79ee6e4..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_name_version.py +++ /dev/null @@ -1,48 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class FunctionNameVersion(WaylayBaseModel): - """FunctionNameVersion.""" - - name: StrictStr = Field(description="The logical name for the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_spec.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/function_spec.py deleted file mode 100644 index 1d7df4fc..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_spec.py +++ /dev/null @@ -1,49 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class FunctionSpec(WaylayBaseModel): - """FunctionSpec.""" - - name: StrictStr = Field(description="The logical name for the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - runtime: StrictStr - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_version_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/function_version_query.py deleted file mode 100644 index b3374357..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/function_version_query.py +++ /dev/null @@ -1,59 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.timestamp_spec import TimestampSpec - - -class FunctionVersionQuery(WaylayBaseModel): - """Filter on function attributes that can change across function versions. When these query parameters are used, the query is considered a _function version_ listing and no HAL links to latest (_draft_, _published_) versions are included..""" - - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_content_params_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/get_content_params_v2.py deleted file mode 100644 index db21fa33..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_content_params_v2.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class GetContentParamsV2(WaylayBaseModel): - """GetContentParamsV2.""" - - wildcard: StrictStr = Field( - description="Full path or path prefix of the asset within the archive", - alias="*", - ) - name: StrictStr = Field(description="The name of the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_invokable_webscript_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/get_invokable_webscript_query.py deleted file mode 100644 index 901e6296..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_invokable_webscript_query.py +++ /dev/null @@ -1,47 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter - - -class GetInvokableWebscriptQuery(WaylayBaseModel): - """GetInvokableWebscriptQuery.""" - - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - version: SemanticVersionRange | None = None - status: List[StatusFilter] | None = Field( - default=None, description="If set, filters on the `status` of the webscript." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_by_name_and_version_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_by_name_and_version_query.py deleted file mode 100644 index f5767a53..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_by_name_and_version_query.py +++ /dev/null @@ -1,33 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class GetRuntimeByNameAndVersionQuery(WaylayBaseModel): - """GetRuntimeByNameAndVersionQuery.""" - - include_deprecated: StrictBool | None = Field( - default=True, - description="If set to `true`, deprecated runtimes will be included in the query.", - alias="includeDeprecated", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_by_name_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_by_name_query.py deleted file mode 100644 index cfea35bc..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_by_name_query.py +++ /dev/null @@ -1,50 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.function_type import FunctionType -from ..models.semantic_version_range import SemanticVersionRange - - -class GetRuntimeByNameQuery(WaylayBaseModel): - """GetRuntimeByNameQuery.""" - - version: SemanticVersionRange | None = None - include_deprecated: StrictBool | None = Field( - default=False, - description="If set to `true`, deprecated runtimes will be included in the query.", - alias="includeDeprecated", - ) - function_type: List[FunctionType] | None = Field( - default=None, - description="If set, filters on the functionType of a runtime. Uses an exact match.", - alias="functionType", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="If set, filters on the archiveFormat of a runtime. Uses an exact match.", - alias="archiveFormat", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_example_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_example_query.py deleted file mode 100644 index 15fb2b94..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_example_query.py +++ /dev/null @@ -1,37 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class GetRuntimeExampleQuery(WaylayBaseModel): - """GetRuntimeExampleQuery.""" - - ls: StrictBool | None = Field( - default=False, - description="If set to `true`, the result will be a listing of the files in the asset, annotated with metadata and validation report from the asset conditions of the functions runtime.", - ) - include_deprecated: StrictBool | None = Field( - default=True, - description="If set to `true`, deprecated runtimes will be included in the query.", - alias="includeDeprecated", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_versions_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_versions_query.py deleted file mode 100644 index b019afb8..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/get_runtime_versions_query.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.function_type import FunctionType -from ..models.latest_version_level import LatestVersionLevel -from ..models.semantic_version_range import SemanticVersionRange - - -class GetRuntimeVersionsQuery(WaylayBaseModel): - """GetRuntimeVersionsQuery.""" - - version: SemanticVersionRange | None = None - latest: LatestVersionLevel | None = None - include_deprecated: StrictBool | None = Field( - default=False, - description="If set to `true`, deprecated runtimes will be included in the query.", - alias="includeDeprecated", - ) - function_type: List[FunctionType] | None = Field( - default=None, - description="If set, filters on the functionType of a runtime. Uses an exact match.", - alias="functionType", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="If set, filters on the archiveFormat of a runtime. Uses an exact match.", - alias="archiveFormat", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/invokable_webscript_response_entity.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/invokable_webscript_response_entity.py deleted file mode 100644 index dc03816e..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/invokable_webscript_response_entity.py +++ /dev/null @@ -1,37 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.invokable_webscript_response_entity_webscript import ( - InvokableWebscriptResponseEntityWebscript, -) -from ..models.status import Status - - -class InvokableWebscriptResponseEntity(WaylayBaseModel): - """InvokableWebscriptResponseEntity.""" - - status: Status - draft: StrictBool - webscript: InvokableWebscriptResponseEntityWebscript - secret: StrictStr | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/invokable_webscript_response_entity_webscript.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/invokable_webscript_response_entity_webscript.py deleted file mode 100644 index 4a5ccf03..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/invokable_webscript_response_entity_webscript.py +++ /dev/null @@ -1,51 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class InvokableWebscriptResponseEntityWebscript(WaylayBaseModel): - """InvokableWebscriptResponseEntityWebscript.""" - - name: StrictStr - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - private: StrictBool - allow_hmac: StrictBool = Field(alias="allowHmac") - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/invoke_internal_hal_link.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/invoke_internal_hal_link.py deleted file mode 100644 index 0a8cd2e5..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/invoke_internal_hal_link.py +++ /dev/null @@ -1,30 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.hal_link import HALLink - - -class InvokeInternalHALLink(WaylayBaseModel): - """InvokeInternalHALLink.""" - - invoke_internal: HALLink | None = Field(default=None, alias="invoke-internal") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_active_event_data.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_active_event_data.py deleted file mode 100644 index 5a39bbdc..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_active_event_data.py +++ /dev/null @@ -1,35 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from datetime import datetime - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.active_event_data import ActiveEventData -from ..models.job_reference import JobReference - - -class JobEventPayloadActiveEventData(WaylayBaseModel): - """JobEventPayloadActiveEventData.""" - - job: JobReference - data: ActiveEventData - timestamp: datetime = Field(description="Timestamp of the event") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_completed_event_data.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_completed_event_data.py deleted file mode 100644 index 5d03e7d4..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_completed_event_data.py +++ /dev/null @@ -1,35 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from datetime import datetime - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.completed_event_data import CompletedEventData -from ..models.job_reference import JobReference - - -class JobEventPayloadCompletedEventData(WaylayBaseModel): - """JobEventPayloadCompletedEventData.""" - - job: JobReference - data: CompletedEventData - timestamp: datetime = Field(description="Timestamp of the event") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_delayed_event_data.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_delayed_event_data.py deleted file mode 100644 index 9d6d03de..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_delayed_event_data.py +++ /dev/null @@ -1,35 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from datetime import datetime - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.delayed_event_data import DelayedEventData -from ..models.job_reference import JobReference - - -class JobEventPayloadDelayedEventData(WaylayBaseModel): - """JobEventPayloadDelayedEventData.""" - - job: JobReference - data: DelayedEventData - timestamp: datetime = Field(description="Timestamp of the event") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_failed_event_data.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_failed_event_data.py deleted file mode 100644 index 9db2c127..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_failed_event_data.py +++ /dev/null @@ -1,35 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from datetime import datetime - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.failed_event_data import FailedEventData -from ..models.job_reference import JobReference - - -class JobEventPayloadFailedEventData(WaylayBaseModel): - """JobEventPayloadFailedEventData.""" - - job: JobReference - data: FailedEventData - timestamp: datetime = Field(description="Timestamp of the event") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_waiting_children_event_data.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_waiting_children_event_data.py deleted file mode 100644 index af384a9a..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_waiting_children_event_data.py +++ /dev/null @@ -1,35 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from datetime import datetime -from typing import Any, Dict - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_reference import JobReference - - -class JobEventPayloadWaitingChildrenEventData(WaylayBaseModel): - """JobEventPayloadWaitingChildrenEventData.""" - - job: JobReference - data: Dict[str, Any] - timestamp: datetime = Field(description="Timestamp of the event") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_waiting_event_data.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_waiting_event_data.py deleted file mode 100644 index acb12d5c..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_event_payload_waiting_event_data.py +++ /dev/null @@ -1,35 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from datetime import datetime - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_reference import JobReference -from ..models.waiting_event_data import WaitingEventData - - -class JobEventPayloadWaitingEventData(WaylayBaseModel): - """JobEventPayloadWaitingEventData.""" - - job: JobReference - data: WaitingEventData - timestamp: datetime = Field(description="Timestamp of the event") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_events_filter_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_events_filter_query.py deleted file mode 100644 index 3fd129dd..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_events_filter_query.py +++ /dev/null @@ -1,37 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_type import JobType - - -class JobEventsFilterQuery(WaylayBaseModel): - """JobEventsFilterQuery.""" - - type: JobType | None = None - id: StrictStr | None = Field(default=None, description="The id of the job.") - children: StrictBool | None = Field( - default=None, - description="If set to true, the event stream will include events of the job's dependants. E.g., when subscribing to a verify job with `children=true`, you will also receive the events of the underlying build and deploy jobs. Defaults to false.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_query.py deleted file mode 100644 index 8b3062d3..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_query.py +++ /dev/null @@ -1,56 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.function_type import FunctionType -from ..models.job_state_result import JobStateResult -from ..models.job_type_schema import JobTypeSchema -from ..models.timestamp_spec import TimestampSpec - - -class JobQuery(WaylayBaseModel): - """JobQuery.""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - type: List[JobTypeSchema] | None = Field( - default=None, description="Filter on job type" - ) - state: List[JobStateResult] | None = Field( - default=None, description="Filter on job state" - ) - function_type: List[FunctionType] | None = Field( - default=None, description="Filter on function type", alias="functionType" - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_reference_params.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_reference_params.py deleted file mode 100644 index 92748fc4..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_reference_params.py +++ /dev/null @@ -1,31 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_type import JobType - - -class JobReferenceParams(WaylayBaseModel): - """JobReferenceParams.""" - - type: JobType - id: StrictStr - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_submitted_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_submitted_response.py deleted file mode 100644 index 5c729cd5..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_submitted_response.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_hal_links import JobHALLinks - - -class JobSubmittedResponse(WaylayBaseModel): - """JobSubmittedResponse.""" - - message: StrictStr - links: JobHALLinks = Field(alias="_links") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_type.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_type.py index e5b4bb89..8558b51f 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_type.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_type.py @@ -24,7 +24,7 @@ class JobType(str, Enum): BATCH = "batch" SCALE = "scale" CLEANUP = "cleanup" - OTHER = "other" + NOTIFY = "notify" def __str__(self) -> str: return str(self.value) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/media_type.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_type_notify.py similarity index 57% rename from waylay-sdk-registry-types/src/waylay/services/registry/models/media_type.py rename to waylay-sdk-registry-types/src/waylay/services/registry/models/job_type_notify.py index 17b6db8f..b75f8158 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/media_type.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_type_notify.py @@ -14,13 +14,10 @@ from enum import Enum -class MediaType(str, Enum): - """MediaType.""" +class JobTypeNotify(str, Enum): + """A job to notify that an function version has changed..""" - APPLICATION_SLASH_JAVASCRIPT = "application/javascript" - APPLICATION_SLASH_JAVA_MINUS_VM = "application/java-vm" - TEXT_SLASH_X_MINUS_PYTHON = "text/x-python" - TEXT_SLASH_X_MINUS_GOLANG = "text/x-golang" + NOTIFY = "notify" def __str__(self) -> str: return str(self.value) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_type_schema.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_type_schema.py index 97f262ea..fd68eb45 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/job_type_schema.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/job_type_schema.py @@ -22,6 +22,7 @@ from ..models.job_type_batch import JobTypeBatch from ..models.job_type_build import JobTypeBuild from ..models.job_type_deploy import JobTypeDeploy +from ..models.job_type_notify import JobTypeNotify from ..models.job_type_scale import JobTypeScale from ..models.job_type_undeploy import JobTypeUndeploy from ..models.job_type_verify import JobTypeVerify @@ -33,5 +34,6 @@ Annotated[JobTypeUndeploy, ""], Annotated[JobTypeScale, ""], Annotated[JobTypeBatch, ""], + Annotated[JobTypeNotify, ""], ] """JobTypeSchema.""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_multiple_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_multiple_response.py deleted file mode 100644 index c9d139da..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_multiple_response.py +++ /dev/null @@ -1,31 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class KFServingDeleteMultipleResponse(WaylayBaseModel): - """Models Deleted.""" - - name: StrictStr - versions: List[StrictStr] - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_multiple_with_job_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_multiple_with_job_response.py deleted file mode 100644 index b55332c9..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_multiple_with_job_response.py +++ /dev/null @@ -1,36 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_hal_links import JobHALLinks - - -class KFServingDeleteMultipleWithJobResponse(WaylayBaseModel): - """Model Deletions Initiated.""" - - name: StrictStr - versions: List[StrictStr] - message: StrictStr - links: JobHALLinks = Field(alias="_links") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_query_v1.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_query_v1.py deleted file mode 100644 index a61a06b3..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_query_v1.py +++ /dev/null @@ -1,107 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.timestamp_spec import TimestampSpec - - -class KFServingDeleteQueryV1(WaylayBaseModel): - """KFServingDeleteQueryV1.""" - - var_async: StrictBool | None = Field( - default=False, - description="If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_query_v2.py deleted file mode 100644 index 28543b4b..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_query_v2.py +++ /dev/null @@ -1,46 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class KFServingDeleteQueryV2(WaylayBaseModel): - """KFServingDeleteQueryV2.""" - - comment: StrictStr | None = Field( - default=None, - description="An optional user-specified comment corresponding to the operation.", - ) - force: StrictBool | None = Field( - default=None, - description="If true, the function version will be immediately undeployed and removed. Otherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_.", - ) - undeploy: StrictBool | None = Field( - default=None, - description="If `true`, the `DELETE` operation * undeploys the (openfaas) function: it becomes no longer available for invocation. * does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only.", - ) - var_async: StrictBool | None = Field( - default=True, - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_response.py deleted file mode 100644 index 72b2cf6c..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_response.py +++ /dev/null @@ -1,48 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class KFServingDeleteResponse(WaylayBaseModel): - """Model Deleted.""" - - name: StrictStr = Field(description="The name of the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_with_job_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_with_job_response.py deleted file mode 100644 index 8d7d995c..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_delete_with_job_response.py +++ /dev/null @@ -1,52 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_hal_links import JobHALLinks - - -class KFServingDeleteWithJobResponse(WaylayBaseModel): - """Model Delete Initiated.""" - - message: StrictStr - links: JobHALLinks = Field(alias="_links") - name: StrictStr = Field(description="The name of the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_latest_version_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_latest_version_query_v2.py deleted file mode 100644 index 99887dab..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_latest_version_query_v2.py +++ /dev/null @@ -1,38 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class KFServingLatestVersionQueryV2(WaylayBaseModel): - """Named Model latest version query..""" - - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_latest_versions_query_v1.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_latest_versions_query_v1.py deleted file mode 100644 index 7dbd0958..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_latest_versions_query_v1.py +++ /dev/null @@ -1,102 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.timestamp_spec import TimestampSpec - - -class KFServingLatestVersionsQueryV1(WaylayBaseModel): - """Model listing query.""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_latest_versions_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_latest_versions_query_v2.py deleted file mode 100644 index 8db06fee..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_latest_versions_query_v2.py +++ /dev/null @@ -1,28 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import ( - Union, -) - -from typing_extensions import ( - Annotated, # >=3.9 -) - -from ..models.latest_function_versions_query import LatestFunctionVersionsQuery -from ..models.latest_functions_query import LatestFunctionsQuery - -KFServingLatestVersionsQueryV2 = Union[ - Annotated[LatestFunctionVersionsQuery, ""], Annotated[LatestFunctionsQuery, ""] -] -"""Latest model versions listing query..""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_models_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_models_response.py deleted file mode 100644 index 50b6dc7d..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_models_response.py +++ /dev/null @@ -1,33 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.kf_serving_response import KFServingResponse -from ..models.paging_response import PagingResponse - - -class KFServingModelsResponse(WaylayBaseModel): - """Successful Response.""" - - models: List[KFServingResponse] - paging: PagingResponse | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_response.py deleted file mode 100644 index a1629a3b..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_response.py +++ /dev/null @@ -1,81 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re -from datetime import datetime -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.failure_reason import FailureReason -from ..models.function_deploy_overrides_type import FunctionDeployOverridesType -from ..models.function_meta import FunctionMeta -from ..models.job_hal_links import JobHALLinks -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status import Status - - -class KFServingResponse(WaylayBaseModel): - """Successful Response.""" - - deploy: FunctionDeployOverridesType | None = None - name: StrictStr = Field(description="The logical name for the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - runtime: StrictStr - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - metadata: FunctionMeta - created_by: StrictStr = Field( - description="The user that created this entity.", alias="createdBy" - ) - created_at: datetime = Field( - description="The timestamp at which this entity was created.", alias="createdAt" - ) - updated_by: StrictStr = Field( - description="The user that last updated this entity.", alias="updatedBy" - ) - updated_at: datetime = Field( - description="The timestamp at which this entity was last updated.", - alias="updatedAt", - ) - status: Status - failure_reason: FailureReason | None = Field(default=None, alias="failureReason") - links: List[JobHALLinks] | None = Field( - default=None, description="Links to related entities.", alias="_links" - ) - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_versions_query_v1.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_versions_query_v1.py deleted file mode 100644 index 28fcbe9b..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/kf_serving_versions_query_v1.py +++ /dev/null @@ -1,91 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.timestamp_spec import TimestampSpec - - -class KFServingVersionsQueryV1(WaylayBaseModel): - """Named model versions query.""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_function_versions_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_function_versions_query.py deleted file mode 100644 index a7e1ed2c..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_function_versions_query.py +++ /dev/null @@ -1,117 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.timestamp_spec import TimestampSpec - - -class LatestFunctionVersionsQuery(WaylayBaseModel): - """Latest function versions listing query..""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - deprecated: StrictBool | None = Field( - default=None, description="Filter on the deprecation status of the function." - ) - draft: StrictBool | None = Field( - default=None, description="Filter on the draft status of the function." - ) - name_version: List[Annotated[str, Field(strict=True)]] | None = Field( - default=None, - description="Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - alias="nameVersion", - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - latest: StrictBool | None = Field( - default=None, - description="When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_functions_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_functions_query.py deleted file mode 100644 index 51cb9620..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_functions_query.py +++ /dev/null @@ -1,74 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat - - -class LatestFunctionsQuery(WaylayBaseModel): - """Request to list latest function versions per named function. A request that only uses these query parameters will include links to the _latest_ draft/published versions..""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_models_response_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_models_response_v2.py index b0c27762..66264969 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_models_response_v2.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_models_response_v2.py @@ -21,8 +21,8 @@ ) from waylay.sdk.api._models import BaseModel as WaylayBaseModel -from ..models.latest_models_response_v2_entities_inner import ( - LatestModelsResponseV2EntitiesInner, +from ..models.entity_with_links_i_kfserving_response_v2 import ( + EntityWithLinksIKfservingResponseV2, ) @@ -38,7 +38,7 @@ class LatestModelsResponseV2(WaylayBaseModel): page: StrictFloat | StrictInt | None = Field( default=None, description="The page number of a paged query result." ) - entities: List[LatestModelsResponseV2EntitiesInner] = Field( + entities: List[EntityWithLinksIKfservingResponseV2] = Field( description="The specification and deployment status of the queried functions" ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_query.py deleted file mode 100644 index 31cf9df5..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_query.py +++ /dev/null @@ -1,106 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.plug_type import PlugType -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.tags_filter import TagsFilter -from ..models.timestamp_spec import TimestampSpec - - -class LatestPlugQuery(WaylayBaseModel): - """LatestPlugQuery.""" - - tags: TagsFilter | None = None - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - type: PlugType - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_version_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_version_query_v2.py deleted file mode 100644 index cc50cb4e..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_version_query_v2.py +++ /dev/null @@ -1,41 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.plug_type import PlugType - - -class LatestPlugVersionQueryV2(WaylayBaseModel): - """Latest named plug version listing query.""" - - type: PlugType | None = None - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_versions_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_versions_query.py deleted file mode 100644 index 575b86dd..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_versions_query.py +++ /dev/null @@ -1,121 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.plug_type import PlugType -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.tags_filter import TagsFilter -from ..models.timestamp_spec import TimestampSpec - - -class LatestPlugVersionsQuery(WaylayBaseModel): - """Plug versions listing query..""" - - tags: TagsFilter | None = None - type: PlugType | None = None - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - deprecated: StrictBool | None = Field( - default=None, description="Filter on the deprecation status of the function." - ) - draft: StrictBool | None = Field( - default=None, description="Filter on the draft status of the function." - ) - name_version: List[Annotated[str, Field(strict=True)]] | None = Field( - default=None, - description="Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - alias="nameVersion", - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - latest: StrictBool | None = Field( - default=None, - description="When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_versions_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_versions_query_v2.py deleted file mode 100644 index cf7c0205..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plug_versions_query_v2.py +++ /dev/null @@ -1,28 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import ( - Union, -) - -from typing_extensions import ( - Annotated, # >=3.9 -) - -from ..models.latest_plug_versions_query import LatestPlugVersionsQuery -from ..models.latest_plugs_query import LatestPlugsQuery - -LatestPlugVersionsQueryV2 = Union[ - Annotated[LatestPlugVersionsQuery, ""], Annotated[LatestPlugsQuery, ""] -] -"""Latest plug versions listing query..""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plugs_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plugs_query.py deleted file mode 100644 index b5943eb1..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plugs_query.py +++ /dev/null @@ -1,76 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.plug_type import PlugType - - -class LatestPlugsQuery(WaylayBaseModel): - """Latest plug versions listing query with latest links. A request that only uses these query parameters will include links to the _latest_ draft/published versions of the plug..""" - - type: PlugType | None = None - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plugs_response_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plugs_response_v2.py index 92cded3d..5a8a96ef 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plugs_response_v2.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_plugs_response_v2.py @@ -21,9 +21,7 @@ ) from waylay.sdk.api._models import BaseModel as WaylayBaseModel -from ..models.latest_plugs_response_v2_entities_inner import ( - LatestPlugsResponseV2EntitiesInner, -) +from ..models.entity_with_links_i_plug_response_v2 import EntityWithLinksIPlugResponseV2 class LatestPlugsResponseV2(WaylayBaseModel): @@ -38,7 +36,7 @@ class LatestPlugsResponseV2(WaylayBaseModel): page: StrictFloat | StrictInt | None = Field( default=None, description="The page number of a paged query result." ) - entities: List[LatestPlugsResponseV2EntitiesInner] = Field( + entities: List[EntityWithLinksIPlugResponseV2] = Field( description="The specification and deployment status of the queried functions" ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_webscripts_response_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_webscripts_response_v2.py index 9dcabeb4..fc5dd681 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_webscripts_response_v2.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/latest_webscripts_response_v2.py @@ -21,8 +21,8 @@ ) from waylay.sdk.api._models import BaseModel as WaylayBaseModel -from ..models.latest_webscripts_response_v2_entities_inner import ( - LatestWebscriptsResponseV2EntitiesInner, +from ..models.entity_with_links_i_webscript_response_with_invoke_link_v2 import ( + EntityWithLinksIWebscriptResponseWithInvokeLinkV2, ) @@ -38,7 +38,7 @@ class LatestWebscriptsResponseV2(WaylayBaseModel): page: StrictFloat | StrictInt | None = Field( default=None, description="The page number of a paged query result." ) - entities: List[LatestWebscriptsResponseV2EntitiesInner] = Field( + entities: List[EntityWithLinksIWebscriptResponseWithInvokeLinkV2] = Field( description="The specification and deployment status of the queried functions" ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_configuration_object.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_configuration_object.py deleted file mode 100644 index 7f811fe1..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_configuration_object.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import Any - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_configuration_object_format import LegacyConfigurationObjectFormat -from ..models.plug_property_data_type import PlugPropertyDataType - - -class LegacyConfigurationObject(WaylayBaseModel): - """LegacyConfigurationObject.""" - - name: StrictStr - type: PlugPropertyDataType - mandatory: StrictBool | None = None - format: LegacyConfigurationObjectFormat | None = None - default_value: Any | None = Field(default=None, alias="defaultValue") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_configuration_object_format.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_configuration_object_format.py deleted file mode 100644 index d77f14dd..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_configuration_object_format.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import Any, List - -from pydantic import ( - ConfigDict, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.plug_property_format_type import PlugPropertyFormatType - - -class LegacyConfigurationObjectFormat(WaylayBaseModel): - """LegacyConfigurationObjectFormat.""" - - type: PlugPropertyFormatType | None = None - values: List[Any] | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_configuration_response_object.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_configuration_response_object.py deleted file mode 100644 index c1e2f39d..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_configuration_response_object.py +++ /dev/null @@ -1,40 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import Any - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_configuration_object_format import LegacyConfigurationObjectFormat -from ..models.plug_property_data_type import PlugPropertyDataType - - -class LegacyConfigurationResponseObject(WaylayBaseModel): - """LegacyConfigurationResponseObject.""" - - name: StrictStr - type: PlugPropertyDataType - mandatory: StrictBool | None = None - format: LegacyConfigurationObjectFormat | None = None - default_value: Any | None = Field(default=None, alias="defaultValue") - sensitive: StrictBool | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_create_debug_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_create_debug_response.py deleted file mode 100644 index 0eb5597a..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_create_debug_response.py +++ /dev/null @@ -1,29 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class LegacyCreateDebugResponse(WaylayBaseModel): - """LegacyCreateDebugResponse.""" - - function_name: StrictStr = Field(alias="functionName") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_debug_plug_manifest.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_debug_plug_manifest.py deleted file mode 100644 index d1d29e8d..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_debug_plug_manifest.py +++ /dev/null @@ -1,62 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re -from typing import Dict - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.function_deploy_overrides_type import FunctionDeployOverridesType -from ..models.function_meta import FunctionMeta -from ..models.semantic_version_range import SemanticVersionRange - - -class LegacyDebugPlugManifest(WaylayBaseModel): - """LegacyDebugPlugManifest.""" - - deploy: FunctionDeployOverridesType | None = None - name: StrictStr = Field(description="The logical name for the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - runtime: StrictStr - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - metadata: FunctionMeta - tenant: StrictStr - dependencies: Dict[str, StrictStr] | None = None - script: StrictStr - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_debug_plug_request.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_debug_plug_request.py deleted file mode 100644 index 96632382..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_debug_plug_request.py +++ /dev/null @@ -1,36 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import Dict - -from pydantic import ( - ConfigDict, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.function_meta import FunctionMeta -from ..models.plug_type import PlugType - - -class LegacyDebugPlugRequest(WaylayBaseModel): - """LegacyDebugPlugRequest.""" - - type: PlugType | None = None - script: StrictStr - dependencies: Dict[str, StrictStr] | None = None - metadata: FunctionMeta | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_documentation.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_documentation.py deleted file mode 100644 index 7e6d1ac8..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_documentation.py +++ /dev/null @@ -1,34 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.documentation_property import DocumentationProperty - - -class LegacyDocumentation(WaylayBaseModel): - """LegacyDocumentation.""" - - supported_states: List[DocumentationProperty] = Field(alias="supportedStates") - configuration: List[DocumentationProperty] - raw_data: List[DocumentationProperty] = Field(alias="rawData") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_documentation_request.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_documentation_request.py deleted file mode 100644 index 3b40a00b..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_documentation_request.py +++ /dev/null @@ -1,36 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.documentation_property import DocumentationProperty - - -class LegacyDocumentationRequest(WaylayBaseModel): - """LegacyDocumentationRequest.""" - - description: StrictStr | None = None - supported_states: List[DocumentationProperty] = Field(alias="supportedStates") - configuration: List[DocumentationProperty] - raw_data: List[DocumentationProperty] = Field(alias="rawData") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_function_meta.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_function_meta.py deleted file mode 100644 index e5dc12ca..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_function_meta.py +++ /dev/null @@ -1,38 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.tag import Tag - - -class LegacyFunctionMeta(WaylayBaseModel): - """LegacyFunctionMeta.""" - - author: StrictStr | None = None - description: StrictStr | None = None - category: StrictStr | None = None - tags: List[Tag] | None = None - icon_url: StrictStr | None = Field(default=None, alias="iconURL") - friendly_name: StrictStr | None = Field(default=None, alias="friendlyName") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_create_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_create_query.py deleted file mode 100644 index dc5c0931..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_create_query.py +++ /dev/null @@ -1,43 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class LegacyPlugCreateQuery(WaylayBaseModel): - """LegacyPlugCreateQuery.""" - - var_async: StrictBool | None = Field( - default=False, - description="If this is set to true, the server will start the required job actions asynchronously and return a 202 Accepted response. Otherwise, the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - dry_run: StrictBool | None = Field( - default=None, - description="If set to true, only validates the incoming request.", - alias="dryRun", - ) - scale_to_zero: StrictBool | None = Field( - default=None, - description="If set to true, scales the function to zero after successful deployment.", - alias="scaleToZero", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_create_request.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_create_request.py deleted file mode 100644 index 7a35dc42..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_create_request.py +++ /dev/null @@ -1,56 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re -from typing import Dict - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_plug_request_metadata import LegacyPlugRequestMetadata -from ..models.plug_type import PlugType - - -class LegacyPlugCreateRequest(WaylayBaseModel): - """LegacyPlugCreateRequest.""" - - name: StrictStr - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - script: StrictStr - dependencies: Dict[str, StrictStr] | None = None - metadata: LegacyPlugRequestMetadata - type: PlugType | None = None - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_create_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_create_response.py deleted file mode 100644 index 709a29c3..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_create_response.py +++ /dev/null @@ -1,35 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictFloat, - StrictInt, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_plug_script_response import LegacyPlugScriptResponse - - -class LegacyPlugCreateResponse(WaylayBaseModel): - """LegacyPlugCreateResponse.""" - - status_code: StrictFloat | StrictInt = Field(alias="statusCode") - uri: StrictStr - entity: LegacyPlugScriptResponse - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_meta_request.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_meta_request.py deleted file mode 100644 index 697d0c30..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_meta_request.py +++ /dev/null @@ -1,43 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_plug_request_metadata_documentation import ( - LegacyPlugRequestMetadataDocumentation, -) -from ..models.tag import Tag - - -class LegacyPlugMetaRequest(WaylayBaseModel): - """LegacyPlugMetaRequest.""" - - author: StrictStr | None = None - description: StrictStr | None = None - category: StrictStr | None = None - tags: List[Tag] | None = None - icon_url: StrictStr | None = Field(default=None, alias="iconURL") - friendly_name: StrictStr | None = Field(default=None, alias="friendlyName") - documentation: LegacyPlugRequestMetadataDocumentation | None = None - documentation_url: StrictStr | None = Field(default=None, alias="documentationURL") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_query.py deleted file mode 100644 index 2a1933a3..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_query.py +++ /dev/null @@ -1,104 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.tags_filter import TagsFilter -from ..models.timestamp_spec import TimestampSpec - - -class LegacyPlugQuery(WaylayBaseModel): - """LegacyPlugQuery.""" - - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - tags: TagsFilter | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request.py deleted file mode 100644 index 7ab06cc2..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request.py +++ /dev/null @@ -1,56 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re -from typing import Dict - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_plug_request_metadata import LegacyPlugRequestMetadata -from ..models.plug_type import PlugType - - -class LegacyPlugRequest(WaylayBaseModel): - """LegacyPlugRequest.""" - - name: StrictStr - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - script: StrictStr - dependencies: Dict[str, StrictStr] | None = None - metadata: LegacyPlugRequestMetadata - type: PlugType - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata.py deleted file mode 100644 index d9b776cb..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata.py +++ /dev/null @@ -1,58 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_configuration_object import LegacyConfigurationObject -from ..models.legacy_plug_request_metadata_documentation import ( - LegacyPlugRequestMetadataDocumentation, -) -from ..models.legacy_plug_request_metadata_raw_data_inner import ( - LegacyPlugRequestMetadataRawDataInner, -) -from ..models.legacy_required_properties_inner import LegacyRequiredPropertiesInner -from ..models.tag import Tag - - -class LegacyPlugRequestMetadata(WaylayBaseModel): - """LegacyPlugRequestMetadata.""" - - required_properties: List[LegacyRequiredPropertiesInner] | None = Field( - default=None, alias="requiredProperties" - ) - supported_states: List[StrictStr] | None = Field( - default=None, alias="supportedStates" - ) - raw_data: List[LegacyPlugRequestMetadataRawDataInner] | None = Field( - default=None, alias="rawData" - ) - configuration: List[LegacyConfigurationObject] | None = None - author: StrictStr | None = None - description: StrictStr | None = None - category: StrictStr | None = None - tags: List[Tag] | None = None - icon_url: StrictStr | None = Field(default=None, alias="iconURL") - friendly_name: StrictStr | None = Field(default=None, alias="friendlyName") - documentation: LegacyPlugRequestMetadataDocumentation | None = None - documentation_url: StrictStr | None = Field(default=None, alias="documentationURL") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata_documentation.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata_documentation.py deleted file mode 100644 index bc9dad4d..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata_documentation.py +++ /dev/null @@ -1,31 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import ( - Union, -) - -from typing_extensions import ( - Annotated, # >=3.9 -) - -from ..models.documentation import Documentation -from ..models.legacy_plug_request_metadata_documentation_any_of import ( - LegacyPlugRequestMetadataDocumentationAnyOf, -) - -LegacyPlugRequestMetadataDocumentation = Union[ - Annotated[LegacyPlugRequestMetadataDocumentationAnyOf, ""], - Annotated[Documentation, ""], -] -"""LegacyPlugRequestMetadataDocumentation.""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata_documentation_any_of.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata_documentation_any_of.py deleted file mode 100644 index e1a31109..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata_documentation_any_of.py +++ /dev/null @@ -1,36 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.documentation_property import DocumentationProperty - - -class LegacyPlugRequestMetadataDocumentationAnyOf(WaylayBaseModel): - """LegacyPlugRequestMetadataDocumentationAnyOf.""" - - supported_states: List[DocumentationProperty] | None = Field( - default=None, alias="supportedStates" - ) - configuration: List[DocumentationProperty] | None = None - raw_data: List[DocumentationProperty] | None = Field(default=None, alias="rawData") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata_raw_data_inner.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata_raw_data_inner.py deleted file mode 100644 index 1eaa69ce..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_request_metadata_raw_data_inner.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.plug_property_data_type import PlugPropertyDataType - - -class LegacyPlugRequestMetadataRawDataInner(WaylayBaseModel): - """LegacyPlugRequestMetadataRawDataInner.""" - - parameter: StrictStr - data_type: PlugPropertyDataType | None = Field(default=None, alias="dataType") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_response.py deleted file mode 100644 index e2f87652..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_response.py +++ /dev/null @@ -1,72 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re -from typing import Any, Dict, List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.failure_reason import FailureReason -from ..models.legacy_configuration_response_object import ( - LegacyConfigurationResponseObject, -) -from ..models.legacy_plug_response_metadata import LegacyPlugResponseMetadata -from ..models.media_type import MediaType -from ..models.status import Status - - -class LegacyPlugResponse(WaylayBaseModel): - """LegacyPlugResponse.""" - - name: StrictStr - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - author: StrictStr | None = None - category: StrictStr | None = None - icon_url: StrictStr | None = Field(default=None, alias="iconURL") - documentation_url: StrictStr | None = Field(default=None, alias="documentationURL") - is_deprecated: StrictBool = Field(alias="isDeprecated") - description: StrictStr | None = None - states: List[StrictStr] | None = None - raw_data: List[Dict[str, Any]] | None = Field(default=None, alias="rawData") - media_type: MediaType = Field(alias="mediaType") - configuration: List[LegacyConfigurationResponseObject] | None = None - commands: List[StrictStr] - status: Status - failure_reason: FailureReason | None = Field(default=None, alias="failureReason") - metadata: LegacyPlugResponseMetadata - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_response_metadata.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_response_metadata.py deleted file mode 100644 index f0a88c4f..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_response_metadata.py +++ /dev/null @@ -1,40 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_documentation import LegacyDocumentation -from ..models.tag import Tag - - -class LegacyPlugResponseMetadata(WaylayBaseModel): - """LegacyPlugResponseMetadata.""" - - documentation: LegacyDocumentation | None = None - author: StrictStr | None = None - description: StrictStr | None = None - category: StrictStr | None = None - tags: List[Tag] | None = None - icon_url: StrictStr | None = Field(default=None, alias="iconURL") - friendly_name: StrictStr | None = Field(default=None, alias="friendlyName") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_script_meta.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_script_meta.py deleted file mode 100644 index 658f5136..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_script_meta.py +++ /dev/null @@ -1,47 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_plug_script_meta_raw_data_inner import ( - LegacyPlugScriptMetaRawDataInner, -) -from ..models.legacy_required_properties_inner import LegacyRequiredPropertiesInner -from ..models.tag import Tag - - -class LegacyPlugScriptMeta(WaylayBaseModel): - """LegacyPlugScriptMeta.""" - - author: StrictStr | None = None - description: StrictStr | None = None - category: StrictStr | None = None - tags: List[Tag] | None = None - icon_url: StrictStr | None = Field(default=None, alias="iconURL") - friendly_name: StrictStr | None = Field(default=None, alias="friendlyName") - supported_states: List[StrictStr] = Field(alias="supportedStates") - raw_data: List[LegacyPlugScriptMetaRawDataInner] = Field(alias="rawData") - required_properties: List[LegacyRequiredPropertiesInner] | None = Field( - default=None, alias="requiredProperties" - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_script_meta_raw_data_inner.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_script_meta_raw_data_inner.py deleted file mode 100644 index d6a0b3b4..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_script_meta_raw_data_inner.py +++ /dev/null @@ -1,30 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class LegacyPlugScriptMetaRawDataInner(WaylayBaseModel): - """LegacyPlugScriptMetaRawDataInner.""" - - parameter: StrictStr - data_type: StrictStr | None = Field(default=None, alias="dataType") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_script_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_script_response.py deleted file mode 100644 index f15b1177..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_plug_script_response.py +++ /dev/null @@ -1,56 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re -from typing import Any, Dict - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_plug_script_meta import LegacyPlugScriptMeta -from ..models.plug_type import PlugType - - -class LegacyPlugScriptResponse(WaylayBaseModel): - """LegacyPlugScriptResponse.""" - - name: StrictStr - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - type: PlugType - script: StrictStr - metadata: LegacyPlugScriptMeta - dependencies: Dict[str, Any] - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_required_properties_inner.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_required_properties_inner.py deleted file mode 100644 index a77e6de3..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_required_properties_inner.py +++ /dev/null @@ -1,27 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import ( - Union, -) - -from typing_extensions import ( - Annotated, # >=3.9 -) - -from ..models.legacy_required_property_object import LegacyRequiredPropertyObject - -LegacyRequiredPropertiesInner = Union[ - Annotated[str, ""], Annotated[LegacyRequiredPropertyObject, ""] -] -"""LegacyRequiredPropertiesInner.""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_required_property_object.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_required_property_object.py deleted file mode 100644 index a80a5c64..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/legacy_required_property_object.py +++ /dev/null @@ -1,34 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.plug_property_data_type import PlugPropertyDataType - - -class LegacyRequiredPropertyObject(WaylayBaseModel): - """LegacyRequiredPropertyObject.""" - - name: StrictStr - type: PlugPropertyDataType - mandatory: StrictBool - sensitive: StrictBool - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/limit_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/limit_query.py deleted file mode 100644 index 141f8137..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/limit_query.py +++ /dev/null @@ -1,38 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class LimitQuery(WaylayBaseModel): - """LimitQuery.""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/message_and_status_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/message_and_status_response.py deleted file mode 100644 index 6c2596bc..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/message_and_status_response.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictFloat, - StrictInt, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class MessageAndStatusResponse(WaylayBaseModel): - """MessageAndStatusResponse.""" - - message: StrictStr - status_code: StrictFloat | StrictInt = Field(alias="statusCode") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/message_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/message_response.py deleted file mode 100644 index d389545a..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/message_response.py +++ /dev/null @@ -1,28 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class MessageResponse(WaylayBaseModel): - """MessageResponse.""" - - message: StrictStr - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/multipart_file_upload.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/multipart_file_upload.py deleted file mode 100644 index cded4937..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/multipart_file_upload.py +++ /dev/null @@ -1,31 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - StrictBytes, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class MultipartFileUpload(WaylayBaseModel): - """A multi-part upload containing one or more file assets..""" - - filename: List[StrictBytes | StrictStr] | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/name.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/name.py deleted file mode 100644 index 3b790a77..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/name.py +++ /dev/null @@ -1,29 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class Name(WaylayBaseModel): - """Name.""" - - name: StrictStr = Field(description="The name of the function.") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/name_and_version.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/name_and_version.py deleted file mode 100644 index b5d463d6..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/name_and_version.py +++ /dev/null @@ -1,48 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class NameAndVersion(WaylayBaseModel): - """NameAndVersion.""" - - name: StrictStr = Field(description="The name of the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_function_versions_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/named_function_versions_query.py deleted file mode 100644 index c2c7216d..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_function_versions_query.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.timestamp_spec import TimestampSpec - - -class NamedFunctionVersionsQuery(WaylayBaseModel): - """Named function versions listing query..""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - deprecated: StrictBool | None = Field( - default=None, description="Filter on the deprecation status of the function." - ) - draft: StrictBool | None = Field( - default=None, description="Filter on the draft status of the function." - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_kf_serving_versions_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/named_kf_serving_versions_query_v2.py deleted file mode 100644 index 9086a2e1..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_kf_serving_versions_query_v2.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.timestamp_spec import TimestampSpec - - -class NamedKFServingVersionsQueryV2(WaylayBaseModel): - """Named Model versions query..""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - deprecated: StrictBool | None = Field( - default=None, description="Filter on the deprecation status of the function." - ) - draft: StrictBool | None = Field( - default=None, description="Filter on the draft status of the function." - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_as_job_reference.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_as_job_reference.py deleted file mode 100644 index d5bb05ac..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_as_job_reference.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.named_parameters_typeof_as_job_reference_job_status import ( - NamedParametersTypeofAsJobReferenceJobStatus, -) - - -class NamedParametersTypeofAsJobReference(WaylayBaseModel): - """NamedParametersTypeofAsJobReference.""" - - job_status: NamedParametersTypeofAsJobReferenceJobStatus = Field(alias="jobStatus") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_as_job_reference_job_status.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_as_job_reference_job_status.py deleted file mode 100644 index 6422bed9..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_as_job_reference_job_status.py +++ /dev/null @@ -1,56 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from datetime import datetime -from typing import Any - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.failure_reason import FailureReason -from ..models.function_ref import FunctionRef -from ..models.job_hal_links import JobHALLinks -from ..models.job_state_result import JobStateResult -from ..models.job_status import JobStatus - - -class NamedParametersTypeofAsJobReferenceJobStatus(WaylayBaseModel): - """NamedParametersTypeofAsJobReferenceJobStatus.""" - - links: JobHALLinks | None = Field(default=None, alias="_links") - type: Any | None = Field(description="The type of the background task.") - state: JobStateResult - request: Any | None = Field( - default=None, description="The request that initiated this job." - ) - result: Any | None = Field( - default=None, description="The result of the job if completed." - ) - created_at: datetime = Field( - description="The timestamp of creation of this job", alias="createdAt" - ) - created_by: StrictStr = Field( - description="The user that created this job", alias="createdBy" - ) - operation: StrictStr = Field(description="Request operation") - function: FunctionRef | None = None - job: JobStatus | None = None - failure_reason: FailureReason | None = Field(default=None, alias="failureReason") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_from_legacy.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_from_legacy.py deleted file mode 100644 index 584938d9..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_from_legacy.py +++ /dev/null @@ -1,34 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_plug_meta_request import LegacyPlugMetaRequest -from ..models.plug_interface import PlugInterface - - -class NamedParametersTypeofFromLegacy(WaylayBaseModel): - """NamedParametersTypeofFromLegacy.""" - - metadata: LegacyPlugMetaRequest - current_interface: PlugInterface | None = Field( - default=None, alias="currentInterface" - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_from_legacy_documentation.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_from_legacy_documentation.py deleted file mode 100644 index 2827cc5f..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_from_legacy_documentation.py +++ /dev/null @@ -1,38 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_plug_request_metadata_documentation import ( - LegacyPlugRequestMetadataDocumentation, -) -from ..models.plug_interface import PlugInterface - - -class NamedParametersTypeofFromLegacyDocumentation(WaylayBaseModel): - """NamedParametersTypeofFromLegacyDocumentation.""" - - legacy_documentation: LegacyPlugRequestMetadataDocumentation | None = Field( - default=None, alias="legacyDocumentation" - ) - current_interface: PlugInterface | None = Field( - default=None, alias="currentInterface" - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_is_not_legacy.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_is_not_legacy.py deleted file mode 100644 index 199de5fe..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_parameters_typeof_is_not_legacy.py +++ /dev/null @@ -1,31 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.legacy_plug_request_metadata_documentation import ( - LegacyPlugRequestMetadataDocumentation, -) - - -class NamedParametersTypeofIsNotLegacy(WaylayBaseModel): - """NamedParametersTypeofIsNotLegacy.""" - - documentation: LegacyPlugRequestMetadataDocumentation | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_plug_versions_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/named_plug_versions_query_v2.py deleted file mode 100644 index 329ebb93..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_plug_versions_query_v2.py +++ /dev/null @@ -1,96 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.tags_filter import TagsFilter -from ..models.timestamp_spec import TimestampSpec - - -class NamedPlugVersionsQueryV2(WaylayBaseModel): - """Named plug version listing query.""" - - tags: TagsFilter | None = None - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - deprecated: StrictBool | None = Field( - default=None, description="Filter on the deprecation status of the function." - ) - draft: StrictBool | None = Field( - default=None, description="Filter on the draft status of the function." - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_versions_filter.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/named_versions_filter.py deleted file mode 100644 index 9e8175ed..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_versions_filter.py +++ /dev/null @@ -1,37 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class NamedVersionsFilter(WaylayBaseModel): - """NamedVersionsFilter.""" - - name_version: List[Annotated[str, Field(strict=True)]] | None = Field( - default=None, - description="Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - alias="nameVersion", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_webscript_versions_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/named_webscript_versions_query_v2.py deleted file mode 100644 index 42c27b53..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/named_webscript_versions_query_v2.py +++ /dev/null @@ -1,94 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.timestamp_spec import TimestampSpec - - -class NamedWebscriptVersionsQueryV2(WaylayBaseModel): - """Webscript named versions listing query..""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - deprecated: StrictBool | None = Field( - default=None, description="Filter on the deprecation status of the function." - ) - draft: StrictBool | None = Field( - default=None, description="Filter on the draft status of the function." - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/jobs_hal_link.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/notify_result.py similarity index 73% rename from waylay-sdk-registry-types/src/waylay/services/registry/models/jobs_hal_link.py rename to waylay-sdk-registry-types/src/waylay/services/registry/models/notify_result.py index 1165f633..738b547c 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/jobs_hal_link.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/notify_result.py @@ -16,13 +16,13 @@ ) from waylay.sdk.api._models import BaseModel as WaylayBaseModel -from ..models.hal_link import HALLink +from ..models.request_operation import RequestOperation -class JobsHALLink(WaylayBaseModel): - """JobsHALLink.""" +class NotifyResult(WaylayBaseModel): + """The result data for a change notification..""" - jobs: HALLink | None = None + operation: RequestOperation model_config = ConfigDict( populate_by_name=True, protected_namespaces=(), extra="ignore" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/openfaas_deploy_args.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/openfaas_deploy_args.py deleted file mode 100644 index 90330e8a..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/openfaas_deploy_args.py +++ /dev/null @@ -1,36 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class OpenfaasDeployArgs(WaylayBaseModel): - """OpenfaasDeployArgs.""" - - namespace: StrictStr = Field( - description="The (openfaas) namespace for the target function." - ) - endpoint: StrictStr = Field(description="The (openfaas) endpoint service name") - image_name: StrictStr = Field( - description="The image name to use for deploying this function", - alias="imageName", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/openfaas_function_ref.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/openfaas_function_ref.py deleted file mode 100644 index 837cb071..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/openfaas_function_ref.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class OpenfaasFunctionRef(WaylayBaseModel): - """OpenfaasFunctionRef.""" - - namespace: StrictStr = Field( - description="The (openfaas) namespace for the target function." - ) - endpoint: StrictStr = Field(description="The (openfaas) endpoint service name") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/operation.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/operation.py deleted file mode 100644 index 5994c9db..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/operation.py +++ /dev/null @@ -1,33 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_type import JobType - - -class Operation(WaylayBaseModel): - """Operation.""" - - id: StrictStr - description: StrictStr - name: StrictStr - type: JobType - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/operation_status.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/operation_status.py deleted file mode 100644 index 3bdb0151..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/operation_status.py +++ /dev/null @@ -1,37 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_type import JobType -from ..models.operation_status_error import OperationStatusError - - -class OperationStatus(WaylayBaseModel): - """OperationStatus.""" - - id: StrictStr - description: StrictStr - name: StrictStr - type: JobType - done: StrictBool - error: OperationStatusError | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/operation_status_error.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/operation_status_error.py deleted file mode 100644 index 9f543a9c..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/operation_status_error.py +++ /dev/null @@ -1,31 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class OperationStatusError(WaylayBaseModel): - """OperationStatusError.""" - - name: StrictStr - message: StrictStr - stack: StrictStr | None = None - code: StrictStr - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/paging_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/paging_query.py deleted file mode 100644 index 2d8cf2d5..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/paging_query.py +++ /dev/null @@ -1,46 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class PagingQuery(WaylayBaseModel): - """PagingQuery.""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/paging_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/paging_response.py deleted file mode 100644 index 68018df4..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/paging_response.py +++ /dev/null @@ -1,39 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictFloat, - StrictInt, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class PagingResponse(WaylayBaseModel): - """PagingResponse.""" - - count: StrictFloat | StrictInt | None = Field( - default=None, - description="The total count of matching items, from which this result is one page.", - ) - limit: StrictFloat | StrictInt | None = Field( - default=None, description="The page size used for this query result." - ) - page: StrictFloat | StrictInt | None = Field( - default=None, description="The page number of a paged query result." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/patch_interface_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/patch_interface_query.py deleted file mode 100644 index 6999f2ce..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/patch_interface_query.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class PatchInterfaceQuery(WaylayBaseModel): - """PatchInterfaceQuery.""" - - comment: StrictStr | None = Field( - default=None, - description="An optional user-specified comment corresponding to the operation.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/patch_metadata_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/patch_metadata_query.py deleted file mode 100644 index 0304d52b..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/patch_metadata_query.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class PatchMetadataQuery(WaylayBaseModel): - """PatchMetadataQuery.""" - - comment: StrictStr | None = Field( - default=None, - description="An optional user-specified comment corresponding to the operation.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/patch_plug_request_v1.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/patch_plug_request_v1.py deleted file mode 100644 index 65701dc4..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/patch_plug_request_v1.py +++ /dev/null @@ -1,29 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.user_plug_meta import UserPlugMeta - - -class PatchPlugRequestV1(WaylayBaseModel): - """PatchPlugRequestV1.""" - - metadata: UserPlugMeta - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_delete_force_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_delete_force_query.py deleted file mode 100644 index 6ad31238..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_delete_force_query.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class PlugDeleteForceQuery(WaylayBaseModel): - """PlugDeleteForceQuery.""" - - force: StrictBool | None = Field( - default=None, - description="If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_delete_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_delete_query.py deleted file mode 100644 index ed0ad3ed..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_delete_query.py +++ /dev/null @@ -1,36 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class PlugDeleteQuery(WaylayBaseModel): - """PlugDeleteQuery.""" - - force: StrictBool | None = Field( - default=None, - description="If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings.", - ) - undeploy: StrictBool | None = Field( - default=None, - description="If `true`, the `DELETE` operation * undeploys the (openfaas) function for the plug: it becomes no longer available for invocation. * does NOT remove the plug from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the plug can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug version(s) as _deprecated_: the plug remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_listing_and_query_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_listing_and_query_response.py deleted file mode 100644 index e46a10d0..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_listing_and_query_response.py +++ /dev/null @@ -1,44 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictFloat, - StrictInt, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.plug_response import PlugResponse - - -class PlugListingAndQueryResponse(WaylayBaseModel): - """Successful Response.""" - - count: StrictFloat | StrictInt | None = Field( - default=None, - description="The total count of matching items, from which this result is one page.", - ) - limit: StrictFloat | StrictInt | None = Field( - default=None, description="The page size used for this query result." - ) - page: StrictFloat | StrictInt | None = Field( - default=None, description="The page number of a paged query result." - ) - plugs: List[PlugResponse] - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_listing_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_listing_response.py deleted file mode 100644 index a2a8869c..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_listing_response.py +++ /dev/null @@ -1,31 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.plug_response import PlugResponse - - -class PlugListingResponse(WaylayBaseModel): - """Successful Response.""" - - plugs: List[PlugResponse] - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_response.py deleted file mode 100644 index cb0e9b13..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_response.py +++ /dev/null @@ -1,83 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re -from datetime import datetime -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.failure_reason import FailureReason -from ..models.function_deploy_overrides_type import FunctionDeployOverridesType -from ..models.function_meta import FunctionMeta -from ..models.job_hal_links import JobHALLinks -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status import Status - - -class PlugResponse(WaylayBaseModel): - """PlugResponse.""" - - deploy: FunctionDeployOverridesType | None = None - name: StrictStr = Field(description="The logical name for the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - runtime: StrictStr - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - metadata: FunctionMeta - created_by: StrictStr = Field( - description="The user that created this entity.", alias="createdBy" - ) - created_at: datetime = Field( - description="The timestamp at which this entity was created.", alias="createdAt" - ) - updated_by: StrictStr = Field( - description="The user that last updated this entity.", alias="updatedBy" - ) - updated_at: datetime = Field( - description="The timestamp at which this entity was last updated.", - alias="updatedAt", - ) - status: Status - failure_reason: FailureReason | None = Field(default=None, alias="failureReason") - links: List[JobHALLinks] | None = Field( - default=None, description="Links to related entities.", alias="_links" - ) - is_deprecated: StrictBool = Field(alias="isDeprecated") - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_type_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_type_query.py deleted file mode 100644 index e1e99480..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/plug_type_query.py +++ /dev/null @@ -1,29 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.plug_type import PlugType - - -class PlugTypeQuery(WaylayBaseModel): - """PlugTypeQuery.""" - - type: PlugType | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/publish_function_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/publish_function_query.py deleted file mode 100644 index e31470fa..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/publish_function_query.py +++ /dev/null @@ -1,43 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.deprecate_previous_policy import DeprecatePreviousPolicy - - -class PublishFunctionQuery(WaylayBaseModel): - """PublishFunctionQuery.""" - - comment: StrictStr | None = Field( - default=None, - description="An optional user-specified comment corresponding to the operation.", - ) - deprecate_previous: DeprecatePreviousPolicy | None = Field( - default=None, alias="deprecatePrevious" - ) - var_async: StrictBool | None = Field( - default=True, - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_computed_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_computed_response.py deleted file mode 100644 index 4aa88145..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_computed_response.py +++ /dev/null @@ -1,31 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_causes import JobCauses - - -class RebuildComputedResponse(WaylayBaseModel): - """Rebuild Ignored.""" - - message: StrictStr - causes: JobCauses - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_query_params.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_query_params.py deleted file mode 100644 index 615d70bc..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_query_params.py +++ /dev/null @@ -1,74 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.rebuild_policy import RebuildPolicy - - -class RebuildQueryParams(WaylayBaseModel): - """RebuildQueryParams.""" - - upgrade: RebuildPolicy | None = None - dry_run: StrictBool | None = Field( - default=None, - description="If set to true, checks whether rebuild jobs are needed, but do not start any jobs.", - alias="dryRun", - ) - force_version: Annotated[str, Field(strict=True)] | None = Field( - default=None, - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org", - alias="forceVersion", - ) - ignore_checks: StrictBool | None = Field( - default=None, - description="If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option", - alias="ignoreChecks", - ) - scale_to_zero: StrictBool | None = Field( - default=None, - description="Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command.", - alias="scaleToZero", - ) - skip_rebuild: StrictBool | None = Field( - default=None, - description="If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function.", - alias="skipRebuild", - ) - - @field_validator("force_version") - @classmethod - def force_version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if value is None: - return value - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_query_v2.py deleted file mode 100644 index 12902f30..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_query_v2.py +++ /dev/null @@ -1,84 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.rebuild_policy import RebuildPolicy - - -class RebuildQueryV2(WaylayBaseModel): - """RebuildQueryV2.""" - - comment: StrictStr | None = Field( - default=None, - description="An optional user-specified comment corresponding to the operation.", - ) - dry_run: StrictBool | None = Field( - default=None, - description="If set to true, checks whether rebuild jobs are needed, but do not start any jobs.", - alias="dryRun", - ) - var_async: StrictBool | None = Field( - default=True, - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - upgrade: RebuildPolicy | None = None - force_version: Annotated[str, Field(strict=True)] | None = Field( - default=None, - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org", - alias="forceVersion", - ) - ignore_checks: StrictBool | None = Field( - default=None, - description="If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option", - alias="ignoreChecks", - ) - scale_to_zero: StrictBool | None = Field( - default=None, - description="Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command.", - alias="scaleToZero", - ) - skip_rebuild: StrictBool | None = Field( - default=None, - description="If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function.", - alias="skipRebuild", - ) - - @field_validator("force_version") - @classmethod - def force_version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if value is None: - return value - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_submitted_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_submitted_response.py deleted file mode 100644 index 7355b867..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/rebuild_submitted_response.py +++ /dev/null @@ -1,34 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.job_causes import JobCauses -from ..models.job_hal_links import JobHALLinks - - -class RebuildSubmittedResponse(WaylayBaseModel): - """Rebuild Initiated.""" - - message: StrictStr - links: JobHALLinks = Field(alias="_links") - causes: JobCauses - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/error_and_status_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/registry_error_response.py similarity index 79% rename from waylay-sdk-registry-types/src/waylay/services/registry/models/error_and_status_response.py rename to waylay-sdk-registry-types/src/waylay/services/registry/models/registry_error_response.py index b525f2d4..a23c61f2 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/error_and_status_response.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/registry_error_response.py @@ -11,6 +11,8 @@ from __future__ import annotations +from typing import Dict + from pydantic import ( ConfigDict, Field, @@ -21,11 +23,13 @@ from waylay.sdk.api._models import BaseModel as WaylayBaseModel -class ErrorAndStatusResponse(WaylayBaseModel): - """ErrorAndStatusResponse.""" +class RegistryErrorResponse(WaylayBaseModel): + """RegistryErrorResponse.""" error: StrictStr + code: StrictStr status_code: StrictFloat | StrictInt = Field(alias="statusCode") + data: Dict[str, StrictStr] | None = None model_config = ConfigDict( populate_by_name=True, protected_namespaces=(), extra="ignore" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/remove_function_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/remove_function_query_v2.py deleted file mode 100644 index f10f292a..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/remove_function_query_v2.py +++ /dev/null @@ -1,46 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class RemoveFunctionQueryV2(WaylayBaseModel): - """RemoveFunctionQueryV2.""" - - comment: StrictStr | None = Field( - default=None, - description="An optional user-specified comment corresponding to the operation.", - ) - var_async: StrictBool | None = Field( - default=True, - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - force: StrictBool | None = Field( - default=None, - description="If true, the function version will be immediately undeployed and removed. Otherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_.", - ) - undeploy: StrictBool | None = Field( - default=None, - description="If `true`, the `DELETE` operation * undeploys the (openfaas) function: it becomes no longer available for invocation. * does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/remove_plug_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/remove_plug_query_v2.py deleted file mode 100644 index 69f9c020..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/remove_plug_query_v2.py +++ /dev/null @@ -1,46 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class RemovePlugQueryV2(WaylayBaseModel): - """RemovePlugQueryV2.""" - - comment: StrictStr | None = Field( - default=None, - description="An optional user-specified comment corresponding to the operation.", - ) - var_async: StrictBool | None = Field( - default=True, - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - force: StrictBool | None = Field( - default=None, - description="If true, the plug version(s) will be undeployed and removed. Otherwise, the plug version(s) will only be deprecated, i.e removed from regular listings.", - ) - undeploy: StrictBool | None = Field( - default=None, - description="If `true`, the `DELETE` operation * undeploys the (openfaas) function for the plug: it becomes no longer available for invocation. * does NOT remove the plug from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the plug can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug version(s) as _deprecated_: the plug remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_info.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_info.py deleted file mode 100644 index 9fc25b19..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_info.py +++ /dev/null @@ -1,34 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.function_type import FunctionType - - -class RuntimeInfo(WaylayBaseModel): - """Runtime attributes that are the same for all versions of a runtime..""" - - name: StrictStr - function_type: FunctionType = Field(alias="functionType") - archive_format: ArchiveFormat = Field(alias="archiveFormat") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_name_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_name_query.py deleted file mode 100644 index b6c4c3c5..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_name_query.py +++ /dev/null @@ -1,47 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.function_type import FunctionType - - -class RuntimeNameQuery(WaylayBaseModel): - """RuntimeNameQuery.""" - - name: StrictStr | None = Field( - default=None, - description="If set, filters on the name of a runtime. Supports * and ? wildcards and is case-insensitive.", - ) - function_type: List[FunctionType] | None = Field( - default=None, - description="If set, filters on the functionType of a runtime. Uses an exact match.", - alias="functionType", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="If set, filters on the archiveFormat of a runtime. Uses an exact match.", - alias="archiveFormat", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_params.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_params.py deleted file mode 100644 index 60b31497..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_params.py +++ /dev/null @@ -1,28 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class RuntimeParams(WaylayBaseModel): - """RuntimeParams.""" - - name: StrictStr - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_query.py deleted file mode 100644 index 90d51d8b..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_query.py +++ /dev/null @@ -1,57 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.function_type import FunctionType -from ..models.latest_version_level import LatestVersionLevel -from ..models.semantic_version_range import SemanticVersionRange - - -class RuntimeQuery(WaylayBaseModel): - """RuntimeQuery.""" - - version: SemanticVersionRange | None = None - latest: LatestVersionLevel | None = None - include_deprecated: StrictBool | None = Field( - default=False, - description="If set to `true`, deprecated runtimes will be included in the query.", - alias="includeDeprecated", - ) - name: StrictStr | None = Field( - default=None, - description="If set, filters on the name of a runtime. Supports * and ? wildcards and is case-insensitive.", - ) - function_type: List[FunctionType] | None = Field( - default=None, - description="If set, filters on the functionType of a runtime. Uses an exact match.", - alias="functionType", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="If set, filters on the archiveFormat of a runtime. Uses an exact match.", - alias="archiveFormat", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_reference.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_reference.py deleted file mode 100644 index c798d169..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_reference.py +++ /dev/null @@ -1,48 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class RuntimeReference(WaylayBaseModel): - """Reference to a runtime version..""" - - name: StrictStr - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_specification.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_specification.py deleted file mode 100644 index 23dcb587..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_specification.py +++ /dev/null @@ -1,49 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.assets_conditions import AssetsConditions -from ..models.build_spec import BuildSpec -from ..models.deploy_spec import DeploySpec -from ..models.language_release import LanguageRelease -from ..models.provided_dependency import ProvidedDependency - - -class RuntimeSpecification(WaylayBaseModel): - """Runtime (version) specification that says * what assets are required/allowed to build the function * what build parameters are used * what deployment parameters are used * which dependencies are provided by the runtime.""" - - build: BuildSpec | None = None - deploy: DeploySpec | None = None - language: LanguageRelease | None = None - provided_dependencies: List[ProvidedDependency] | None = Field( - default=None, - description="Description of dependencies provided by this runtime version.", - alias="providedDependencies", - ) - assets: AssetsConditions | None = None - deprecated: StrictBool | None = Field( - default=None, - description="If true, this runtime should no longer be used for new functions.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_summary_attrs.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_summary_attrs.py deleted file mode 100644 index 14806f01..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_summary_attrs.py +++ /dev/null @@ -1,36 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.function_type import FunctionType - - -class RuntimeSummaryAttrs(WaylayBaseModel): - """RuntimeSummaryAttrs.""" - - name: StrictStr - title: StrictStr - description: StrictStr | None = None - function_type: FunctionType = Field(alias="functionType") - archive_format: ArchiveFormat = Field(alias="archiveFormat") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_and_path_params.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_and_path_params.py deleted file mode 100644 index 49e83af9..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_and_path_params.py +++ /dev/null @@ -1,36 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.semantic_version_range import SemanticVersionRange - - -class RuntimeVersionAndPathParams(WaylayBaseModel): - """RuntimeVersionAndPathParams.""" - - wildcard: StrictStr = Field( - description="Full path or path prefix of the asset within the archive", - alias="*", - ) - name: StrictStr - version: SemanticVersionRange - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_params.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_params.py deleted file mode 100644 index ee405b79..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_params.py +++ /dev/null @@ -1,31 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.semantic_version_range import SemanticVersionRange - - -class RuntimeVersionParams(WaylayBaseModel): - """RuntimeVersionParams.""" - - name: StrictStr - version: SemanticVersionRange - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_query.py deleted file mode 100644 index a7880e6e..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_query.py +++ /dev/null @@ -1,38 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.latest_version_level import LatestVersionLevel -from ..models.semantic_version_range import SemanticVersionRange - - -class RuntimeVersionQuery(WaylayBaseModel): - """RuntimeVersionQuery.""" - - version: SemanticVersionRange | None = None - latest: LatestVersionLevel | None = None - include_deprecated: StrictBool | None = Field( - default=False, - description="If set to `true`, deprecated runtimes will be included in the query.", - alias="includeDeprecated", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_specification.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_specification.py deleted file mode 100644 index c9cada29..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_specification.py +++ /dev/null @@ -1,70 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.assets_conditions import AssetsConditions -from ..models.build_spec import BuildSpec -from ..models.deploy_spec import DeploySpec -from ..models.language_release import LanguageRelease -from ..models.provided_dependency import ProvidedDependency - - -class RuntimeVersionSpecification(WaylayBaseModel): - """RuntimeVersionSpecification.""" - - build: BuildSpec | None = None - deploy: DeploySpec | None = None - language: LanguageRelease | None = None - provided_dependencies: List[ProvidedDependency] | None = Field( - default=None, - description="Description of dependencies provided by this runtime version.", - alias="providedDependencies", - ) - assets: AssetsConditions | None = None - deprecated: StrictBool | None = Field( - default=None, - description="If true, this runtime should no longer be used for new functions.", - ) - title: StrictStr - description: StrictStr | None = None - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_status.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_status.py deleted file mode 100644 index 696e54b9..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_status.py +++ /dev/null @@ -1,34 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class RuntimeVersionStatus(WaylayBaseModel): - """RuntimeVersionStatus.""" - - deprecated: StrictBool = Field( - description="If true, the function uses a deprecated runtime." - ) - upgradable: StrictBool = Field( - description="If true, a newer runtime for this function is available using the `rebuild` API." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_summary.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_summary.py deleted file mode 100644 index 88a251ea..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/runtime_version_summary.py +++ /dev/null @@ -1,62 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.function_type import FunctionType - - -class RuntimeVersionSummary(WaylayBaseModel): - """RuntimeVersionSummary.""" - - deprecated: StrictBool = Field( - description="If true, the function uses a deprecated runtime." - ) - upgradable: StrictBool = Field( - description="If true, a newer runtime for this function is available using the `rebuild` API." - ) - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - title: StrictStr - description: StrictStr | None = None - name: StrictStr - function_type: FunctionType = Field(alias="functionType") - archive_format: ArchiveFormat = Field(alias="archiveFormat") - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/scale_args.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/scale_args.py index 70809523..8a4b5589 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/scale_args.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/scale_args.py @@ -39,9 +39,8 @@ class ScaleArgs(WaylayBaseModel): description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org", alias="runtimeVersion", ) - revision: StrictStr | None = Field( - default=None, - description="The revision hash of the current (draft) function revision", + revision: StrictStr = Field( + description="The revision hash of the current (draft) function revision" ) replicas: StrictFloat | StrictInt = Field(description="Number of target replicas") diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/schema_by_id_params.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/schema_by_id_params.py deleted file mode 100644 index f2a4890f..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/schema_by_id_params.py +++ /dev/null @@ -1,29 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class SchemaByIdParams(WaylayBaseModel): - """SchemaByIdParams.""" - - schema_id: StrictStr = Field(description="Schema id", alias="schemaId") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/schema_params.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/schema_params.py deleted file mode 100644 index 28a3ed83..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/schema_params.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.asset_role import AssetRole -from ..models.function_type import FunctionType - - -class SchemaParams(WaylayBaseModel): - """SchemaParams.""" - - function_type: FunctionType = Field(alias="functionType") - role: AssetRole - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/show_related_type.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/show_related_type.py new file mode 100644 index 00000000..7e5cecd2 --- /dev/null +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/show_related_type.py @@ -0,0 +1,25 @@ +# coding: utf-8 +"""Waylay Function Registry models. + +This code was generated from the OpenAPI documentation of 'Waylay Function Registry' + +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. + +""" + +from __future__ import annotations + +from enum import Enum + + +class ShowRelatedType(str, Enum): + """ShowRelatedType.""" + + EMBED = "embed" + LINK = "link" + NONE = "none" + + def __str__(self) -> str: + return str(self.value) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/status_exclude.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/status_exclude.py new file mode 100644 index 00000000..5e111da5 --- /dev/null +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/status_exclude.py @@ -0,0 +1,30 @@ +# coding: utf-8 +"""Waylay Function Registry models. + +This code was generated from the OpenAPI documentation of 'Waylay Function Registry' + +Generated by OpenAPI Generator (https://openapi-generator.tech) + +Do not edit the class manually. + +""" + +from __future__ import annotations + +from enum import Enum + + +class StatusExclude(str, Enum): + """Any status value with a `-` postfix appended, excludes that status as a filter..""" + + REGISTERED_MINUS = "registered-" + RUNNING_MINUS = "running-" + PENDING_MINUS = "pending-" + DEPLOYED_MINUS = "deployed-" + UNHEALTHY_MINUS = "unhealthy-" + FAILED_MINUS = "failed-" + UNDEPLOYING_MINUS = "undeploying-" + UNDEPLOYED_MINUS = "undeployed-" + + def __str__(self) -> str: + return str(self.value) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/status_filter.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/status_filter.py index fd07492d..0942eff3 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/status_filter.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/status_filter.py @@ -20,14 +20,10 @@ ) from ..models.status_any import StatusAny +from ..models.status_exclude import StatusExclude from ..models.status_include import StatusInclude StatusFilter = Union[ - Annotated[StatusInclude, ""], - Annotated[ - str, - "Any status value with a `-` postfix appended, excludes that status as a filter.", - ], - Annotated[StatusAny, ""], + Annotated[StatusInclude, ""], Annotated[StatusExclude, ""], Annotated[StatusAny, ""] ] """Inclusion or exclusion filter on the `status` property..""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/status_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/status_response.py deleted file mode 100644 index 8c97e3e6..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/status_response.py +++ /dev/null @@ -1,30 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictFloat, - StrictInt, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class StatusResponse(WaylayBaseModel): - """StatusResponse.""" - - status_code: StrictFloat | StrictInt = Field(alias="statusCode") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/tag_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/tag_query.py deleted file mode 100644 index 4c63ba25..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/tag_query.py +++ /dev/null @@ -1,36 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class TagQuery(WaylayBaseModel): - """TagQuery.""" - - name: StrictStr | None = Field( - default=None, - description="If set, filters on the name of a tag. Supports * and ? wildcards and is case-insensitive.", - ) - color: StrictStr | None = Field( - default=None, - description="If set, filters on the color of a tag. Uses an exact match.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/tags_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/tags_query.py deleted file mode 100644 index 069f387c..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/tags_query.py +++ /dev/null @@ -1,29 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.tags_filter import TagsFilter - - -class TagsQuery(WaylayBaseModel): - """TagsQuery.""" - - tags: TagsFilter | None = None - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/undeploy_args.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/undeploy_args.py index 10b8ae44..67cf019f 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/undeploy_args.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/undeploy_args.py @@ -38,9 +38,8 @@ class UndeployArgs(WaylayBaseModel): description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org", alias="runtimeVersion", ) - revision: StrictStr | None = Field( - default=None, - description="The revision hash of the current (draft) function revision", + revision: StrictStr = Field( + description="The revision hash of the current (draft) function revision" ) is_native_plug: StrictBool = Field( description="If true, the function is not expected to be deployed on openfaas.", diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/unhealthy_invokable_webscript_error.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/unhealthy_invokable_webscript_error.py deleted file mode 100644 index 225abb47..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/unhealthy_invokable_webscript_error.py +++ /dev/null @@ -1,37 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.invokable_webscript_response_entity import ( - InvokableWebscriptResponseEntity, -) -from ..models.invoke_internal_hal_link import InvokeInternalHALLink - - -class UnhealthyInvokableWebscriptError(WaylayBaseModel): - """Webscript Not Healthy.""" - - entity: InvokableWebscriptResponseEntity - links: InvokeInternalHALLink = Field(alias="_links") - error: StrictStr - code: StrictStr - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/update_comment.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/update_comment.py deleted file mode 100644 index 85f90bed..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/update_comment.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class UpdateComment(WaylayBaseModel): - """UpdateComment.""" - - comment: StrictStr | None = Field( - default=None, - description="An optional user-specified comment corresponding to the operation.", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/update_draft_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/update_draft_query.py deleted file mode 100644 index e7100a8b..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/update_draft_query.py +++ /dev/null @@ -1,41 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class UpdateDraftQuery(WaylayBaseModel): - """UpdateDraftQuery.""" - - comment: StrictStr | None = Field( - default=None, - description="An optional user-specified comment corresponding to the operation.", - ) - var_async: StrictBool | None = Field( - default=True, - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs.", - alias="async", - ) - chown: StrictBool = Field( - description="If set, ownership of the draft function is transferred to the current user." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/update_metadata_request_v1.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/update_metadata_request_v1.py deleted file mode 100644 index bd3dc5e9..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/update_metadata_request_v1.py +++ /dev/null @@ -1,60 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.tag import Tag - - -class UpdateMetadataRequestV1(WaylayBaseModel): - """UpdateMetadataRequestV1.""" - - author: StrictStr | None = Field( - default=None, description="The author of the function." - ) - description: StrictStr | None = Field( - default=None, description="A description of the function" - ) - icon_url: StrictStr | None = Field( - default=None, - description="An url to an icon that represents this function.", - alias="iconURL", - ) - category: StrictStr | None = Field( - default=None, - description="A category for this function (Deprecated: use tags to categorise your functions)", - ) - documentation_url: StrictStr | None = Field( - default=None, - description="External url that document this function.", - alias="documentationURL", - ) - tags: List[Tag] | None = Field( - default=None, description="Tags associated with this function." - ) - friendly_name: StrictStr | None = Field( - default=None, - description="Display title for this function.", - alias="friendlyName", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/user_plug_meta.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/user_plug_meta.py deleted file mode 100644 index 2d13bcf2..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/user_plug_meta.py +++ /dev/null @@ -1,60 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.tag import Tag - - -class UserPlugMeta(WaylayBaseModel): - """Plug metadata that the user can update as `metadata`.""" - - author: StrictStr | None = Field( - default=None, description="The author of the function." - ) - description: StrictStr | None = Field( - default=None, description="A description of the function" - ) - icon_url: StrictStr | None = Field( - default=None, - description="An url to an icon that represents this function.", - alias="iconURL", - ) - category: StrictStr | None = Field( - default=None, - description="A category for this function (Deprecated: use tags to categorise your functions)", - ) - documentation_url: StrictStr | None = Field( - default=None, - description="External url that document this function.", - alias="documentationURL", - ) - tags: List[Tag] | None = Field( - default=None, description="Tags associated with this function." - ) - friendly_name: StrictStr | None = Field( - default=None, - description="Display title for this function.", - alias="friendlyName", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/verify_args.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/verify_args.py index 978e84ad..73e605ec 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/verify_args.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/models/verify_args.py @@ -37,9 +37,8 @@ class VerifyArgs(WaylayBaseModel): description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org", alias="runtimeVersion", ) - revision: StrictStr | None = Field( - default=None, - description="The revision hash of the current (draft) function revision", + revision: StrictStr = Field( + description="The revision hash of the current (draft) function revision" ) @field_validator("runtime_version") diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/verify_query_v1.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/verify_query_v1.py deleted file mode 100644 index 68cf224c..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/verify_query_v1.py +++ /dev/null @@ -1,33 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class VerifyQueryV1(WaylayBaseModel): - """VerifyQueryV1.""" - - scale_to_zero: StrictBool | None = Field( - default=None, - description="Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command.", - alias="scaleToZero", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/version_includes.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/version_includes.py deleted file mode 100644 index 3293001a..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/version_includes.py +++ /dev/null @@ -1,38 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class VersionIncludes(WaylayBaseModel): - """VersionIncludes.""" - - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/versions_query.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/versions_query.py deleted file mode 100644 index 91614c69..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/versions_query.py +++ /dev/null @@ -1,117 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.timestamp_spec import TimestampSpec - - -class VersionsQuery(WaylayBaseModel): - """Function versions paged query.""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - endpoint: StrictStr | None = Field( - default=None, - description="Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - image_name: StrictStr | None = Field( - default=None, - description="Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - alias="imageName", - ) - storage_location: StrictStr | None = Field( - default=None, - description="Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - alias="storageLocation", - ) - deprecated: StrictBool | None = Field( - default=None, description="Filter on the deprecation status of the function." - ) - draft: StrictBool | None = Field( - default=None, description="Filter on the draft status of the function." - ) - name_version: List[Annotated[str, Field(strict=True)]] | None = Field( - default=None, - description="Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - alias="nameVersion", - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/versions_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/versions_query_v2.py deleted file mode 100644 index 5438bfca..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/versions_query_v2.py +++ /dev/null @@ -1,117 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.timestamp_spec import TimestampSpec - - -class VersionsQueryV2(WaylayBaseModel): - """Function versions paged query.""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - endpoint: StrictStr | None = Field( - default=None, - description="Filter on the openfaas endpoint. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - image_name: StrictStr | None = Field( - default=None, - description="Filter on the container image name. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - alias="imageName", - ) - storage_location: StrictStr | None = Field( - default=None, - description="Filter on the storageLocation. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - alias="storageLocation", - ) - deprecated: StrictBool | None = Field( - default=None, description="Filter on the deprecation status of the function." - ) - draft: StrictBool | None = Field( - default=None, description="Filter on the draft status of the function." - ) - name_version: List[Annotated[str, Field(strict=True)]] | None = Field( - default=None, - description="Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered.", - alias="nameVersion", - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/versions_response_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/versions_response_v2.py deleted file mode 100644 index 47e13a83..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/versions_response_v2.py +++ /dev/null @@ -1,45 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictFloat, - StrictInt, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.any_function_response import AnyFunctionResponse - - -class VersionsResponseV2(WaylayBaseModel): - """Version Listing Response.""" - - limit: StrictFloat | StrictInt | None = Field( - default=None, description="The page size used for this query result." - ) - count: StrictFloat | StrictInt = Field( - description="The total count of matching items, from which this result is one page." - ) - page: StrictFloat | StrictInt | None = Field( - default=None, description="The page number of a paged query result." - ) - entities: List[AnyFunctionResponse] = Field( - description="The specification and deployment status of the queried functions" - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_latest_version_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_latest_version_query_v2.py deleted file mode 100644 index ca148714..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_latest_version_query_v2.py +++ /dev/null @@ -1,38 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictBool, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class WebscriptLatestVersionQueryV2(WaylayBaseModel): - """Webscript latest named version query..""" - - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_latest_versions_query_v1.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_latest_versions_query_v1.py deleted file mode 100644 index 0d07668b..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_latest_versions_query_v1.py +++ /dev/null @@ -1,102 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.archive_format import ArchiveFormat -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status_filter import StatusFilter -from ..models.timestamp_spec import TimestampSpec - - -class WebscriptLatestVersionsQueryV1(WaylayBaseModel): - """Webscript lastest versions listing query.""" - - limit: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The maximum number of items to be return from this query. Has a deployment-defined default and maximum value.", - ) - page: ( - Annotated[float, Field(strict=True, ge=0)] - | Annotated[int, Field(strict=True, ge=0)] - | None - ) = Field( - default=None, - description="The number of pages to skip when returning result to this query.", - ) - include_draft: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**.", - alias="includeDraft", - ) - include_deprecated: StrictBool | None = Field( - default=None, - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**.", - alias="includeDeprecated", - ) - version: StrictStr | None = Field( - default=None, - description="Filter on the version of the function (case-sensitive, supports wildcards).", - ) - status: List[StatusFilter] | None = Field( - default=None, - description="Filter on the status of the plug. Filter values with a `-` postfix exclude the status. Use the `any` filter value to include all states. When not specified, a default `undeployed-` filter excludes _undeployed_ functions.", - ) - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - created_by: StrictStr | None = Field( - default=None, - description="Filter on the user that create the plug. You can use the `@me` token to indicate your own plugs.", - alias="createdBy", - ) - updated_by: StrictStr | None = Field( - default=None, - description="Filter on the user that last updated the plug. You can use the `@me` token to indicate your own plugs.", - alias="updatedBy", - ) - created_before: TimestampSpec | None = Field(default=None, alias="createdBefore") - created_after: TimestampSpec | None = Field(default=None, alias="createdAfter") - updated_before: TimestampSpec | None = Field(default=None, alias="updatedBefore") - updated_after: TimestampSpec | None = Field(default=None, alias="updatedAfter") - name: StrictStr | None = Field( - default=None, - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters).", - ) - archive_format: List[ArchiveFormat] | None = Field( - default=None, - description="Filter on the archive format of the function.", - alias="archiveFormat", - ) - runtime: List[StrictStr] | None = Field( - default=None, description="Filter on the runtime of the function." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_latest_versions_query_v2.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_latest_versions_query_v2.py deleted file mode 100644 index 791f03b5..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_latest_versions_query_v2.py +++ /dev/null @@ -1,28 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from typing import ( - Union, -) - -from typing_extensions import ( - Annotated, # >=3.9 -) - -from ..models.latest_function_versions_query import LatestFunctionVersionsQuery -from ..models.latest_functions_query import LatestFunctionsQuery - -WebscriptLatestVersionsQueryV2 = Union[ - Annotated[LatestFunctionVersionsQuery, ""], Annotated[LatestFunctionsQuery, ""] -] -"""Webscript lastest versions listing query..""" diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_response.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_response.py deleted file mode 100644 index beea8f99..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/webscript_response.py +++ /dev/null @@ -1,82 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -import re -from datetime import datetime -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictStr, - field_validator, -) -from typing_extensions import ( - Annotated, # >=3.11 -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.failure_reason import FailureReason -from ..models.function_deploy_overrides_type import FunctionDeployOverridesType -from ..models.function_meta import FunctionMeta -from ..models.job_hal_links import JobHALLinks -from ..models.semantic_version_range import SemanticVersionRange -from ..models.status import Status - - -class WebscriptResponse(WaylayBaseModel): - """Successful Response.""" - - deploy: FunctionDeployOverridesType | None = None - name: StrictStr = Field(description="The logical name for the function.") - version: Annotated[str, Field(strict=True)] = Field( - description="A semantic version with _exactly_ a `major`, `minor` and `patch` specifier. No `pre-release` or `build` identifiers are allowed. See https://semver.org" - ) - runtime: StrictStr - runtime_version: SemanticVersionRange | None = Field( - default=None, alias="runtimeVersion" - ) - metadata: FunctionMeta - created_by: StrictStr = Field( - description="The user that created this entity.", alias="createdBy" - ) - created_at: datetime = Field( - description="The timestamp at which this entity was created.", alias="createdAt" - ) - updated_by: StrictStr = Field( - description="The user that last updated this entity.", alias="updatedBy" - ) - updated_at: datetime = Field( - description="The timestamp at which this entity was last updated.", - alias="updatedAt", - ) - status: Status - failure_reason: FailureReason | None = Field(default=None, alias="failureReason") - links: List[JobHALLinks] | None = Field( - default=None, description="Links to related entities.", alias="_links" - ) - secret: StrictStr | None - - @field_validator("version") - @classmethod - def version_validate_regular_expression(cls, value): - """Validate the regular expression.""" - if not re.match(r"^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$", value): - raise ValueError( - r"must validate the regular expression /^(0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/" - ) - return value - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/with_asset_hal_link.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/with_asset_hal_link.py deleted file mode 100644 index 6c79a55a..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/with_asset_hal_link.py +++ /dev/null @@ -1,30 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.asset_summary_with_hal_link_links import AssetSummaryWithHALLinkLinks - - -class WithAssetHALLink(WaylayBaseModel): - """WithAssetHALLink.""" - - links: AssetSummaryWithHALLinkLinks = Field(alias="_links") - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/with_entity_attributes.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/with_entity_attributes.py deleted file mode 100644 index a21daa2e..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/with_entity_attributes.py +++ /dev/null @@ -1,62 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from datetime import datetime -from typing import List - -from pydantic import ( - ConfigDict, - Field, - StrictBool, - StrictStr, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - -from ..models.failure_reason import FailureReason -from ..models.runtime_attributes import RuntimeAttributes -from ..models.status import Status -from ..models.update_record import UpdateRecord - - -class WithEntityAttributes(WaylayBaseModel): - """WithEntityAttributes.""" - - created_by: StrictStr = Field( - description="The user that created this entity.", alias="createdBy" - ) - created_at: datetime = Field( - description="The timestamp at which this entity was created.", alias="createdAt" - ) - updated_by: StrictStr = Field( - description="The user that last updated this entity.", alias="updatedBy" - ) - updated_at: datetime = Field( - description="The timestamp at which this entity was last updated.", - alias="updatedAt", - ) - updates: List[UpdateRecord] = Field( - description="The audit logs corresponding to the latest modifying operations on this entity." - ) - status: Status - failure_reason: FailureReason | None = Field(default=None, alias="failureReason") - runtime: RuntimeAttributes - deprecated: StrictBool = Field( - description="If true this function is deprecated and removed from regular listings." - ) - draft: StrictBool = Field( - description="If true this function is a draft function and it's assets are still mutable." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/with_limit.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/with_limit.py deleted file mode 100644 index a3cc4595..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/with_limit.py +++ /dev/null @@ -1,32 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictFloat, - StrictInt, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class WithLimit(WaylayBaseModel): - """WithLimit.""" - - limit: StrictFloat | StrictInt | None = Field( - default=None, description="The page size used for this query result." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/models/with_paging.py b/waylay-sdk-registry-types/src/waylay/services/registry/models/with_paging.py deleted file mode 100644 index 8be6b095..00000000 --- a/waylay-sdk-registry-types/src/waylay/services/registry/models/with_paging.py +++ /dev/null @@ -1,38 +0,0 @@ -# coding: utf-8 -"""Waylay Function Registry models. - -This code was generated from the OpenAPI documentation of 'Waylay Function Registry' - -Generated by OpenAPI Generator (https://openapi-generator.tech) - -Do not edit the class manually. - -""" - -from __future__ import annotations - -from pydantic import ( - ConfigDict, - Field, - StrictFloat, - StrictInt, -) -from waylay.sdk.api._models import BaseModel as WaylayBaseModel - - -class WithPaging(WaylayBaseModel): - """WithPaging.""" - - limit: StrictFloat | StrictInt | None = Field( - default=None, description="The page size used for this query result." - ) - count: StrictFloat | StrictInt = Field( - description="The total count of matching items, from which this result is one page." - ) - page: StrictFloat | StrictInt | None = Field( - default=None, description="The page number of a paged query result." - ) - - model_config = ConfigDict( - populate_by_name=True, protected_namespaces=(), extra="ignore" - ) diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/queries/__init__.py b/waylay-sdk-registry-types/src/waylay/services/registry/queries/__init__.py index 5d5aace8..267dbc30 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/queries/__init__.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/queries/__init__.py @@ -3,7 +3,7 @@ This code was generated from the OpenAPI documentation of 'Waylay Function Registry' -version: 2.12.4 +version: 2.13.0 V2 API to build and deploy Waylay functions (plugs, webscripts, BYOML models). diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/queries/default_api.py b/waylay-sdk-registry-types/src/waylay/services/registry/queries/about_api.py similarity index 100% rename from waylay-sdk-registry-types/src/waylay/services/registry/queries/default_api.py rename to waylay-sdk-registry-types/src/waylay/services/registry/queries/about_api.py diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/queries/webscript_functions_api.py b/waylay-sdk-registry-types/src/waylay/services/registry/queries/models_api.py similarity index 78% rename from waylay-sdk-registry-types/src/waylay/services/registry/queries/webscript_functions_api.py rename to waylay-sdk-registry-types/src/waylay/services/registry/queries/models_api.py index fbe8265a..72747706 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/queries/webscript_functions_api.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/queries/models_api.py @@ -29,30 +29,65 @@ from ..models.job_state_result import JobStateResult from ..models.job_type_schema import JobTypeSchema from ..models.rebuild_policy import RebuildPolicy +from ..models.show_related_type import ShowRelatedType from ..models.status_filter import StatusFilter def _create_query_alias_for(field_name: str) -> str: + if field_name == "deploy": + return "deploy" + if field_name == "author": + return "author" + if field_name == "comment": + return "comment" + if field_name == "scale_to_zero": + return "scaleToZero" if field_name == "deprecate_previous": return "deprecatePrevious" if field_name == "dry_run": return "dryRun" if field_name == "var_async": return "async" - if field_name == "scale_to_zero": - return "scaleToZero" if field_name == "version": return "version" if field_name == "name": return "name" if field_name == "draft": return "draft" + if field_name == "runtime": + return "runtime" + if field_name == "copy_from": + return "copy" return field_name class CreateQuery(WaylayBaseModel): """Model for `create` query parameters.""" + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None + comment: Annotated[ + StrictStr | None, + Field( + description="An optional user-specified comment corresponding to the operation." + ), + ] = None + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None deprecate_previous: Annotated[ DeprecatePreviousPolicy | None, Field( @@ -71,12 +106,6 @@ class CreateQuery(WaylayBaseModel): description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs." ), ] = None - scale_to_zero: Annotated[ - StrictBool | None, - Field( - description="If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately." - ), - ] = None version: Annotated[ Any | None, Field( @@ -95,6 +124,18 @@ class CreateQuery(WaylayBaseModel): description="If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid." ), ] = None + runtime: Annotated[ + Annotated[str, Field(strict=True)] | None, + Field( + description="If set, the created function will use the indicated runtime (latest version within specified range). This takes precedence over the runtime specified in a function manifest (copied or from request body)." + ), + ] = None + copy_from: Annotated[ + Any | None, + Field( + description="Indicates the _source_ of initial assets for a _new function_. When using this query parameter, the request body does not need to contain assets, but any assets in the request body will overwrite the copied assets. #### Selection of _assets_ source * If set as `[@]`, the _new function_ will be created with copied assets of the selected _source function_. * If set as `!example`, a `runtime` query parameter is required, and the _new function_ will be initialized with assets of the _runtime example_. #### Selection of the _source function_ When `` is a range (or is not given), the latest _published_ version (in that range) is used. If no _published_ version exists, the latest _draft_ is selected. If no versions in the range exist, a `404` _Not Found_ error is returned. #### The `name` of the _new function_ If a `name` is NOT specified (either as query parameter, or in an optional manifest asset in the request body), the `name` of the _new function_ will be that of the _source function_. #### The `version` of the _new function_ When the _target_ and _source_ name are equal, the `version` query parameters is defaulted to `` (`~` when it's an exact version) The version of the _new function_ will be: * If a `version` is NOT specified (either as query parameter, in an optional manifest asset, or as `` _default_) * a **patch increment** (`..+1`) of the latest **existing version** with the target `name` * **`1.0.0`** otherwise * If a `version` is specified: * the **lowest version** in that range **if no existing version** is in that range. * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. #### Deployment overrides The new function will use the deployment overrides of the copied function, unless a _manifest_ was specified in the request body." + ), + ] = None model_config = ConfigDict( protected_namespaces=(), @@ -105,30 +146,54 @@ class CreateQuery(WaylayBaseModel): def _delete_asset_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" + if field_name == "deploy": + return "deploy" + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "var_async": return "async" - if field_name == "chown": - return "chown" return field_name class DeleteAssetQuery(WaylayBaseModel): """Model for `delete_asset` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None chown: Annotated[ - StrictBool, + StrictBool | None, Field( description="If set, ownership of the draft function is transferred to the current user." ), - ] + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None var_async: Annotated[ StrictBool | None, Field( @@ -296,15 +361,21 @@ class JobsQuery(WaylayBaseModel): ) -def _list_versions_query_alias_for(field_name: str) -> str: +def _list_query_alias_for(field_name: str) -> str: if field_name == "limit": return "limit" if field_name == "page": return "page" + if field_name == "include_draft": + return "includeDraft" + if field_name == "include_deprecated": + return "includeDeprecated" if field_name == "deprecated": return "deprecated" if field_name == "draft": return "draft" + if field_name == "name_version": + return "nameVersion" if field_name == "version": return "version" if field_name == "status": @@ -323,15 +394,21 @@ def _list_versions_query_alias_for(field_name: str) -> str: return "updatedBefore" if field_name == "updated_after": return "updatedAfter" + if field_name == "name": + return "name" if field_name == "archive_format": return "archiveFormat" if field_name == "runtime": return "runtime" + if field_name == "latest": + return "latest" + if field_name == "show_related": + return "showRelated" return field_name -class ListVersionsQuery(WaylayBaseModel): - """Model for `list_versions` query parameters.""" +class ListQuery(WaylayBaseModel): + """Model for `list` query parameters.""" limit: Annotated[ Annotated[float, Field(strict=True, ge=0)] @@ -349,6 +426,18 @@ class ListVersionsQuery(WaylayBaseModel): description="The number of pages to skip when returning result to this query." ), ] = None + include_draft: Annotated[ + StrictBool | None, + Field( + description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." + ), + ] = None + include_deprecated: Annotated[ + StrictBool | None, + Field( + description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." + ), + ] = None deprecated: Annotated[ StrictBool | None, Field(description="Filter on the deprecation status of the function."), @@ -357,6 +446,12 @@ class ListVersionsQuery(WaylayBaseModel): StrictBool | None, Field(description="Filter on the draft status of the function."), ] = None + name_version: Annotated[ + List[Annotated[str, Field(strict=True)]] | None, + Field( + description="Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered." + ), + ] = None version: Annotated[ StrictStr | None, Field( @@ -408,6 +503,12 @@ class ListVersionsQuery(WaylayBaseModel): description="Filter on funtions that were updated after the given timestamp or age." ), ] = None + name: Annotated[ + StrictStr | None, + Field( + description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." + ), + ] = None archive_format: Annotated[ List[ArchiveFormat] | None, Field(description="Filter on the archive format of the function."), @@ -416,30 +517,36 @@ class ListVersionsQuery(WaylayBaseModel): List[StrictStr] | None, Field(description="Filter on the runtime of the function."), ] = None + latest: Annotated[ + StrictBool | None, + Field( + description="When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter." + ), + ] = None + show_related: Annotated[ + ShowRelatedType | None, + Field( + description="Sets the representation of related function versions (like the _latest_ draft and/or published) in the response. - `embed`: as full summary representation (in `_embedded`). - `link`: as HAL link in (in `_links`). - `none`: omitted." + ), + ] = None model_config = ConfigDict( protected_namespaces=(), extra="allow", - alias_generator=_list_versions_query_alias_for, + alias_generator=_list_query_alias_for, populate_by_name=True, ) -def _list_query_alias_for(field_name: str) -> str: +def _list_versions_query_alias_for(field_name: str) -> str: if field_name == "limit": return "limit" if field_name == "page": return "page" - if field_name == "include_draft": - return "includeDraft" - if field_name == "include_deprecated": - return "includeDeprecated" if field_name == "deprecated": return "deprecated" if field_name == "draft": return "draft" - if field_name == "name_version": - return "nameVersion" if field_name == "version": return "version" if field_name == "status": @@ -458,19 +565,15 @@ def _list_query_alias_for(field_name: str) -> str: return "updatedBefore" if field_name == "updated_after": return "updatedAfter" - if field_name == "name": - return "name" if field_name == "archive_format": return "archiveFormat" if field_name == "runtime": return "runtime" - if field_name == "latest": - return "latest" return field_name -class ListQuery(WaylayBaseModel): - """Model for `list` query parameters.""" +class ListVersionsQuery(WaylayBaseModel): + """Model for `list_versions` query parameters.""" limit: Annotated[ Annotated[float, Field(strict=True, ge=0)] @@ -488,18 +591,6 @@ class ListQuery(WaylayBaseModel): description="The number of pages to skip when returning result to this query." ), ] = None - include_draft: Annotated[ - StrictBool | None, - Field( - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - ), - ] = None - include_deprecated: Annotated[ - StrictBool | None, - Field( - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - ), - ] = None deprecated: Annotated[ StrictBool | None, Field(description="Filter on the deprecation status of the function."), @@ -508,12 +599,6 @@ class ListQuery(WaylayBaseModel): StrictBool | None, Field(description="Filter on the draft status of the function."), ] = None - name_version: Annotated[ - List[Annotated[str, Field(strict=True)]] | None, - Field( - description="Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered." - ), - ] = None version: Annotated[ StrictStr | None, Field( @@ -565,12 +650,6 @@ class ListQuery(WaylayBaseModel): description="Filter on funtions that were updated after the given timestamp or age." ), ] = None - name: Annotated[ - StrictStr | None, - Field( - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - ), - ] = None archive_format: Annotated[ List[ArchiveFormat] | None, Field(description="Filter on the archive format of the function."), @@ -579,17 +658,11 @@ class ListQuery(WaylayBaseModel): List[StrictStr] | None, Field(description="Filter on the runtime of the function."), ] = None - latest: Annotated[ - StrictBool | None, - Field( - description="When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter." - ), - ] = None model_config = ConfigDict( protected_namespaces=(), extra="allow", - alias_generator=_list_query_alias_for, + alias_generator=_list_versions_query_alias_for, populate_by_name=True, ) @@ -619,8 +692,12 @@ class PatchMetadataQuery(WaylayBaseModel): def _publish_query_alias_for(field_name: str) -> str: + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "deprecate_previous": return "deprecatePrevious" if field_name == "var_async": @@ -631,12 +708,24 @@ def _publish_query_alias_for(field_name: str) -> str: class PublishQuery(WaylayBaseModel): """Model for `publish` query parameters.""" + chown: Annotated[ + StrictBool | None, + Field( + description="If set, ownership of the draft function is transferred to the current user." + ), + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None deprecate_previous: Annotated[ DeprecatePreviousPolicy | None, Field( @@ -659,6 +748,8 @@ class PublishQuery(WaylayBaseModel): def _rebuild_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" if field_name == "comment": return "comment" if field_name == "dry_run": @@ -671,8 +762,6 @@ def _rebuild_query_alias_for(field_name: str) -> str: return "forceVersion" if field_name == "ignore_checks": return "ignoreChecks" - if field_name == "scale_to_zero": - return "scaleToZero" if field_name == "skip_rebuild": return "skipRebuild" return field_name @@ -681,6 +770,12 @@ def _rebuild_query_alias_for(field_name: str) -> str: class RebuildQuery(WaylayBaseModel): """Model for `rebuild` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." + ), + ] = None comment: Annotated[ StrictStr | None, Field( @@ -717,12 +812,6 @@ class RebuildQuery(WaylayBaseModel): description="If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option" ), ] = None - scale_to_zero: Annotated[ - StrictBool | None, - Field( - description="Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command." - ), - ] = None skip_rebuild: Annotated[ StrictBool | None, Field( @@ -789,12 +878,12 @@ class RemoveVersionQuery(WaylayBaseModel): def _remove_versions_query_alias_for(field_name: str) -> str: if field_name == "comment": return "comment" - if field_name == "var_async": - return "async" if field_name == "force": return "force" if field_name == "undeploy": return "undeploy" + if field_name == "var_async": + return "async" return field_name @@ -807,12 +896,6 @@ class RemoveVersionsQuery(WaylayBaseModel): description="An optional user-specified comment corresponding to the operation." ), ] = None - var_async: Annotated[ - StrictBool | None, - Field( - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs." - ), - ] = None force: Annotated[ StrictBool | None, Field( @@ -825,6 +908,12 @@ class RemoveVersionsQuery(WaylayBaseModel): description="If `true`, the `DELETE` operation * undeploys the (openfaas) function: it becomes no longer available for invocation. * does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only." ), ] = None + var_async: Annotated[ + StrictBool | None, + Field( + description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs." + ), + ] = None model_config = ConfigDict( protected_namespaces=(), @@ -835,30 +924,54 @@ class RemoveVersionsQuery(WaylayBaseModel): def _update_asset_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" + if field_name == "deploy": + return "deploy" + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "var_async": return "async" - if field_name == "chown": - return "chown" return field_name class UpdateAssetQuery(WaylayBaseModel): """Model for `update_asset` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None chown: Annotated[ - StrictBool, + StrictBool | None, Field( description="If set, ownership of the draft function is transferred to the current user." ), - ] + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None var_async: Annotated[ StrictBool | None, Field( @@ -875,30 +988,54 @@ class UpdateAssetQuery(WaylayBaseModel): def _update_assets_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" + if field_name == "deploy": + return "deploy" + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "var_async": return "async" - if field_name == "chown": - return "chown" return field_name class UpdateAssetsQuery(WaylayBaseModel): """Model for `update_assets` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None chown: Annotated[ - StrictBool, + StrictBool | None, Field( description="If set, ownership of the draft function is transferred to the current user." ), - ] + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None var_async: Annotated[ StrictBool | None, Field( @@ -915,22 +1052,20 @@ class UpdateAssetsQuery(WaylayBaseModel): def _verify_query_alias_for(field_name: str) -> str: - if field_name == "comment": - return "comment" - if field_name == "var_async": - return "async" if field_name == "scale_to_zero": return "scaleToZero" + if field_name == "var_async": + return "async" return field_name class VerifyQuery(WaylayBaseModel): """Model for `verify` query parameters.""" - comment: Annotated[ - StrictStr | None, + scale_to_zero: Annotated[ + StrictBool | None, Field( - description="An optional user-specified comment corresponding to the operation." + description="Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." ), ] = None var_async: Annotated[ @@ -939,12 +1074,6 @@ class VerifyQuery(WaylayBaseModel): description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs." ), ] = None - scale_to_zero: Annotated[ - StrictBool | None, - Field( - description="Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." - ), - ] = None model_config = ConfigDict( protected_namespaces=(), diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/queries/plug_functions_api.py b/waylay-sdk-registry-types/src/waylay/services/registry/queries/plugs_api.py similarity index 79% rename from waylay-sdk-registry-types/src/waylay/services/registry/queries/plug_functions_api.py rename to waylay-sdk-registry-types/src/waylay/services/registry/queries/plugs_api.py index 7f1b55c4..6782c4af 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/queries/plug_functions_api.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/queries/plugs_api.py @@ -30,30 +30,65 @@ from ..models.job_type_schema import JobTypeSchema from ..models.plug_type import PlugType from ..models.rebuild_policy import RebuildPolicy +from ..models.show_related_type import ShowRelatedType from ..models.status_filter import StatusFilter def _create_query_alias_for(field_name: str) -> str: + if field_name == "deploy": + return "deploy" + if field_name == "author": + return "author" + if field_name == "comment": + return "comment" + if field_name == "scale_to_zero": + return "scaleToZero" if field_name == "deprecate_previous": return "deprecatePrevious" if field_name == "dry_run": return "dryRun" if field_name == "var_async": return "async" - if field_name == "scale_to_zero": - return "scaleToZero" if field_name == "version": return "version" if field_name == "name": return "name" if field_name == "draft": return "draft" + if field_name == "runtime": + return "runtime" + if field_name == "copy_from": + return "copy" return field_name class CreateQuery(WaylayBaseModel): """Model for `create` query parameters.""" + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None + comment: Annotated[ + StrictStr | None, + Field( + description="An optional user-specified comment corresponding to the operation." + ), + ] = None + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None deprecate_previous: Annotated[ DeprecatePreviousPolicy | None, Field( @@ -72,12 +107,6 @@ class CreateQuery(WaylayBaseModel): description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs." ), ] = None - scale_to_zero: Annotated[ - StrictBool | None, - Field( - description="If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately." - ), - ] = None version: Annotated[ Any | None, Field( @@ -96,6 +125,18 @@ class CreateQuery(WaylayBaseModel): description="If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid." ), ] = None + runtime: Annotated[ + Annotated[str, Field(strict=True)] | None, + Field( + description="If set, the created function will use the indicated runtime (latest version within specified range). This takes precedence over the runtime specified in a function manifest (copied or from request body)." + ), + ] = None + copy_from: Annotated[ + Any | None, + Field( + description="Indicates the _source_ of initial assets for a _new function_. When using this query parameter, the request body does not need to contain assets, but any assets in the request body will overwrite the copied assets. #### Selection of _assets_ source * If set as `[@]`, the _new function_ will be created with copied assets of the selected _source function_. * If set as `!example`, a `runtime` query parameter is required, and the _new function_ will be initialized with assets of the _runtime example_. #### Selection of the _source function_ When `` is a range (or is not given), the latest _published_ version (in that range) is used. If no _published_ version exists, the latest _draft_ is selected. If no versions in the range exist, a `404` _Not Found_ error is returned. #### The `name` of the _new function_ If a `name` is NOT specified (either as query parameter, or in an optional manifest asset in the request body), the `name` of the _new function_ will be that of the _source function_. #### The `version` of the _new function_ When the _target_ and _source_ name are equal, the `version` query parameters is defaulted to `` (`~` when it's an exact version) The version of the _new function_ will be: * If a `version` is NOT specified (either as query parameter, in an optional manifest asset, or as `` _default_) * a **patch increment** (`..+1`) of the latest **existing version** with the target `name` * **`1.0.0`** otherwise * If a `version` is specified: * the **lowest version** in that range **if no existing version** is in that range. * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. #### Deployment overrides The new function will use the deployment overrides of the copied function, unless a _manifest_ was specified in the request body." + ), + ] = None model_config = ConfigDict( protected_namespaces=(), @@ -106,30 +147,54 @@ class CreateQuery(WaylayBaseModel): def _delete_asset_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" + if field_name == "deploy": + return "deploy" + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "var_async": return "async" - if field_name == "chown": - return "chown" return field_name class DeleteAssetQuery(WaylayBaseModel): """Model for `delete_asset` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None chown: Annotated[ - StrictBool, + StrictBool | None, Field( description="If set, ownership of the draft function is transferred to the current user." ), - ] + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None var_async: Annotated[ StrictBool | None, Field( @@ -347,6 +412,8 @@ def _list_query_alias_for(field_name: str) -> str: return "runtime" if field_name == "latest": return "latest" + if field_name == "show_related": + return "showRelated" return field_name @@ -475,6 +542,12 @@ class ListQuery(WaylayBaseModel): description="When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter." ), ] = None + show_related: Annotated[ + ShowRelatedType | None, + Field( + description="Sets the representation of related function versions (like the _latest_ draft and/or published) in the response. - `embed`: as full summary representation (in `_embedded`). - `link`: as HAL link in (in `_links`). - `none`: omitted." + ), + ] = None model_config = ConfigDict( protected_namespaces=(), @@ -670,8 +743,12 @@ class PatchMetadataQuery(WaylayBaseModel): def _publish_query_alias_for(field_name: str) -> str: + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "deprecate_previous": return "deprecatePrevious" if field_name == "var_async": @@ -682,12 +759,24 @@ def _publish_query_alias_for(field_name: str) -> str: class PublishQuery(WaylayBaseModel): """Model for `publish` query parameters.""" + chown: Annotated[ + StrictBool | None, + Field( + description="If set, ownership of the draft function is transferred to the current user." + ), + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None deprecate_previous: Annotated[ DeprecatePreviousPolicy | None, Field( @@ -710,6 +799,8 @@ class PublishQuery(WaylayBaseModel): def _rebuild_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" if field_name == "comment": return "comment" if field_name == "dry_run": @@ -722,8 +813,6 @@ def _rebuild_query_alias_for(field_name: str) -> str: return "forceVersion" if field_name == "ignore_checks": return "ignoreChecks" - if field_name == "scale_to_zero": - return "scaleToZero" if field_name == "skip_rebuild": return "skipRebuild" return field_name @@ -732,6 +821,12 @@ def _rebuild_query_alias_for(field_name: str) -> str: class RebuildQuery(WaylayBaseModel): """Model for `rebuild` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." + ), + ] = None comment: Annotated[ StrictStr | None, Field( @@ -768,12 +863,6 @@ class RebuildQuery(WaylayBaseModel): description="If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option" ), ] = None - scale_to_zero: Annotated[ - StrictBool | None, - Field( - description="Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command." - ), - ] = None skip_rebuild: Annotated[ StrictBool | None, Field( @@ -886,30 +975,54 @@ class RemoveVersionsQuery(WaylayBaseModel): def _update_asset_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" + if field_name == "deploy": + return "deploy" + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "var_async": return "async" - if field_name == "chown": - return "chown" return field_name class UpdateAssetQuery(WaylayBaseModel): """Model for `update_asset` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None chown: Annotated[ - StrictBool, + StrictBool | None, Field( description="If set, ownership of the draft function is transferred to the current user." ), - ] + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None var_async: Annotated[ StrictBool | None, Field( @@ -926,30 +1039,54 @@ class UpdateAssetQuery(WaylayBaseModel): def _update_assets_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" + if field_name == "deploy": + return "deploy" + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "var_async": return "async" - if field_name == "chown": - return "chown" return field_name class UpdateAssetsQuery(WaylayBaseModel): """Model for `update_assets` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None chown: Annotated[ - StrictBool, + StrictBool | None, Field( description="If set, ownership of the draft function is transferred to the current user." ), - ] + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None var_async: Annotated[ StrictBool | None, Field( @@ -966,22 +1103,20 @@ class UpdateAssetsQuery(WaylayBaseModel): def _verify_query_alias_for(field_name: str) -> str: - if field_name == "comment": - return "comment" - if field_name == "var_async": - return "async" if field_name == "scale_to_zero": return "scaleToZero" + if field_name == "var_async": + return "async" return field_name class VerifyQuery(WaylayBaseModel): """Model for `verify` query parameters.""" - comment: Annotated[ - StrictStr | None, + scale_to_zero: Annotated[ + StrictBool | None, Field( - description="An optional user-specified comment corresponding to the operation." + description="Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." ), ] = None var_async: Annotated[ @@ -990,12 +1125,6 @@ class VerifyQuery(WaylayBaseModel): description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs." ), ] = None - scale_to_zero: Annotated[ - StrictBool | None, - Field( - description="Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." - ), - ] = None model_config = ConfigDict( protected_namespaces=(), diff --git a/waylay-sdk-registry-types/src/waylay/services/registry/queries/model_functions_api.py b/waylay-sdk-registry-types/src/waylay/services/registry/queries/webscripts_api.py similarity index 78% rename from waylay-sdk-registry-types/src/waylay/services/registry/queries/model_functions_api.py rename to waylay-sdk-registry-types/src/waylay/services/registry/queries/webscripts_api.py index 548ae4aa..b69d5a4c 100644 --- a/waylay-sdk-registry-types/src/waylay/services/registry/queries/model_functions_api.py +++ b/waylay-sdk-registry-types/src/waylay/services/registry/queries/webscripts_api.py @@ -29,30 +29,65 @@ from ..models.job_state_result import JobStateResult from ..models.job_type_schema import JobTypeSchema from ..models.rebuild_policy import RebuildPolicy +from ..models.show_related_type import ShowRelatedType from ..models.status_filter import StatusFilter def _create_query_alias_for(field_name: str) -> str: + if field_name == "deploy": + return "deploy" + if field_name == "author": + return "author" + if field_name == "comment": + return "comment" + if field_name == "scale_to_zero": + return "scaleToZero" if field_name == "deprecate_previous": return "deprecatePrevious" if field_name == "dry_run": return "dryRun" if field_name == "var_async": return "async" - if field_name == "scale_to_zero": - return "scaleToZero" if field_name == "version": return "version" if field_name == "name": return "name" if field_name == "draft": return "draft" + if field_name == "runtime": + return "runtime" + if field_name == "copy_from": + return "copy" return field_name class CreateQuery(WaylayBaseModel): """Model for `create` query parameters.""" + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None + comment: Annotated[ + StrictStr | None, + Field( + description="An optional user-specified comment corresponding to the operation." + ), + ] = None + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None deprecate_previous: Annotated[ DeprecatePreviousPolicy | None, Field( @@ -71,12 +106,6 @@ class CreateQuery(WaylayBaseModel): description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs." ), ] = None - scale_to_zero: Annotated[ - StrictBool | None, - Field( - description="If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately." - ), - ] = None version: Annotated[ Any | None, Field( @@ -95,6 +124,18 @@ class CreateQuery(WaylayBaseModel): description="If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid." ), ] = None + runtime: Annotated[ + Annotated[str, Field(strict=True)] | None, + Field( + description="If set, the created function will use the indicated runtime (latest version within specified range). This takes precedence over the runtime specified in a function manifest (copied or from request body)." + ), + ] = None + copy_from: Annotated[ + Any | None, + Field( + description="Indicates the _source_ of initial assets for a _new function_. When using this query parameter, the request body does not need to contain assets, but any assets in the request body will overwrite the copied assets. #### Selection of _assets_ source * If set as `[@]`, the _new function_ will be created with copied assets of the selected _source function_. * If set as `!example`, a `runtime` query parameter is required, and the _new function_ will be initialized with assets of the _runtime example_. #### Selection of the _source function_ When `` is a range (or is not given), the latest _published_ version (in that range) is used. If no _published_ version exists, the latest _draft_ is selected. If no versions in the range exist, a `404` _Not Found_ error is returned. #### The `name` of the _new function_ If a `name` is NOT specified (either as query parameter, or in an optional manifest asset in the request body), the `name` of the _new function_ will be that of the _source function_. #### The `version` of the _new function_ When the _target_ and _source_ name are equal, the `version` query parameters is defaulted to `` (`~` when it's an exact version) The version of the _new function_ will be: * If a `version` is NOT specified (either as query parameter, in an optional manifest asset, or as `` _default_) * a **patch increment** (`..+1`) of the latest **existing version** with the target `name` * **`1.0.0`** otherwise * If a `version` is specified: * the **lowest version** in that range **if no existing version** is in that range. * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. #### Deployment overrides The new function will use the deployment overrides of the copied function, unless a _manifest_ was specified in the request body." + ), + ] = None model_config = ConfigDict( protected_namespaces=(), @@ -105,30 +146,54 @@ class CreateQuery(WaylayBaseModel): def _delete_asset_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" + if field_name == "deploy": + return "deploy" + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "var_async": return "async" - if field_name == "chown": - return "chown" return field_name class DeleteAssetQuery(WaylayBaseModel): """Model for `delete_asset` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None chown: Annotated[ - StrictBool, + StrictBool | None, Field( description="If set, ownership of the draft function is transferred to the current user." ), - ] + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None var_async: Annotated[ StrictBool | None, Field( @@ -296,21 +361,15 @@ class JobsQuery(WaylayBaseModel): ) -def _list_query_alias_for(field_name: str) -> str: +def _list_versions_query_alias_for(field_name: str) -> str: if field_name == "limit": return "limit" if field_name == "page": return "page" - if field_name == "include_draft": - return "includeDraft" - if field_name == "include_deprecated": - return "includeDeprecated" if field_name == "deprecated": return "deprecated" if field_name == "draft": return "draft" - if field_name == "name_version": - return "nameVersion" if field_name == "version": return "version" if field_name == "status": @@ -329,19 +388,15 @@ def _list_query_alias_for(field_name: str) -> str: return "updatedBefore" if field_name == "updated_after": return "updatedAfter" - if field_name == "name": - return "name" if field_name == "archive_format": return "archiveFormat" if field_name == "runtime": return "runtime" - if field_name == "latest": - return "latest" return field_name -class ListQuery(WaylayBaseModel): - """Model for `list` query parameters.""" +class ListVersionsQuery(WaylayBaseModel): + """Model for `list_versions` query parameters.""" limit: Annotated[ Annotated[float, Field(strict=True, ge=0)] @@ -359,18 +414,6 @@ class ListQuery(WaylayBaseModel): description="The number of pages to skip when returning result to this query." ), ] = None - include_draft: Annotated[ - StrictBool | None, - Field( - description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." - ), - ] = None - include_deprecated: Annotated[ - StrictBool | None, - Field( - description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." - ), - ] = None deprecated: Annotated[ StrictBool | None, Field(description="Filter on the deprecation status of the function."), @@ -379,12 +422,6 @@ class ListQuery(WaylayBaseModel): StrictBool | None, Field(description="Filter on the draft status of the function."), ] = None - name_version: Annotated[ - List[Annotated[str, Field(strict=True)]] | None, - Field( - description="Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered." - ), - ] = None version: Annotated[ StrictStr | None, Field( @@ -436,12 +473,6 @@ class ListQuery(WaylayBaseModel): description="Filter on funtions that were updated after the given timestamp or age." ), ] = None - name: Annotated[ - StrictStr | None, - Field( - description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." - ), - ] = None archive_format: Annotated[ List[ArchiveFormat] | None, Field(description="Filter on the archive format of the function."), @@ -450,30 +481,30 @@ class ListQuery(WaylayBaseModel): List[StrictStr] | None, Field(description="Filter on the runtime of the function."), ] = None - latest: Annotated[ - StrictBool | None, - Field( - description="When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter." - ), - ] = None model_config = ConfigDict( protected_namespaces=(), extra="allow", - alias_generator=_list_query_alias_for, + alias_generator=_list_versions_query_alias_for, populate_by_name=True, ) -def _list_versions_query_alias_for(field_name: str) -> str: +def _list_query_alias_for(field_name: str) -> str: if field_name == "limit": return "limit" if field_name == "page": return "page" + if field_name == "include_draft": + return "includeDraft" + if field_name == "include_deprecated": + return "includeDeprecated" if field_name == "deprecated": return "deprecated" if field_name == "draft": return "draft" + if field_name == "name_version": + return "nameVersion" if field_name == "version": return "version" if field_name == "status": @@ -492,15 +523,21 @@ def _list_versions_query_alias_for(field_name: str) -> str: return "updatedBefore" if field_name == "updated_after": return "updatedAfter" + if field_name == "name": + return "name" if field_name == "archive_format": return "archiveFormat" if field_name == "runtime": return "runtime" + if field_name == "latest": + return "latest" + if field_name == "show_related": + return "showRelated" return field_name -class ListVersionsQuery(WaylayBaseModel): - """Model for `list_versions` query parameters.""" +class ListQuery(WaylayBaseModel): + """Model for `list` query parameters.""" limit: Annotated[ Annotated[float, Field(strict=True, ge=0)] @@ -518,6 +555,18 @@ class ListVersionsQuery(WaylayBaseModel): description="The number of pages to skip when returning result to this query." ), ] = None + include_draft: Annotated[ + StrictBool | None, + Field( + description="Configures the inclusion of _draft_ versions when selecting latest versions per name. By default, draft versions are only considered when no other versions are available. If set to `true`, draft versions are **included**. If set to `false`, draft versions are **excluded**." + ), + ] = None + include_deprecated: Annotated[ + StrictBool | None, + Field( + description="Configures the inclusion of _deprecated_ versions when selecting latest versions per name. By default, deprecated versions are only considered when no other versions are available. If set to `true`, deprecated versions are **included**. If set to `false`, deprecated versions are **excluded**." + ), + ] = None deprecated: Annotated[ StrictBool | None, Field(description="Filter on the deprecation status of the function."), @@ -526,6 +575,12 @@ class ListVersionsQuery(WaylayBaseModel): StrictBool | None, Field(description="Filter on the draft status of the function."), ] = None + name_version: Annotated[ + List[Annotated[str, Field(strict=True)]] | None, + Field( + description="Filter on exact `{name}@{version}` functions. Using this filter implies a `latest=false` default, returning multiple versions of the same named versions if they are filtered." + ), + ] = None version: Annotated[ StrictStr | None, Field( @@ -577,6 +632,12 @@ class ListVersionsQuery(WaylayBaseModel): description="Filter on funtions that were updated after the given timestamp or age." ), ] = None + name: Annotated[ + StrictStr | None, + Field( + description="Filter on the name of the function. This is case-insensitive and supports wild-cards `?` (any one character) and `*` (any sequence of characters)." + ), + ] = None archive_format: Annotated[ List[ArchiveFormat] | None, Field(description="Filter on the archive format of the function."), @@ -585,11 +646,23 @@ class ListVersionsQuery(WaylayBaseModel): List[StrictStr] | None, Field(description="Filter on the runtime of the function."), ] = None + latest: Annotated[ + StrictBool | None, + Field( + description="When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter." + ), + ] = None + show_related: Annotated[ + ShowRelatedType | None, + Field( + description="Sets the representation of related function versions (like the _latest_ draft and/or published) in the response. - `embed`: as full summary representation (in `_embedded`). - `link`: as HAL link in (in `_links`). - `none`: omitted." + ), + ] = None model_config = ConfigDict( protected_namespaces=(), extra="allow", - alias_generator=_list_versions_query_alias_for, + alias_generator=_list_query_alias_for, populate_by_name=True, ) @@ -619,8 +692,12 @@ class PatchMetadataQuery(WaylayBaseModel): def _publish_query_alias_for(field_name: str) -> str: + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "deprecate_previous": return "deprecatePrevious" if field_name == "var_async": @@ -631,12 +708,24 @@ def _publish_query_alias_for(field_name: str) -> str: class PublishQuery(WaylayBaseModel): """Model for `publish` query parameters.""" + chown: Annotated[ + StrictBool | None, + Field( + description="If set, ownership of the draft function is transferred to the current user." + ), + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None deprecate_previous: Annotated[ DeprecatePreviousPolicy | None, Field( @@ -659,6 +748,8 @@ class PublishQuery(WaylayBaseModel): def _rebuild_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" if field_name == "comment": return "comment" if field_name == "dry_run": @@ -671,8 +762,6 @@ def _rebuild_query_alias_for(field_name: str) -> str: return "forceVersion" if field_name == "ignore_checks": return "ignoreChecks" - if field_name == "scale_to_zero": - return "scaleToZero" if field_name == "skip_rebuild": return "skipRebuild" return field_name @@ -681,6 +770,12 @@ def _rebuild_query_alias_for(field_name: str) -> str: class RebuildQuery(WaylayBaseModel): """Model for `rebuild` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." + ), + ] = None comment: Annotated[ StrictStr | None, Field( @@ -717,12 +812,6 @@ class RebuildQuery(WaylayBaseModel): description="If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option" ), ] = None - scale_to_zero: Annotated[ - StrictBool | None, - Field( - description="Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command." - ), - ] = None skip_rebuild: Annotated[ StrictBool | None, Field( @@ -789,12 +878,12 @@ class RemoveVersionQuery(WaylayBaseModel): def _remove_versions_query_alias_for(field_name: str) -> str: if field_name == "comment": return "comment" + if field_name == "var_async": + return "async" if field_name == "force": return "force" if field_name == "undeploy": return "undeploy" - if field_name == "var_async": - return "async" return field_name @@ -807,22 +896,22 @@ class RemoveVersionsQuery(WaylayBaseModel): description="An optional user-specified comment corresponding to the operation." ), ] = None - force: Annotated[ + var_async: Annotated[ StrictBool | None, Field( - description="If true, the function version will be immediately undeployed and removed. Otherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_." + description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs." ), ] = None - undeploy: Annotated[ + force: Annotated[ StrictBool | None, Field( - description="If `true`, the `DELETE` operation * undeploys the (openfaas) function: it becomes no longer available for invocation. * does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only." + description="If true, the function version will be immediately undeployed and removed. Otherwise, the removal will be delayed to allow current invocations to end. During that period, the function is marked _deprecated_." ), ] = None - var_async: Annotated[ + undeploy: Annotated[ StrictBool | None, Field( - description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs." + description="If `true`, the `DELETE` operation * undeploys the (openfaas) function: it becomes no longer available for invocation. * does NOT remove the function from registry: it stays in an `undeployed` status. All assets and definitions are retained, so the version can be restored later with a _rebuild_ action. If `false`, the `DELETE` operation * _only_ marks the plug function as _deprecated_, the function remains active but is removed from the default listings. This also applies to _draft_ versions. This parameter is incompatible with `force=true`. If not set the default behaviour applies: * _draft_ versions are _undeployed_ and _removed_ from registry. * non-_draft_ versions are marked _deprecated_ only." ), ] = None @@ -835,30 +924,54 @@ class RemoveVersionsQuery(WaylayBaseModel): def _update_asset_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" + if field_name == "deploy": + return "deploy" + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "var_async": return "async" - if field_name == "chown": - return "chown" return field_name class UpdateAssetQuery(WaylayBaseModel): """Model for `update_asset` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None chown: Annotated[ - StrictBool, + StrictBool | None, Field( description="If set, ownership of the draft function is transferred to the current user." ), - ] + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None var_async: Annotated[ StrictBool | None, Field( @@ -875,30 +988,54 @@ class UpdateAssetQuery(WaylayBaseModel): def _update_assets_query_alias_for(field_name: str) -> str: + if field_name == "scale_to_zero": + return "scaleToZero" + if field_name == "deploy": + return "deploy" + if field_name == "chown": + return "chown" if field_name == "comment": return "comment" + if field_name == "author": + return "author" if field_name == "var_async": return "async" - if field_name == "chown": - return "chown" return field_name class UpdateAssetsQuery(WaylayBaseModel): """Model for `update_assets` query parameters.""" + scale_to_zero: Annotated[ + StrictBool | None, + Field( + description="If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately." + ), + ] = None + deploy: Annotated[ + StrictBool | None, + Field( + description="Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage." + ), + ] = None chown: Annotated[ - StrictBool, + StrictBool | None, Field( description="If set, ownership of the draft function is transferred to the current user." ), - ] + ] = None comment: Annotated[ StrictStr | None, Field( description="An optional user-specified comment corresponding to the operation." ), ] = None + author: Annotated[ + StrictStr | None, + Field( + description="Optionally changes the author metadata when updating a function." + ), + ] = None var_async: Annotated[ StrictBool | None, Field( @@ -915,22 +1052,20 @@ class UpdateAssetsQuery(WaylayBaseModel): def _verify_query_alias_for(field_name: str) -> str: - if field_name == "comment": - return "comment" - if field_name == "var_async": - return "async" if field_name == "scale_to_zero": return "scaleToZero" + if field_name == "var_async": + return "async" return field_name class VerifyQuery(WaylayBaseModel): """Model for `verify` query parameters.""" - comment: Annotated[ - StrictStr | None, + scale_to_zero: Annotated[ + StrictBool | None, Field( - description="An optional user-specified comment corresponding to the operation." + description="Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." ), ] = None var_async: Annotated[ @@ -939,12 +1074,6 @@ class VerifyQuery(WaylayBaseModel): description="Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs." ), ] = None - scale_to_zero: Annotated[ - StrictBool | None, - Field( - description="Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command." - ), - ] = None model_config = ConfigDict( protected_namespaces=(), diff --git a/waylay-sdk-registry/.openapi-generator/FILES b/waylay-sdk-registry/.openapi-generator/FILES index c7daa7dc..220ed1b1 100644 --- a/waylay-sdk-registry/.openapi-generator/FILES +++ b/waylay-sdk-registry/.openapi-generator/FILES @@ -1,14 +1,14 @@ LICENSE.txt pyproject.toml src/waylay/services/registry/api/__init__.py -src/waylay/services/registry/api/default_api.py +src/waylay/services/registry/api/about_api.py src/waylay/services/registry/api/jobs_api.py -src/waylay/services/registry/api/model_functions_api.py -src/waylay/services/registry/api/plug_functions_api.py +src/waylay/services/registry/api/models_api.py +src/waylay/services/registry/api/plugs_api.py src/waylay/services/registry/api/py.typed src/waylay/services/registry/api/runtimes_api.py src/waylay/services/registry/api/schemas_api.py -src/waylay/services/registry/api/webscript_functions_api.py +src/waylay/services/registry/api/webscripts_api.py src/waylay/services/registry/service/__init__.py src/waylay/services/registry/service/py.typed src/waylay/services/registry/service/service.py diff --git a/waylay-sdk-registry/README.md b/waylay-sdk-registry/README.md index ff8db33d..6fe14a51 100644 --- a/waylay-sdk-registry/README.md +++ b/waylay-sdk-registry/README.md @@ -2,7 +2,7 @@ V2 API to build and deploy Waylay functions (plugs, webscripts, BYOML models). This Python package is automatically generated based on the -Waylay Registry OpenAPI specification (API version: 2.12.4) +Waylay Registry OpenAPI specification (API version: 2.13.0) For more information, please visit [the openapi specification](https://docs.waylay.io/openapi/public/redocly/registry.html). It consists of a plugin for the waylay-sdk-core package, and contains the Registry api methods. @@ -33,22 +33,16 @@ from waylay.sdk.api.api_exceptions import ApiError waylay_client = WaylayClient.from_profile() # Note that the typed model classes for responses/parameters/... are only available when `waylay-sdk-registry-types` is installed -from waylay.services.registry.models.function_type import FunctionType -from waylay.services.registry.models.job_state_result import JobStateResult -from waylay.services.registry.models.job_type_schema import JobTypeSchema -from waylay.services.registry.models.jobs_response import JobsResponse +from waylay.services.registry.models.root_page_response import RootPageResponse try: - # List Jobs - # calls `GET /registry/v2/jobs/` - api_response = await waylay_client.registry.jobs.list( - # query parameters: - query = { - }, + # Get Service Status + # calls `GET /registry/v2/` + api_response = await waylay_client.registry.about.get( ) - print("The response of registry.jobs.list:\n") + print("The response of registry.about.get:\n") pprint(api_response) except ApiError as e: - print("Exception when calling registry.jobs.list: %s\n" % e) + print("Exception when calling registry.about.get: %s\n" % e) ``` diff --git a/waylay-sdk-registry/pyproject.toml b/waylay-sdk-registry/pyproject.toml index 4c61c429..15550c22 100644 --- a/waylay-sdk-registry/pyproject.toml +++ b/waylay-sdk-registry/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta" [project] name = "waylay-sdk-registry" -version = "2.12.4.20240423" +version = "2.13.0.20240430" description = "Waylay Function Registry" authors = [ { name = "Waylay", email = "info@waylay.io"} diff --git a/waylay-sdk-registry/src/waylay/services/registry/api/__init__.py b/waylay-sdk-registry/src/waylay/services/registry/api/__init__.py index 833c8ca0..63c3a61c 100644 --- a/waylay-sdk-registry/src/waylay/services/registry/api/__init__.py +++ b/waylay-sdk-registry/src/waylay/services/registry/api/__init__.py @@ -1,20 +1,20 @@ """Waylay Function Registry: apis.""" # import apis into api package -from .default_api import DefaultApi +from .about_api import AboutApi from .jobs_api import JobsApi -from .model_functions_api import ModelFunctionsApi -from .plug_functions_api import PlugFunctionsApi +from .models_api import ModelsApi +from .plugs_api import PlugsApi from .runtimes_api import RuntimesApi from .schemas_api import SchemasApi -from .webscript_functions_api import WebscriptFunctionsApi +from .webscripts_api import WebscriptsApi __all__ = [ + "AboutApi", "JobsApi", - "ModelFunctionsApi", - "PlugFunctionsApi", + "ModelsApi", + "PlugsApi", "RuntimesApi", "SchemasApi", - "WebscriptFunctionsApi", - "DefaultApi", + "WebscriptsApi", ] diff --git a/waylay-sdk-registry/src/waylay/services/registry/api/default_api.py b/waylay-sdk-registry/src/waylay/services/registry/api/about_api.py similarity index 95% rename from waylay-sdk-registry/src/waylay/services/registry/api/default_api.py rename to waylay-sdk-registry/src/waylay/services/registry/api/about_api.py index c22bfbdd..2c52904e 100644 --- a/waylay-sdk-registry/src/waylay/services/registry/api/default_api.py +++ b/waylay-sdk-registry/src/waylay/services/registry/api/about_api.py @@ -33,12 +33,12 @@ if TYPE_CHECKING: from waylay.services.registry.models import RootPageResponse - from waylay.services.registry.queries.default_api import GetQuery + from waylay.services.registry.queries.about_api import GetQuery try: from waylay.services.registry.models import RootPageResponse - from waylay.services.registry.queries.default_api import GetQuery + from waylay.services.registry.queries.about_api import GetQuery MODELS_AVAILABLE = True except ImportError: @@ -52,8 +52,8 @@ T = TypeVar("T") -class DefaultApi(WithApiClient): - """DefaultApi service methods. +class AboutApi(WithApiClient): + """AboutApi service methods. NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -137,9 +137,9 @@ async def get( headers: HeaderTypes | None = None, **kwargs, ) -> RootPageResponse | T | Response | Model: - """Version. + """Get Service Status. - Get the version of this function registry deployment. + Get the status and version of the function registry service. :param query: URL Query parameters. :type query: GetQuery | QueryParamTypes, optional :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. diff --git a/waylay-sdk-registry/src/waylay/services/registry/api/model_functions_api.py b/waylay-sdk-registry/src/waylay/services/registry/api/models_api.py similarity index 82% rename from waylay-sdk-registry/src/waylay/services/registry/api/model_functions_api.py rename to waylay-sdk-registry/src/waylay/services/registry/api/models_api.py index 71a9111a..363a289c 100644 --- a/waylay-sdk-registry/src/waylay/services/registry/api/model_functions_api.py +++ b/waylay-sdk-registry/src/waylay/services/registry/api/models_api.py @@ -17,12 +17,14 @@ Literal, Optional, TypeVar, + Union, overload, ) from pydantic import ( Field, StrictBool, + StrictBytes, StrictStr, TypeAdapter, ) @@ -47,16 +49,16 @@ JobsForModelResponseV2, LatestModelsResponseV2, ModelVersionsResponseV2, - MultipartFileUpload, PostModelJobAsyncResponseV2, PostModelJobSyncResponseV2, RebuildModelAsyncResponseV2, RebuildModelSyncResponseV2, + RegistryErrorResponse, UndeployedResponseV2, UndeploySubmittedResponseV2, VerifyModelSyncResponseV2, ) - from waylay.services.registry.queries.model_functions_api import ( + from waylay.services.registry.queries.models_api import ( CreateQuery, DeleteAssetQuery, GetArchiveQuery, @@ -85,16 +87,16 @@ JobsForModelResponseV2, LatestModelsResponseV2, ModelVersionsResponseV2, - MultipartFileUpload, PostModelJobAsyncResponseV2, PostModelJobSyncResponseV2, RebuildModelAsyncResponseV2, RebuildModelSyncResponseV2, + RegistryErrorResponse, UndeployedResponseV2, UndeploySubmittedResponseV2, VerifyModelSyncResponseV2, ) - from waylay.services.registry.queries.model_functions_api import ( + from waylay.services.registry.queries.models_api import ( CreateQuery, DeleteAssetQuery, GetArchiveQuery, @@ -119,8 +121,6 @@ MODELS_AVAILABLE = False if not TYPE_CHECKING: - MultipartFileUpload = Model - CreateQuery = dict PostModelJobSyncResponseV2 = Model @@ -131,6 +131,8 @@ PostModelJobAsyncResponseV2 = Model + RegistryErrorResponse = Model + GetArchiveQuery = dict GetAssetQuery = dict @@ -182,13 +184,15 @@ PostModelJobAsyncResponseV2 = Model - MultipartFileUpload = Model + RegistryErrorResponse = Model UpdateAssetsQuery = dict PostModelJobSyncResponseV2 = Model PostModelJobAsyncResponseV2 = Model + RegistryErrorResponse = Model + VerifyQuery = dict VerifyModelSyncResponseV2 = Model @@ -198,8 +202,8 @@ T = TypeVar("T") -class ModelFunctionsApi(WithApiClient): - """ModelFunctionsApi service methods. +class ModelsApi(WithApiClient): + """ModelsApi service methods. NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -211,10 +215,16 @@ class ModelFunctionsApi(WithApiClient): async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -233,10 +243,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -255,10 +271,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -277,10 +299,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -299,10 +327,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -320,10 +354,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -341,27 +381,39 @@ async def create( ): """Create Model. - Creates a new model function by uploading its assets. The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. - :param content: The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. + Creates a new model function by uploading its assets. The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. + :param json: The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. + :type json: bytearray, optional + :param content: The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. :type content: ContentRequest, optional :param files: The files of a `content-type: multipart/form-data` request. :type files: FilesRequest, optional :param query: URL Query parameters. :type query: CreateQuery | QueryParamTypes, optional + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str + :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. + :type query['comment']: str + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool :param query['deprecatePrevious'] (dict)
    query.deprecate_previous (Query) : Set the cleanup policy used to automatically deprecate/delete previous versions. :type query['deprecatePrevious']: DeprecatePreviousPolicy :param query['dryRun'] (dict)
    query.dry_run (Query) : If set to true, validates the deployment conditions, but does not change anything. :type query['dryRun']: bool :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately. - :type query['scaleToZero']: bool :param query['version'] (dict)
    query.version (Query) : If set, the function version will be an increment of the latest existing version that satisfies the `version` range. Note that this increment always takes precedence over an explicit `version` in the function manifest. :type query['version']: SemanticVersionRange :param query['name'] (dict)
    query.name (Query) : If set, the value will be used as the function name instead of the one specified in the manifest. :type query['name']: str :param query['draft'] (dict)
    query.draft (Query) : If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. :type query['draft']: bool + :param query['runtime'] (dict)
    query.runtime (Query) : If set, the created function will use the indicated runtime (latest version within specified range). This takes precedence over the runtime specified in a function manifest (copied or from request body). + :type query['runtime']: str + :param query['copy'] (dict)
    query.copy_from (Query) : Indicates the _source_ of initial assets for a _new function_. When using this query parameter, the request body does not need to contain assets, but any assets in the request body will overwrite the copied assets. #### Selection of _assets_ source * If set as `[@]`, the _new function_ will be created with copied assets of the selected _source function_. * If set as `!example`, a `runtime` query parameter is required, and the _new function_ will be initialized with assets of the _runtime example_. #### Selection of the _source function_ When `` is a range (or is not given), the latest _published_ version (in that range) is used. If no _published_ version exists, the latest _draft_ is selected. If no versions in the range exist, a `404` _Not Found_ error is returned. #### The `name` of the _new function_ If a `name` is NOT specified (either as query parameter, or in an optional manifest asset in the request body), the `name` of the _new function_ will be that of the _source function_. #### The `version` of the _new function_ When the _target_ and _source_ name are equal, the `version` query parameters is defaulted to `` (`~` when it's an exact version) The version of the _new function_ will be: * If a `version` is NOT specified (either as query parameter, in an optional manifest asset, or as `` _default_) * a **patch increment** (`..+1`) of the latest **existing version** with the target `name` * **`1.0.0`** otherwise * If a `version` is specified: * the **lowest version** in that range **if no existing version** is in that range. * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. #### Deployment overrides The new function will use the deployment overrides of the copied function, unless a _manifest_ was specified in the request body. + :type query['copy']: CreateWebscriptsCopyParameter :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -390,6 +442,17 @@ async def create( ## named body parameters body_args: Dict[str, Any] = {} + if json is not None and validate_request: + body_adapter = TypeAdapter( + Annotated[ + Optional[Union[StrictBytes, StrictStr]], + Field( + description="The assets for a model function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another model in the copy argument
    The required model.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=kfserving). For each runtime other files will be required or supported. " + ), + ] + ) + json = body_adapter.validate_python(json) # type: ignore # https://github.com/pydantic/pydantic/discussions/7094 + body_args["json"] = json body_args["content"] = content body_args["files"] = files @@ -571,12 +634,18 @@ async def delete_asset( :type wildcard: str :param query: URL Query parameters. :type query: DeleteAssetQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. (required) - :type query['chown']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -622,7 +691,9 @@ async def delete_asset( "202": PostModelJobAsyncResponseV2 if not select_path else Model, } ) - non_200_response_types_map: Dict[str, Any] = {} + non_200_response_types_map: Dict[str, Any] = { + "403": RegistryErrorResponse, + } response_types_map.update(non_200_response_types_map) ## peform request @@ -1600,7 +1671,7 @@ async def list( ) -> LatestModelsResponseV2 | T | Response | Model: """List Models. - List the (latest) versions of available models. ### List Latest Model Versions By default, the result includes the latest non-deprecated, non-draft version for each model name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour:
    • includeDeprecated=true: do not prefer non-deprecated versions as a latest version: if the latest version is a deprecated one, it will be shown, even if there are older non-deprecated versions.
    • includeDraft=true: do not prefer non-draft versions as a latest version: if the latest version is a draft, it will be shown, even if there are older non-draft versions.
    As long as no _version filters_ are used, each listed model version item will contain a HAL **link to the latest** _draft_ (`entities[]._links.draft`) or latest _published_ (`entities[]._links.publisned`) version (if existing and different). ### List Latest Model Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named model that satisfy the filters, but **without links**. ### List All Model Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ models versions that satisfy the query, possibly multiple versions per named models. No HAL links are provided. #### Filter on _status_ By default model versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the model listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft` + List the (latest) versions of available models. ### List Latest Model Versions By default, the result includes the latest non-deprecated, non-draft version for each model name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour:
    • includeDeprecated=true: do not prefer non-deprecated versions as a latest version: if the latest version is a deprecated one, it will be shown, even if there are older non-deprecated versions.
    • includeDraft=true: do not prefer non-draft versions as a latest version: if the latest version is a draft, it will be shown, even if there are older non-draft versions.
    As long as no version filters are used, each listed model version contains representations of the latest draft (`entities[]._links.draft`) or latest published (`entities[]._links.published`) version (if existing and different). Use the query parameter `showRelated` to include only a link (default `showRelated=link`) or a full representation (`showRelated=embed`). ### List Latest Model Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named model that satisfy the filters, but **without links**. ### List All Model Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ models versions that satisfy the query, possibly multiple versions per named models. No HAL links are provided. #### Filter on _status_ By default model versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the model listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft` :param query: URL Query parameters. :type query: ListQuery | QueryParamTypes, optional :param query['limit'] (dict)
    query.limit (Query) : The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. @@ -1643,6 +1714,8 @@ async def list( :type query['runtime']: List[str] :param query['latest'] (dict)
    query.latest (Query) : When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. :type query['latest']: bool + :param query['showRelated'] (dict)
    query.show_related (Query) : Sets the representation of related function versions (like the _latest_ draft and/or published) in the response. - `embed`: as full summary representation (in `_embedded`). - `link`: as HAL link in (in `_links`). - `none`: omitted. + :type query['showRelated']: ShowRelatedType :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -2172,8 +2245,12 @@ async def publish( :type version: str :param query: URL Query parameters. :type query: PublishQuery | QueryParamTypes, optional + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['deprecatePrevious'] (dict)
    query.deprecate_previous (Query) : Set the cleanup policy used to automatically deprecate/delete previous versions. :type query['deprecatePrevious']: DeprecatePreviousPolicy :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. @@ -2350,6 +2427,8 @@ async def rebuild( :type version: str :param query: URL Query parameters. :type query: RebuildQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. + :type query['scaleToZero']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str :param query['dryRun'] (dict)
    query.dry_run (Query) : If set to true, checks whether rebuild jobs are needed, but do not start any jobs. @@ -2362,8 +2441,6 @@ async def rebuild( :type query['forceVersion']: str :param query['ignoreChecks'] (dict)
    query.ignore_checks (Query) : If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option :type query['ignoreChecks']: bool - :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command. - :type query['scaleToZero']: bool :param query['skipRebuild'] (dict)
    query.skip_rebuild (Query) : If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function. :type query['skipRebuild']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. @@ -2931,12 +3008,18 @@ async def update_asset( :type content: ContentRequest, optional :param query: URL Query parameters. :type query: UpdateAssetQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. (required) - :type query['chown']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -2983,7 +3066,9 @@ async def update_asset( "202": PostModelJobAsyncResponseV2 if not select_path else Model, } ) - non_200_response_types_map: Dict[str, Any] = {} + non_200_response_types_map: Dict[str, Any] = { + "403": RegistryErrorResponse, + } response_types_map.update(non_200_response_types_map) ## peform request @@ -3011,7 +3096,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json     json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json     json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3037,7 +3122,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3063,7 +3148,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3089,7 +3174,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3115,7 +3200,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3140,7 +3225,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3158,23 +3243,29 @@ async def update_assets( ): """Update Model Assets. - Update a draft model function by updating its assets. The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. + Update a draft model function by updating its assets. The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. :param name: The name of the function. (required) :type name: str :param version: The version of the function. (required) :type version: str - :param content: The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. + :param content: The assets for a model function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the model function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the model.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. :type content: ContentRequest, optional :param files: The files of a `content-type: multipart/form-data` request. :type files: FilesRequest, optional :param query: URL Query parameters. :type query: UpdateAssetsQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. (required) - :type query['chown']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -3221,7 +3312,9 @@ async def update_assets( "202": PostModelJobAsyncResponseV2 if not select_path else Model, } ) - non_200_response_types_map: Dict[str, Any] = {} + non_200_response_types_map: Dict[str, Any] = { + "403": RegistryErrorResponse, + } response_types_map.update(non_200_response_types_map) ## peform request @@ -3347,12 +3440,10 @@ async def verify( :type version: str :param query: URL Query parameters. :type query: VerifyQuery | QueryParamTypes, optional - :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. - :type query['comment']: str - :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - :type query['async']: bool :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. :type query['scaleToZero']: bool + :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. + :type query['async']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. diff --git a/waylay-sdk-registry/src/waylay/services/registry/api/plug_functions_api.py b/waylay-sdk-registry/src/waylay/services/registry/api/plugs_api.py similarity index 83% rename from waylay-sdk-registry/src/waylay/services/registry/api/plug_functions_api.py rename to waylay-sdk-registry/src/waylay/services/registry/api/plugs_api.py index f658f75a..49669582 100644 --- a/waylay-sdk-registry/src/waylay/services/registry/api/plug_functions_api.py +++ b/waylay-sdk-registry/src/waylay/services/registry/api/plugs_api.py @@ -17,12 +17,14 @@ Literal, Optional, TypeVar, + Union, overload, ) from pydantic import ( Field, StrictBool, + StrictBytes, StrictStr, TypeAdapter, ) @@ -46,18 +48,18 @@ GetPlugResponseV2, JobsForPlugResponseV2, LatestPlugsResponseV2, - MultipartFileUpload, PlugVersionsResponseV2, PostPlugJobAsyncResponseV2, PostPlugJobSyncResponseV2, RebuildPlugAsyncResponseV2, RebuildPlugSyncResponseV2, + RegistryErrorResponse, UndeployedResponseV2, UndeploySubmittedResponseV2, UpdateMetadataRequestV2, VerifyPlugSyncResponseV2, ) - from waylay.services.registry.queries.plug_functions_api import ( + from waylay.services.registry.queries.plugs_api import ( CreateQuery, DeleteAssetQuery, GetArchiveQuery, @@ -86,18 +88,18 @@ GetPlugResponseV2, JobsForPlugResponseV2, LatestPlugsResponseV2, - MultipartFileUpload, PlugVersionsResponseV2, PostPlugJobAsyncResponseV2, PostPlugJobSyncResponseV2, RebuildPlugAsyncResponseV2, RebuildPlugSyncResponseV2, + RegistryErrorResponse, UndeployedResponseV2, UndeploySubmittedResponseV2, UpdateMetadataRequestV2, VerifyPlugSyncResponseV2, ) - from waylay.services.registry.queries.plug_functions_api import ( + from waylay.services.registry.queries.plugs_api import ( CreateQuery, DeleteAssetQuery, GetArchiveQuery, @@ -123,8 +125,6 @@ MODELS_AVAILABLE = False if not TYPE_CHECKING: - MultipartFileUpload = Model - CreateQuery = dict PostPlugJobSyncResponseV2 = Model @@ -135,6 +135,8 @@ PostPlugJobAsyncResponseV2 = Model + RegistryErrorResponse = Model + GetArchiveQuery = dict GetAssetQuery = dict @@ -191,13 +193,15 @@ PostPlugJobAsyncResponseV2 = Model - MultipartFileUpload = Model + RegistryErrorResponse = Model UpdateAssetsQuery = dict PostPlugJobSyncResponseV2 = Model PostPlugJobAsyncResponseV2 = Model + RegistryErrorResponse = Model + VerifyQuery = dict VerifyPlugSyncResponseV2 = Model @@ -207,8 +211,8 @@ T = TypeVar("T") -class PlugFunctionsApi(WithApiClient): - """PlugFunctionsApi service methods. +class PlugsApi(WithApiClient): + """PlugsApi service methods. NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -220,10 +224,16 @@ class PlugFunctionsApi(WithApiClient): async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -242,10 +252,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -264,10 +280,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -286,10 +308,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -308,10 +336,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -329,10 +363,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -348,27 +388,39 @@ async def create( ) -> PostPlugJobSyncResponseV2 | PostPlugJobAsyncResponseV2 | T | Response | Model: """Create Plug. - Creates a new plug function by uploading its assets. The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. - :param content: The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. + Creates a new plug function by uploading its assets. The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. + :param json: The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. + :type json: bytearray, optional + :param content: The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. :type content: ContentRequest, optional :param files: The files of a `content-type: multipart/form-data` request. :type files: FilesRequest, optional :param query: URL Query parameters. :type query: CreateQuery | QueryParamTypes, optional + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str + :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. + :type query['comment']: str + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool :param query['deprecatePrevious'] (dict)
    query.deprecate_previous (Query) : Set the cleanup policy used to automatically deprecate/delete previous versions. :type query['deprecatePrevious']: DeprecatePreviousPolicy :param query['dryRun'] (dict)
    query.dry_run (Query) : If set to true, validates the deployment conditions, but does not change anything. :type query['dryRun']: bool :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately. - :type query['scaleToZero']: bool :param query['version'] (dict)
    query.version (Query) : If set, the function version will be an increment of the latest existing version that satisfies the `version` range. Note that this increment always takes precedence over an explicit `version` in the function manifest. :type query['version']: SemanticVersionRange :param query['name'] (dict)
    query.name (Query) : If set, the value will be used as the function name instead of the one specified in the manifest. :type query['name']: str :param query['draft'] (dict)
    query.draft (Query) : If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. :type query['draft']: bool + :param query['runtime'] (dict)
    query.runtime (Query) : If set, the created function will use the indicated runtime (latest version within specified range). This takes precedence over the runtime specified in a function manifest (copied or from request body). + :type query['runtime']: str + :param query['copy'] (dict)
    query.copy_from (Query) : Indicates the _source_ of initial assets for a _new function_. When using this query parameter, the request body does not need to contain assets, but any assets in the request body will overwrite the copied assets. #### Selection of _assets_ source * If set as `[@]`, the _new function_ will be created with copied assets of the selected _source function_. * If set as `!example`, a `runtime` query parameter is required, and the _new function_ will be initialized with assets of the _runtime example_. #### Selection of the _source function_ When `` is a range (or is not given), the latest _published_ version (in that range) is used. If no _published_ version exists, the latest _draft_ is selected. If no versions in the range exist, a `404` _Not Found_ error is returned. #### The `name` of the _new function_ If a `name` is NOT specified (either as query parameter, or in an optional manifest asset in the request body), the `name` of the _new function_ will be that of the _source function_. #### The `version` of the _new function_ When the _target_ and _source_ name are equal, the `version` query parameters is defaulted to `` (`~` when it's an exact version) The version of the _new function_ will be: * If a `version` is NOT specified (either as query parameter, in an optional manifest asset, or as `` _default_) * a **patch increment** (`..+1`) of the latest **existing version** with the target `name` * **`1.0.0`** otherwise * If a `version` is specified: * the **lowest version** in that range **if no existing version** is in that range. * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. #### Deployment overrides The new function will use the deployment overrides of the copied function, unless a _manifest_ was specified in the request body. + :type query['copy']: CreateWebscriptsCopyParameter :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -397,6 +449,17 @@ async def create( ## named body parameters body_args: Dict[str, Any] = {} + if json is not None and validate_request: + body_adapter = TypeAdapter( + Annotated[ + Optional[Union[StrictBytes, StrictStr]], + Field( + description="The assets for a plug function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another plug in the copy argument
    The required plug.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=plugs). For each runtime other files will be required or supported. " + ), + ] + ) + json = body_adapter.validate_python(json) # type: ignore # https://github.com/pydantic/pydantic/discussions/7094 + body_args["json"] = json body_args["content"] = content body_args["files"] = files @@ -576,12 +639,18 @@ async def delete_asset( :type wildcard: str :param query: URL Query parameters. :type query: DeleteAssetQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. (required) - :type query['chown']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -627,7 +696,9 @@ async def delete_asset( "202": PostPlugJobAsyncResponseV2 if not select_path else Model, } ) - non_200_response_types_map: Dict[str, Any] = {} + non_200_response_types_map: Dict[str, Any] = { + "403": RegistryErrorResponse, + } response_types_map.update(non_200_response_types_map) ## peform request @@ -1607,7 +1678,7 @@ async def list( ) -> LatestPlugsResponseV2 | T | Response | Model: """List Plugs. - List the (latest) versions of available plugs. ### List Latest Plug Versions By default, the result includes the latest non-deprecated, non-draft version for each plug name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour:
    • includeDeprecated=true: do not prefer non-deprecated versions as a latest version: if the latest version is a deprecated one, it will be shown, even if there are older non-deprecated versions.
    • includeDraft=true: do not prefer non-draft versions as a latest version: if the latest version is a draft, it will be shown, even if there are older non-draft versions.
    As long as no _version filters_ are used, each listed plug version item will contain a HAL **link to the latest** _draft_ (`entities[]._links.draft`) or latest _published_ (`entities[]._links.publisned`) version (if existing and different). ### List Latest Plug Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named plug that satisfy the filters, but **without links**. ### List All Plug Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ plugs versions that satisfy the query, possibly multiple versions per named plugs. No HAL links are provided. #### Filter on _status_ By default plug versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the plug listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft`, `tags` + List the (latest) versions of available plugs. ### List Latest Plug Versions By default, the result includes the latest non-deprecated, non-draft version for each plug name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour:
    • includeDeprecated=true: do not prefer non-deprecated versions as a latest version: if the latest version is a deprecated one, it will be shown, even if there are older non-deprecated versions.
    • includeDraft=true: do not prefer non-draft versions as a latest version: if the latest version is a draft, it will be shown, even if there are older non-draft versions.
    As long as no version filters are used, each listed plug version contains representations of the latest draft (`entities[]._links.draft`) or latest published (`entities[]._links.published`) version (if existing and different). Use the query parameter `showRelated` to include only a link (default `showRelated=link`) or a full representation (`showRelated=embed`). ### List Latest Plug Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named plug that satisfy the filters, but **without links**. ### List All Plug Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ plugs versions that satisfy the query, possibly multiple versions per named plugs. No HAL links are provided. #### Filter on _status_ By default plug versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the plug listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft`, `tags` :param query: URL Query parameters. :type query: ListQuery | QueryParamTypes, optional :param query['tags'] (dict)
    query.tags (Query) : Filter on the tags of the item. Can be a single tag, or a list of tags. When multiple tags are specified, an item must have all of the tags to be selected. @@ -1654,6 +1725,8 @@ async def list( :type query['runtime']: List[str] :param query['latest'] (dict)
    query.latest (Query) : When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. :type query['latest']: bool + :param query['showRelated'] (dict)
    query.show_related (Query) : Sets the representation of related function versions (like the _latest_ draft and/or published) in the response. - `embed`: as full summary representation (in `_embedded`). - `link`: as HAL link in (in `_links`). - `none`: omitted. + :type query['showRelated']: ShowRelatedType :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -2366,8 +2439,12 @@ async def publish( :type version: str :param query: URL Query parameters. :type query: PublishQuery | QueryParamTypes, optional + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['deprecatePrevious'] (dict)
    query.deprecate_previous (Query) : Set the cleanup policy used to automatically deprecate/delete previous versions. :type query['deprecatePrevious']: DeprecatePreviousPolicy :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. @@ -2542,6 +2619,8 @@ async def rebuild( :type version: str :param query: URL Query parameters. :type query: RebuildQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. + :type query['scaleToZero']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str :param query['dryRun'] (dict)
    query.dry_run (Query) : If set to true, checks whether rebuild jobs are needed, but do not start any jobs. @@ -2554,8 +2633,6 @@ async def rebuild( :type query['forceVersion']: str :param query['ignoreChecks'] (dict)
    query.ignore_checks (Query) : If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option :type query['ignoreChecks']: bool - :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command. - :type query['scaleToZero']: bool :param query['skipRebuild'] (dict)
    query.skip_rebuild (Query) : If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function. :type query['skipRebuild']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. @@ -3121,12 +3198,18 @@ async def update_asset( :type content: ContentRequest, optional :param query: URL Query parameters. :type query: UpdateAssetQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. (required) - :type query['chown']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -3173,7 +3256,9 @@ async def update_asset( "202": PostPlugJobAsyncResponseV2 if not select_path else Model, } ) - non_200_response_types_map: Dict[str, Any] = {} + non_200_response_types_map: Dict[str, Any] = { + "403": RegistryErrorResponse, + } response_types_map.update(non_200_response_types_map) ## peform request @@ -3201,7 +3286,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3227,7 +3312,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3253,7 +3338,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3279,7 +3364,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3305,7 +3390,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3330,7 +3415,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3346,23 +3431,29 @@ async def update_assets( ) -> PostPlugJobSyncResponseV2 | PostPlugJobAsyncResponseV2 | T | Response | Model: """Update Plug Assets. - Update a draft plug function by updating its assets. The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. + Update a draft plug function by updating its assets. The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. :param name: The name of the function. (required) :type name: str :param version: The version of the function. (required) :type version: str - :param content: The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. + :param content: The assets for a plug function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the plug function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the plug.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. :type content: ContentRequest, optional :param files: The files of a `content-type: multipart/form-data` request. :type files: FilesRequest, optional :param query: URL Query parameters. :type query: UpdateAssetsQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. (required) - :type query['chown']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -3409,7 +3500,9 @@ async def update_assets( "202": PostPlugJobAsyncResponseV2 if not select_path else Model, } ) - non_200_response_types_map: Dict[str, Any] = {} + non_200_response_types_map: Dict[str, Any] = { + "403": RegistryErrorResponse, + } response_types_map.update(non_200_response_types_map) ## peform request @@ -3535,12 +3628,10 @@ async def verify( :type version: str :param query: URL Query parameters. :type query: VerifyQuery | QueryParamTypes, optional - :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. - :type query['comment']: str - :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - :type query['async']: bool :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. :type query['scaleToZero']: bool + :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. + :type query['async']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. diff --git a/waylay-sdk-registry/src/waylay/services/registry/api/webscript_functions_api.py b/waylay-sdk-registry/src/waylay/services/registry/api/webscripts_api.py similarity index 82% rename from waylay-sdk-registry/src/waylay/services/registry/api/webscript_functions_api.py rename to waylay-sdk-registry/src/waylay/services/registry/api/webscripts_api.py index 41433003..3820ca58 100644 --- a/waylay-sdk-registry/src/waylay/services/registry/api/webscript_functions_api.py +++ b/waylay-sdk-registry/src/waylay/services/registry/api/webscripts_api.py @@ -17,12 +17,14 @@ Literal, Optional, TypeVar, + Union, overload, ) from pydantic import ( Field, StrictBool, + StrictBytes, StrictStr, TypeAdapter, ) @@ -46,17 +48,17 @@ GetWebscriptResponseV2, JobsForWebscriptResponseV2, LatestWebscriptsResponseV2, - MultipartFileUpload, PostWebscriptJobAsyncResponseV2, PostWebscriptJobSyncResponseV2, RebuildWebscriptAsyncResponseV2, RebuildWebscriptSyncResponseV2, + RegistryErrorResponse, UndeployedResponseV2, UndeploySubmittedResponseV2, VerifyWebscriptSyncResponseV2, WebscriptVersionsResponseV2, ) - from waylay.services.registry.queries.webscript_functions_api import ( + from waylay.services.registry.queries.webscripts_api import ( CreateQuery, DeleteAssetQuery, GetArchiveQuery, @@ -84,17 +86,17 @@ GetWebscriptResponseV2, JobsForWebscriptResponseV2, LatestWebscriptsResponseV2, - MultipartFileUpload, PostWebscriptJobAsyncResponseV2, PostWebscriptJobSyncResponseV2, RebuildWebscriptAsyncResponseV2, RebuildWebscriptSyncResponseV2, + RegistryErrorResponse, UndeployedResponseV2, UndeploySubmittedResponseV2, VerifyWebscriptSyncResponseV2, WebscriptVersionsResponseV2, ) - from waylay.services.registry.queries.webscript_functions_api import ( + from waylay.services.registry.queries.webscripts_api import ( CreateQuery, DeleteAssetQuery, GetArchiveQuery, @@ -119,8 +121,6 @@ MODELS_AVAILABLE = False if not TYPE_CHECKING: - MultipartFileUpload = Model - CreateQuery = dict PostWebscriptJobSyncResponseV2 = Model @@ -131,6 +131,8 @@ PostWebscriptJobAsyncResponseV2 = Model + RegistryErrorResponse = Model + GetArchiveQuery = dict GetAssetQuery = dict @@ -182,13 +184,15 @@ PostWebscriptJobAsyncResponseV2 = Model - MultipartFileUpload = Model + RegistryErrorResponse = Model UpdateAssetsQuery = dict PostWebscriptJobSyncResponseV2 = Model PostWebscriptJobAsyncResponseV2 = Model + RegistryErrorResponse = Model + VerifyQuery = dict VerifyWebscriptSyncResponseV2 = Model @@ -198,8 +202,8 @@ T = TypeVar("T") -class WebscriptFunctionsApi(WithApiClient): - """WebscriptFunctionsApi service methods. +class WebscriptsApi(WithApiClient): + """WebscriptsApi service methods. NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech @@ -211,10 +215,16 @@ class WebscriptFunctionsApi(WithApiClient): async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -233,10 +243,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -255,10 +271,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -277,10 +299,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -299,10 +327,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -320,10 +354,16 @@ async def create( async def create( self, *, + json: Annotated[ + StrictBytes | StrictStr | None, + Field( + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + ), + ] = None, content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " ), ] = None, files: Annotated[ @@ -345,27 +385,39 @@ async def create( ): """Create Webscript Version. - Creates a new webscript function by uploading its assets. The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. - :param content: The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. + Creates a new webscript function by uploading its assets. The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. + :param json: The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. + :type json: bytearray, optional + :param content: The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. :type content: ContentRequest, optional :param files: The files of a `content-type: multipart/form-data` request. :type files: FilesRequest, optional :param query: URL Query parameters. :type query: CreateQuery | QueryParamTypes, optional + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str + :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. + :type query['comment']: str + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool :param query['deprecatePrevious'] (dict)
    query.deprecate_previous (Query) : Set the cleanup policy used to automatically deprecate/delete previous versions. :type query['deprecatePrevious']: DeprecatePreviousPolicy :param query['dryRun'] (dict)
    query.dry_run (Query) : If set to true, validates the deployment conditions, but does not change anything. :type query['dryRun']: bool :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. Saves computing resources when the function is not to be used immediately. - :type query['scaleToZero']: bool :param query['version'] (dict)
    query.version (Query) : If set, the function version will be an increment of the latest existing version that satisfies the `version` range. Note that this increment always takes precedence over an explicit `version` in the function manifest. :type query['version']: SemanticVersionRange :param query['name'] (dict)
    query.name (Query) : If set, the value will be used as the function name instead of the one specified in the manifest. :type query['name']: str :param query['draft'] (dict)
    query.draft (Query) : If set, the created function will be a draft function and its assets are still mutable. A build and deploy is initiated only in the case when all necessary assets are present and valid. :type query['draft']: bool + :param query['runtime'] (dict)
    query.runtime (Query) : If set, the created function will use the indicated runtime (latest version within specified range). This takes precedence over the runtime specified in a function manifest (copied or from request body). + :type query['runtime']: str + :param query['copy'] (dict)
    query.copy_from (Query) : Indicates the _source_ of initial assets for a _new function_. When using this query parameter, the request body does not need to contain assets, but any assets in the request body will overwrite the copied assets. #### Selection of _assets_ source * If set as `[@]`, the _new function_ will be created with copied assets of the selected _source function_. * If set as `!example`, a `runtime` query parameter is required, and the _new function_ will be initialized with assets of the _runtime example_. #### Selection of the _source function_ When `` is a range (or is not given), the latest _published_ version (in that range) is used. If no _published_ version exists, the latest _draft_ is selected. If no versions in the range exist, a `404` _Not Found_ error is returned. #### The `name` of the _new function_ If a `name` is NOT specified (either as query parameter, or in an optional manifest asset in the request body), the `name` of the _new function_ will be that of the _source function_. #### The `version` of the _new function_ When the _target_ and _source_ name are equal, the `version` query parameters is defaulted to `` (`~` when it's an exact version) The version of the _new function_ will be: * If a `version` is NOT specified (either as query parameter, in an optional manifest asset, or as `` _default_) * a **patch increment** (`..+1`) of the latest **existing version** with the target `name` * **`1.0.0`** otherwise * If a `version` is specified: * the **lowest version** in that range **if no existing version** is in that range. * an **increment** of the latest existing version, **at the highest level** (_major_,_minor_,_patch_) allowed by that range. * otherwise, if all allowed versions already exist, a **`409` _Duplicate_ error** is raised. #### Deployment overrides The new function will use the deployment overrides of the copied function, unless a _manifest_ was specified in the request body. + :type query['copy']: CreateWebscriptsCopyParameter :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -394,6 +446,17 @@ async def create( ## named body parameters body_args: Dict[str, Any] = {} + if json is not None and validate_request: + body_adapter = TypeAdapter( + Annotated[ + Optional[Union[StrictBytes, StrictStr]], + Field( + description="The assets for a webscript function can be provided as
    • A single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • Separate files in a multipart/form-data request
    • A reference to the assets of another webscript in the copy argument
    The required webscript.json json file contains the function metadata, and must have a runtime attribute that is one of the supported runtimes (see GET /registry/v2/runtimes?functionType=webscripts). For each runtime other files will be required or supported. " + ), + ] + ) + json = body_adapter.validate_python(json) # type: ignore # https://github.com/pydantic/pydantic/discussions/7094 + body_args["json"] = json body_args["content"] = content body_args["files"] = files @@ -579,12 +642,18 @@ async def delete_asset( :type wildcard: str :param query: URL Query parameters. :type query: DeleteAssetQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. (required) - :type query['chown']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -630,7 +699,9 @@ async def delete_asset( "202": PostWebscriptJobAsyncResponseV2 if not select_path else Model, } ) - non_200_response_types_map: Dict[str, Any] = {} + non_200_response_types_map: Dict[str, Any] = { + "403": RegistryErrorResponse, + } response_types_map.update(non_200_response_types_map) ## peform request @@ -1786,7 +1857,7 @@ async def list( ) -> LatestWebscriptsResponseV2 | T | Response | Model: """List Webscripts. - List the (latest) versions of available webscripts. ### List Latest Webscript Versions By default, the result includes the latest non-deprecated, non-draft version for each webscript name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour:
    • includeDeprecated=true: do not prefer non-deprecated versions as a latest version: if the latest version is a deprecated one, it will be shown, even if there are older non-deprecated versions.
    • includeDraft=true: do not prefer non-draft versions as a latest version: if the latest version is a draft, it will be shown, even if there are older non-draft versions.
    As long as no _version filters_ are used, each listed webscript version item will contain a HAL **link to the latest** _draft_ (`entities[]._links.draft`) or latest _published_ (`entities[]._links.publisned`) version (if existing and different). ### List Latest Webscript Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named webscript that satisfy the filters, but **without links**. ### List All Webscript Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ webscripts versions that satisfy the query, possibly multiple versions per named webscripts. No HAL links are provided. #### Filter on _status_ By default webscript versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the webscript listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft` + List the (latest) versions of available webscripts. ### List Latest Webscript Versions By default, the result includes the latest non-deprecated, non-draft version for each webscript name. If there is no such version, the latest _deprecated_ or the latest _draft_ version is included, with the former taking precedence. Use the boolean query parameters includeDeprecated or includeDraft to change this behaviour:
    • includeDeprecated=true: do not prefer non-deprecated versions as a latest version: if the latest version is a deprecated one, it will be shown, even if there are older non-deprecated versions.
    • includeDraft=true: do not prefer non-draft versions as a latest version: if the latest version is a draft, it will be shown, even if there are older non-draft versions.
    As long as no version filters are used, each listed webscript version contains representations of the latest draft (`entities[]._links.draft`) or latest published (`entities[]._links.published`) version (if existing and different). Use the query parameter `showRelated` to include only a link (default `showRelated=link`) or a full representation (`showRelated=embed`). ### List Latest Webscript Versions (with filter) When any of the _version filter_ query parameters are used, the response contains the _latest_ version per named webscript that satisfy the filters, but **without links**. ### List All Webscript Versions When using `latest=false` (default when using the `namedVersion` filter), the listing contains _all_ webscripts versions that satisfy the query, possibly multiple versions per named webscripts. No HAL links are provided. #### Filter on _status_ By default webscript versions with status `undeployed` are **excluded** in all cases. Use the _version filter_ `status` to include/exclude a status from the results. By example, > `?status=any&includeDeprecated=true&includeDraft=true&latest=false` will list _ALL_ versions known to the function registry. #### Version filter parameters The following query parameters are _version filters_ for the webscript listing: > `version`, `status`, `runtimeVersion`, `createdBy`, `createdBefore`, `createdAfter`, `updatedBy`, `updatedBefore`, `updatedAfter`, `nameVersion`, `deprecated`, `draft` :param query: URL Query parameters. :type query: ListQuery | QueryParamTypes, optional :param query['limit'] (dict)
    query.limit (Query) : The maximum number of items to be return from this query. Has a deployment-defined default and maximum value. @@ -1829,6 +1900,8 @@ async def list( :type query['runtime']: List[str] :param query['latest'] (dict)
    query.latest (Query) : When `true`, only the latest version per function name is returned. If set to `false`, multiple versions per named function can be returned. Defaults to `true`, except when specific versions are selected with the `nameVersion` filter. :type query['latest']: bool + :param query['showRelated'] (dict)
    query.show_related (Query) : Sets the representation of related function versions (like the _latest_ draft and/or published) in the response. - `embed`: as full summary representation (in `_embedded`). - `link`: as HAL link in (in `_links`). - `none`: omitted. + :type query['showRelated']: ShowRelatedType :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -2184,8 +2257,12 @@ async def publish( :type version: str :param query: URL Query parameters. :type query: PublishQuery | QueryParamTypes, optional + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['deprecatePrevious'] (dict)
    query.deprecate_previous (Query) : Set the cleanup policy used to automatically deprecate/delete previous versions. :type query['deprecatePrevious']: DeprecatePreviousPolicy :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. @@ -2366,6 +2443,8 @@ async def rebuild( :type version: str :param query: URL Query parameters. :type query: RebuildQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. + :type query['scaleToZero']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str :param query['dryRun'] (dict)
    query.dry_run (Query) : If set to true, checks whether rebuild jobs are needed, but do not start any jobs. @@ -2378,8 +2457,6 @@ async def rebuild( :type query['forceVersion']: str :param query['ignoreChecks'] (dict)
    query.ignore_checks (Query) : If set to true, checks that normally prevent a rebuild are overriden. These checks include: * function state in `pending`, `running`, `failed` or `undeployed` * backoff period due to recent failures * usage of deprecated dependencies * running jobs on entity * the `dryRun` option :type query['ignoreChecks']: bool - :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : Indicates whether the function needs to be scaled down after successful (re-)deployment. If not set, the function is scaled to zero only if it was not active before this command. - :type query['scaleToZero']: bool :param query['skipRebuild'] (dict)
    query.skip_rebuild (Query) : If set, the function will not be rebuild. Always uses the current runtime version when re-deploying/re-verifying the function. :type query['skipRebuild']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. @@ -2951,12 +3028,18 @@ async def update_asset( :type content: ContentRequest, optional :param query: URL Query parameters. :type query: UpdateAssetQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. (required) - :type query['chown']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -3003,7 +3086,9 @@ async def update_asset( "202": PostWebscriptJobAsyncResponseV2 if not select_path else Model, } ) - non_200_response_types_map: Dict[str, Any] = {} + non_200_response_types_map: Dict[str, Any] = { + "403": RegistryErrorResponse, + } response_types_map.update(non_200_response_types_map) ## peform request @@ -3031,7 +3116,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3057,7 +3142,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3083,7 +3168,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3109,7 +3194,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3135,7 +3220,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3160,7 +3245,7 @@ async def update_assets( content: Annotated[ RequestContent | None, Field( - description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " + description="The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. " ), ] = None, files: Annotated[ @@ -3182,23 +3267,29 @@ async def update_assets( ): """Update Webscript Assets. - Update a draft webscript function by updating its assets. The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. + Update a draft webscript function by updating its assets. The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. :param name: The name of the function. (required) :type name: str :param version: The version of the function. (required) :type version: str - :param content: The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. + :param content: The assets for a webscript function can be provided as either
    • a single tar archive (optionally compressed), with one of the content types application/octet-stream, application/tar, application/tar+gzip, application/x-gzip, application/x-tar, application/gzip
    • separate files in a multipart/form-data request
    The provided assets will be added to the webscript function's collection of existing assets, replacing any existing assets with the same name. Please note that it is not allowed to update the webscript.json json file with a changed value for any of the name, version and/or runtime attributes. For each runtime other files are supported. :type content: ContentRequest, optional :param files: The files of a `content-type: multipart/form-data` request. :type files: FilesRequest, optional :param query: URL Query parameters. :type query: UpdateAssetsQuery | QueryParamTypes, optional + :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : If set to true, after successful deployment, the deployed function will be scaled to zero. This saves computing resources when the function is not to be used immediately. + :type query['scaleToZero']: bool + :param query['deploy'] (dict)
    query.deploy (Query) : Indicates that a function should be _deployed_ when its assets are valid. * If `true` (default), jobs to build and deploy the function will be initiated after it is checked that the assets are valid. Invalid assets lead to a validation error, and the function and its assets are not created or updated. * If `false`, the uploaded assets are stored and the function is created/updated in `registered` state. Asset validation errors are only returned as warning, and stored as `failureReason` on the function entity. Use an _asset update_ or _rebuild_ to initiate a build and deploy at a later stage. + :type query['deploy']: bool + :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. + :type query['chown']: bool :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. :type query['comment']: str + :param query['author'] (dict)
    query.author (Query) : Optionally changes the author metadata when updating a function. + :type query['author']: str :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. :type query['async']: bool - :param query['chown'] (dict)
    query.chown (Query) : If set, ownership of the draft function is transferred to the current user. (required) - :type query['chown']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. @@ -3245,7 +3336,9 @@ async def update_assets( "202": PostWebscriptJobAsyncResponseV2 if not select_path else Model, } ) - non_200_response_types_map: Dict[str, Any] = {} + non_200_response_types_map: Dict[str, Any] = { + "403": RegistryErrorResponse, + } response_types_map.update(non_200_response_types_map) ## peform request @@ -3377,12 +3470,10 @@ async def verify( :type version: str :param query: URL Query parameters. :type query: VerifyQuery | QueryParamTypes, optional - :param query['comment'] (dict)
    query.comment (Query) : An optional user-specified comment corresponding to the operation. - :type query['comment']: str - :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. - :type query['async']: bool :param query['scaleToZero'] (dict)
    query.scale_to_zero (Query) : Indicates whether the function needs to be scaled down after successful verification. If not set, the function is scaled to zero only if it was not active before this command. :type query['scaleToZero']: bool + :param query['async'] (dict)
    query.var_async (Query) : Unless this is set to false, the server will start the required job actions asynchronously and return a 202 Accepted response. If false the request will block until the job actions are completed, or a timeout occurs. + :type query['async']: bool :param raw_response: If true, return the http Response object instead of returning an api model object, or throwing an ApiError. :param select_path: Denotes the json path applied to the response object before returning it. Set it to the empty string `""` to receive the full response object. diff --git a/waylay-sdk-registry/src/waylay/services/registry/service/__init__.py b/waylay-sdk-registry/src/waylay/services/registry/service/__init__.py index 3e992e32..1286b53d 100644 --- a/waylay-sdk-registry/src/waylay/services/registry/service/__init__.py +++ b/waylay-sdk-registry/src/waylay/services/registry/service/__init__.py @@ -3,7 +3,7 @@ This code was generated from the OpenAPI documentation of 'Waylay Function Registry' -version: 2.12.4 +version: 2.13.0 V2 API to build and deploy Waylay functions (plugs, webscripts, BYOML models). @@ -12,7 +12,7 @@ Do not edit the class manually. """ -__version__ = "2.12.4.20240423" +__version__ = "2.13.0.20240430" from .service import RegistryService diff --git a/waylay-sdk-registry/src/waylay/services/registry/service/service.py b/waylay-sdk-registry/src/waylay/services/registry/service/service.py index 635bcd5d..2c8f4dff 100644 --- a/waylay-sdk-registry/src/waylay/services/registry/service/service.py +++ b/waylay-sdk-registry/src/waylay/services/registry/service/service.py @@ -2,13 +2,13 @@ from waylay.sdk import ApiClient, WaylayService -from ..api.default_api import DefaultApi +from ..api.about_api import AboutApi from ..api.jobs_api import JobsApi -from ..api.model_functions_api import ModelFunctionsApi -from ..api.plug_functions_api import PlugFunctionsApi +from ..api.models_api import ModelsApi +from ..api.plugs_api import PlugsApi from ..api.runtimes_api import RuntimesApi from ..api.schemas_api import SchemasApi -from ..api.webscript_functions_api import WebscriptFunctionsApi +from ..api.webscripts_api import WebscriptsApi class RegistryService(WaylayService): @@ -17,22 +17,22 @@ class RegistryService(WaylayService): name = "registry" title = "Registry Service" + about: AboutApi jobs: JobsApi - model_functions: ModelFunctionsApi - plug_functions: PlugFunctionsApi + models: ModelsApi + plugs: PlugsApi runtimes: RuntimesApi schemas: SchemasApi - webscript_functions: WebscriptFunctionsApi - default: DefaultApi + webscripts: WebscriptsApi def __init__(self, api_client: ApiClient): """Create the registry service.""" super().__init__(api_client) + self.about = AboutApi(api_client) self.jobs = JobsApi(api_client) - self.model_functions = ModelFunctionsApi(api_client) - self.plug_functions = PlugFunctionsApi(api_client) + self.models = ModelsApi(api_client) + self.plugs = PlugsApi(api_client) self.runtimes = RuntimesApi(api_client) self.schemas = SchemasApi(api_client) - self.webscript_functions = WebscriptFunctionsApi(api_client) - self.default = DefaultApi(api_client) + self.webscripts = WebscriptsApi(api_client)